mirror of https://github.com/saymrwulf/xous-core.git synced 2026-11-04 04:27:34 +00:00

History

Sean Cross 5dfad296ae xous: mark MemoryRange::as_slice and friends as unsafe Mark `MemoryRange::as_slice()` and `MemoryRange::as_slice_mut()` as unsafe. This is due to the fact that not all representable types can be cast to an arbitrary value. For example, if Process A sends random values to Process B, then Process B casts the memory to a slice of `bool`, then any values that are not 0 or 1 are undefined. Because these functions can leak UB into the program, they are marked as unsafe. This patch adds `unsafe {}` blocks to all instances where this function is called. Additionally, all instances have been checked to verify that they do not cast to any invalid types -- most use `u8` or `u32`. Additionally, the long-deprecated `MemoryRange::from_parts()` call was removed, since that causes UB without being marked as unsafe. Signed-off-by: Sean Cross <sean@xobs.io>		2023-09-12 10:07:38 +08:00
..
bin	kernel: use correct fake interrupt cause	2023-04-09 15:31:06 +08:00
src	xous: mark MemoryRange::as_slice and friends as unsafe	2023-09-12 10:07:38 +08:00
assemble.ps1	kernel: add arm to asm scripts	2023-03-14 18:41:33 +04:00
assemble.sh	harmonize scripts around xpack distro (goodbye sifive)	2023-04-27 22:09:08 +08:00
build.rs	kernel: update build script to pick arch specific linker and asm binary	2023-03-14 18:37:40 +04:00
Cargo.toml	publish package updates, sync to release tag	2023-08-08 14:35:49 +08:00
link.x	add an "endcap" to the kernel region	2023-01-17 23:07:05 +08:00
README.md

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 use riscv32imac-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

This project is licensed under the Apache License 2.0 LICENSE. For accurate information, please check individual files.