SchOS/docs
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Nexoniarz e72205cdc0 panic: the crash screen reaches every display, not just the console's
"it also doesn't show crash screen on virtio gpu or just other gpu than default
vga" -- true, and on the virtio-gpu it was worse than nothing. The head kept
showing the console from a second before the panic: one screen saying the
kernel is dead, the other showing a shell prompt.

panic() painted into the console framebuffer and stopped there. Two cases were
missing, and they are not the same problem.

**The kernel still drives it.** display_acquire() hands back a buffer; the
report is copied in and presented. Ordinary, and a no-op when the display
class's buffer *is* the console's, so a one-screen machine does not do the work
twice.

**A process drives it.** The hard one, and the one hybrid.md owed an answer
for. The kernel let go of the device deliberately, and the process holding it
will never run again -- there is no scheduling after a panic -- so there is
nobody left to ask. It is not a race that can be won by being careful.

So the userspace driver says where it is scanning out *in advance*:
PCIIOC_PANICFB, registered by vgpud after bring-up and after every modeset. On
a panic the kernel paints the report into that memory and asks the kernel
driver the device was taken from to put it on screen one last time --
`panic_present` in struct pci_driver, which virtio-gpu implements by resetting
the device out from under a driver that is still nominally running. That is
safe here and nowhere else, because nothing is going to run again.

The panic path allocates nothing. It cannot: a corrupted heap is one of the
ways a machine gets here, and an allocator that deadlocks takes the crash
screen *and* the serial log's last chance to be read. So the driver keeps its
BAR mappings across the handover, rebuilds one queue from 20 KB of static
memory, and bounds every spin -- including the reset acknowledge, which is an
unbounded `while` in probe() and correct there.

**The registration is checked like the promise it is.** The range must lie
inside a block that process got from PCIIOC_DMA on that device. Without that,
a claimed device would be a way to nominate any physical address in the machine
-- page tables, kernel text -- to be overwritten with four megabytes of crash
report at the one moment nothing is left to notice. That is a worse bug than
the one this fixes. It goes away with the claim and with the process.

What it buys is worth stating plainly: a device can be evicted to userspace
without the kernel losing its ability to tell you the machine died. The
alternative was a driver boundary that is also a blind spot.

Verified both ways under QEMU with two heads, `echo c > /proc/sysrq`, and a
screendump of each over QMP:

  vgpud holding the device   both heads byte-identical, serial says
                             "The report is on the virtio-gpu display too."
  kernel holding it          same, via display_acquire/display_present
                             (/proc/pci shows 1af4:1050 [virtio-gpu])

Both supported configurations: one boot each, no traps, no panics, socktest and
memfdtest green.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-22 16:53:16 +02:00
..
architecture panic: the crash screen reaches every display, not just the console's 2026-09-22 16:53:16 +02:00
branding smp: a verbose boot triple-faulted, and vgpud drew a test card 2026-09-22 10:50:53 +02:00
guides docs: the tree moved and the documentation did not 2026-09-13 20:05:06 +02:00
history zsh: two more cache answers that claimed capabilities SchOS lacks 2026-09-22 00:36:48 +02:00
plan panic: the crash screen reaches every display, not just the console's 2026-09-22 16:53:16 +02:00
Website branding: one mark, and PSOGM draws it 2026-09-21 21:35:58 +02:00
licensing.md userland: 268 applets, an editor, names that resolve, and a web server 2026-09-14 19:24:55 +02:00
README.md branding: one mark, and PSOGM draws it 2026-09-21 21:35:58 +02:00

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 two that belong to no category and apply to everything: licensing.md — read it before copying anyone else's code in — and branding/, which holds the marks and the rules for using them.


The rule that keeps this from rotting

When something is finished, it moves from plan/ to architecture/ 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:

  1. The code works and is tested.
  2. The plan entry is deleted.
  3. 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 and the register of everything half-built. Then plan/README.md for the order.

About to start something new → the register, first. Nothing new starts while it has rows in it, and a row leaves only by being finished or deleted.

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.
terminals.md The six virtual terminals, and how one is switched to.
networking.md Drivers, lwIP, sockets — Unix and INET.
init.md schinit, PID 1 as a role, 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, and the freeze. What 1.0 contains, what is deferred, and the register of every half-built thing in the tree.
foundations.md The kernel work everything else is blocked on.
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.

branding/ — the marks

README Shift, the one mark: what it is for, the colour rule, why an icon and a mascot were removed, and why a raster is committed next to its SVG.

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.
schfs.md The filesystem's own, from the same period as its design.
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.