Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manticoreos/manticore
Manticore is a research operating system, written in Rust.
https://github.com/manticoreos/manticore
kernel operating-system rust
Last synced: 14 days ago
JSON representation
Manticore is a research operating system, written in Rust.
- Host: GitHub
- URL: https://github.com/manticoreos/manticore
- Owner: manticoreos
- License: apache-2.0
- Created: 2016-10-18T20:36:47.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-01T14:17:03.000Z (12 months ago)
- Last Synced: 2024-08-01T16:19:07.623Z (3 months ago)
- Topics: kernel, operating-system, rust
- Language: C
- Homepage: https://manticoreos.io/
- Size: 1010 KB
- Stars: 287
- Watchers: 13
- Forks: 15
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# Manticore
Manticore is a research operating system to explore parakernels.
## Table of Contents
* [Introduction](#introduction)
* [Getting Started](#getting-started)
* [Building from Sources](#building-from-sources)
* [Supported Hardware](#supported-hardware)
* [Code Structure](#code-structure)
* [Documentation](#documentation)
* [Publications](#publications)
* [Community and Contributing](#contributing)
* [Authors](#authors)
* [License](#license)
## Introduction
Manticore is a clean-slate research operating system, written in the [Rust programming language](https://www.rust-lang.org/), with the aim of exploring the [parakernel](http://penberg.org/parakernel-hotos19.pdf) OS architecture.
Please refer to the [project homepage](https://manticoreos.io/) for more information.
## Getting Started
### Building from Sources
First, install the toolchain, which includes [`rustup`](https://rustup.rs/), Rust, and other dependencies:
```
./scripts/install-toolchain
```
Now that you have the toolchain installed, you can build Manticore with:
```
make
```
The build system generates a `kernel.iso` image, which you can launch under QEMU with:
```
$ ./scripts/run kernel.iso
```
For more information, see [Manticore Hacker's Guide](HACKING.md).
### Running Example Applications
Once `kernel.elf` is built, you can build an user space echo server with:
```
$ make -C usr/echod
```
and launch it under QEMU with:
```
$ ./scripts/run --publish 7777/udp usr/echod/echod.iso
```
You can now communicate with the echo server with:
```
$ nc -u4 localhost 7777
hello
hello
```
### Supported Hardware
* Legacy-free PC with a 64-bit x86 processor
* xAPIC2 interrupt controller
* MSI-X interrupt delivery
* PCIe 3.0 bus
* VirtIO network device
### Code Structure
Manticore's code is structured into different directories as follows:
* [`arch`](./arch): machine architecture specific code
* [`drivers`](./drivers): device drivers
* [`virtio`](./drivers/virtio): VirtIO device drivers
* [`pci`](./drivers/pci): PCIe device drivers
* [`kernel`](./kernel): kernel services (e.g., process scheduling and system calls)
* [`lib`](./lib): support libraries
* [`mm`](./mm): memory management (e.g., virtual memory manager and kernel dynamic memory allocator)
* [`usr`](./usr): user space libraries and example applications
## Documentation
* [Manticore Hacker's Guide](HACKING.md)
## Publications
* Pekka Enberg, Ashwin Rao, and Sasu Tarkoma. 2019. [I/O Is Faster Than the CPU – Let’s Partition Resources and Eliminate (Most) OS Abstractions](http://penberg.org/parakernel-hotos19.pdf). HotOS '19
## Community and Contributing
If you have questions or comments, please join the [Manticore Slack](https://join.slack.com/t/manticoreos/shared_invite/zt-10516cdkl-uXnQeqGXq8Lkz0Z0kp_LnQ)! Bug reports and pull requests are also welcome!
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Coduct](code-of-conduct.md) for details.
## Authors
* [Pekka Enberg](https://penberg.org)
See also the list of [contributors](https://github.com/penberg/manticore/contributors) who contributed to this project.
## License
Licensed under either of these:
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
Unless you explicitly state otherwise, any contribution you intentionally submit for inclusion in the work, as defined in the Apache-2.0 license, shall be dual-licensed as above, without any additional terms or conditions.