https://github.com/redox-os/kernel

Mirror of https://gitlab.redox-os.org/redox-os/kernel
https://github.com/redox-os/kernel

Last synced: about 2 months 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 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-25T16:17:25.000Z (about 2 months ago)
• Last Synced: 2024-07-25T20:22:52.746Z (about 2 months ago)
• Language: Rust
• Homepage:
• Size: 3.38 MB
• Stars: 559
• Watchers: 51
• Forks: 75
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kernel

Redox OS Microkernel

[![docs](https://img.shields.io/badge/docs-master-blue.svg)](https://docs.rs/redox_syscall/latest/syscall/)

[![SLOCs counter](https://tokei.rs/b1/github/redox-os/kernel?category=code)](https://github.com/XAMPPRocky/tokei)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

## 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.