1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<!-- Read Me of NeKernel -->
<div align="center">
<img src="meta/png/nekernel.png" alt="NeKernel Logo" width="180"/>
<h1>NeKernel</h1>
<p>
<b>Modern, Modular, and Secure Microkernel for Next-Generation Systems</b>
</p>
<p>
<a href="https://github.com/amlel-el-mahrouss/nekernel/actions/workflows/boot-pio.yml"><img src="https://github.com/amlel-el-mahrouss/nekernel/actions/workflows/boot-pio.yml/badge.svg" alt="CI"></a>
<a href="https://github.com/amlel-el-mahrouss/nekernel/actions/workflows/kernel-ahci.yml"><img src="https://github.com/amlel-el-mahrouss/nekernel/actions/workflows/kernel-ahci.yml/badge.svg" alt="CI"></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/license-GPL--3.0-blue.svg" alt="License"></a>
<img src="https://img.shields.io/badge/QEMU-Tested-success" alt="QEMU Tested">
</p>
</div>
---
## Overview
**NeKernel** is a modern, multi-platform microkernel designed for security, modularity, and performance. It features a custom VFS, advanced memory management, a flexible DDK (Driver Development Kit), and robust userland tooling. NeKernel is built for research, education, and next-generation OS development.
---
## Features
- **Modular Microkernel Architecture**: Clean separation of kernel, drivers, userland, and frameworks.
- **Custom Filesystems**: (HeFS), catalog/fork model (NeFS), and metadata handling.
- **Memory Management**: Custom heap manager, page manager, and safe memory utilities. Kernel heap allocations are protected with metadata and CRCs. Userland and kernel memory separation.
- **Device and Driver Model**: Abstracted device interfaces for storage, network, and more. DDK (Device Driver Kit) for writing drivers in C/C++ with kernel RPC and memory-safe APIs.
- **Userland Tooling**: CLI tools for formatting, checking, and managing filesystems, disk image utilities, and system utilities. All tools interact with kernel or disk images using well-defined APIs.
- **System Call Interface**: low-level syscall ABI, with a stable high-level SDK for user applications. System calls are routed through a syscall manager and abstracted by `libSystem`.
- **Security and Robustness**: kernel and tooling (bounds checks, safe memory copy/set, error codes). Kernel panics and error reporting for critical failures. No dynamic code loading in kernel space.
- **Documentation and Specs**: Full LaTeX specifications for HeFS and NeFS, with on-disk structure diagrams and API documentation. Markdown docs for tooling and usage.
- **Cross-Platform Boot Support**: Bootloader and platform code for AMD64 and ARM64, with handover and hardware abstraction layers.
- **Testing and Debugging**: Logging, debug output, and kernel test framework headers. (Note: Fuzzing/sanitizer support is planned but not fully implemented.)
---
## Getting Started
### **Requirements**
- [MINGW-W64](https://www.mingw-w64.org/) (cross-compiling)
- [CLANG](https://clang.llvm.org/)
- [NASM](https://nasm.us/)
- [BTB](https://github.com/nekernel-org/btb) (build system)
### **Build & Run**
```sh
git clone https://github.com/nekernel-org/nekernel.git
cd nekernel
./setup_x64.sh
./debug_ata_x64.sh # For generic ATA PIO target (QEMU)
```
- For ARM64 or other targets, see the scripts in `dev/boot/`.
---
## Structure
- `dev/kernel/` — Core kernel source (scheduling, memory, VFS, drivers)
- `dev/boot/` — Bootloader, platform bring-up, and early system code
- `dev/ddk/` — Driver Development Kit (DDK) and sample drivers
- `dev/libSystem/` — Userland system call interface and runtime
- `public/tools/` — CLI tools (mkfs, fsck, open, manual, etc.)
- `public/frameworks/` — Userland frameworks (CoreFoundation, DiskImage, etc.)
- `docs/` — Specifications, design docs, and diagrams
---
## Security
- **Vulnerability Disclosure:**
Please report security issues privately via email or GitHub Security Advisories.
---
## Documentation
- [API Reference (Doxygen)](https://nekernel-org.github.io/docs/)
- [Filesystem Specifications](docs/tex/)
---
## Contributing
- Please run `format.sh` before committing (uses `.clang-format`).
- All contributions (code, docs, fuzzing, security) are welcome!
---
## Authors & Credits
- **Amlal El Mahrouss** — Lead developer, kernel architect
- [Full contributor list](https://github.com/nekernel-org/nekernel/graphs/contributors)
---
## License
This project is licensed under the [GPL-3.0 License](LICENSE).
---
<div align="center">
<sub>
© 2024-2025 Amlal El Mahrouss & NeKernel contributors. All rights reserved.
</sub>
</div>
|
