Crate kernel 

Kernel entry point

Authors: MarioS271

Modules

arch 🔒

Architecture-specific code Each arch’s top level mod.rs should provide a public boot function to make initializing that arch easier

config 🔒

Compile-Time Kernel Config; configure the compiled kernel’s default params

cpu 🔒

Arch-abstract CPU definitions and state (mainly contains KSTATE::cpu)

drivers 🔒

Drivers; includes TTY system, GPU/display drivers and much more

ipc 🔒

Inter-Process Communication: Pipes, Sockets and more

kprint 🔒

Kernel Print: the [macros!] macro, kernel serial logging, kernel log ringbuffer and more

lib 🔒

Shared kernel lib: IrqMutex, FmtBuffer, AlignedStack, panic codes and more

mm 🔒

Memory subsystem: physical memory manager, virtual memory manager, and heap allocator.

net 🔒

Networking

sched 🔒

Scheduler, ELF loading and more

state 🔒

Global kernel state: [KState] aggregate and [KStateSubCategory] trait.

syscall 🔒

Syscalls

vfs 🔒

The VFS subsystem; creates and managed VFS namespaces like fs:/, dev:/, …

Macros

kalert

Log a line at alert severity (action must be taken immediately).

kcrit

Log a line at critical severity.

kdebug

Log a line at debug severity; compiled out unless the debug-logging feature is enabled.

kemerg

Log a line at emergency severity (system is unusable).

kerror

Log a line at error severity.

kinfo

Log a line at info severity.

knotice

Log a line at notice severity.

kwarn

Log a line at warning severity.

Structs

AlignedBytes 🔒

BootInfo 🔒

Standardized Boot Info passed to kernel_main

FramebufferInfo 🔒

Bootloader-provided info for constructing the basic framebuffer

VirtAddr 🔒

A type representing virtual addresses in the CPU’s virtual address space

Enums

PanicCode 🔒

SpawnError 🔒

Indicates an error when attempting to spawn a new process

Constants

USER_BINARY_LEN 🔒

Statics

KSTATE 🔒

SIMPLE_STATE 🔒

Data structure for keeping the serial UART logger and basic_fb fb resources for early boot and panic The default initializations should not contain any non-null value in order for SIMPLE_STATE to be able to live in .bss to reduce binary size

USER_BINARY

USER_BINARY_ALIGNED 🔒

Functions

basic_fb_init 🔒

Initializes the Basic Framebuffer

kernel_main 🔒

Abstract kernel entry point, called from the per-arch entry

kernel_panic 🔒

Halt the kernel with a diagnostic message; re-entrant calls skip straight to the halt loop.

spawn_from_elf 🔒 ^⚠

Spawn a new process, returning its PID