no-identd / node-replicated-kernel

Experimental kernel with built-in replication.

Bespin

Bespin is an (experimental) research OS kernel for x86-64 (amd64) machines written in rust. You can read more about it here.

Installation

Check-out the source tree

1. git clone <repo-url>
2. cd bespin
3. Note: In case you don't have the SSH key of your machine registered with a github account, you need to convert the submodule URLs to the https protocol, to do so run: sed -i'' -e 's/[e-mail]:/https:\/\/github.com\//' .gitmodules
4. git submodule init
5. git submodule update

Install dependencies

Run bash setup.sh, this will install required dependencies on Linux to build and run bespin.

Build and run

1. cd kernel
2. python3 ./run.py

If you just want to compile the code you can also execute:

1. RUST_TARGET_PATH=`pwd`/src/arch/x86_64 xargo build --target=bespin

in the kernel directory (run.py will do that on your behalf).

Development

Testing

To run the unit tests of the kernel:

1. cd kernel
2. RUST_BACKTRACE=1 RUST_TEST_THREADS=1 cargo test --bin bespin

To run the integration tests of the kernel:

1. cd kernel
2. RUST_TEST_THREADS=1 cargo test --features smoke --test integration-test

If you would like to run a specific integration test you can pass it with --:

1. RUST_TEST_THREADS=1 cargo test --test integration-test -- --nocapture userspace_smoke

Note: Parallel testing is not possible at the moment due to reliance on build flags for testing.

Submitting a change

Update latest master:

1. git checkout master
2. git pull
3. git submodule update --init

Create a new feature branch:

1. git checkout -b <BRANCH-NAME>
2. Make changes in code.

Make sure that the code compiles without warnings, is properly formatted and passes tests:

1. cd kernel
2. bash commitable.sh

Commit changes and push

1. git add <CHANGED-FILES>
2. git commit
3. git push -u origin <BRANCH-NAME>
4. Create a Pull Request on GitHub.