https://github.com/redox-os/kernel
Mirror of https://gitlab.redox-os.org/redox-os/kernel
https://github.com/redox-os/kernel
linux microkernel plan9 redox rust sel4 syscall
Last synced: about 1 month ago
JSON representation
Mirror of https://gitlab.redox-os.org/redox-os/kernel
- Host: GitHub
- URL: https://github.com/redox-os/kernel
- Owner: redox-os
- License: mit
- Created: 2017-01-04T22:41:21.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-04T23:17:26.000Z (7 months ago)
- Last Synced: 2024-11-05T00:21:58.265Z (7 months ago)
- Topics: linux, microkernel, plan9, redox, rust, sel4, syscall
- Language: Rust
- Homepage:
- Size: 3.64 MB
- Stars: 627
- Watchers: 51
- Forks: 85
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kernel
Redox OS Microkernel
[](https://docs.rs/redox_syscall/latest/syscall/)
[](https://github.com/XAMPPRocky/tokei)
[](./LICENSE)
## Requirements
* [`nasm`](https://nasm.us/) needs to be available on the PATH at build time.
## Building The Documentation
Use this command:
```sh
cargo doc --open --target x86_64-unknown-none
```
## Debugging
### QEMU
Running [QEMU](https://www.qemu.org) with the `-s` flag will set up QEMU to listen on port `1234` for a GDB client to connect to it. To debug the redox kernel run.
```sh
make qemu gdb=yes
```
This will start a virtual machine with and listen on port `1234` for a GDB or LLDB client.
### GDB
If you are going to use [GDB](https://www.gnu.org/software/gdb/), run these commands to load debug symbols and connect to your running kernel:
```
(gdb) symbol-file build/kernel.sym
(gdb) target remote localhost:1234
```
### LLDB
If you are going to use [LLDB](https://lldb.llvm.org/), run these commands to start debugging:
```
(lldb) target create -s build/kernel.sym build/kernel
(lldb) gdb-remote localhost:1234
```
After connecting to your kernel you can set some interesting breakpoints and `continue`
the process. See your debuggers man page for more information on useful commands to run.
## Notes
- Always use `foo.get(n)` instead of `foo[n]` and try to cover for the possibility of `Option::None`. Doing the regular way may work fine for applications, but never in the kernel. No possible panics should ever exist in kernel space, because then the whole OS would just stop working.
- If you receive a kernel panic in QEMU, use `pkill qemu-system` to kill the frozen QEMU process.
## How To Contribute
To learn how to contribute to this system component you need to read the following document:
- [CONTRIBUTING.md](https://gitlab.redox-os.org/redox-os/redox/-/blob/master/CONTRIBUTING.md)
## Development
To learn how to do development with this system component inside the Redox build system you need to read the [Build System](https://doc.redox-os.org/book/build-system-reference.html) and [Coding and Building](https://doc.redox-os.org/book/coding-and-building.html) pages.
### How To Build
To build this system component you need to download the Redox build system, you can learn how to do it on the [Building Redox](https://doc.redox-os.org/book/podman-build.html) page.
This is necessary because they only work with cross-compilation to a Redox virtual machine, but you can do some testing from Linux.