{"id":13599883,"url":"https://github.com/redox-os/kernel","last_synced_at":"2025-10-04T11:44:43.520Z","repository":{"id":47268103,"uuid":"78058884","full_name":"redox-os/kernel","owner":"redox-os","description":"Mirror of https://gitlab.redox-os.org/redox-os/kernel","archived":false,"fork":false,"pushed_at":"2025-06-25T15:17:30.000Z","size":4028,"stargazers_count":731,"open_issues_count":14,"forks_count":94,"subscribers_count":51,"default_branch":"master","last_synced_at":"2025-06-25T16:34:13.025Z","etag":null,"topics":["linux","microkernel","plan9","redox","rust","sel4","syscall"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redox-os.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-01-04T22:41:21.000Z","updated_at":"2025-06-25T15:17:34.000Z","dependencies_parsed_at":"2024-04-28T16:28:41.603Z","dependency_job_id":"7a14e3fb-02cf-4d50-96c7-c96f0ec4e358","html_url":"https://github.com/redox-os/kernel","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/redox-os/kernel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redox-os%2Fkernel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redox-os%2Fkernel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redox-os%2Fkernel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redox-os%2Fkernel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redox-os","download_url":"https://codeload.github.com/redox-os/kernel/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redox-os%2Fkernel/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261937039,"owners_count":23232846,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["linux","microkernel","plan9","redox","rust","sel4","syscall"],"created_at":"2024-08-01T17:01:15.747Z","updated_at":"2025-10-04T11:44:38.474Z","avatar_url":"https://github.com/redox-os.png","language":"Rust","readme":"# Kernel\n\nRedox OS Microkernel\n\n[![docs](https://img.shields.io/badge/docs-master-blue.svg)](https://docs.rs/redox_syscall/latest/syscall/)\n[![SLOCs counter](https://tokei.rs/b1/github/redox-os/kernel?category=code)](https://github.com/XAMPPRocky/tokei)\n[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)\n\n## Requirements\n\n* [`nasm`](https://nasm.us/) needs to be available on the PATH at build time.\n\n## Building The Documentation\n\nUse this command:\n\n```sh\ncargo doc --open --target x86_64-unknown-none\n```\n\n## Debugging\n\n### QEMU\n\nRunning [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.\n\n```sh\nmake qemu gdb=yes\n```\n\nThis will start a virtual machine with and listen on port `1234` for a GDB or LLDB client.\n\n### GDB\n\nIf 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:\n\n```\n(gdb) symbol-file build/kernel.sym\n(gdb) target remote localhost:1234\n```\n\n### LLDB\n\nIf you are going to use [LLDB](https://lldb.llvm.org/), run these commands to start debugging:\n\n```\n(lldb) target create -s build/kernel.sym build/kernel\n(lldb) gdb-remote localhost:1234\n```\n\nAfter connecting to your kernel you can set some interesting breakpoints and `continue`\nthe process. See your debuggers man page for more information on useful commands to run.\n\n## Notes\n\n- 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.\n\n- If you receive a kernel panic in QEMU, use `pkill qemu-system` to kill the frozen QEMU process.\n\n## How To Contribute\n\nTo learn how to contribute to this system component you need to read the following document:\n\n- [CONTRIBUTING.md](https://gitlab.redox-os.org/redox-os/redox/-/blob/master/CONTRIBUTING.md)\n\n## Development\n\nTo 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.\n\n### How To Build\n\nTo 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.\n\nThis is necessary because they only work with cross-compilation to a Redox virtual machine, but you can do some testing from Linux.\n\n## Funding - _Unix-style Signals and Process Management_\n\nThis project is funded through [NGI Zero Core](https://nlnet.nl/core), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program. Learn more at the [NLnet project page](https://nlnet.nl/project/RedoxOS-Signals).\n\n[\u003cimg src=\"https://nlnet.nl/logo/banner.png\" alt=\"NLnet foundation logo\" width=\"20%\" /\u003e](https://nlnet.nl)\n[\u003cimg src=\"https://nlnet.nl/image/logos/NGI0_tag.svg\" alt=\"NGI Zero Logo\" width=\"20%\" /\u003e](https://nlnet.nl/core)\n","funding_links":[],"categories":["Rust"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredox-os%2Fkernel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredox-os%2Fkernel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredox-os%2Fkernel/lists"}