Go to file
Jeremy Soller 531dfaa3e1 Format 2025-11-06 22:14:25 -07:00
.helix Updates .helix config to the new file format 2024-10-01 14:36:11 +00:00
linkers Handle building for i586-unknown-redox 2025-11-01 19:30:40 +01:00
res Add support for graphical debug, to be used during ACPI phase 2018-03-11 11:36:58 -06:00
rmm@7e14945bc5 Update rmm submodule 2025-10-26 16:25:01 +01:00
src Format 2025-11-06 22:14:25 -07:00
targets Handle building for i586-unknown-redox 2025-11-01 19:30:40 +01:00
.gitignore Add the sys:stat scheme 2025-02-22 14:27:10 +00:00
.gitlab-ci.yml Fix Linter CI 2025-08-04 06:34:31 -06:00
.gitmodules Remove slab allocator 2025-09-19 20:29:53 -06:00
ARM-AARCH64-PORT-OUTLINE.md Update status: Toolchain spec done 2018-04-16 02:53:59 +05:30
Cargo.lock Remove byteorder dependency 2025-10-26 12:43:08 -06:00
Cargo.toml Remove byteorder dependency 2025-10-26 12:43:08 -06:00
LICENSE Create LICENSE 2017-09-26 12:57:43 -06:00
Makefile Fix makefile ifeq 2025-11-01 14:02:34 -06:00
README.md Refer to NLnet funding. 2025-04-19 16:30:48 +02:00
build.rs Remove rustc_cfg dependency 2025-10-26 16:32:42 +01:00
clippy.sh Clippy fixes 2022-11-11 13:19:14 -07:00
config.toml.example Support XSAVE, XSAVEOPT, and AVX2. 2023-09-14 10:54:30 +02:00
rust-toolchain.toml Add rust-toolchain.toml 2025-10-04 09:18:10 -06:00
rustfmt.toml Fix Linter CI 2025-08-04 06:34:31 -06:00

README.md

Kernel

Redox OS Microkernel

docs SLOCs counter MIT licensed

Requirements

  • nasm needs to be available on the PATH at build time.

Building The Documentation

Use this command:

cargo doc --open --target x86_64-unknown-none

Debugging

QEMU

Running QEMU 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.

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, 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, 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:

Development

To learn how to do development with this system component inside the Redox build system you need to read the Build System and Coding and Building 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 page.

This is necessary because they only work with cross-compilation to a Redox virtual machine, but you can do some testing from Linux.

Funding - Unix-style Signals and Process Management

This project is funded through NGI Zero Core, a fund established by NLnet with financial support from the European Commission's Next Generation Internet program. Learn more at the NLnet project page.

NLnet foundation logo NGI Zero Logo