writeonce/docs/plan/exploration/c-runtime/01-architecture.md
shoney.arickathil c0b0dbb846 docs: audit all markdown against the code, fix findings, flatten status folders
- README: shipped concurrency/HTTP/WebSockets sat in the roadmap as "not yet
  available"; "no package manager" contradicted [deps]; the deps example
  would not have compiled (the key IS the module name)
- runtime/README: leads with wovm, wo-rt.c demoted to a historical section;
  dropped 2 nonexistent recipes, crates/rt, @gc refcounting, 13 suites -> 18
- employee + log-watcher READMEs claimed "does not compile"; both are gates
- error catalog: +10 emitted codes incl WO-E250, the only diagnostic the
  shipped query surface raises; recorded why the sweep rotted
- language-surface: group-by parses, then the typechecker refuses it
- 00-code-review + 00-link-audit re-run; history kept, not rewritten
- 48 dead Rust-era exploration links de-linked rather than re-pointed (their
  prose names the retired plan by number); successor map -> discarded.md
- 08-project-structure: compiler/plan/ never existed; corpus has 9 dirs, 5 empty
- releasing.md: dropped a --draft step the workflow never had
- new docs/00-doc-audit.md: findings + disposition, incl one row where the
  audit was wrong and the doc it accused was right
- status folders removed: 34 stories flat, status only in frontmatter; 252
  links recomputed from resolved paths; board/board-views/structure retaught
- story 24 -> in-progress, since frontmatter is now the only truth
- new iteration 38: fs mutation verbs + net.connect, the two capability
  families no iteration owned
- new iteration 39: gofiber/fiber v3.5.0 parity study. The ledger called
  CSRF/sessions unblocked by iteration 34's HMAC, but the runtime has no
  source of randomness at all
- linkcheck skips .dev/.superpowers: 0 broken paths, 0 bad anchors

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-26 19:20:22 +02:00

9.3 KiB
Raw Permalink Blame History

wo-rt-c architecture — one memory address, two spaces, a million connections

This document defines the runtime's architecture by following one memory address through user space, kernel space, and hardware, under a million connections reading and writing it concurrently — then suggests improvements. Companion docs: 00-plan.md (the phases that build this), README.md (phase-0 module map).

The cast: one address

The database is one mmap arena. After the 4 KB header page, shard 0's first row slot sits at:

row  =  arena + 4096          →  virtual address  0x7f3a2c001000   (say)

Three facts define everything that follows:

  1. User space sees a virtual address. 0x7f3a2c001000 is an entry in this process's page tables; the kernel resolved it to one physical RAM frame at fault time (MAP_POPULATE faults it in at boot, before any request).
  2. The kernel pins the frame. mlock guarantees the physical page is never swapped — a load from this address is always a RAM access, never disk I/O in disguise.
  3. Exactly one thread owns writes to it. The address lies inside shard 0's slice; thread 0 is the only code in the process that may store to it (00-plan.md decision 2). Data exists once — ownership, not copying, is the concurrency model.

The two spaces

User space and kernel space touch the same physical pages in exactly two places — the arena (data) and the io_uring rings (control). Everything else crosses by syscall.

flowchart TB
    subgraph US["USER SPACE  (N pinned threads, shared-nothing)"]
        T0["thread 0<br/>event loop"]
        ARENA["mmap arena<br/><b>0x7f3a2c001000</b> = shard-0 slot 0<br/>(mlock'd, MAP_POPULATE)"]
        SQ["io_uring SQ/CQ rings<br/>(mmap'd — shared with kernel)"]
        CB["per-connection buffers"]
        T0 -->|"MOV — plain load/store,<br/>no syscall"| ARENA
        T0 -->|"write SQE / read CQE<br/>no syscall"| SQ
        T0 --- CB
    end
    subgraph KS["KERNEL SPACE"]
        PT["page tables + TLB<br/>VA→PA for 0x7f3a2c001000"]
        URING["io_uring engine"]
        SKB["socket buffers (1M sockets,<br/>SO_REUSEPORT spread over N listeners)"]
        PC["page cache + block layer<br/>(WAL file shard-0.wal)"]
    end
    subgraph HW["HARDWARE"]
        RAM["RAM frame<br/>(the one physical copy)"]
        NIC["NIC"]
        SSD["SSD"]
    end
    SQ <-->|"io_uring_enter — ONE syscall<br/>per loop tick, batched"| URING
    URING --> SKB
    URING --> PC
    ARENA -.->|"page tables map it"| PT
    PT -.-> RAM
    SKB <--> NIC
    PC <--> SSD

The arrows worth staring at: the thread's access to the database (MOV) and to the I/O queues (ring writes) cross no boundary. The only recurring syscall is one batched io_uring_enter per loop tick.

Write path — the address changes

One of the million connections POSTs a new value. Dual-write order per 00-plan.md decision 6: RAM first, then the hard drive, ack only after the disk confirms.

sequenceDiagram
    participant NIC as NIC (hw)
    participant K as kernel
    participant T0 as thread 0 (user)
    participant ROW as 0x7f3a2c001000 (RAM)
    participant SSD as SSD (hw)
    NIC->>K: packets → socket buffer
    K->>T0: recv CQE (ring memory, no syscall)
    T0->>T0: parse request, check invariants  [C of ACID]
    T0->>ROW: MOV — store new row bytes  [RAM applied]
    T0->>K: write SQE: WAL record len|crc32|payload|COMMIT
    K->>SSD: page cache → block layer
    T0->>K: one fdatasync SQE for ALL commits this tick  [group commit]
    SSD-->>K: flush done
    K-->>T0: fsync CQE
    T0->>K: send SQE — HTTP 201 ack  [D of ACID: ack after fsync]
    K->>NIC: response bytes out

