| Filename | Latest commit message | Latest commit date |
|---|---|---|
3fd1cc5279
docs/plan/ldls.md milestone L3b. ldls/ko.c, btf.c and stub.c were written
freestanding so they would build unchanged on both sides; cmd/ldlsd collects
that promise -- the same three files, linked against lib/ instead of a libc,
in an ordinary SchOS process.
# ldlsd /lib/modules/8139too.ko /lib/modules/btf
module 8139too license GPL wants 94 symbols
defused 6 %gs stack-guard reference(s)
calling init_module
1 _printk(...)
| 8139too: 8139too Fast Ethernet driver 0.9.28
2 __pci_register_driver(...)
btf 122279 types
layout pci_driver.probe +16 pci_dev 2680 bytes
driver "8139too" devices it claims: 10ec:8139 ... and 18 more
calling probe
1 alloc_etherdev_mqs(0x368, 0x1)
probe returned -12 after 1 stub call(s)
Byte for byte the host harness's behaviour, which is what the shared source
was for. Two earlier predictions came good with no work: a process's mmap area
starts at 0x40000000, inside the window R_X86_64_32S needs, and the kernel
never sets EFER.NXE so every mapping is executable. The second is a gap rather
than a feature and is now recorded as one -- LDLS is relying on the absence of
a protection an OS should have.
One thing did not just work. The first run faulted before probe's first call,
err 5 -- present, read, user -- at a kernel address, with the rip resolving to
mov %gs:0x0(%rip),%rax # rtl8139_init_one+0x26
Modules are built -mstack-protector-guard-reg=gs, so the canary comes through
the GS segment, and that is an ABI between the kernel and its own per-CPU area
which a host that is not that kernel cannot provide. ko_defuse_gs() rewrites
those references to xor %reg,%reg.
There are two forms and the second is easy to miss: the prologue loads the
guard with mov (8b) and the epilogue compares it with sub (2b) before a jne to
__stack_chk_fail. xor is right for both -- it zeroes the saved canary and sets
ZF, so the epilogue's branch falls through exactly as a passing check does. Six
sites in 8139too.
It checks every site before patching any and refuses the whole operation on
anything it does not recognise. That refusal is what found the sub form, by
declining to guess -- a loader that half-understands an instruction should not
be editing it.
make ldls-stage/ldls-unstage put a module and its kernel's BTF into the local
sysroot and take them out again. Not part of `all`, and .gitignore refuses
*.ko, so an image only carries somebody else's GPL code between two commands
you typed on purpose.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VQ7Qx8E1q1M1bbCq8QLHS2
|
||
| .. | ||
| architecture | ||
| branding | ||
| guides | ||
| history | ||
| plan | ||
| Website | ||
| 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 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/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 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 logo, Guru the icon, SchCotie the mascot: what each is for, the colour rule, 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.