- C 90.2%
- Makefile 3.2%
- PowerShell 2.3%
- Shell 1.7%
- Python 1.3%
- Other 1.2%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
9e6d8dd4e3
sendmsg/recvmsg with SCM_RIGHTS. Item 1 of docs/plan/foundations.md and
mechanism 1 of docs/plan/hybrid.md, which are the same primitive seen from two
directions: Wayland's wl_shm_create_pool passes a file descriptor with no
integer-shaped alternative, and handing a driver process the device it is
allowed to touch is the same act. Both plans stopped here.
Linux's structures byte for byte -- msghdr, cmsghdr, the CMSG_ macros -- because
the programs that need this are not ours. libwayland and toybox both call
recvmsg with Linux's headers and would not notice a friendlier door.
The delivery rule is the whole design. A batch of descriptors is pinned to the
stream position of the first byte of the message that carried it, and that has
two halves: a reader arriving at that position is handed them, and a reader that
has not reached it is stopped SHORT of it. Leave out the second half and a
program asking for 4096 bytes swallows three messages and is handed one
message's descriptors, with nothing in the result saying which. socktest checks
exactly that: two one-byte messages, an eight-byte read, one byte back.
The kernel holds a reference to every descriptor in flight, so a sender may
close its own copy the moment sendmsg returns. Giving that reference back is the
part that leaks if it is not written down, and there are three ways a message
ends:
- received with room installed in the receiver's table
- received without room, or by
plain read(2) closed; MSG_CTRUNC for the first case
- never received, socket closed closed by sockclose
The middle row looks like a choice and is not: holding kernel references for a
receiver that has proved it is not looking is a leak with extra steps.
No garbage collector. A socket descriptor sent over that same socket and never
received holds a reference to the socket that holds the reference to it, and
neither close reaches zero. Linux carries several hundred lines for this.
Nothing on either plan passes a socket over a socket -- Wayland passes memory,
the driver work passes devices -- so it is a bounded leak that is documented
rather than a silent one.
Fourteen checks in cmd/socktest, and every one moves data through the descriptor
rather than inspecting it. The descriptor passed is always a pipe end, because a
pipe announces its own lifetime: a read of a pipe whose writers are all gone
returns 0, which turns "was the kernel's reference released" -- otherwise
invisible from userspace -- into a value a test can compare.
Two bugs fell out, neither in the new code:
- sockpair() never set the socket's domain, so every socketpair() socket
claimed domain 0. Invisible while the data paths asked only whether a socket
was AF_INET or AF_NETLINK, since zero answers "neither" correctly.
SCM_RIGHTS asks "is this AF_UNIX", and zero is wrong for that one.
- pipe_poll() reports POLLHUP but not POLLIN at end of file, so a non-blocking
read of a pipe whose writers had all gone returned EAGAIN forever instead of
0 -- a program that polls and reads spins waiting for an end that already
happened. sockreadable() always had the equivalent condition; the pipe path
did not. Found because the test helper for "is this descriptor closed" is a
non-blocking read of a pipe.
projects/schcom/README.md said SCM_RIGHTS was done for a long time while nothing
in the kernel implemented it, and an entire GUI plan was drawn on that line.
It is true now, which is not the same as it having been right, and the README
says so.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VQ7Qx8E1q1M1bbCq8QLHS2
|
||
| .claude/memory | ||
| boot | ||
| cmd | ||
| docs | ||
| etc | ||
| include | ||
| kernel | ||
| lib | ||
| ports | ||
| projects | ||
| tools | ||
| .gdbinit | ||
| .gitattributes | ||
| .gitignore | ||
| LICENSE | ||
| LICENSE.MIT | ||
| Makefile | ||
| NOTICE | ||
| README.md | ||
| run.ps1 | ||
| shell.nix | ||
A 64-bit operating system, written from the metal up.
SMP · copy-on-write filesystem · TCP/IP · PCI, USB and virtio drivers · TrueType text · Linux syscall ABI
SchOS began as xv6 and is now mostly something else. The scheduler, the memory manager and the trap path have been rewritten for x86-64 and for more than one processor; the filesystem has been replaced outright; the syscall table speaks Linux numbering so that real software — musl, toybox, mksh — runs unmodified.
It is a hobby system built by one person, and it is honest about that: what works below has been run, not inferred, and the gaps are listed as plainly as the features.
The pieces
| Layer | Name | What it is |
|---|---|---|
| System | SchOS | The distribution — kernel, userland, tooling |
| Kernel | SchIFT | Multi-core x86-64 kernel with a modular VFS |
| Filesystem | SchFS | Transactional, copy-on-write, the root filesystem |
| API | SchAPI | System programming interface — the stable surface |
| Compositor | SchCom | Display compositor (planned) |
| Window manager | SchWM | (planned) |
| Desktop | SchDE | (planned) |
uname -s reports SchIFT, the way every Unix reports its kernel rather than
its distribution.
What works
Kernel — Long mode, 4-level paging, preemptive multitasking. SMP: one, two and four processors all boot, with CPU enumeration from the ACPI MADT rather than the 1994 MP table. Memory sized from the E820 map, so it runs in tens of megabytes rather than demanding hundreds.
Filesystem — SchFS is the root: a copy-on-write B-tree with a
uberblock ring, so a crash leaves either the old tree or the new one and there
is nothing to repair. Free space is derived from the tree rather than stored
beside it, which removes a whole class of disagreement. /proc/schfs shows the
generation counter advancing as writes commit.
Processes — fork, exec, wait, pipes, signals, sessions and process groups,
mmap (anonymous and file-backed), POSIX shared memory, Unix domain sockets,
poll.
Devices — PCI enumeration with a bus-agnostic device model at
/proc/devices. Drivers for e1000 networking, virtio-gpu and stdvga
displays, xHCI USB with HID, hub and mass-storage class drivers, IDE, PS/2,
serial. /dev/fb0 speaks the Linux fbdev interface.
Networking — ARP, IPv4, ICMP, UDP, TCP and DHCP, on lwIP behind a driver-agnostic interface class. Verified end to end from the host, both directions, rather than by inspection.
Userland — musl, toybox and mksh, built from source. ls, cat, ps,
top, wc, cp, mount and the rest behave the way you expect, because they
are the real programs.
Text — a TrueType rasteriser (glyf outlines, composite glyphs, cmap
format 4) replacing the 8×16 cell grid. JetBrains Mono for the terminal, Roboto
for the desktop layer to come.
When it dies — PSOGM, the Purple Screen of Guru Meditation: stop code, fault address, call chain, and a QR code containing a text copy of the whole report.
Quick start
make # kernel + UEFI loader + root filesystem
make qemu # build it and boot it
make iso # a bootable ISO for VMware or real hardware
Builds on Linux, macOS, FreeBSD/OpenBSD/NetBSD and Windows (Git Bash). The toolchain is clang + lld everywhere — it is a cross-compiler by construction, so one LLVM install targets the bare-metal kernel, the 16-bit boot code and musl userland from any host. See docs/guides/building.md for prerequisites per platform, and docs/history/moving-to-linux.md for moving a checkout between machines.
Testing
Booting to a prompt proves nothing: a filesystem can mount and still fail the first real command, and that has happened here. So the test harness drives the serial console and asserts on what comes back.
tools/windows/bootcheck.ps1 # boot, run real commands, check the answers
tools/windows/bootcheck.ps1 -Tty -Ps # terminal behaviour, process enumeration
make schfs-check # SchFS B-tree, object and image suites
bootcheck is PowerShell because pwsh runs on every supported host.
Layout
kernel/ arch/ core/ dev/ drivers/ fs/ net/ proc/ sys/
fs/schfs/ the filesystem -- same source the host tools compile
include/ kernel and userland headers
boot/ uefi/ (PE loader) common/ (shared loader UI)
lib/ cmd/ first-party userland runtime and programs
ports/ third-party software built from source
tools/ windows/ (.ps1) posix/ (.sh) python/ (.py) and .c/.pl
docs/ architecture/ (what it is) plan/ (what's next)
guides/ (how to work on it) history/ (why it's like this)
docs/README.md is the index. If you are reading the tree for the first time, docs/architecture/README.md is the system layer by layer.
One rule worth knowing: the kernel and the host tools compile the same SchFS
source. mkschfs cannot disagree with the kernel about the on-disk format,
because there is only one implementation — found and fixed on the host, where a
test takes a second instead of a boot.
Another: syscalls are declared in exactly one place,
kernel/sys/table.inc. Everything else is generated from it.
Not there yet
- No desktop. Schcom composites and routes input; the plan is now to put it on Wayland and delete the homegrown protocol. See docs/plan/wayland.md.
- No descriptor passing. No
sendmsg/recvmsg, so noSCM_RIGHTS— which is what the GUI work stops at. docs/plan/foundations.md. - No dynamic linking.
exechandles staticET_EXEConly. - No page cache, so writable
MAP_SHAREDof a file is refused rather than faked. - A USB disk cannot be booted from — the root device is compiled in rather than selectable.
- SchFS has no Linux driver yet; the plan is on-disk format version first, then FUSE, then a kernel module.
- CFF/OpenType outlines and TrueType hinting are deliberately out of scope.
Licensing
Apache-2.0, copyright Nexoniarz. See LICENSE.
The kernel derives from xv6, which is MIT — see LICENSE.MIT. Third-party code redistributed in a built image (musl, toybox, mksh, the fonts) keeps its own licence; NOTICE carries the attributions.
Drivers may be adapted from BSD sources, which are compatible. Linux drivers are not: GPL-2.0-only and Apache-2.0 cannot be combined and redistributed. Reading Linux to understand hardware is fine; translating a driver is not. Best of all is the public specification — xHCI, virtio, AHCI, e1000 — which carries no licence on what you write from it.