# crickertech/nife architecture

> Architecture diagram of the GitHub repository crickertech/nife, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/crickertech/nife
- Repository: https://github.com/crickertech/nife

## Overview

nife is a capability-based Rust microkernel OS. Its principal workflow is booting into the kernel, entering userspace, and having a userspace progenitor construct processes and services; users then interact through a capability shell whose grant logic makes resource designation authorization. Kernel memory, scheduling, capabilities, and revocation underpin that workflow. The README documents the product capabilities; the source excerpts and index show selected kernel relationships, so unsampled service wiring is not expanded into speculative call chains.

Main entry points: [`kernel/src/user.rs`](https://github.com/crickertech/nife/blob/main/kernel/src/user.rs) (User process runtime), [`kernel/src/main.rs`](https://github.com/crickertech/nife/blob/main/kernel/src/main.rs) (Kernel entry), [`kernel/src/sched.rs`](https://github.com/crickertech/nife/blob/main/kernel/src/sched.rs) (Scheduler), [`kernel/src/memory_region.rs`](https://github.com/crickertech/nife/blob/main/kernel/src/memory_region.rs) (Memory regions)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_boot["Boot and execution"]
  node_loader["UEFI loader<br/>[main.rs]"]
  node_kernel_entry["Kernel entry<br/>[main.rs]"]
end

subgraph group_kernel["Kernel core"]
  node_arch["Architecture layer<br/>[mod.rs]"]
  node_scheduler["Scheduler<br/>[sched.rs]"]
  node_threads["Thread runtime<br/>[thread.rs]"]
  node_physical_memory["Physical memory<br/>[memory.rs]"]
  node_console["Kernel console<br/>[console.rs]"]
  node_kernel_stats["Machine statistics"]
  node_fp["Floating-point state<br/>[fp.rs]"]
  node_kernel_sync["Kernel synchronization<br/>[sync.rs]"]
  node_kernel_stack["Kernel stacks<br/>[stack.rs]"]
  node_progenitor_stack["Progenitor stack"]
  node_kernel_testing["Kernel test support<br/>[testing.rs]"]
end

subgraph group_authority["Capabilities and processes"]
  node_capabilities["Capability objects<br/>[cap.rs]"]
  node_memory_regions["Memory regions<br/>[memory_region.rs]"]
  node_user_runtime["User process runtime<br/>[user.rs]"]
  node_revocation["Object revocation<br/>[revoke.rs]"]
  node_grant_planning["Grant planning<br/>[lib.rs]"]
end

subgraph group_services["Userspace services"]
  node_progenitor["Userspace progenitor<br/>[lib.rs]"]
  node_shell["Capability shell<br/>[swish.rs]"]
  node_fs_service["Filesystem service<br/>[fs_service.rs]"]
  node_network_time["Network time client"]
  node_display["Display and compositor<br/>[display_service.rs]"]
end

node_firmware(("Platform firmware"))
node_user(("System user"))

node_firmware -.->|"starts boot"| node_loader
node_loader -.->|"hands off"| node_kernel_entry
node_kernel_entry -.->|"selects hardware"| node_arch
node_kernel_entry -.->|"starts kernel"| node_scheduler
node_scheduler -->|"schedules"| node_threads
node_scheduler -->|"uses objects"| node_capabilities
node_user_runtime -->|"maps processes"| node_physical_memory
node_user_runtime -->|"manages spaces"| node_memory_regions
node_user_runtime -->|"tears down"| node_revocation
node_memory_regions -->|"allocates frames"| node_physical_memory
node_memory_regions -->|"supports revocation"| node_revocation
node_progenitor -->|"builds processes"| node_user_runtime
node_user -->|"enters commands"| node_shell
node_shell -->|"plans grants"| node_grant_planning
node_progenitor -.->|"builds services"| node_fs_service
node_user_runtime -.->|"hosts service"| node_network_time
node_user_runtime -.->|"hosts service"| node_display
node_user_runtime -.->|"provides diagnostics"| node_console

click node_loader "https://github.com/crickertech/nife/blob/main/uefi_loader/src/main.rs"
click node_kernel_entry "https://github.com/crickertech/nife/blob/main/kernel/src/main.rs"
click node_arch "https://github.com/crickertech/nife/blob/main/kernel/src/arch/mod.rs"
click node_scheduler "https://github.com/crickertech/nife/blob/main/kernel/src/sched.rs"
click node_threads "https://github.com/crickertech/nife/blob/main/kernel/src/thread.rs"
click node_capabilities "https://github.com/crickertech/nife/blob/main/kernel/src/cap.rs"
click node_physical_memory "https://github.com/crickertech/nife/blob/main/kernel/src/memory.rs"
click node_memory_regions "https://github.com/crickertech/nife/blob/main/kernel/src/memory_region.rs"
click node_user_runtime "https://github.com/crickertech/nife/blob/main/kernel/src/user.rs"
click node_revocation "https://github.com/crickertech/nife/blob/main/kernel/src/revoke.rs"
click node_progenitor "https://github.com/crickertech/nife/blob/main/crates/system_initializer/src/lib.rs"
click node_shell "https://github.com/crickertech/nife/blob/main/components/src/swish.rs"
click node_grant_planning "https://github.com/crickertech/nife/blob/main/crates/grant_plan/src/lib.rs"
click node_fs_service "https://github.com/crickertech/nife/blob/main/kernel/src/user/fs_service.rs"
click node_network_time "https://github.com/crickertech/nife/blob/main/components/src/network_time_client.rs"
click node_display "https://github.com/crickertech/nife/blob/main/kernel/src/user/display_service.rs"
click node_console "https://github.com/crickertech/nife/blob/main/kernel/src/console.rs"
click node_kernel_stats "https://github.com/crickertech/nife/blob/main/kernel/src/machine_statistics.rs"
click node_fp "https://github.com/crickertech/nife/blob/main/kernel/src/fp.rs"
click node_kernel_sync "https://github.com/crickertech/nife/blob/main/kernel/src/sync.rs"
click node_kernel_stack "https://github.com/crickertech/nife/blob/main/kernel/src/stack.rs"
click node_progenitor_stack "https://github.com/crickertech/nife/blob/main/kernel/src/progenitor_stack.rs"
click node_kernel_testing "https://github.com/crickertech/nife/blob/main/kernel/src/testing.rs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_loader,node_kernel_entry,node_user toneBlue
class node_arch,node_scheduler,node_threads,node_physical_memory,node_console,node_kernel_stats,node_fp,node_kernel_sync,node_kernel_stack,node_progenitor_stack,node_kernel_testing toneAmber
class node_capabilities,node_memory_regions,node_user_runtime,node_revocation,node_grant_planning toneMint
class node_progenitor,node_shell,node_fs_service,node_network_time,node_display toneRose
class node_firmware toneIndigo
```

## Components

### Boot and execution

- [UEFI loader](https://github.com/crickertech/nife/blob/main/uefi_loader/src/main.rs): `uefi_loader/src/main.rs`
- [Kernel entry](https://github.com/crickertech/nife/blob/main/kernel/src/main.rs): `kernel/src/main.rs`

### Kernel core

- [Architecture layer](https://github.com/crickertech/nife/blob/main/kernel/src/arch/mod.rs): `kernel/src/arch/mod.rs`
- [Scheduler](https://github.com/crickertech/nife/blob/main/kernel/src/sched.rs): `kernel/src/sched.rs`
- [Thread runtime](https://github.com/crickertech/nife/blob/main/kernel/src/thread.rs): `kernel/src/thread.rs`
- [Physical memory](https://github.com/crickertech/nife/blob/main/kernel/src/memory.rs): `kernel/src/memory.rs`
- [Kernel console](https://github.com/crickertech/nife/blob/main/kernel/src/console.rs): `kernel/src/console.rs`
- [Machine statistics](https://github.com/crickertech/nife/blob/main/kernel/src/machine_statistics.rs): `kernel/src/machine_statistics.rs`
- [Floating-point state](https://github.com/crickertech/nife/blob/main/kernel/src/fp.rs): `kernel/src/fp.rs`
- [Kernel synchronization](https://github.com/crickertech/nife/blob/main/kernel/src/sync.rs): `kernel/src/sync.rs`
- [Kernel stacks](https://github.com/crickertech/nife/blob/main/kernel/src/stack.rs): `kernel/src/stack.rs`
- [Progenitor stack](https://github.com/crickertech/nife/blob/main/kernel/src/progenitor_stack.rs): `kernel/src/progenitor_stack.rs`
- [Kernel test support](https://github.com/crickertech/nife/blob/main/kernel/src/testing.rs): `kernel/src/testing.rs`

### Capabilities and processes

- [Capability objects](https://github.com/crickertech/nife/blob/main/kernel/src/cap.rs): `kernel/src/cap.rs`
- [Memory regions](https://github.com/crickertech/nife/blob/main/kernel/src/memory_region.rs): `kernel/src/memory_region.rs`
- [User process runtime](https://github.com/crickertech/nife/blob/main/kernel/src/user.rs): `kernel/src/user.rs`
- [Object revocation](https://github.com/crickertech/nife/blob/main/kernel/src/revoke.rs): `kernel/src/revoke.rs`
- [Grant planning](https://github.com/crickertech/nife/blob/main/crates/grant_plan/src/lib.rs): `crates/grant_plan/src/lib.rs`

### Userspace services

- [Userspace progenitor](https://github.com/crickertech/nife/blob/main/crates/system_initializer/src/lib.rs): `crates/system_initializer/src/lib.rs`
- [Capability shell](https://github.com/crickertech/nife/blob/main/components/src/swish.rs): `components/src/swish.rs`
- [Filesystem service](https://github.com/crickertech/nife/blob/main/kernel/src/user/fs_service.rs): `kernel/src/user/fs_service.rs`
- [Network time client](https://github.com/crickertech/nife/blob/main/components/src/network_time_client.rs): `components/src/network_time_client.rs`
- [Display and compositor](https://github.com/crickertech/nife/blob/main/kernel/src/user/display_service.rs): `kernel/src/user/display_service.rs`

### Other components

- **Platform firmware**
- **System user**

## Connections

- Platform firmware → UEFI loader: starts boot
- UEFI loader → Kernel entry: hands off
- Kernel entry → Architecture layer: selects hardware
- Kernel entry → Scheduler: starts kernel
- Scheduler → Thread runtime: schedules (evidence: `kernel/src/sched.rs`)
- Scheduler → Capability objects: uses objects (evidence: `kernel/src/sched.rs`)
- User process runtime → Physical memory: maps processes (evidence: `kernel/src/user.rs`)
- User process runtime → Memory regions: manages spaces (evidence: `kernel/src/user.rs`)
- User process runtime → Object revocation: tears down (evidence: `kernel/src/user.rs`)
- Memory regions → Physical memory: allocates frames (evidence: `kernel/src/memory_region.rs`)
- Memory regions → Object revocation: supports revocation (evidence: `kernel/src/memory_region.rs`)
- Userspace progenitor → User process runtime: builds processes (evidence: `README.md`)
- System user → Capability shell: enters commands (evidence: `README.md`)
- Capability shell → Grant planning: plans grants (evidence: `crates/grant_plan/src/lib.rs`)
- Userspace progenitor → Filesystem service: builds services (evidence: `README.md`)
- User process runtime → Network time client: hosts service (evidence: `README.md`)
- User process runtime → Display and compositor: hosts service (evidence: `README.md`)
- User process runtime → Kernel console: provides diagnostics (evidence: `README.md`)
