- 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 |
|---|---|---|
docs/plan/ldls.md milestone L2, less the half that needs /dev/pci.
In Linux, __pci_register_driver ends at the PCI core, which matches a
driver's id_table against the bus and calls probe(). There is no PCI core
here, so LDLS keeps the pointer that call was given and plays the part.
To do that it must know where pci_driver.probe is, and it asks the kernel
rather than being told by us. ldls/btf.c reads /sys/kernel/btf/vmlinux --
122,279 types, every struct layout and every function prototype, as generated
data describing the kernel that is installed. Implemented from
Documentation/bpf/btf.rst, which is a published specification.
$ ldls-types /sys/kernel/btf/vmlinux --need
pci_driver probe offset 16 size 8
pci_dev resource offset 1000 size 1088
resource start offset 0 size 8
all present
Cross-checked against pahole on the same file, field for field. No offset in
this is ours, which is rule 3's uncomfortable row disappearing rather than
being argued about.
And then the driver:
driver name "8139too"
devices it claims: 10ec:8139 ... and 16 more
calling probe(pci_dev 10ec:8139, ...)
1 alloc_etherdev_mqs(0x368, 1, 1)
2 pci_enable_device / 3 pci_request_regions / 4 pci_set_master
5 pci_iomap(pdev, 1, 0)
6..544 ioread8 / iowrite8 -- 0x88, 0x8a, 0x8c, 0x8e, over and over
545 dev_addr_mod / 547 netif_napi_add_weight_locked
549 timer_init_key / 550 register_netdev / 551 netdev_info
probe returned 0 after 552 stub call(s)
10ec:8139 is the real RTL8139 id. It mapped BAR 1, the one marked
IORESOURCE_MEM. Those 538 alternating byte accesses stepping 0x88/0x8a/0x8c/
0x8e are serial EEPROM clocking -- the driver bit-banging the chip for its MAC
address and handing the result to dev_addr_mod. Then NAPI, a watchdog timer,
register_netdev, its "found it" line, and zero.
Fifteen distinct symbols carry that entire probe, and three of them are 540 of
the 552 calls. L1 said 44 symbols carry 110 modules through init; L2 says 15
carry this one through probe. Neither is a number anyone would have guessed
and both came from running the thing.
Recorded as not done, because it is not: probe receives a pci_dev whose shape
is right and whose contents are invented. The BARs are made up, pci_iomap
returns a zeroed page, and 8139too read a MAC address of zeroes and was
perfectly happy about it. The "all through /dev/pci" half of L2 belongs to the
SchOS side. Also recorded: BTF has to come from somewhere, and SchOS has no
/sys/kernel/btf/vmlinux -- the user brings it with the module, from the kernel
the module was built for.
make ldls-check is 27 checks, four of them L2's, and it says so out loud when
it skips them on a machine with no BTF rather than passing silently.
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 | ||
| ldls | ||
| 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.