- 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 |
|---|---|---|
26e5d89c73
`jmp mpenter`.
x86-64 requires rsp to be 16-byte aligned immediately before a `call`, so a
function starts with rsp ending in 8 -- the return address -- and its
`push %rbp; mov %rsp,%rbp` prologue leaves %rbp 16-byte aligned. Compilers
build on that: an aligned vector store to a frame slot is `movaps`, and
`movaps` to a misaligned address is #GP.
entry64mp loaded the AP's stack pointer, which is page-aligned, and *jumped*.
Nothing pushed a return address, so %rbp came out eight bytes off -- on every
frame, on every application processor, for the life of the machine.
It cost nothing for as long as no function an AP ran needed an aligned vector
store. Then the console's glyph path started returning a small struct by value
(the cell-as-a-surface change), clang spilled it with movaps, and CPU 1 took a
#GP the instant it announced itself on a verbose boot:
unexpected trap 13 from cpu 1 rip ffff800000120a3b <draw_glyph_px+0x1cb>
120a37: 0f 10 45 90 movups -0x70(%rbp), %xmm0
120a3b: 0f 29 45 b0 movaps %xmm0, -0x50(%rbp) <- #GP
movups on the line above loads fine; movaps stores and faults. The
displacement is a multiple of 16, so what is misaligned is %rbp itself, which
is a fact about how the function was entered.
`call mpenter`, not `jmp`. Eight bytes for an ABI the whole toolchain assumes.
**It was hiding behind a second bug.** The first report was not a #GP at all:
Stop code ACQUIRE
#2 cprintf+0xae
#3 trap+0x2c4
trap() reported the fault with cprintf(), cprintf() takes the console lock,
and the faulting code was already holding it -- on a verbose boot every
character is drawn under that lock. acquire() panicked about a lock its own
call chain owned, and the trap number, the faulting address and the registers
were all lost. A kernel-mode trap ends in panic() a dozen lines later anyway,
so the console goes into panic mode *before* the report rather than during it.
**And a third, in the same boot.** The console reported "JetBrains Mono, 8x16
cells" -- a name from one font and metrics from another. The built-in bitmap
became a provider like any other in the previous commit, so draw_glyph_px()
installs it lazily on the first glyph; on a verbose boot that happens before
gfx_font_init() runs, which then returned early because a font was already
installed. The console spent the whole boot in the fallback while claiming not
to be. "A font is installed" and "a typeface was chosen" had been the same test
and quietly stopped being; they are two flags now.
Verified: verbose boot reaches a shell twice running with no traps and no
panics, and reports 10x21 cells -- the real typeface -- where it reported 8x16
before. Both supported configurations quiet: one boot each, no traps, no
panics, socktest and memfdtest green.
Written up as section 22 of docs/history/kernel.md, because the interesting
part is not the missing eight bytes but that three separate faults had to be
peeled off in order before the first one could be seen.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
||
| .claude/memory | ||
| boot | ||
| cmd | ||
| docs | ||
| etc | ||
| include | ||
| kernel | ||
| ldls | ||
| lib | ||
| ports | ||
| projects | ||
| srv | ||
| 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. Names resolve, so wget http://host/
works; httpd serves a directory back the other way.
Userland — musl, toybox, mksh and zsh, built from source. 268 applets:
ls, cat, ps, top, wc, cp, mount, awk, bc, diff and the rest
behave the way you expect, because they are the real programs. edit is
kilo — arrow keys, Ctrl-S, Ctrl-Q, nothing
to learn.
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, zsh, kilo, the fonts) keeps its own licence; NOTICE carries the attributions. All of it is permissive — there is no GPL in an image this builds, which is why the userland is toybox and not BusyBox and the editor is kilo and not nano. See docs/licensing.md.
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.