Overview of the project directories

build

Temp build files. See build_instructions on how to compile the system.

build/root Compiled user space apps for VIMIX. This directory will be copied into a file_system in a file (filesystem.img) as the root file system of VIMIX.
build/kernel-vimix The compiled kernel
build/filesystem.img The final image of the file system for qemu
build_host The applications which can be build on the host as well end up here in the same structure as in build.

docs

This documentation, see also: README

kernel

The VIMIX kernel contains all the code that runs in S-mode.

The sub-directory structure was inspired by Linux:

arch/riscv (RISC V) (ideally) all architecture dependent code
drivers (devices) drivers by category
fs (file_system)
- fs/xv6fs xv6fs is a simple file system based on the one from xv6 (which was inspired by the UNIX 6 file system)
include kernel API for kernel code (e.g. drivers)
- user space kernel API: usr/include/sys
init (init_overview) boot and init of all subsystems
kernel (kernel) primary functions of the OS like process management
lib libs shared by different kernel modules
- lib/libfdt device tree parsing lib from https://github.com/dgibson/dtc.
mm (memory_management)

tools

Tools for the development environment.

Scripts for debugging.

usr

user space applications and libs for VIMIX.

usr/bin: All default apps
usr/bin/mkfs:
- mkfs: The tool to create xv6fs file systems.
- fsck.xv6fs: A simple xv6fs file system checker.
usr/bin/usertests: The usertests app.
usr/include: user space headers
usr/include/sys: user space kernel API
usr/local/bin: additional applications which are not essential

Up: README

build_instructions | debugging | run_on_qemu | run_on_spike | run_on_visionfive2 | overview_directories | architectures | kernel | user space