This repository builds a fully bootable distribution for the Menix kernel.
It also includes several ports of popular apps and tools.
To build the distribution you will need the following tools installed on your system:
- A POSIX-compatible shell
- GNU make
- curl
To create a bootable image you will additionally need:
- dosfstools (for mkfs.vfat)
- e2fsprogs (for mkfs.ext2)
- parted (for partitioning the image)
To run the built image you will also need QEMU for the target architecture.
The easiest way to get a bootable image is to run
$ makein the root of the repository.
This will build the entire distribution and create a bootable image named
menix.img in the current directory.
You can also build separate packages by running ../jinx build <package>
inside the respective build directory for the target architecture.
For example, to build the menix package for the x86_64 architecture, you would
run the following commands (assuming you are in the root of the repository):
$ cd build-x86_64 # Switch to the x86_64 build directory
$ ../jinx build menix # Build the menix packageThe built package will be located in the pkgs directory.
To run the image, you can use the provided make target:
$ make qemuThis will run the image using QEMU with the appropriate options for the
target architecture. If you want to pass your own QEMU flags,
you can do so by setting the QEMUFLAGS variable, e.g.:
$ make qemu QEMUFLAGS="-m 512M -smp 4"To debug Menix, build a normal image, but make sure to also build the package
menix-debug.
The binary is unstripped and contains debuginfo.
Run QEMU with:
$ make qemu QEMUFLAGS="-s -S" KVM=0and then attach your debugger.
For convenicence, there is a debugging configuration using CodeLLDB for VS Code.
Simply select Run > Start Debugging and use .vscode/launch.json as the config.
Finally, start the menix-debug kernel in the bootloader and make sure KASLR
has been disabled or you have provided the debugger with the load offset.