this is gated behind the feature "debug-proc" because this could leak attacker-useful information, and also it adds a primitive that causes the kernel to write the debug information into any page that the userspace already has access to. There are some checks to ensure that the page is actually in RAM (so you can't use this to trigger weird peripheral states, etc.) so hypothetically this should just cause corruption in the userspace process if it is abused, but still - more attack surface, more problems. however, the feature is useful enough and the risk is small enough that I think I'm going to leave it enabled for the foreseeable future. It's definitely helpful to be able to see how much free memory you have, and other resource allocation trackers like connection limits and interrupt handler allocations. |
||
|---|---|---|
| .. | ||
| bin | ||
| src | ||
| test | ||
| assemble.ps1 | ||
| assemble.sh | ||
| build.rs | ||
| Cargo.toml | ||
| link.x | ||
| README.md | ||
Xous Kernel
This contains the core kernel for Xous. It requires a stage 1 loader in order to start up, as it assumes the system is already running in Supervisor mode.
Building
To build the kernel, you will need a riscv32 target for Rust. Possible
targets include riscv32i-unknown-none-elf, riscv32imac-unknown-none-elf,
or riscv32imac-unknown-xous-elf.
- Decide what target you want. For simple, embedded systems this could
be
riscv32i-unknown-none-elf, and for more complex systems with compressed instructions you could useriscv32imac-unknown-none-elf. - Get Rust. Go to https://rustup.rs/ and follow its instructions.
- Install the proper toolchain:
rustup target add ${target_arch} - Build the kernel:
cargo build --release --target ${target_arch}
Using
To use the kernel, you must package it up into an arguments binary with
xous-tools.
Testing
TBD
Contribution Guidelines
Please see CONTRIBUTING for details on how to make a contribution.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide its terms.
License
Copyright © 2020
This project is licensed under the Apache License 2.0 LICENSE. For accurate information, please check individual files.