| Filename | Latest commit message | Latest commit date |
|---|---|---|
25530e7eed
Started as "fix the ASAN leak in schfs_objtest" and the test turned out to be
the messenger. The allocation map was taken through a palloc callback and there
was no way to return it: no schfs_space_release, and a comment in
schfs_space_init reading "caller frees what was taken" for an API the caller
did not have.
Three separate leaks from that one gap:
* The kernel leaked the entire map on every unmount -- up to 2 MB, at 8 KiB
per GiB of volume -- because kmount_unmount flushed, cleared `mounted` and
walked away. This is the one that matters; the others are test-only.
* schfs_space_init stranded a page on its own error path. npages was raised
only after *both* of a pair of allocations succeeded, so a failure on the
second left the first outside the count -- unreachable to any cleanup that
could later exist.
* schfs_objtest leaked 2121728 bytes in 518 allocations, which is what made
the whole SchFS suite exit non-zero regardless of its assertions.
The map now carries its own pfree rather than taking one at release time, so it
can only ever be freed by the allocator that filled it -- the kernel's pages
come from kalloc and a host tool's from calloc, and the two are not
interchangeable. schfs_vol_open and schfs_vol_format release any map the volume
is already holding before building another, which is what stops a re-open
leaking; struct schfs_vol must therefore be zeroed before first use, and the
header now says so.
The test's own leak was the last one found and the simplest: it does
memset(&VOL, 0, sizeof(VOL)) before reopening, which wiped the map's pointers
before vol_open could release them. Eight of those, each now releasing first.
schfs_objtest asserts the balance -- 520 pages taken, 520 given back -- because
a suite that leaks cannot detect a leak: the filesystem's own allocations would
arrive as noise inside the harness's. The next one fails the run instead.
make schfs-check now exits 0. The 31 UBSAN misalignment reports are still
there and are still a Gate 0 item.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VQ7Qx8E1q1M1bbCq8QLHS2
|
||
| .. | ||
| architecture | ||
| guides | ||
| history | ||
| plan | ||
| licensing.md | ||
| README.md | ||
SchOS documentation
Four kinds of document, kept in four directories, because they answer four different questions and go stale at four different rates.
| architecture/ | What SchOS is | Present tense. Describes what is built and working. |
| plan/ | What SchOS will be | Future tense. Everything here is unbuilt. |
| guides/ | How to work on it | Imperative. Build it, test it, add to it. |
| history/ | Why it is the way it is | Past tense. Bugs whose cause is not visible from the fix. |
Plus one rule that belongs to no category and applies to everything: licensing.md — read it before copying anyone else's code in.
The rule that keeps this from rotting
When something is finished, it moves from
plan/toarchitecture/and is rewritten as a description of the thing rather than a record of building it.
A completed item is not a ticked checkbox. A ticked checkbox says the work happened; it does not say what the work produced, and six months later the checkbox is the only thing left and it explains nothing.
So finishing a piece of work has three steps, and the third is not optional:
- The code works and is tested.
- The plan entry is deleted.
- A description exists in
architecture/written for somebody who was not there — what it does, what shape it has, what it costs, and what it still does not do.
This is not bookkeeping. The tree has already proved it necessary: the network stack was finished, verified end to end, and for a month afterwards the only description of it anywhere was a checkbox in a roadmap, four levels of indentation deep, written in the past tense of somebody arguing for the work rather than explaining the result.
The "what it does not do" section is the one that pays. Every description in
architecture/ ends with one. A document that only lists a subsystem's
strengths is marketing, and the reader who most needs the document is the one
about to trip over a limitation nobody wrote down.
Start here
New to the tree → architecture/README.md, the system layer by layer, then guides/layout.md for where the files are.
Trying to build it → guides/building.md.
Wondering what happens next → plan/1.0.md, which is the finish line, then plan/README.md for the order.
Something is broken and it feels familiar → history/. There is a good chance it is in there.
architecture/ — what SchOS is
| README | The system, layer by layer. Read first. |
| boot.md | Firmware to the first userspace process. |
| kernel.md | SchIFT: memory, processes, scheduling, traps, signals, SMP. |
| syscalls.md | The call table, and the Linux personality that lets real software run. |
| filesystem.md | The VFS, the buffer cache, procfs, mounts. |
| schfs.md | SchFS: the copy-on-write root filesystem. |
| devices.md | The device model, driver binding, the class vtables. |
| usb.md | xHCI, the USB core, and the class drivers. |
| graphics.md | Framebuffer, text rendering, console, and the crash screen. |
| networking.md | Drivers, lwIP, sockets — Unix and INET. |
| init.md | schinit, PID 1, and the job manifests. |
plan/ — what SchOS will be
| README | The three current decisions and the order they happen in. |
| 1.0.md | The finish line. What 1.0 contains, and what is explicitly deferred past it. |
| foundations.md | The kernel work everything else is blocked on. |
| init.md | PID 1 becomes a role rather than a process. |
| wayland.md | The GUI stack, and what gets deleted to make room. |
| hybrid.md | Moving drivers out of the kernel. |
| schapi.md | The long-term API layering, and the compatibility promise. |
| roadmap.md | Everything else still open. |
guides/ — how to work on it
| building.md | Prerequisites and the build, per host. |
| testing.md | The harnesses, and what each one actually proves. |
| layout.md | Repository map, and how to add a program or a port. |
| adding-a-driver.md | Writing one, binding it, publishing its class vtable. |
history/ — why it is the way it is
| README | What belongs in here and what does not. |
| kernel.md | Bugs whose cause was nowhere near their symptom. |
| moving-to-linux.md | The Windows-to-Fedora move, kept for the parts that recur. |
Writing one of these
Four conventions, all of them observable in the existing files:
State the cost. Every design choice gave something up. A document that does not say what is a document that will be argued with later by somebody who only sees the downside.
Prefer the measured number to the remembered one. "500 of 3565 files carry the advertising clause" is worth more than "some do", and it was worth the minute it took to count.
Write down the bug that shaped it. Half the non-obvious code in this tree is non-obvious because something failed once. If a design is strange, the strangeness is load-bearing and the reader deserves to know why before changing it.
No dates in headings. A date in a heading turns a description into a
changelog, and the description is the thing with a long life. Dates belong in
history/, where they mean something.