| <img width="256" align="right" src="https://github.com/hermit-os/.github/blob/main/logo/hermit-logo.svg" /> |
| |
| # Hermit for Rust |
| |
| A Rust-based, lightweight unikernel. |
| |
| [](https://hermit.zulipchat.com/) |
| |
| [Hermit](http://hermit-os.org) is a [unikernel](http://unikernel.org) targeting a scalable and predictable runtime for high-performance and cloud computing. |
| Unikernel means, you bundle your application directly with the kernel library, so that it can run without any installed operating system. |
| This reduces overhead, therefore, interesting applications include virtual machines and high-performance computing. |
| |
| The kernel is able to run applications authored in [Rust](https://github.com/hermit-os/hermit-rs), [C](https://github.com/hermit-os/hermit-c), among others. |
| |
| --- |
| |
| The repository contains following directories and submodules: |
| |
| 1. _demo_ is a small demo application based on the data-parallelism library [Rayon](https://github.com/rayon-rs/rayon) |
| 2. _hermit-abi_ contains the platform APIs and builds the interface between library operating system and the application |
| 3. _hermit_ contains a crate to automate the build process of the library operating systems |
| 4. _kernel_ is the kernel itself |
| 5. _netbench_ provides some basic network benchmarks |
| |
| ## Background |
| |
| **Hermit** is a rewrite of HermitCore in [Rust](https://www.rust-lang.org) developed at [RWTH-Aachen](https://www.rwth-aachen.de). |
| HermitCore was a research unikernel written in C ([libhermit](https://github.com/hermit-os/libhermit)). |
| |
| The ownership model of Rust guarantees memory/thread-safety and enables us to eliminate many classes of bugs at compile-time. |
| Consequently, the use of Rust for kernel development promises fewer vulnerabilities in comparison to common programming languages. |
| |
| The kernel and the integration into the Rust runtime are entirely written in Rust and do not use any C/C++ Code. |
| We extended the Rust toolchain so that the build process is similar to Rust's usual workflow. |
| Rust applications that use the Rust runtime and do not directly use OS services are able to run on Hermit without modifications. |
| |
| ## Requirements |
| |
| * [`rustup`](https://www.rust-lang.org/tools/install) |
| |
| ## Building your own applications |
| |
| Have a look at [the template](https://github.com/hermit-os/hermit-rs-template). |
| |
| |
| ## Use Hermit for C/C++, Go, and Fortran applications |
| |
| If you are interested to build C/C++, Go, and Fortran applications on top of a Rust-based library operating system, please take a look at [https://github.com/hermit-os/hermit-playground](https://github.com/hermit-os/hermit-playground). |
| |
| ## Wiki |
| |
| Please use the [Wiki](https://github.com/hermit-os/hermit-rs/wiki) to get further information and configuration options. |
| |
| ## Credits |
| |
| Hermit is derived from following tutorials and software distributions: |
| |
| 1. Philipp Oppermann's [excellent series of blog posts][opp]. |
| 2. Erik Kidd's [toyos-rs][kidd], which is an extension of Philipp Opermann's kernel. |
| 3. The Rust-based teaching operating system [eduOS-rs][eduos]. |
| |
| [opp]: http://blog.phil-opp.com/ |
| [kidd]: http://www.randomhacks.net/bare-metal-rust/ |
| [eduos]: http://rwth-os.github.io/eduOS-rs/ |
| |
| ## License |
| |
| Licensed under either of |
| |
| * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) |
| * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) |
| |
| at your option. |
| |
| ## Contribution |
| |
| Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. |
| |
| Hermit is being developed on [GitHub](https://github.com/hermit-os/hermit-rs). |
| Create your own fork, send us a pull request, and chat with us on [Zulip](https://hermit.zulipchat.com/). |
