Repository: tomaka/os
Branch: main
Commit: 9bf924ce2997
Files: 247
Total size: 3.2 MB
Directory structure:
gitextract_fwagyvzx/
├── .dockerignore
├── .github/
│ ├── dependabot.yml
│ └── workflows/
│ └── ci.yml
├── .gitignore
├── Cargo.toml
├── LICENSE
├── README.md
├── docs/
│ ├── authorizations.md
│ ├── interfaces.md
│ ├── introduction.md
│ └── messages.md
├── interface-wrappers/
│ ├── disk/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── disk.rs
│ │ ├── ffi.rs
│ │ └── lib.rs
│ ├── ethernet/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ ├── interface.rs
│ │ └── lib.rs
│ ├── framebuffer/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ └── lib.rs
│ ├── hardware/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ ├── lib.rs
│ │ └── malloc.rs
│ ├── interface/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ └── lib.rs
│ ├── kernel-debug/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ └── lib.rs
│ ├── kernel-log/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ └── lib.rs
│ ├── loader/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ └── lib.rs
│ ├── log/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ └── lib.rs
│ ├── pci/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ └── lib.rs
│ ├── random/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ └── lib.rs
│ ├── syscalls/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── block_on.rs
│ │ ├── emit.rs
│ │ ├── ffi.rs
│ │ ├── lib.rs
│ │ ├── response.rs
│ │ └── traits.rs
│ ├── system-time/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ └── lib.rs
│ ├── tcp/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── ffi.rs
│ │ └── lib.rs
│ ├── time/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── delay.rs
│ │ ├── ffi.rs
│ │ ├── instant.rs
│ │ └── lib.rs
│ └── video-output/
│ ├── Cargo.toml
│ └── src/
│ ├── ffi.rs
│ ├── lib.rs
│ └── video_output.rs
├── kernel/
│ ├── core/
│ │ ├── Cargo.toml
│ │ ├── benches/
│ │ │ ├── keccak.rs
│ │ │ └── keccak.wasm
│ │ └── src/
│ │ ├── extrinsics/
│ │ │ ├── log_calls.rs
│ │ │ └── wasi.rs
│ │ ├── extrinsics.rs
│ │ ├── id_pool.rs
│ │ ├── lib.rs
│ │ ├── module.rs
│ │ ├── primitives.rs
│ │ ├── scheduler/
│ │ │ ├── extrinsics/
│ │ │ │ └── calls.rs
│ │ │ ├── extrinsics.rs
│ │ │ ├── ipc/
│ │ │ │ ├── notifications_queue.rs
│ │ │ │ └── waiting_threads.rs
│ │ │ ├── ipc.rs
│ │ │ ├── processes/
│ │ │ │ ├── tests.rs
│ │ │ │ └── wakers.rs
│ │ │ ├── processes.rs
│ │ │ ├── tests/
│ │ │ │ ├── basic_module.rs
│ │ │ │ ├── emit_not_available.rs
│ │ │ │ └── trapping_module.rs
│ │ │ ├── tests.rs
│ │ │ └── vm.rs
│ │ ├── scheduler.rs
│ │ ├── system/
│ │ │ ├── interfaces.rs
│ │ │ └── pending_answers.rs
│ │ └── system.rs
│ ├── core-proc-macros/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ └── lib.rs
│ └── standalone/
│ ├── Cargo.toml
│ ├── build.rs
│ └── src/
│ ├── arch/
│ │ ├── arm/
│ │ │ ├── executor.rs
│ │ │ ├── log.rs
│ │ │ ├── misc.rs
│ │ │ ├── time_aarch64.rs
│ │ │ └── time_arm.rs
│ │ ├── arm.rs
│ │ ├── riscv/
│ │ │ ├── executor.rs
│ │ │ ├── interrupts.rs
│ │ │ ├── log.rs
│ │ │ └── misc.rs
│ │ ├── riscv.rs
│ │ ├── x86_64/
│ │ │ ├── acpi.rs
│ │ │ ├── ap_boot.rs
│ │ │ ├── apic/
│ │ │ │ ├── io_apic.rs
│ │ │ │ ├── io_apics.rs
│ │ │ │ ├── local.rs
│ │ │ │ ├── pic.rs
│ │ │ │ ├── timers.rs
│ │ │ │ └── tsc_sync.rs
│ │ │ ├── apic.rs
│ │ │ ├── boot.rs
│ │ │ ├── executor.rs
│ │ │ ├── gdt.rs
│ │ │ ├── interrupts.rs
│ │ │ ├── panic.rs
│ │ │ └── pit.rs
│ │ └── x86_64.rs
│ ├── arch.rs
│ ├── hardware.rs
│ ├── kernel.rs
│ ├── klog/
│ │ ├── logger.rs
│ │ ├── native.rs
│ │ └── video.rs
│ ├── klog.rs
│ ├── lib.rs
│ ├── mem_alloc.rs
│ ├── pci/
│ │ ├── native.rs
│ │ └── pci.rs
│ ├── pci.rs
│ ├── random/
│ │ ├── native.rs
│ │ └── rng.rs
│ ├── random.rs
│ └── time.rs
├── kernel-standalone-builder/
│ ├── Cargo.toml
│ ├── build.rs
│ ├── res/
│ │ ├── rpi-firmware/
│ │ │ └── boot/
│ │ │ ├── COPYING.linux
│ │ │ ├── LICENCE.broadcom
│ │ │ ├── bcm2711-rpi-4-b.dtb
│ │ │ ├── start.elf
│ │ │ └── start4.elf
│ │ └── specs/
│ │ ├── aarch64-freestanding.json
│ │ ├── aarch64-freestanding.ld
│ │ ├── arm-freestanding.json
│ │ ├── arm-freestanding.ld
│ │ ├── riscv-hifive.json
│ │ ├── riscv-hifive.ld
│ │ ├── x86_64-multiboot2.json
│ │ └── x86_64-multiboot2.ld
│ ├── simpleboot/
│ │ ├── README.md
│ │ ├── simpleboot/
│ │ │ ├── .gitignore
│ │ │ ├── Kconfig
│ │ │ ├── Kconfig.name
│ │ │ ├── LICENSE
│ │ │ ├── Makefile
│ │ │ ├── README.md
│ │ │ ├── distrib/
│ │ │ │ ├── PKGBUILD
│ │ │ │ ├── simpleboot
│ │ │ │ ├── simpleboot-1.0.0.ebuild
│ │ │ │ ├── simpleboot-9999.ebuild
│ │ │ │ ├── simpleboot_1.0.0-amd64.deb
│ │ │ │ └── simpleboot_1.0.0-armhf.deb
│ │ │ ├── docs/
│ │ │ │ ├── ABI.md
│ │ │ │ ├── README.md
│ │ │ │ └── coreboot.md
│ │ │ ├── example/
│ │ │ │ ├── Makefile
│ │ │ │ ├── README.md
│ │ │ │ ├── bochs.rc
│ │ │ │ ├── gdb.rc
│ │ │ │ ├── kernel.c
│ │ │ │ ├── linux.c
│ │ │ │ └── simpleboot.cfg
│ │ │ ├── simpleboot.h
│ │ │ └── src/
│ │ │ ├── Makefile
│ │ │ ├── boot_x86.asm
│ │ │ ├── cdemu_x86.asm
│ │ │ ├── data.h
│ │ │ ├── inflate.h
│ │ │ ├── loader.h
│ │ │ ├── loader_cb.c
│ │ │ ├── loader_rpi.c
│ │ │ ├── loader_x86.c
│ │ │ ├── misc/
│ │ │ │ ├── bin2h.c
│ │ │ │ └── deb_control
│ │ │ ├── rombios_x86.asm
│ │ │ ├── romfoss_x86.asm
│ │ │ └── simpleboot.c
│ │ └── wrapper.c
│ └── src/
│ ├── bin/
│ │ └── main.rs
│ ├── binary.rs
│ ├── build.rs
│ ├── emulator.rs
│ ├── image.rs
│ ├── lib.rs
│ ├── simpleboot.rs
│ └── test.rs
├── programs/
│ ├── .cargo/
│ │ └── config.toml
│ ├── .dockerignore
│ ├── Cargo.toml
│ ├── compositor/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── lib.rs
│ │ ├── main.rs
│ │ └── rect.rs
│ ├── diagnostics-http-server/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ └── main.rs
│ ├── dummy-system-time/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ └── main.rs
│ ├── e1000/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── device.rs
│ │ └── main.rs
│ ├── hello-world/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ └── main.rs
│ ├── log-to-kernel/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ └── main.rs
│ ├── network-manager/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── interface.rs
│ │ ├── lib.rs
│ │ ├── main.rs
│ │ ├── manager.rs
│ │ └── port_assign.rs
│ ├── pci-printer/
│ │ ├── Cargo.toml
│ │ ├── build/
│ │ │ └── pci.ids
│ │ ├── build.rs
│ │ └── src/
│ │ └── main.rs
│ ├── rpi-framebuffer/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ ├── mailbox.rs
│ │ ├── main.rs
│ │ └── property.rs
│ ├── stub/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ └── main.rs
│ ├── third-party/
│ │ ├── README.md
│ │ └── wasm-timer/
│ │ ├── Cargo.toml
│ │ └── src/
│ │ └── lib.rs
│ └── vga-vbe/
│ ├── Cargo.toml
│ └── src/
│ ├── interpreter/
│ │ └── tests.rs
│ ├── interpreter.rs
│ ├── main.rs
│ └── vbe.rs
└── rust-toolchain
================================================
FILE CONTENTS
================================================
================================================
FILE: .dockerignore
================================================
target
================================================
FILE: .github/dependabot.yml
================================================
version: 2
updates:
- package-ecosystem: github-actions
directory: "/"
labels: []
rebase-strategy: disabled # Redundant with mergify
schedule:
interval: daily
- package-ecosystem: cargo
directory: "/kernel-standalone-builder"
labels: []
rebase-strategy: disabled # Redundant with mergify
schedule:
interval: daily
- package-ecosystem: cargo
directory: "/programs"
labels: []
rebase-strategy: disabled # Redundant with mergify
schedule:
interval: daily
- package-ecosystem: cargo
directory: "/"
labels: []
rebase-strategy: disabled # Redundant with mergify
schedule:
interval: daily
================================================
FILE: .github/workflows/ci.yml
================================================
name: Continuous integration
on:
pull_request:
jobs:
build-programs:
name: Build WASM programs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Rust
uses: actions-rs/toolchain@v1
with:
toolchain: nightly-2025-03-14
target: wasm32-wasip1
override: true
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y cmake
- uses: actions/cache@v4.2.3
with:
path: |
~/.cargo/registry
~/.cargo/git
programs/target
key: programs-cargo-${{ hashFiles('./programs/Cargo.lock') }}
- name: Build programs
run: cargo build --manifest-path ./programs/Cargo.toml --workspace --exclude stub --locked --verbose --release --target=wasm32-wasip1
- name: Upload WASM programs
uses: actions/upload-artifact@v4
with:
name: wasm-programs
path: programs/target
test-core:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/cache@v4.2.3
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: core-cargo-${{ hashFiles('**/Cargo.lock') }}
- name: Install nightly Rust
uses: actions-rs/toolchain@v1
with:
toolchain: nightly-2025-03-14
target: wasm32-wasip1
override: true
- name: Test redshirt-core
run: cargo test --package redshirt-core
build-test-standalone:
name: Build and test standalone kernel
needs: build-programs
runs-on: ubuntu-20.04 # TODO: for the more recent QEmu version compared to ubuntu-18
strategy:
matrix:
#target: [x86_64-multiboot2, arm-rpi2] # TODO: not implemented
target: [x86_64-multiboot2]
steps:
- uses: actions/checkout@v4
- name: Download WASM programs
uses: actions/download-artifact@v4
with:
name: wasm-programs
- name: Install required packages
run: |
sudo apt-get update
sudo apt-get install -y clang lld libisoburn1 xorriso grub-pc-bin mtools
- run: |
sudo apt-get install qemu-utils qemu-system-x86
if: ${{ matrix.target == 'x86_64-multiboot2'}}
- uses: actions/cache@v4.2.3
with:
path: |
~/.cargo/registry
~/.cargo/git
kernel-standalone-builder/target
target
key: standalone-kernel-cargo-${{ hashFiles('**/Cargo.lock') }}
- name: Install nightly Rust
uses: actions-rs/toolchain@v1
with:
toolchain: nightly-2025-03-14
target: wasm32-wasip1
override: true
- name: Install rust-src
run: rustup component add rust-src
- name: Build kernel
run: cargo run --manifest-path=./kernel-standalone-builder/Cargo.toml -- build-image --target ${{ matrix.target }} --device-type cdrom --out image
- name: Test kernel
run: cargo run --manifest-path=./kernel-standalone-builder/Cargo.toml -- emulator-test --target ${{ matrix.target }} --emulator qemu
- name: Upload generated kernel
uses: actions/upload-artifact@v4
with:
name: kernel-${{ matrix.target }}
path: image
fmt:
name: Rustfmt
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
- name: Install stable toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
- name: Install rustfmt
run: rustup component add rustfmt
- name: Run cargo fmt on root workspace
uses: actions-rs/cargo@v1
with:
command: fmt
args: --all -- --check
- name: Run cargo fmt on programs workspace
uses: actions-rs/cargo@v1
with:
command: fmt
args: --all --manifest-path=programs/Cargo.toml -- --check
- name: Run cargo fmt on standalone tester workspace
uses: actions-rs/cargo@v1
with:
command: fmt
args: --all --manifest-path=kernel-standalone-builder/Cargo.toml -- --check
intra-doc-links:
name: Check intra-doc links
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: nightly-2025-03-14
target: wasm32-wasip1
override: true
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y clang
- uses: actions/cache@v4.2.3
with:
path: |
~/.cargo/registry
~/.cargo/git
programs/target
kernel-standalone-builder/target
target
key: intra-doc-links-${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
- name: Check core intra-doc links
run: RUSTDOCFLAGS="--deny broken_intra_doc_links" cargo doc --verbose --workspace --no-deps --document-private-items
- name: Check programs intra-doc links
run: RUSTDOCFLAGS="--deny broken_intra_doc_links" cargo doc --verbose --manifest-path programs/Cargo.toml --workspace --no-deps --document-private-items
all-ci:
# This dummy job depends on all the mandatory checks. It succeeds if and only if CI is
# considered successful.
needs: [build-test-standalone, fmt, intra-doc-links]
runs-on: ubuntu-latest
steps:
- run: echo Success
================================================
FILE: .gitignore
================================================
target
================================================
FILE: Cargo.toml
================================================
[workspace]
members = [
"kernel/core",
"kernel/core-proc-macros",
"kernel/standalone",
"interface-wrappers/disk",
"interface-wrappers/ethernet",
"interface-wrappers/framebuffer",
"interface-wrappers/hardware",
"interface-wrappers/interface",
"interface-wrappers/kernel-debug",
"interface-wrappers/kernel-log",
"interface-wrappers/loader",
"interface-wrappers/log",
"interface-wrappers/pci",
"interface-wrappers/random",
"interface-wrappers/syscalls",
"interface-wrappers/system-time",
"interface-wrappers/tcp",
"interface-wrappers/time",
"interface-wrappers/video-output",
]
[profile.dev]
opt-level = 1
[profile.dev.package."*"]
opt-level = 3
[profile.test.package."*"]
opt-level = 3
[profile.release]
opt-level = 3
lto = true
codegen-units = 1
panic = 'abort'
================================================
FILE: LICENSE
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C) 2019-2020 Pierre Krieger
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C) 2019-2021 Pierre Krieger
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
================================================
FILE: README.md
================================================
The **redshirt** operating system is an experiment to build some kind of operating-system-like
environment where executables are all in Wasm and are loaded from an IPFS-like decentralized
network.
See the `docs/introduction.md` file for an introduction.
# How to test
**Important**: At the moment, most of the compilation requires a nightly version of Rust. See also https://github.com/tomaka/redshirt/issues/300.
Your C compiler must be recent enough to be capable of compiling to WebAssembly. This is for example the case for clang 9. See also https://github.com/tomaka/redshirt/issues/257.
You also need to install the `wasm32-wasip1` target, as the Wasm programs are compiled for Wasi, and the `rust-src` component in order to build the standalone kernel.
```
rustup toolchain install --target=wasm32-wasip1 nightly
rustup component add --toolchain=nightly rust-src
```
Building the freestanding kernel is then done through the utility called `standalone-builder`:
```
cd kernel-standalone-builder
cargo +nightly run -- emulator-run --emulator qemu --target x86_64-multiboot2
```
# Repository structure
Short overview of the structure of the repository:
- `docs` contains a description of what redshirt is and how it works. Start with `docs/introduction.md`.
- `interface-wrappers` contains crates that provide definitions and helpers for Wasm programs to use
(examples: `tcp` for TCP/IP, `window` for windowing).
- `kernel` contains the code required to run the kernel.
- `kernel-standalone-kernel` contains a utility allowing to run and test the standalone kernel.
- `programs` contains Wasm programs.
# Contributing
Please note that so far this is mostly a personal project. I reserve the right to change anything
at any time, including the license.
================================================
FILE: docs/authorizations.md
================================================
It is generally desirable to limit as much as possible the rights that a program has.
In redshirt, there is no system-wide rights management. Instead, each interface holds a list of which program can have access to the capabilities that they provide.
For example, it is the network manager program that holds a list of the programs that are allowed to open TCP connections.
By default, all programs should be banned from using anything, and must instead be whitelisted. For example, when you create a new process, it is by default prevented from using the TCP connection. One must then send a message to the TCP interface to inform the network manager that the newly-created process is allowed to open TCP connections.
================================================
FILE: docs/interfaces.md
================================================
This document contains information about interfaces, plus a list of interfaces that exist.
# Interfaces designing
## Does this warrant an interface?
Interfaces are fundamentally related to code re-use and synchronizing components.
It is for example theoretically possible for an HTTP server to communicate directly with the networking card of the machine and to directly issue read commands to hard-disk drives. This can be done by statically linking the server to device drivers.
In practice, however, doing so has two big drawbacks:
- Even if we suppose that the HTTP server supports all hardware that has ever existed, new incompatible hardware gets constantly released. As such, the HTTP server would stop working on newer machines unless it gets updated.
- Multiple programs trying to access the same hardware will conflict with each other.
Because of these two drawbacks, the hardware should be abstracted behind an interface. The first drawback is solved because the interface user and the interface handler can both be updated separately, and the second drawback is solved by having multiple interface users communicate with the same interface handler.
If, however, we take the example of font rendering (turning font files into bitmaps), none of these two drawbacks apply. Consequently, there shouldn't be an interface dedicated to font rendering.
## Updating an interface
It sometimes happens that interfaces need a modification. Interfaces are considered immutable, and modifying an interface can in practice be done only by creating a different interface (that closely resembles the old one) with a different hash.
Simply switching everything to the new interface, however, would break all the existing softwares that use the former interface.
In order to remedy to this, there are two solutions:
- Interface handlers can register both the old and the new hash.
- There can be a program can acts as a conversion layer between the old and the new hash, accepting messages from the old interface, translating them, and re-emitting them.
## Avoiding cross-interface concerns
The list of interfaces will never be set in marble, and each version of an interface is in principle unrelated to the previous versions of that interface. As such, an interface must **never** depend on another interface.
For example, in the Linux world, creating an OpenGL context requires passing an X11 display. This means that a hypothetical equivalent redshirt OpenGL interface would depend on the equivalent redshirt X11 interface. This is forbidden.
If an equivalent of OpenGL+X11 had to be designed, one could create an interface that combines all of OpenGL and X11 together.
Keep in mind that there is no one-to-one relation between interfaces and messages. For example an interface can combine into one the messaages of multiple other interfaces. "Elegance", "minimalism" or "code reuse" are not valid reasons to split an interface in multiple parts.
# Kernel-handled interfaces
Some interfaces, such as the `interface` interface, must be handled by the kernel. There is no other way that would lead to a correct implementation.
# Determining an interface hash
Undesigned at the moment.
# List of existing or planned interfaces
And now for a list. This list is most likely not up-to-date.
This list contains human-friendly names, but remember that interfaces are defined by their hash.
- `audio-playback`: Playing sounds.
- `device-tree`: Accessing hardware devices described by a DeviceTree (if any).
- `disks`: Registering disks potentially containing files.
- `ethernet`: Registering Ethernet interfaces.
- `files`: Opening/reading/writing files on a specific disk.
- `framebuffer`: Drawing a RGB buffer to an unspecified location.
- `hardware`: Accessing physical memory. Note: will most likely disappear to be superceded by `pci` and `device-tree`.
- `hid`: Accessing human-interface devices (keyboard, mouse, joysticks, etc.).
- `interface`: Registering interfaces.
- `kernel-debug`: Gathering information and statistics about the kernel. Supposed to be shown to users.
- `kernel-log`: Indicating to the kernel how to write its logs.
- `loader`: Loading content-addressed resources.
- `log`: Sending out logs destined to the user.
- `pci`: Accessing PCI devices (if any): reading/writing their memory-mapped memory/registers and waiting for interrupts.
- `random`: Generating random values.
- `system-time`: Managing the real time clock.
- `tcp`: TCP/IP sockets.
- `time`: Getting the value of the monotonic clock and waiting.
- `udp`: UDP packets.
- `usb`: Accessing USB devices (if any).
- `video-output`: Registering video outputs that will be presented to the user. Typically a video card connected to a monitor.
- `webgpu`: Issuing WebGPU draw calls to an unspecified location.
================================================
FILE: docs/introduction.md
================================================
# Introduction
Redshirt is similar to an operating system. It allows executing programs that communicate with each other via messages.
# Programs
The concept of a **program** is the same as in an operating system. It is a list of instructions that are executed and that have access to some memory.
Contrary to most operating systems, the instruction set of programs in redshirt is [WebAssembly](https://webassembly.org/) (also referred to as "Wasm").
Using WebAssembly as the instructions set has two consequences:
- All programs are cross-platform.
- Programs are not executed directly by the CPU, but by an interpreter or must first be translated into native code.
Thanks to the second point, we can eliminate the need for mechanisms such as paging/virtual memory and privilege levels. In other words, we don't make use of any of the sandboxing measures normally provided by the CPU.
## How are programs actually executed?
At the time of the writing of this documentation, we use [the `wasmi` crate](https://docs.rs/wasmi) to execute programs.
It has been measured that compiling a program and executing it with `wasmi` is approximately ten times slower than compiling the same program for the native architecture and executing it.
This measurement has been performed within Linux and this doesn't account, however, for the overhead introduced by the CPU's sandboxing measures.
Crates such as [`wasmtime`](https://docs.rs/wasmtime) should make it possible to considerably boost the performance of programs. Comparing a well-optimized HTTP server compiled for the native architecture to a badly-optimized HTTP server executed by `wasmtime` showed that the latter was capable of serving half of the requests per second of the former.
## Limitations of sandboxing
One design issue that hasn't been solved at the time of this writing is [preemption](https://en.wikipedia.org/wiki/Preemption_(computing)). In other words: how to run multiple CPU-intensive programs on the same CPU? In a typical operating system, the CPU receives periodic interrupts during which the operating system swaps the current thread for another.
Ideally, we would like to avoid relying on the CPU receiving interrupts and instead rely on [cooperating multitasking](https://en.wikipedia.org/wiki/Cooperative_multitasking). It is possible to make the WebAssembly interpreter or JIT insert periodic checks that interrupt the execution if a certain time has passed, but these checks are generally thought to be prohibitively expensive.
Additionally, at the time of this writing, redshirt doesn't enforce any limit on the memory that Wasm programs can use. This is however only a matter of implementation.
## About threads
WebAssembly at the moment doesn't specify any threading model or any memory model.
While redshirt has experimental support for creating multiple threads within a single process, WebAssembly-targeting compilers work under the assumption that only a single thread exists at any given point in time. As an example, LLVM stores the current stack pointer in a global variable.
Consequently, while experimental support exists, it isn't possible at the moment for programs to create secondary threads.
# Messages and interfaces
Programs are totally sandboxed, except for their capability to send messages to other processes and receive messages sent by other processes.
It is not possible, however, to send a message to a specific process (through a PID for instance). Instead, when you send a message, what you target is an **interface**.
Here is how it works:
- Program A registers itself towards the operating system to be the handler of a specific interface I.
- Program B sends a message whose destination is I.
- Program A receives the message that B has sent.
- Optionally, A can send a single answer to B's message.
In this example, B doesn't know about the existence of A. However, A knows about the existence of B so that it can properly track resources allocation.
Interfaces are referred to by a hash.
## What is the hash of an interface?
In the initial design, interfaces are defined by a list of messages and answers. The hash of an interface corresponds to the hash of the definition of these messages.
This is however quite difficult to implement in practice, and at the moment the hash is randomly generated manually (by visiting https://random.org) when a new interface is defined.
## Answers
Each message emitted accepts either zero or one answer. The sender indicates to the operating system whether it expects an answer.
If the emitter indicates that it expects an answer, a unique **message ID** gets assigned. This identifier is later passed to the interface handler for it to indicate which message it is answering.
## Message bodies and answer bodies
The actual message's body and the answer's body consist of an opaque buffer of data.
The way this body must be interpreted depends on the interface the message is targetting.
================================================
FILE: docs/messages.md
================================================
Contains details about the messages passing system.
# Syscalls
There exists five syscalls at the moment:
- `next_notification`
- `emit_message`
- `emit_answer`
- `emit_message_error`
- `cancel_message`
Describing their exact API/ABI here would be redundant. Please read the source code of the `syscalls` crate.
In WebAssembly, imported functions always belong to a namespace. The namespace of these five functions is `redshirt`.
# Emitting a message
The `emit_message` syscall requires passing:
- A target interface.
- A message body.
- A flag indicating whether or not an answer is expected.
- A flag indicating whether or not the function is allowed to wait in case there is no interface handler or the interface handler is overwhelmed.
If an answer is expected, a `MessageId` gets assigned and is returned to the caller.
If no interface handler exists for the target interface, or if the interface handler isn't capable of accepting a message at the moment, the function will either wait or immediately return with an error, depending on the function parameters.
## System initialization
At system initialization, the kernel is tasked to start all the programs that the user has requested to start.
The kernel doesn't know in advance which program is going to use or register which interface, so it simply starts everything at the same time.
Consequently, it is possible (in particular shortly after the system's initialization) for a program to try emit a message on an interface that hasn't been registered yet but is going to be in the near future.
It is, consequently, recommended to leave the `allow_block` flag on.
## Limits
(Note: this is not yet implemented at the time of this writing)
There exists a limit to the number of simultaneous `MessageId`s held by a specific process. Messages continue to count towards the limit as long as they haven't been answered, even if they have been cancelled (see below).
This mechanism can be compared to the `ulimits` in the Linux world.
Note that this limit is not supposed to be normally reached under normal circumstances, and serves mostly as a protection against accidental infinite loops.
# Waiting for notifications
Each process is characterized by a queue of notifications that can be retrieved using this function. A notification only consists, at the moment, of an answer to a previously-emitted message.
The `next_notification` syscall allows querying the operating system for notifications. It is similar to `epoll` in the Linux world.
The parameters of this syscall are:
- A list of `MessageId`s whose answer to query.
- A flag indicating whether to wait or not.
If a notification in the queue matches one of the elements in the list, then this notification is retrieved. Otherwise, the function will block if the flag is set or return immediately if it is not.
Notifications contain the `MessageId`, whether the message has been successful or not, and the body of the answer.
## Limit to the queue size
(note: this isn't implemented at the time of writing)
If the number of notifications in a queue is higher than a certain limit, then emitting a message on the registered interfaces will block the emitter.
# Answering messages
Messages can be answer either by a "success" answer, containing a body, or by an "error" answer, via respectively the `emit_answer` and `emit_message_error` syscalls.
If an interface handler crashes, then all of the messages that it was supposed to answer are automatically answered with an error.
After a message has been answered, the corresponding `MessageId` is no longer valid.
# Cancelling messages
The `cancel_message` syscall allows one to notify the kernel that it is no longer interested in the answer to a previously-emitted message.
The message continues to be processed normally, and the interface handler isn't made aware of the cancellation.
The difference is that answers to cancelled messages are not pushed in the queue of notifications of the sending process.
Cancelling a message makes it possible to avoid the awkward situation where one needs to somehow call `next_notification` with that message only to discard the answer immediately after. Having to call `next_notification` even when we've free'd all the other resources associated with the message can be very annoying to deal with by itself.
# Backpressure
Under the design described above, an interface handler has no way to pro-actively notify an interface user of something happening.
For example the network manager has no way to tell the program that has opened a TCP socket that a message has arrived on that socket.
Instead, the interface user must emit a message asking the interface handler for the next event that happens. When the handler wants to notify the user of something, it can do so by answering that message.
This scheme permits proper backpressure to apply. A message sender is guaranteed to not receive more answers that it has emitted messages. It prevents a possible deadlock where a handler is waiting for more room in a process's queue, while the process is waiting for more room in the handler's queue.
There is, however, a possible deadlock if A tries to send to B, B sends to C, and C sends to A, while all three queues are full. This need to be solved.
================================================
FILE: interface-wrappers/disk/Cargo.toml
================================================
[package]
name = "redshirt-disk-interface"
version = "0.1.0"
license = "GPL-3.0-or-later"
authors = ["Pierre Krieger "]
edition = "2018"
[dependencies]
futures = "0.3.13"
redshirt-syscalls = { path = "../syscalls" }
parity-scale-codec = { version = "1.3.6", features = ["derive"] }
rand = "0.8.3"
================================================
FILE: interface-wrappers/disk/src/disk.rs
================================================
// Copyright (C) 2019-2021 Pierre Krieger
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
//! Registering disks.
//!
//! This module allows you to register your disk. Reading and writing commands can then be issued
//! towards this disk.
//!
//! Use this if you're writing for example an ATA/ATAPI or USB driver.
//!
//! # Usage
//!
//! - Call [`register_disk`] in order to notify of the existence of a disk.
//! - You obtain a [`DiskRegistration`] that you can use to obtain the commands that need to be
//! executed by the disk.
//! - Dropping the [`DiskRegistration`] unregisters the disk.
//!
use crate::ffi;
use core::fmt;
use futures::{lock::Mutex, prelude::*};
use redshirt_syscalls::{Decode as _, Encode as _, EncodedMessage};
/// Configuration of an interface to register.
#[derive(Debug)]
pub struct DiskConfig {
/// `True` if the disk accepts write commands. `False` is the disk can only be read, for
/// example for CD-ROMs.
pub allow_write: bool,
/// Size, in bytes, of a sector.
pub sector_size: u32,
/// Number of sectors on the disk.
pub num_sectors: u32,
}
/// Registers a new disk.
pub async fn register_disk(config: DiskConfig) -> DiskRegistration {
unsafe {
let id = rand::random();
redshirt_syscalls::emit_message_without_response(&ffi::INTERFACE, &{
ffi::DiskMessage::RegisterDisk {
id,
allow_write: config.allow_write,
sector_size: config.sector_size,
num_sectors: config.num_sectors,
}
})
.unwrap();
DiskRegistration {
id,
commands: Mutex::new((0..10).map(|_| build_commands_future(id)).collect()),
}
}
}
/// Registered disk.
///
/// Destroying this object will unregister the interface.
pub struct DiskRegistration {
/// Identifier of the interface in the disks manager.
id: u64,
/// Futures that will resolve once we receive a command that the disk must execute.
commands: Mutex>>>,
}
/// Build a `Future` resolving to the next command to execute by the disk.
fn build_commands_future(disk_id: u64) -> redshirt_syscalls::MessageResponseFuture> {
unsafe {
let message = ffi::DiskMessage::DiskNextCommand(disk_id).encode();
let msg_id = redshirt_syscalls::MessageBuilder::new()
.add_data(&message)
.emit_with_response_raw(&ffi::INTERFACE)
.unwrap();
redshirt_syscalls::message_response(msg_id)
}
}
impl DiskRegistration {
/// Returns the next command that the disk must execute.
///
/// > **Note**: It is possible to call this method multiple times on the same
/// > [`DiskRegistration`]. If that is done, no guarantee exists as to which
/// > `Future` finishes first.
pub async fn next_command(&self) -> Command {
let mut commands = self.commands.lock().await;
let data = commands.next().await.unwrap();
commands.push(build_commands_future(self.id));
// TODO: extra copy when decoding :-/
let decoded = ffi::DiskCommand::decode(EncodedMessage(data)).unwrap();
match decoded {
ffi::DiskCommand::StartRead {
id,
sector_lba,
num_sectors,
} => Command::Read(ReadCommand {
id,
sector_lba,
num_sectors,
}),
ffi::DiskCommand::StartWrite {
id,
sector_lba,
data,
} => Command::Write(WriteCommand {
id,
sector_lba,
data,
}),
}
}
}
impl fmt::Debug for DiskRegistration {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_tuple("DiskRegistration").field(&self.id).finish()
}
}
impl Drop for DiskRegistration {
fn drop(&mut self) {
unsafe {
let message = ffi::DiskMessage::UnregisterDisk(self.id);
redshirt_syscalls::emit_message_without_response(&ffi::INTERFACE, &message).unwrap();
}
}
}
/// Command received from the disks manager.
pub enum Command {
/// See [`ReadCommand`].
Read(ReadCommand),
/// See [`WriteCommand`].
Write(WriteCommand),
}
/// Read command received from the disks manager. The registerer must read data from the disk.
pub struct ReadCommand {
id: ffi::ReadId,
sector_lba: u64,
num_sectors: u32,
}
impl ReadCommand {
/// Returns the first sector to read from.
pub fn sector_lba(&self) -> u64 {
self.sector_lba
}
/// Returns the number of sectors to read.
pub fn num_sectors(&self) -> u32 {
self.num_sectors
}
/// Report that the read has finished. Contains the data read from the disk.
pub fn report_finished(self, data: Vec) {
unsafe {
let message = ffi::DiskMessage::ReadFinished(self.id, data);
redshirt_syscalls::emit_message_without_response(&ffi::INTERFACE, &message).unwrap();
}
}
}
/// Write command received from the disks manager. The registerer must write data to the disk.
pub struct WriteCommand {
id: ffi::WriteId,
sector_lba: u64,
data: Vec,
}
impl WriteCommand {
/// Data to write to the disk.
pub fn data(&self) -> &[u8] {
&self.data
}
/// Returns the first sector to write to.
pub fn sector_lba(&self) -> u64 {
self.sector_lba
}
/// Report that the write has finished.
pub fn report_finished(self) {
unsafe {
let message = ffi::DiskMessage::WriteFinished(self.id);
redshirt_syscalls::emit_message_without_response(&ffi::INTERFACE, &message).unwrap();
}
}
}
================================================
FILE: interface-wrappers/disk/src/ffi.rs
================================================
// Copyright (C) 2019-2021 Pierre Krieger
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
use parity_scale_codec::{Decode, Encode};
use redshirt_syscalls::InterfaceHash;
// TODO: this has been randomly generated; instead should be a hash or something
pub const INTERFACE: InterfaceHash = InterfaceHash::from_raw_hash([
0x99, 0x94, 0xca, 0x60, 0xcf, 0x73, 0x7b, 0x59, 0xf7, 0xdc, 0x0c, 0xc4, 0xf0, 0x57, 0x42, 0x2e,
0x79, 0xa7, 0xb6, 0x81, 0xbb, 0xf8, 0x4e, 0x24, 0x8e, 0xbf, 0x1a, 0x8f, 0x2c, 0xf6, 0xea, 0xc8,
]);
#[derive(Debug, Encode, Decode)]
pub enum DiskMessage {
/// Notify of the existence of a new disk.
// TODO: what if this id was already registered?
RegisterDisk {
/// Unique per-process identifier.
id: u64,
/// True if writing to this disk is allowed.
allow_write: bool,
/// Size, in bytes, of a sector of the disk.
sector_size: u32,
/// Number of sectors on the disk.
num_sectors: u32,
},
/// Removes a previously-registered disk.
UnregisterDisk(u64),
/// Asks for the next command the disk must execute.
///
/// Must answer with a [`DiskCommand`].
DiskNextCommand(u64),
/// Report that a [`DiskCommand::StartRead`] has finished.
///
/// Has no response.
ReadFinished(ReadId, Vec),
/// Report that a [`DiskCommand::StartWrite`] has finished.
///
/// Has no response.
WriteFinished(WriteId),
}
#[derive(Debug, Encode, Decode)]
pub enum DiskCommand {
StartRead {
id: ReadId,
sector_lba: u64,
num_sectors: u32,
},
StartWrite {
id: WriteId,
sector_lba: u64,
data: Vec,
},
}
#[derive(Debug, Encode, Decode, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ReadId(pub u64);
#[derive(Debug, Encode, Decode, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct WriteId(pub u64);
================================================
FILE: interface-wrappers/disk/src/lib.rs
================================================
// Copyright (C) 2019-2021 Pierre Krieger
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
//! Disk registration and commands issuance.
//!
//! # Overview
//!
//! This interface allows indicating the presence of a disk on the machine by registering it. The
//! registered disk can then receive commands (such as reading and writing data) that it must
//! execute.
//!
//! The word "disk" should be understood as in a hard disk drive (HDD), solid-state drive (SSD),
//! CD-ROM drive, floppy disk drive, and anything similar.
//!
//! It is recommended to **not** register disks that aren't actual physical objects connected to
//! the machine (such as disks accessed over the network, or equivalents to UNIX's `losetup`).
//! Redshirt tries to be as explicit as possible and to keep its abstractions as close as possible
//! to the objects being abstracted.
//!
//! Users of this interface are expected to be ATA/ATAPI drivers, USB drivers, and similar. The
//! handler of this interface is expected to be a filesystem manager that determines the list of
//! partitions and handles the file systems.
//!
//! # About disks
//!
//! In the abstraction exposed by this interface, a disk is composed of a certain number of
//! sectors, each having a certain size. The size of all sectors is identical. These sectors are
//! indexed from `0` to `num_sectors - 1`.
//!
//! The sector index is typically referred to by the term "LBA sector". *LBA* designates the fact
//! that each sector is addressed through a index ranging linearly from `0` to `num_sectors - 1`,
//! as opposed to the older *CHS* addressing where sectors were referred to a by a head number,
//! cylinder number, and sectors offset. CHS addressing isn't used in this interface.
//!
//! It is not possible to partially read or write a sector. The sector has to be read entirely,
//! or written entirely.
//!
//! # Flushing
//!
//! The interface requires each disk write to be confirmed by sending a message on the interface
//! after it has been performed. This is important in order for the upper layer to be capable of
//! handling problematic situations such as a power outage.
//!
//! Consequently, while the disk driver is allowed to maintain a write cache, it must not report
//! a write success after the data has been put in cache, but after it has been written to disk.
//!
//! In the interval of time between the moment the writing is issued and the moment it is
//! confirmed, the upper layers should consider that the sector is physically in an undefined
//! state.
pub mod disk;
pub mod ffi;
================================================
FILE: interface-wrappers/ethernet/Cargo.toml
================================================
[package]
name = "redshirt-ethernet-interface"
version = "0.1.0"
license = "GPL-3.0-or-later"
authors = ["Pierre Krieger "]
edition = "2018"
[dependencies]
futures = "0.3.13"
redshirt-syscalls = { path = "../syscalls" }
parity-scale-codec = { version = "1.3.6", features = ["derive"] }
rand = "0.8.3"
================================================
FILE: interface-wrappers/ethernet/src/ffi.rs
================================================
// Copyright (C) 2019-2021 Pierre Krieger
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
use parity_scale_codec::{Decode, Encode};
use redshirt_syscalls::InterfaceHash;
// TODO: this has been randomly generated; instead should be a hash or something
pub const INTERFACE: InterfaceHash = InterfaceHash::from_raw_hash([
0x56, 0xf0, 0xad, 0x54, 0x6c, 0x6d, 0x91, 0xce, 0xc2, 0x10, 0x88, 0xf6, 0x32, 0x2b, 0x66, 0x45,
0xd4, 0xcf, 0xbe, 0xa3, 0xf7, 0x03, 0x13, 0xcd, 0x04, 0x65, 0xfd, 0x7f, 0x06, 0xd4, 0x24, 0xa1,
]);
#[derive(Debug, Encode, Decode)]
pub enum NetworkMessage {
/// Notify of the existence of a new Ethernet interface.
// TODO: what if this id was already registered?
RegisterInterface {
/// Unique per-process identifier.
id: u64,
/// MAC address of the interface.
mac_address: [u8; 6],
},
/// Removes a previously-registered interface.
UnregisterInterface(u64),
/// Notify when an interface has received data (e.g. from the outside world). Must answer with
/// a `()` when the send is finished and we're ready to accept a new packet.
///
/// The packet must be an Ethernet frame without the CRC.
InterfaceOnData(u64, Vec),
/// Asks for the next packet of data to send out through this interface (e.g. going towards
/// the outside world). Must answer with a `Vec`.
///
/// The packet must be an Ethernet frame without the CRC.
InterfaceWaitData(u64),
}
================================================
FILE: interface-wrappers/ethernet/src/interface.rs
================================================
// Copyright (C) 2019-2021 Pierre Krieger
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
//! Registering Ethernet interfaces.
//!
//! This module allows you to register your Ethernet interface. TCP and UDP sockets will then use
//! it to communicate with the outside.
//!
//! Use this if you're writing for example a networking driver or a VPN.
//!
//! # Usage
//!
//! - Call [`register_interface`] in order to notify of the existence of an interface.
//! - You obtain a [`NetInterfaceRegistration`] that you can use to report packets that came from
//! the wire, and from which you can obtain packets to send to the wire.
//! - Dropping the [`NetInterfaceRegistration`] unregisters the interface.
//!
use crate::ffi;
use core::fmt;
use futures::{
lock::{Mutex, MutexGuard},
prelude::*,
};
use redshirt_syscalls::Encode as _;
/// Configuration of an interface to register.
#[derive(Debug)]
pub struct InterfaceConfig {
/// MAC address of the interface.
///
/// If this is a virtual device, feel free to randomly generate a MAC address.
pub mac_address: [u8; 6],
}
/// Registers a new network interface.
pub async fn register_interface(config: InterfaceConfig) -> NetInterfaceRegistration {
unsafe {
let id = rand::random();
redshirt_syscalls::emit_message_without_response(&ffi::INTERFACE, &{
ffi::NetworkMessage::RegisterInterface {
id,
mac_address: config.mac_address,
}
})
.unwrap();
NetInterfaceRegistration {
id,
packet_from_net: Mutex::new(None),
packet_to_net: Mutex::new((0..10).map(|_| build_packet_to_net(id)).collect()),
}
}
}
/// Registered network interface.
///
/// Destroying this object will unregister the interface.
pub struct NetInterfaceRegistration {
/// Identifier of the interface in the network manager.
id: u64,
/// Futures that will resolve once we receive a packet from the network manager to send to the
/// network.
packet_to_net: Mutex>>>,
/// Future that will resolve once we have successfully delivered a packet from the network,
/// and are ready to deliver a next one.
// TODO: should probably change to send multiple packets in parallel
packet_from_net: Mutex>>,
}
/// Build a `Future` resolving to the next packet to send to the network.
///
/// Only one such `Future` must be alive at any given point in time.
fn build_packet_to_net(interface_id: u64) -> redshirt_syscalls::MessageResponseFuture> {
unsafe {
let message = ffi::NetworkMessage::InterfaceWaitData(interface_id).encode();
let msg_id = redshirt_syscalls::MessageBuilder::new()
.add_data(&message)
.emit_with_response_raw(&ffi::INTERFACE)
.unwrap();
redshirt_syscalls::message_response(msg_id)
}
}
impl NetInterfaceRegistration {
/// Wait until the network manager is ready to accept a packet coming from the network.
///
/// Returns a [`PacketFromNetwork`] object that allows you to transmit the packet.
///
/// > **Note**: It is possible to call this method multiple times on the same
/// > [`NetInterfaceRegistration`]. If that is done, no guarantee exists as to which
/// > `Future` finishes first.
pub async fn packet_from_network<'a>(&'a self) -> PacketFromNetwork<'a> {
// Wait for the previous send to be finished.
let mut packet_from_net = self.packet_from_net.lock().await;
if let Some(fut) = packet_from_net.as_mut() {
fut.await;
}
*packet_from_net = None;
PacketFromNetwork {
parent: self,
send_future: packet_from_net,
}
}
/// Returns the next packet to send to the network.
///
/// > **Note**: It is possible to call this method multiple times on the same
/// > [`NetInterfaceRegistration`]. If that is done, no guarantee exists as to which
/// > `Future` finishes first.
pub async fn packet_to_send(&self) -> Vec {
let mut packet_to_net = self.packet_to_net.lock().await;
let data = packet_to_net.next().await.unwrap();
packet_to_net.push(build_packet_to_net(self.id));
data
}
}
impl fmt::Debug for NetInterfaceRegistration {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_tuple("NetInterfaceRegistration")
.field(&self.id)
.finish()
}
}
impl Drop for NetInterfaceRegistration {
fn drop(&mut self) {
unsafe {
let message = ffi::NetworkMessage::UnregisterInterface(self.id);
redshirt_syscalls::emit_message_without_response(&ffi::INTERFACE, &message).unwrap();
}
}
}
/// Allows you to transmit a packet received from the network to the manager.
#[must_use]
pub struct PacketFromNetwork<'a> {
parent: &'a NetInterfaceRegistration,
send_future: MutexGuard<'a, Option>>,
}
impl<'a> PacketFromNetwork<'a> {
/// Send the packet to the manager.
pub fn send(mut self, data: impl Into>) {
unsafe {
debug_assert!(self.send_future.is_none());
let message =
ffi::NetworkMessage::InterfaceOnData(self.parent.id, data.into()).encode();
let msg_id = redshirt_syscalls::MessageBuilder::new()
.add_data(&message)
.emit_with_response_raw(&ffi::INTERFACE)
.unwrap();
let fut = redshirt_syscalls::message_response(msg_id);
*self.send_future = Some(fut);
}
}
}
================================================
FILE: interface-wrappers/ethernet/src/lib.rs
================================================
// Copyright (C) 2019-2021 Pierre Krieger
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
//! Ethernet interfaces.
//!
//! This interface allows registering Ethernet interfaces that conform to the requirements
//! described in [RFC1122](https://tools.ietf.org/html/rfc1122).
//!
//! Users of this interface can notify of the presence of an Ethernet interface, after which it
//! can notify of Ethernet frames having been received on this interface, and request Ethernet
//! frames to be sent on the interface.
//!
//! The Ethernet frames that are communicated contain:
//!
//! - The destination MAC.
//! - The source MAC.
//! - An optional 802.1Q tag.
//! - The Ethertype field.
//! - The payload.
//!
//! Most notably, they **don't** include any preamble, delimiter, interpacket gap, and checksum.
//!
//! # Networking overview
//!
//! This section provides some overview of networking in general.
//!
//! ## Link layer routing
//!
//! Each Ethernet interface registered with this interface possesses a MAC address, and is assumed
//! to be directly connected to zero, one, or more other machines.
//!
//! Thanks to the ARP or NDP protocols, it is possible to broadcast a request on the Ethernet
//! interface asking who we are connected to. The nodes that receive the request respond with their
//! IP and MAC address. If later we want to send a direct message to one of these nodes, we simply
//! emit an Ethernet frame with the MAC address of the destination.
//!
//! Note that being "directly connected" to a node doesn't necessarily mean that there exists a
//! physical cable between us and this node. Hubs, switches, or Wifi routers, can act as an
//! intermediary.
//!
//! ## IP layer routing
//!
//! All of the registered Ethernet interfaces are considered as being part of one single network
//! (typically the Internet).
//!
//! > **Note**: This doesn't mean that we are free to send out packets on any interface that we
//! > want and expect the routing to make the packet find its way. In particular, this
//! > single network can be disjoint.
//!
//! Nodes on this network (i.e. something with an IP address) can be split into two categories:
//!
//! - Nodes we are directly connected to, as described in the previous section. It is possible to
//! send a direct message to these nodes by writing bytes on the right interface.
//! - Nodes we are *not* directly connected to.
//!
//! The implementer of this interface maintains what we call a *routing table*. A routing table is
//! a collection of entries, each entry consisting of:
//!
//! - A "pattern", kind of similar to a regex for example. This pattern consists of an IP address
//! and mask. An IP address matches that pattern if
//! `(ip_addr & pattern.mask) == (pattern.ip & pattern.mask)`.
//! - A gateway. This is the IP address of a node that we are physically connected to and that is
//! in charge of relaying packets to nodes that match the given pattern.
//! - The network interface the gateway is connected to.
//!
//! When we want to reach the node with a specific IP address, we look through the table until
//! we find an entry whose pattern matches the target IP address. If multiple entries are matching,
//! we pick the one with the most specific mask.
//!
//! The gateway is then expected to properly direct the packet towards its rightful destination.
//!
pub mod ffi;
pub mod interface;
================================================
FILE: interface-wrappers/framebuffer/Cargo.toml
================================================
[package]
name = "redshirt-framebuffer-interface"
version = "0.1.0"
license = "GPL-3.0-or-later"
authors = ["Pierre Krieger "]
edition = "2018"
[dependencies]
futures = "0.3"
parity-scale-codec = { version = "1.3.6", features = ["derive"] }
redshirt-random-interface = { path = "../random", default-features = false }
redshirt-syscalls = { path = "../syscalls", default-features = false }
================================================
FILE: interface-wrappers/framebuffer/src/ffi.rs
================================================
// Copyright (C) 2019-2021 Pierre Krieger
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
//!
//!
//! Message format:
//!
//! The type of message depends on the first byte:
//!
//! - 0: Creates a framebuffer. Next 4 bytes are a "framebuffer ID" as decided by the message
//! emitter. Next 4 bytes are the width in little endian. Next 4 bytes are the height in little
//! endian.
//! - 1: Destroys a framebuffer. Next 4 bytes are the framebuffer ID.
//! - 2: Set framebuffer content. Next 4 bytes are the framebuffer ID. The rest is 3 * width *
//! height values. The rest is RGB triplets.
//! - 3: Send back the next input event. Next 4 bytes are the framebuffer ID. The answer consists
//! in an input event whose format is a SCALE-encoding of the [`Event`] struct below.
//!
//! There actually exists two interfaces that use the same messages format: with events, or without
//! events. Messages whose first byte is `3` are invalid in the "without events" interface.
use redshirt_syscalls::InterfaceHash;
// TODO: this has been randomly generated; instead should be a hash or something
pub const INTERFACE_WITH_EVENTS: InterfaceHash = InterfaceHash::from_raw_hash([
0xfc, 0x60, 0x2e, 0x6e, 0xf2, 0x43, 0x9c, 0xa0, 0x40, 0x88, 0x81, 0x7d, 0xe5, 0xaf, 0xb6, 0x90,
0x9e, 0x57, 0xc6, 0xc2, 0x5e, 0xbf, 0x02, 0x5b, 0x87, 0x7f, 0xaa, 0xae, 0xbe, 0xd5, 0x19, 0x9c,
]);
// TODO: this has been randomly generated; instead should be a hash or something
pub const INTERFACE_WITHOUT_EVENTS: InterfaceHash = InterfaceHash::from_raw_hash([
0xdf, 0x67, 0x74, 0x34, 0xd8, 0x0d, 0xc5, 0x9e, 0xf0, 0x6e, 0xb9, 0x44, 0xce, 0xaa, 0xc4, 0xde,
0x8d, 0x2f, 0xdf, 0x39, 0x0a, 0xe6, 0xa8, 0x29, 0x3c, 0x8f, 0x88, 0x76, 0x5b, 0xe9, 0x1c, 0x70,
]);
/// Event that can be reported by a framebuffer.
///
/// > **Note**: These events are designed to take into account the possibility that some events are
/// > lost. This can happen if the recipient queues messages too slowly.
#[derive(Debug, Clone, parity_scale_codec::Encode, parity_scale_codec::Decode)]
pub enum Event {
/// A keyboard key has been pressed or released.
KeyboardChange {
/// Scancode as defined in the USB HID Usage tables.
///
/// See table 12 on page 53:
/// https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf
scancode: u16,
/// New state of the given key.
new_state: ElementState,
},
/// The cursor has moved over the framebuffer.
CursorMoved {
/// New position of the cursor in millipixels relative to the top-left hand corner of the
/// framebuffer. `None` if the cursor is not on the framebuffer.
///
/// Please note that these are millipixels. As such, you have to divide them by 1000 to
/// obtain a value in pixels.
new_position: Option<(u64, u64)>,
},
/// A mouse button has been pressed or released.
MouseButtonChange {
/// Which mouse button is concerned.
button: MouseButton,
/// New state of the given button.
new_state: ElementState,
},
}
#[derive(Debug, Clone, parity_scale_codec::Encode, parity_scale_codec::Decode)]
pub enum MouseButton {
/// Typically but not necessarily the left mouse button.
Main,
/// Typically but not necessarily the right mouse button.
Secondary,
}
#[derive(Debug, Clone, parity_scale_codec::Encode, parity_scale_codec::Decode)]
pub enum ElementState {
Pressed,
Released,
}
================================================
FILE: interface-wrappers/framebuffer/src/lib.rs
================================================
// Copyright (C) 2019-2021 Pierre Krieger
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
//! Framebuffer interface.
//!
//! Allows drawing an image.
//!
//! > **Note**: The fate of this interface is kind of vague. It is also unclear whether
//! > keyboard/mouse input should be handled here as well. Use at your own risks.
#![no_std]
extern crate alloc;
use alloc::collections::VecDeque;
use core::convert::TryFrom as _;
use redshirt_syscalls::{InterfaceHash, MessageId};
pub mod ffi;
/// Framebuffer containing pixel data.
pub struct Framebuffer {
/// Identifier of the framebuffer. Used for all communications.
id: u32,
/// Interface used for this framebuffer.
interface: &'static InterfaceHash,
/// Width of the framebuffer in pixels.
width: u32,
/// Height of the framebuffer in pixels.
height: u32,
/// List of active messages that will be responded with incoming events.
///
/// The capacity of this container also corresponds to the number of elements that we want to
/// have in it at any given moment. In other words, there is no field in this struct indicating
/// the number of events because that'd be redundant with `event_messages.capacity()`.
event_messages: VecDeque,
}
impl Framebuffer {
/// Initializes a new framebuffer of the given width and height.
pub async fn new(with_events: bool, width: u32, height: u32) -> Self {
let id = unsafe {
let mut out = [0; 4];
redshirt_random_interface::generate_in(&mut out).await;
u32::from_le_bytes(out)
};
let interface = if with_events {
&ffi::INTERFACE_WITH_EVENTS
} else {
&ffi::INTERFACE_WITHOUT_EVENTS
};
unsafe {
let id_le_bytes = id.to_le_bytes();
let width_le_bytes = width.to_le_bytes();
let height_le_bytes = height.to_le_bytes();
redshirt_syscalls::MessageBuilder::new()
.add_data_raw(&[0])
.add_data_raw(&id_le_bytes[..])
.add_data_raw(&width_le_bytes[..])
.add_data_raw(&height_le_bytes[..])
.emit_without_response(interface)
.unwrap();
}
let num_events_queue = if with_events { 10 } else { 0 };
let mut fb = Framebuffer {
id,
interface,
width,
height,
event_messages: VecDeque::with_capacity(num_events_queue),
};
fb.fill_event_messages();
fb
}
/// Sets the data in the framebuffer.
///
/// The size of `data` must be `width * height * 3`.
pub fn set_data(&self, data: &[u8]) {
unsafe {
assert_eq!(
data.len(),
usize::try_from(
self.width
.checked_mul(self.height)
.unwrap()
.checked_mul(3)
.unwrap()
)
.unwrap()
);
let id_le_bytes = self.id.to_le_bytes();
redshirt_syscalls::MessageBuilder::new()
.add_data_raw(&[2])
.add_data_raw(&id_le_bytes[..])
.add_data_raw(data)
.emit_without_response(self.interface)
.unwrap();
}
}
/// Returns the next event that the framebuffer receives.
// TODO: proper return type
pub async fn next_event(&mut self) -> u32 {
if let Some(first_event) = self.event_messages.front() {
let event: u32 = redshirt_syscalls::message_response(*first_event).await; // TODO: proper event type
self.event_messages.pop_front();
self.fill_event_messages();
event
} else {
futures::future::pending().await
}
}
/// Pushes back events to `event_messages` until we reach the maximum.
fn fill_event_messages(&mut self) {
while self.event_messages.len() < self.event_messages.capacity() {
let new_event = unsafe {
redshirt_syscalls::MessageBuilder::new()
.add_data_raw(&[3])
.add_data_raw(&self.id.to_le_bytes()[..])
.emit_with_response_raw(self.interface)
.unwrap()
};
self.event_messages.push_back(new_event);
}
}
}
impl Drop for Framebuffer {
fn drop(&mut self) {
unsafe {
let id_le_bytes = self.id.to_le_bytes();
redshirt_syscalls::MessageBuilder::new()
.add_data_raw(&[1])
.add_data_raw(&id_le_bytes[..])
.emit_without_response(self.interface)
.unwrap();
}
}
}
================================================
FILE: interface-wrappers/hardware/Cargo.toml
================================================
[package]
name = "redshirt-hardware-interface"
version = "0.1.0"
license = "GPL-3.0-or-later"
authors = ["Pierre Krieger "]
edition = "2018"
[dependencies]
futures = { version = "0.3.13", default-features = false }
redshirt-syscalls = { path = "../syscalls", default-features = false }
parity-scale-codec = { version = "1.3.6", default-features = false, features = ["derive"] }
[features]
default = ["std"]
std = []
================================================
FILE: interface-wrappers/hardware/src/ffi.rs
================================================
// Copyright (C) 2019-2021 Pierre Krieger
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
use alloc::vec::Vec;
use parity_scale_codec::{Decode, Encode};
use redshirt_syscalls::InterfaceHash;
// TODO: this has been randomly generated; instead should be a hash or something
pub const INTERFACE: InterfaceHash = InterfaceHash::from_raw_hash([
0x24, 0x5d, 0x25, 0x5e, 0x37, 0xf1, 0x8a, 0xce, 0x23, 0xd6, 0x68, 0xe9, 0xe2, 0xd8, 0xd1, 0xbc,
0x37, 0xf3, 0xd3, 0x3c, 0xad, 0x55, 0xf8, 0xd9, 0x22, 0x3a, 0x57, 0xd1, 0x54, 0x46, 0x7b, 0x78,
]);
/// Message in destination to the hardware interface handler.
#[derive(Debug, Encode, Decode)]
pub enum HardwareMessage {
/// Allocate RAM. Must answer with a `u64`. The value `0` is returned if the allocation is
/// too large.
///
/// This is useful in situations where you want to pass a pointer to a device.
Malloc {
/// Size to allocate.
size: u64,
/// Alignment of the pointer to return.
///
/// The returned value modulo `alignment` must be equal to 0.
alignment: u64,
},
/// Opposite of malloc.
Free {
/// Value previously returned after a malloc message.
ptr: u64,
},
/// Request to perform some access on the physical memory or ports.
///
/// All operations must be performed in order.
///
/// If there is at least one memory or port read, the response must be a
/// `Vec` where each element corresponds to a read. No response is
/// expected if there are only writes.
// TODO: should we enforce some limits in the amount of data that can be returned in a response?
HardwareAccess(Vec),
/// Ask the handler to send back a response when the interrupt with the given number is
/// triggered.
///
/// > **Note**: If called with a non-hardware interrupt, no response will ever come back.
// TODO: how to not miss any interrupt? we instead need some registration system or something
InterruptWait(u32),
}
/// Request to perform accesses to physical memory or to ports.
#[derive(Debug, Encode, Decode)]
pub enum Operation {
PhysicalMemoryMemset {
address: u64,
len: u64,
value: u8,
},
PhysicalMemoryWriteU8 {
address: u64,
data: Vec,
},
/// Uses the platform's native endianess.
PhysicalMemoryWriteU16 {
address: u64,
data: Vec,
},
/// Uses the platform's native endianess.
PhysicalMemoryWriteU32 {
address: u64,
data: Vec,
},
PhysicalMemoryReadU8 {
address: u64,
len: u32,
},
PhysicalMemoryReadU16 {
address: u64,
/// Number of `u16`s to read.
len: u32,
},
PhysicalMemoryReadU32 {
address: u64,
/// Number of `u32`s to read.
len: u32,
},
/// Write data to a port.
///
/// If the hardware doesn't support this operation, then nothing happens.
PortWriteU8 {
port: u32,
data: u8,
},
/// Write data to a port.
///
/// If the hardware doesn't support this operation, then nothing happens.
PortWriteU16 {
port: u32,
data: u16,
},
/// Write data to a port.
///
/// If the hardware doesn't support this operation, then nothing happens.
PortWriteU32 {
port: u32,
data: u32,
},
/// Reads data from a port.
///
/// If the hardware doesn't support this operation, then `0` is produced.
PortReadU8 {
port: u32,
},
/// Reads data from a port.
///
/// If the hardware doesn't support this operation, then `0` is produced.
PortReadU16 {
port: u32,
},
/// Reads data from a port.
///
/// If the hardware doesn't support this operation, then `0` is produced.
PortReadU32 {
port: u32,
},
}
/// Response to a [`HardwareMessage::HardwareAccess`].
#[derive(Debug, Encode, Decode)]
pub enum HardwareAccessResponse {
/// Sent back in response to a [`Operation::PhysicalMemoryReadU8`].
PhysicalMemoryReadU8(Vec),
/// Sent back in response to a [`Operation::PhysicalMemoryReadU16`].
PhysicalMemoryReadU16(Vec),
/// Sent back in response to a [`Operation::PhysicalMemoryReadU32`].
PhysicalMemoryReadU32(Vec),
/// Sent back in response to a [`Operation::PortReadU8`].
PortReadU8(u8),
/// Sent back in response to a [`Operation::PortReadU16`].
PortReadU16(u16),
/// Sent back in response to a [`Operation::PortReadU32`].
PortReadU32(u32),
}
================================================
FILE: interface-wrappers/hardware/src/lib.rs
================================================
// Copyright (C) 2019-2021 Pierre Krieger
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
//! Access to physical hardware.
//!
//! Use this interface if you're writing a device driver.
#![cfg_attr(not(feature = "std"), no_std)]
extern crate alloc;
use alloc::{vec, vec::Vec};
use core::convert::TryFrom as _;
use futures::prelude::*;
pub mod ffi;
pub mod malloc;
/// Builder for write-only hardware operations.
pub struct HardwareWriteOperationsBuilder {
operations: Vec,
}
impl HardwareWriteOperationsBuilder {
pub fn new() -> Self {
HardwareWriteOperationsBuilder {
operations: Vec::new(),
}
}
pub fn with_capacity(capacity: usize) -> Self {
HardwareWriteOperationsBuilder {
operations: Vec::with_capacity(capacity),
}
}
pub unsafe fn memset(&mut self, address: u64, len: u64, value: u8) {
self.operations.push(ffi::Operation::PhysicalMemoryMemset {
address,
len,
value,
});
}
pub unsafe fn write(&mut self, address: u64, data: impl Into>) {
self.operations.push(ffi::Operation::PhysicalMemoryWriteU8 {
address,
data: data.into(),
});
}
pub unsafe fn write_one_u32(&mut self, address: u64, data: u32) {
self.operations
.push(ffi::Operation::PhysicalMemoryWriteU32 {
address,
data: vec![data],
});
}
pub unsafe fn port_write_u8(&mut self, port: u32, data: u8) {
self.operations
.push(ffi::Operation::PortWriteU8 { port, data });
}
pub unsafe fn port_write_u16(&mut self, port: u32, data: u16) {
self.operations
.push(ffi::Operation::PortWriteU16 { port, data });
}
pub unsafe fn port_write_u32(&mut self, port: u32, data: u32) {
self.operations
.push(ffi::Operation::PortWriteU32 { port, data });
}
pub fn send(self) {
unsafe {
if self.operations.is_empty() {
return;
}
let msg = ffi::HardwareMessage::HardwareAccess(self.operations);
redshirt_syscalls::emit_message_without_response(&ffi::INTERFACE, &msg).unwrap();
}
}
}
/// Writes the given data to the given physical memory address location.
pub unsafe fn write(address: u64, data: impl Into>) {
let mut builder = HardwareWriteOperationsBuilder::with_capacity(1);
builder.write(address, data);
builder.send();
}
/// Reads memory to a buffer.
pub async unsafe fn read_to(address: u64, mut out: &mut [u8]) {
let mut ops = HardwareOperationsBuilder::new();
ops.read(address, &mut out);
ops.send().await;
}
/// Reads memory.
pub async unsafe fn read(address: u64, len: u32) -> Vec {
let len_usize = usize::try_from(len).unwrap();
let mut out = Vec::with_capacity(len_usize);
out.set_len(len_usize);
let mut ops = HardwareOperationsBuilder::new();
ops.read(address, &mut out);
ops.send().await;
out
}
/// Reads a single `u32` from the given memory address.
#[cfg(feature = "std")]
pub async unsafe fn read_one_u32(address: u64) -> u32 {
let mut ops = HardwareOperationsBuilder::new();
let mut out = [0];
ops.read_u32(address, &mut out);
ops.send().await;
out[0]
}
pub unsafe fn write_one_u32(address: u64, data: u32) {
let mut builder = HardwareWriteOperationsBuilder::with_capacity(1);
builder.write_one_u32(address, data);
builder.send();
}
pub unsafe fn port_write_u8(port: u32, data: u8) {
let mut builder = HardwareWriteOperationsBuilder::with_capacity(1);
builder.port_write_u8(port, data);
builder.send();
}
pub unsafe fn port_write_u16(port: u32, data: u16) {
let mut builder = HardwareWriteOperationsBuilder::with_capacity(1);
builder.port_write_u16(port, data);
builder.send();
}
pub unsafe fn port_write_u32(port: u32, data: u32) {
let mut builder = HardwareWriteOperationsBuilder::with_capacity(1);
builder.port_write_u32(port, data);
builder.send();
}
/// Reads the given port.
pub async unsafe fn port_read_u8(port: u32) -> u8 {
let mut builder = HardwareOperationsBuilder::with_capacity(1);
let mut out = 0;
builder.port_read_u8(port, &mut out);
builder.send().await;
out
}
pub async unsafe fn port_read_u16(port: u32) -> u16 {
let mut builder = HardwareOperationsBuilder::with_capacity(1);
let mut out = 0;
builder.port_read_u16(port, &mut out);
builder.send().await;
out
}
pub async unsafe fn port_read_u32(port: u32) -> u32 {
let mut builder = HardwareOperationsBuilder::with_capacity(1);
let mut out = 0;
builder.port_read_u32(port, &mut out);
builder.send().await;
out
}
/// Builder for read and write hardware operations.
pub struct HardwareOperationsBuilder<'a> {
operations: Vec,
out: Vec>,
}
enum Out<'a> {
MemReadU8(&'a mut [u8]),
MemReadU16(&'a mut [u16]),
MemReadU32(&'a mut [u32]),
PortU8(&'a mut u8),
PortU16(&'a mut u16),
PortU32(&'a mut u32),
Discard,
}
impl<'a> HardwareOperationsBuilder<'a> {
pub fn new() -> Self {
HardwareOperationsBuilder {
operations: Vec::new(),
out: Vec::new(),
}
}
pub fn with_capacity(capacity: usize) -> Self {
HardwareOperationsBuilder {
operations: Vec::with_capacity(capacity),
out: Vec::with_capacity(capacity),
}
}
pub unsafe fn read(&mut self, address: u64, out: &'a mut (impl ?Sized + AsMut<[u8]>)) {
let out = out.as_mut();
self.operations.push(ffi::Operation::PhysicalMemoryReadU8 {
address,
len: out.len() as u32, // TODO: don't use `as`
});
self.out.push(Out::MemReadU8(out));
}
pub unsafe fn read_u16(&mut self, address: u64, out: &'a mut (impl ?Sized + AsMut<[u16]>)) {
let out = out.as_mut();
self.operations.push(ffi::Operation::PhysicalMemoryReadU16 {
address,
len: out.len() as u32, // TODO: don't use `as`
});
self.out.push(Out::MemReadU16(out));
}
pub unsafe fn read_u32(&mut self, address: u64, out: &'a mut (impl ?Sized + AsMut<[u32]>)) {
let out = out.as_mut();
self.operations.push(ffi::Operation::PhysicalMemoryReadU32 {
address,
len: out.len() as u32, // TODO: don't use `as`
});
self.out.push(Out::MemReadU32(out));
}
pub unsafe fn memset(&mut self, address: u64, len: u64, value: u8) {
self.operations.push(ffi::Operation::PhysicalMemoryMemset {
address,
len,
value,
});
}
pub unsafe fn write(&mut self, address: u64, data: impl Into>) {
self.operations.push(ffi::Operation::PhysicalMemoryWriteU8 {
address,
data: data.into(),
});
}
pub unsafe fn write_one_u32(&mut self, address: u64, data: u32) {
self.operations
.push(ffi::Operation::PhysicalMemoryWriteU32 {
address,
data: vec![data],
});
}
pub unsafe fn port_write_u8(&mut self, port: u32, data: u8) {
self.operations
.push(ffi::Operation::PortWriteU8 { port, data });
}
pub unsafe fn port_write_u16(&mut self, port: u32, data: u16) {
self.operations
.push(ffi::Operation::PortWriteU16 { port, data });
}
pub unsafe fn port_write_u32(&mut self, port: u32, data: u32) {
self.operations
.push(ffi::Operation::PortWriteU32 { port, data });
}
pub unsafe fn port_read_u8(&mut self, port: u32, out: &'a mut u8) {
self.operations.push(ffi::Operation::PortReadU8 { port });
self.out.push(Out::PortU8(out));
}
pub unsafe fn port_read_u16(&mut self, port: u32, out: &'a mut u16) {
self.operations.push(ffi::Operation::PortReadU16 { port });
self.out.push(Out::PortU16(out));
}
pub unsafe fn port_read_u32(&mut self, port: u32, out: &'a mut u32) {
self.operations.push(ffi::Operation::PortReadU32 { port });
self.out.push(Out::PortU32(out));
}
pub unsafe fn port_read_u8_discard(&mut self, port: u32) {
self.operations.push(ffi::Operation::PortReadU8 { port });
self.out.push(Out::Discard);
}
pub unsafe fn port_read_u16_discard(&mut self, port: u32) {
self.operations.push(ffi::Operation::PortReadU16 { port });
self.out.push(Out::Discard);
}
pub unsafe fn port_read_u32_discard(&mut self, port: u32) {
self.operations.push(ffi::Operation::PortReadU32 { port });
self.out.push(Out::Discard);
}
pub fn send(self) -> impl Future