Boundary crossings per commit: amortized to one io_uring_enter shared by every commit in the tick — the store to the address itself costs zero. Atomicity lives in the WAL framing (a torn record fails CRC and is dropped whole on replay); isolation is thread 0's serial execution; durability is the ack ordering.

Read path — the address is observed

GET /api/notes/0  →  thread 0 formats JSON straight from 0x7f3a2c001000
                  →  send SQE  →  socket buffer  →  NIC

The database read is a memory load. No file descriptor, no syscall, no kernel involvement until the response leaves. This is what "the whole database resides in RAM" buys: the kernel is in the room for networking and durability, not for reads.

A million connections against this one address

  • The kernel's SO_REUSEPORT hash spreads ~1M sockets across N listeners → each thread owns ~1M/N connections outright (accepts never migrate).
  • Memory ceiling: ~8 KB user-space state per connection (conns[] buffer) + kernel sk_buffs → 1M connections ≈ 8 GB user + kernel-tunable socket memory. RLIMIT_NOFILE must be raised at boot (00-plan.md phase F).
  • Writes: every write to the address funnels to thread 0 and serializes — that is the ACID isolation story, and group commit keeps the WAL from becoming a per-write fsync storm.
  • Reads — the honest bottleneck: today a connection that hashed to thread 3 cannot serve the address; only shard 0's thread may touch it. One hot row = one core's worth of read throughput (~the per-core ceiling), while the other N−1 cores idle on that row. The improvements below exist for exactly this.

Suggested improvements

Ordered by how cleanly each fits the locked doctrine (thread-per-core, no locks on the data path, no duplication, libc only).

1. Per-slot seqlock — every core may read the one address

The single highest-leverage change. Give each slot a version counter; the owning thread (still the only writer) increments it before and after the store (odd = mid-write). Any thread on any core may then read the address directly:

do { v1 = atomic_load_acquire(&slot->ver);          /* spin only while odd */
     memcpy(local, slot->bytes, len);
     v2 = atomic_load_acquire(&slot->ver);
} while (v1 != v2 || (v1 & 1));

A hot row becomes readable by all N cores with zero duplication — same physical frame, same address — and writes stay serial, so ACID isolation is untouched. Cost: two atomic increments per write, a retry loop per read (C11 atomics, no library). Doctrine note: this relaxes "only the owner touches the slice" to "only the owner writes the slice"; contrast with plan 13e's hot-row read replicas, which solve the same bottleneck by copying rows per thread — seqlock is the no-duplication answer the replica design isn't.

2. Registered buffers and files (IORING_REGISTER_BUFFERS / _FILES)

The arena and connection buffers are already mlock-pinned; registering them lets the kernel skip per-operation page lookup/refcounting, and WAL fds skip the fd-table walk. Pure win, no doctrine impact.

3. Zero-copy send (IORING_OP_SEND_ZC)

Responses currently copy user → socket buffer. Zero-copy send transmits straight from user memory — strongest when combined with improvement 5, where the hot row's bytes are already response-shaped.

4. SQPOLL (IORING_SETUP_SQPOLL)

A kernel-side poller consumes the SQ ring; steady state needs zero syscalls — even the per-tick io_uring_enter disappears. This is precisely the "the only non-userland thread is the kernel-owned io_uring SQPOLL helper" end state already written into the project's concurrency model (CLAUDE.md). Cost: one kernel thread per ring burning a core fraction; enable per-deployment.

5. Serialized-row cache beside the slot

Store the rendered JSON next to the row bytes, invalidated by the same seqlock version bump. A hot read becomes memcpy from the address — no formatting per request. Trades arena bytes for CPU; measurable in phase F before adopting.

6. NUMA-aware arena placement (set_mempolicy / mbind)

On multi-socket boxes, bind each shard slice's pages to the owning core's NUMA node — the address is always a local-node load (~80 ns vs ~140 ns remote). No-op on single-socket dev machines; matters at the 16-core scale-out target.

7. Multishot recv + huge pages

IORING_RECV_MULTISHOT arms one SQE per connection instead of one per request — at 1M connections that is the difference between 1M and ~0 re-arm submissions per tick. MAP_HUGETLB (already phase B) cuts TLB pressure: a 16 GB arena is 8.4M × 4 KB entries but only 8K × 2 MB entries.

Deliberately not suggested

Work stealing (breaks single-writer ACID), shared-heap locking (the doctrine exists to avoid it — and at 1M readers a mutex on the row would serialize everything the seqlock parallelizes), liburing (the prototype's value is the raw syscall sequence), and multi-node distribution (plan 09's single-box stance). See plan 09 § Non-scope.

Cross-references

  • 00-plan.md — phases A–F that build the architecture described here; improvements 1–7 slot into phases C/F or follow them.
  • ../../docs/plan/09-concurrency-scaleout.md — the thread-per-core doctrine.
  • ../../docs/plan/exploration/linux/07-io_uring.md, 08-mmap.md — the two shared-page mechanisms.
  • ../../docs/plan/13-class-model-live-pricing.md — 13e's read-replica alternative, contrasted in improvement 1.
  • README.md — the C/assembly "one address" pedagogy the single-binary story extends to a full runtime.