Skip to content

Latest commit

 

History

History
140 lines (112 loc) · 6.43 KB

File metadata and controls

140 lines (112 loc) · 6.43 KB

Clan OS Documentation Index

Central index for validation gates, deep-dive guides, and historical scope checklists. The public roadmap lives in the root README.

Validation (authoritative)

Document Role
VALIDATION_GATES.md Unified validation gate serial lines, scripts, CI matrix
GATE_AUDIT.md Per-gate substance audit (real vs shallow vs stub)
GAP_AUDIT.md Gap registry addressed substance audit
GATE_AUDIT_401_500.md Post-400 gate vs roadmap falsifiers
GATE_DESIGN_401_500.md Post-400 gate design backlog (ADR-0002 priority)
RELEASE_SCORECARD.md Fully operational OS release criteria
architecture/ADR/ADR-0001-unified-validation-gate.md Unified validation gate merge (ADR-0001)

Historical pre-unification scorecards (superseded): RELEASE_SCORECARD_M350.md, RELEASE_SCORECARD_M400.md, RELEASE_SCORECARD_M500.md.

Quick checks:

cargo check -p kernel
python scripts/gate/host.py
python scripts/gate/run.py --gate all --timeout 360

Full matrix:

python scripts/validation_matrix.py --smoke-timeout 180

Canonical scripts live under scripts/gate/ and scripts/preemption/. Deprecated wrappers (boot.py, system.py) forward to run.py with stderr warnings.

Module: kernel/src/validation_gate.rs (VALIDATION_GATE_VERSION = 2.1.0).

Validation gate subsystems

All subsystems emit ClanOS-Gate: name=<subsystem> ok=true. Use --gate <subsystem> with scripts/gate/run.py. Scope indices map via scripts/gate/map.py (gate_for_scope).

Gate Scope / epoch Check
shell_storage 6–8 run.py --gate shell_storage
loader_security 9–13 --gate loader_security
memory_layout 14–16 --gate memory_layout
userspace_bootstrap 17–20 --gate userspace_bootstrap
hw_paging 21–30 --gate hw_paging
sched_userspace 31–40 --gate sched_userspace
dynamic_runtime 41–50 --gate dynamic_runtime
fd_mmap 51–60 --gate fd_mmap
vm_fork 61–70 --gate vm_fork
syscall_ring3 71–80 --gate syscall_ring3
path_exec 81–90 --gate path_exec
smp_depth 91–100 --gate smp_depth
constitutional 110 --gate constitutional
capabilities 120 --gate capabilities
service_loader 121 --gate service_loader
platform_brokers 130 --gate platform_brokers
build_endpoints 131–140 --gate build_endpoints
virtio_blk 201 --gate virtio_blk
network_compat 404 --gate network_compat
scheduler_epoch 149 --gate scheduler_epoch
boundary 150 --gate boundary
integrity Epoch 7 --gate integrity
scheduling Epoch 8 --gate scheduling
hardware Epoch 9 --gate hardware
federation Epoch 10 --gate federation
release Epoch 11 --gate release
desktop_preview Desktop preview --gate desktop_preview
desktop Desktop stack --gate desktop
functional Functional OS --gate functional
ci CI hardening --gate ci
production Production SMP --gate production
network External network --gate network
all Full matrix --gate allClanOS-Gate: ok=true

Post-100 architecture guides

Guide Role
ROADMAP_POST100.md Constitutional + capability foundation
ROADMAP_151_350.md Epochs 7–14
ROADMAP_351_400.md Desktop + userland + network
ROADMAP_401_500.md Production SMP + signed ELF + fully operational OS
NATIVE_MODEL.md Post-Unix native definition
AXIOMS.md Constitutional axioms A1–A10
KERNEL_OBJECT_MODEL.md Universal objects; G1
RIGHTS_ALGEBRA.md Authority calculus; G2
TEMPORAL_SEMANTICS.md Visibility; G5
SEMANTIC_SPECS.md Architecture-preservation cases
ABI_SYSCALL.md Compat clan-abi-v1
ABI_IPC.md Endpoint guarantees; G3

Deep-dive guides

Guide Topics
SCHEDULER.md Preemption, CR3 binding, runqueues
STORAGE.md Filesystem, block devices
DEVICES.md PCI, block manager
PROGRAMS.md Loader, manifests, ELF
SECURITY.md Credentials, trust
EXECUTABLE_IMAGES.md ELF validation
USER_PAGE_TABLES.md Paging, CR3, W^X
USER_SYSCALLS.md Syscall surface
SMP.md APs, IPI, work-stealing
context-lab.md Cooperative context lab

Historical scope checklists

Per-scope checklists (scope-*-checklist.md) record completed implementation scope. They are not the runtime validation surface — use VALIDATION_GATES.md.

Scopes 1–100 (click to expand file links)
Scope Topic Checklist
1 Boot scope-1-checklist.md
2 Hardware / IRQ scope-2-checklist.md
3 Memory / paging scope-3-checklist.md
4 Processes scope-4-checklist.md
5 Preemptive scheduling scope-5-checklist.md
6–100 Userland through SMP integration scope-6-checklist.mdscope-100-checklist.md
Scopes 101–500 (click to expand)

Constitutional (101–110), capabilities (111–120), platform brokers (121–130), build/IPC (131–140), scheduler epoch (141–149), boundary (150), post-150 roadmaps (151–500). Individual files: scope-NNN-checklist.md.

Windows QEMU note

taskkill /IM qemu-system-x86_64.exe /F

The validation matrix retries llvm-objcopy lock errors and pauses after preemption-integration on Windows.