Compare commits
13
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a53c2b0193 | ||
|
|
bf481c080c | ||
|
|
3a78dcab3f | ||
|
|
470f93a83d | ||
|
|
7798706b41 | ||
|
|
ad40de03c2 | ||
|
|
d8778b4b70 | ||
|
|
79d859a111 | ||
|
|
37fb09f75e | ||
|
|
34ebeb968d | ||
|
|
3cc1d38dd0 | ||
|
|
36e804b848 | ||
|
|
be83a42d42 |
@@ -212,6 +212,13 @@ pub fn build(b: *std.Build) void {
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// The device-manager protocol: hello + (M18.2) tree reports, exposed as its
|
||||||
|
// own module like the other protocol modules. Imported through the runtime.
|
||||||
|
const device_manager_protocol_module = b.addModule("device-manager-protocol", .{
|
||||||
|
.root_source_file = b.path("system/services/device-manager/device-manager-protocol.zig"),
|
||||||
|
});
|
||||||
|
runtime_module.addImport("device-manager-protocol", device_manager_protocol_module);
|
||||||
|
|
||||||
// Typed volatile MMIO register access + memory-ordering barriers, for drivers on
|
// Typed volatile MMIO register access + memory-ordering barriers, for drivers on
|
||||||
// top of an mmio_map grant. Depends only on `builtin` (arch-conditional barriers);
|
// top of an mmio_map grant. Depends only on `builtin` (arch-conditional barriers);
|
||||||
// no target set, so it inherits each driver's. See library/mmio/mmio.zig.
|
// no target set, so it inherits each driver's. See library/mmio/mmio.zig.
|
||||||
@@ -332,6 +339,24 @@ pub fn build(b: *std.Build) void {
|
|||||||
const ps2_keyboard_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "ps2-keyboard", "system/drivers/ps2-bus/keyboard.zig");
|
const ps2_keyboard_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "ps2-keyboard", "system/drivers/ps2-bus/keyboard.zig");
|
||||||
const ps2_mouse_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "ps2-mouse", "system/drivers/ps2-bus/mouse.zig");
|
const ps2_mouse_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "ps2-mouse", "system/drivers/ps2-bus/mouse.zig");
|
||||||
const usb_xhci_bus_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "usb-xhci-bus", "system/drivers/usb-xhci-bus/usb-xhci-bus.zig");
|
const usb_xhci_bus_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "usb-xhci-bus", "system/drivers/usb-xhci-bus/usb-xhci-bus.zig");
|
||||||
|
// A test fixture, not a real driver: hellos to the device manager, then faults —
|
||||||
|
// what the driver-restart scenario drives the crash-loop cap with.
|
||||||
|
const crash_test_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "crash-test", "system/services/crash-test/crash-test.zig");
|
||||||
|
const device_list_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "device-list", "system/services/device-list/device-list.zig");
|
||||||
|
// The discovery service: one swappable process per firmware
|
||||||
|
// (docs/m19-m20-plan.md decision 7), bundled under the neutral ramdisk name
|
||||||
|
// "discovery" so the device manager never learns which firmware it is on.
|
||||||
|
// x86 boots describe hardware with ACPI; the Raspberry Pis hand over a
|
||||||
|
// flattened device tree — the aarch64 target flips the default when it
|
||||||
|
// lands (docs/arm.md). Both are placeholders until M20.1 (acpi) and the
|
||||||
|
// ARM bring-up (fdt).
|
||||||
|
const Discovery = enum { acpi, fdt };
|
||||||
|
const discovery = b.option(Discovery, "discovery", "Which discovery service fills the ramdisk's 'discovery' slot (default: acpi)") orelse Discovery.acpi;
|
||||||
|
const discovery_source: []const u8 = switch (discovery) {
|
||||||
|
.acpi => "system/services/acpi/acpi.zig",
|
||||||
|
.fdt => "system/services/fdt/fdt.zig",
|
||||||
|
};
|
||||||
|
const discovery_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "discovery", discovery_source);
|
||||||
const device_manager_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "device-manager", "system/services/device-manager/device-manager.zig");
|
const device_manager_exe = addUserBinary(b, kernel_target, runtime_module, posix_module, mmio_module, xkeyboard_config_module, acpi_ids_module, "device-manager", "system/services/device-manager/device-manager.zig");
|
||||||
// The input service and its exercisers: the fan-out server, a hardware-free synthetic
|
// The input service and its exercisers: the fan-out server, a hardware-free synthetic
|
||||||
// source, and a subscriber that doubles as the `input` test's oracle. See docs/input.md.
|
// source, and a subscriber that doubles as the `input` test's oracle. See docs/input.md.
|
||||||
@@ -363,6 +388,12 @@ pub fn build(b: *std.Build) void {
|
|||||||
mk_run.addFileArg(ps2_mouse_exe.getEmittedBin());
|
mk_run.addFileArg(ps2_mouse_exe.getEmittedBin());
|
||||||
mk_run.addArg("usb-xhci-bus");
|
mk_run.addArg("usb-xhci-bus");
|
||||||
mk_run.addFileArg(usb_xhci_bus_exe.getEmittedBin());
|
mk_run.addFileArg(usb_xhci_bus_exe.getEmittedBin());
|
||||||
|
mk_run.addArg("crash-test");
|
||||||
|
mk_run.addFileArg(crash_test_exe.getEmittedBin());
|
||||||
|
mk_run.addArg("device-list");
|
||||||
|
mk_run.addFileArg(device_list_exe.getEmittedBin());
|
||||||
|
mk_run.addArg("discovery");
|
||||||
|
mk_run.addFileArg(discovery_exe.getEmittedBin());
|
||||||
mk_run.addArg("device-manager");
|
mk_run.addArg("device-manager");
|
||||||
mk_run.addFileArg(device_manager_exe.getEmittedBin());
|
mk_run.addFileArg(device_manager_exe.getEmittedBin());
|
||||||
mk_run.addArg("input");
|
mk_run.addArg("input");
|
||||||
|
|||||||
+11
-1
@@ -1,6 +1,16 @@
|
|||||||
# The device manager
|
# The device manager
|
||||||
|
|
||||||
**Status: design.** The primitives this builds on are real ([process-management.md](process-management.md):
|
**Status: the protocol and supervision are built** (M18.1, 2026-07-13): `hello`
|
||||||
|
with its deadline, supervised spawn, restart with backoff, and the crash-loop
|
||||||
|
cap are in — usb-xhci-bus is the first conforming driver, and the
|
||||||
|
`driver-restart` scenario proves fault → backoff → re-claim → cap end to end.
|
||||||
|
Tree reports are built too (M18.2, 2026-07-13): the xHCI driver scans its
|
||||||
|
root-hub ports and reports each connected device (`child_added`); the manager
|
||||||
|
mirrors them and prunes a dead reporter's children, and the `usb-report`
|
||||||
|
scenario proves report → prune → respawn → re-report. The application surface is built (M18.3, 2026-07-13):
|
||||||
|
`enumerate` and `subscribe` over IPC, with `device-list` as the first client —
|
||||||
|
the manager is now the one answer to "what devices exist" for applications.
|
||||||
|
The primitives underneath are real ([process-management.md](process-management.md):
|
||||||
spawn/supervise/kill/exit-notification; [driver-model.md](driver-model.md): the device
|
spawn/supervise/kill/exit-notification; [driver-model.md](driver-model.md): the device
|
||||||
table as a capability system; [drivers.md](drivers.md): claim/map/IRQ), and the first
|
table as a capability system; [drivers.md](drivers.md): claim/map/IRQ), and the first
|
||||||
per-device driver spawn works (the device manager matches the xHCI controller by PCI
|
per-device driver spawn works (the device manager matches the xHCI controller by PCI
|
||||||
|
|||||||
+21
-6
@@ -44,12 +44,27 @@ only when its definition of green holds.
|
|||||||
on the tick; bindSignals/signalsFrom/sendSignal/stop + timerOnce;
|
on the tick; bindSignals/signalsFrom/sendSignal/stop + timerOnce;
|
||||||
runtime.service.run with the zero-length ping; VFS converted; `signals`
|
runtime.service.run with the zero-length ping; VFS converted; `signals`
|
||||||
scenario; suite 51/51)
|
scenario; suite 51/51)
|
||||||
- [ ] **merge** `feat/process-lifecycle` → main, push
|
- [x] **merge** `feat/process-lifecycle` → main, push (merged 2026-07-13)
|
||||||
- [ ] **M18.1** — device-manager protocol: hello + restart policy (branch `feat/device-manager`)
|
- [x] **M18.1** — device-manager protocol: hello + restart policy
|
||||||
- [ ] **merge** `feat/device-manager` → main, push
|
(device-manager-protocol module; the manager as a harness service:
|
||||||
- [ ] **M18.2** — xHCI port scan + tree reports (branch `feat/usb-xhci-bus`)
|
supervised spawns, hello deadline via timer sweep, restart with
|
||||||
- [ ] **M18.3** — app surface: enumerate/subscribe + device-list
|
300/600/1200ms backoff, exit reasons deciding restart-vs-stopped,
|
||||||
- [ ] **merge** `feat/usb-xhci-bus` → main, push — **loop ends here**
|
crash-loop cap; usb-xhci-bus first conforming driver; crash-test fixture
|
||||||
|
re-proving claim release each respawn; `driver-restart` scenario;
|
||||||
|
maximum_tasks 16→32 — the sweep was overflowing the pool; suite 52/52)
|
||||||
|
- [x] **merge** `feat/device-manager` → main, push (merged 2026-07-13)
|
||||||
|
- [x] **M18.2** — xHCI port scan + tree reports (child_added/child_removed in
|
||||||
|
the protocol; the manager's child mirror with death-pruning; xHCI maps the
|
||||||
|
register BAR — resource 0 is ECAM — reads CAPLENGTH/HCSPARAMS1, scans
|
||||||
|
PORTSC, reports connected ports with speed-class identity; `usb-report`
|
||||||
|
scenario proves report → prune → respawn → re-report; suite 53/53)
|
||||||
|
- [x] **M18.3** — app surface: enumerate/subscribe over IPC (subscriber
|
||||||
|
endpoint rides as the call's capability; events are the same structs the
|
||||||
|
buses send); device-list first client; protocol capped at the kernel's
|
||||||
|
IPC MESSAGE_MAXIMUM (256); the startUserTask debug print removed — it
|
||||||
|
sheared concurrent serial lines and was the scenario-flake root cause;
|
||||||
|
`device-list` scenario; suite 54/54)
|
||||||
|
- [x] **merge** `feat/usb-xhci-bus` → main, push (merged 2026-07-13) — **plan complete**
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,187 @@
|
|||||||
|
# M19–M20 execution plan: discovery migration
|
||||||
|
|
||||||
|
The operational plan for [device-manager.md](device-manager.md)'s increment 8:
|
||||||
|
discovery leaves the kernel — a **pci-bus driver** (M19) and an **acpi service**
|
||||||
|
(M20), with the kernel's device enumeration retired behind them. Same rules as
|
||||||
|
[m17-m18-plan.md](m17-m18-plan.md): one phase at a time, each green before the
|
||||||
|
next; this file is the build order and the checklist.
|
||||||
|
|
||||||
|
**Definition of green, every phase:** `zig build` clean, `zig build test` clean,
|
||||||
|
`python3 test/qemu_test.py` passes (existing scenarios plus the phase's new
|
||||||
|
one), and the relevant design doc updated. Commit per green phase (no co-author
|
||||||
|
trailers). The full suite is the regression net — the existing
|
||||||
|
`driver-restart` / `usb-report` / `device-list` / `input` scenarios must stay
|
||||||
|
green *through* the migration, which is the whole point: the system must not be
|
||||||
|
able to tell who enumerated it.
|
||||||
|
|
||||||
|
**Workflow:** dedicated worktree; branches off `main` — `feat/pci-bus`
|
||||||
|
(M19.0–19.3), `feat/acpi-service` (M20.1–20.3); auto-merge to main when a
|
||||||
|
branch is green; keep branches; push everything.
|
||||||
|
|
||||||
|
## Settled decisions (2026-07-13 — veto before the loop starts)
|
||||||
|
|
||||||
|
1. **What "retiring the kernel scan" means.** The kernel keeps, forever, the
|
||||||
|
parses it needs before user space exists: RSDP/XSDT location, MADT (SMP),
|
||||||
|
the HPET table (the tick), FADT + the AML `\_S5` evaluation (poweroff — the
|
||||||
|
power tests prove it), and MCFG (the host bridge node). What retires is
|
||||||
|
**device enumeration**: the ECAM function walk (M19.3) and the DSDT/SSDT
|
||||||
|
namespace walk that builds device nodes (M20.3). The AML module stays a
|
||||||
|
shared build module compiled into both the kernel (for `\_S5`) and the acpi
|
||||||
|
service (for everything else) — same source, two builds, no fork.
|
||||||
|
2. **Bridge apertures come from the firmware memory map, not AML.** Registered
|
||||||
|
PCI functions carry BAR resources, and containment demands the bridge own
|
||||||
|
windows that cover them. The apertures are derived kernel-side from the
|
||||||
|
boot memory map's MMIO holes (regions that are neither RAM nor tables) —
|
||||||
|
mechanical, AML-free, and available at boot regardless of what later moved
|
||||||
|
to user space. (The bridge today carries only ECAM + bus range; this is the
|
||||||
|
prerequisite M19.0 exists for.)
|
||||||
|
3. **`device_register` becomes idempotent on exact match.** A re-registration
|
||||||
|
with identical (parent, class, resources) returns the existing id instead
|
||||||
|
of appending. The kernel table has no unregister, so without this a
|
||||||
|
restarted registering bus would duplicate its children on every respawn —
|
||||||
|
idempotence makes restart-and-re-report safe for every future bus, not just
|
||||||
|
PCI.
|
||||||
|
4. **The manager matches from reports.** `ChildAdded` gains a `device_id`
|
||||||
|
field (the kernel-registered id, `no_device` for unregistered leaves like
|
||||||
|
USB ports). After the M19.3 flip, PCI driver matching keys off reported
|
||||||
|
identity (the class triple) instead of the manager's boot-time snapshot —
|
||||||
|
the snapshot match remains only for what the kernel still seeds. One flip
|
||||||
|
phase changes both sides at once so no device is ever matched twice.
|
||||||
|
5. **The acpi service's authority is one node.** The kernel publishes an
|
||||||
|
`acpi-tables` device: memory resources covering the table blobs plus a
|
||||||
|
broad `io_port` resource — the documented trust grant to exactly one
|
||||||
|
process (AML OperationRegions reach EC/PM ports; the claim-gated
|
||||||
|
io_read/io_write calls already exist). The service claims it, maps the
|
||||||
|
tables, and runs the shared AML module in ring 3 behind a `Hal` backed by
|
||||||
|
`mmio_map` + `io_read`/`io_write`.
|
||||||
|
6. **Both new processes are protocol drivers** under the manager: hello,
|
||||||
|
supervision, restart with backoff — all inherited from M18.1 for free.
|
||||||
|
Registration idempotence (decision 3) is what makes their restarts sound.
|
||||||
|
7. **Firmware neutrality is the contract** (2026-07-13). The generic layer is
|
||||||
|
everything at and above the device-manager protocol — descriptors,
|
||||||
|
containment, reports, matching, supervision — and none of it may become
|
||||||
|
x86-specific. Discovery is one swappable process per firmware: the acpi
|
||||||
|
service on x86; an **fdt service** on the Raspberry Pis (claims a
|
||||||
|
`devicetree-blob` node, reports children from the flattened device tree —
|
||||||
|
pure data, no bytecode, no port grant, strictly simpler than ACPI). The
|
||||||
|
manager owns the tree as *data* and touches no hardware, ever — AML runs in
|
||||||
|
a crashable, supervised discoverer precisely so a firmware-bytecode fault
|
||||||
|
can never take down the supervisor. Two consequences recorded now:
|
||||||
|
`DeviceDescriptor`'s 8-byte `hid` cannot hold an FDT `compatible` string
|
||||||
|
("brcm,bcm2835-aux-uart") — identity widens before the fdt service exists;
|
||||||
|
and cross-firmware surfaces are named by **domain, not firmware** (M21
|
||||||
|
defines a *power* protocol, not an "ACPI events" protocol — PSCI/mailbox
|
||||||
|
sources feed the same subscribers on ARM). **Landed early (2026-07-13):**
|
||||||
|
both services exist as placeholders (system/services/acpi, system/services/
|
||||||
|
fdt) and the build's `-Ddiscovery=acpi|fdt` option fills the ramdisk's
|
||||||
|
neutral `discovery` slot — the manager will spawn "discovery" by that name
|
||||||
|
in M20.3 and never learn which firmware it is on.
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
- [ ] **M19.0** — prerequisites on `feat/pci-bus`: bridge MMIO apertures from
|
||||||
|
the memory-map holes; `device_register` idempotence (+ kernel unit
|
||||||
|
checks); `ChildAdded.device_id`; archive note on m17-m18-plan.md.
|
||||||
|
- [ ] **M19.1** — pci-bus driver, scan only: claim the host bridge, map the
|
||||||
|
ECAM window, walk bus/device/function headers, log what it finds.
|
||||||
|
Scenario `pci-scan`: the kernel test compares the driver's reported count
|
||||||
|
against the broker table's `pci_device` count — equivalence, per class.
|
||||||
|
- [ ] **M19.2** — register + report: each function registered under the bridge
|
||||||
|
(config-space slice + BARs, `pci_class` in the descriptor), reported with
|
||||||
|
`child_added { device_id, identity = class triple }`. Manager mirrors;
|
||||||
|
spawn-from-reports stays **off**. Scenario extends `pci-scan`:
|
||||||
|
registered ids resolve, no duplicates after a forced driver restart
|
||||||
|
(idempotence proven end to end).
|
||||||
|
- [ ] **M19.3** — the flip: kernel `enumeratePci` call removed (bridge node
|
||||||
|
stays); manager matches PCI drivers from reports. One commit. The
|
||||||
|
existing xHCI scenarios (`driver-restart`, `usb-report`, `device-list`)
|
||||||
|
are the assertion — xhci must come up spawned off a pci-bus report, and
|
||||||
|
the suite must not be able to tell the difference. discovery.md updated.
|
||||||
|
- [ ] **merge** `feat/pci-bus` → main, push.
|
||||||
|
- [ ] **M20.1** — acpi service, parse only (fills the existing placeholder at
|
||||||
|
system/services/acpi/acpi.zig): kernel publishes `acpi-tables`
|
||||||
|
(decision 5) — memory over the table blobs, the broad io_port grant, and
|
||||||
|
**the SCI as an irq resource** (from the FADT; unused until M21 but free
|
||||||
|
to record now). The service claims it, maps the blobs, runs the shared
|
||||||
|
AML module in ring 3, logs the namespace device count and `_HID`s.
|
||||||
|
Scenario `acpi-parse`: user-space count equals the kernel walk's count.
|
||||||
|
- [ ] **M20.2** — register + report: namespace devices with `_HID` + `_CRS`
|
||||||
|
resources registered under `acpi-tables` (its io_port + the memory-map
|
||||||
|
holes give containment), reported to the manager. Spawn-from-reports for
|
||||||
|
ACPI matches stays off. Scenario: the reported set includes the PS/2
|
||||||
|
keyboard and mouse nodes with their IRQ resources.
|
||||||
|
- [ ] **M20.3** — the flip: kernel DSDT device-node building removed (static
|
||||||
|
tables + `\_S5` stay, decision 1); manager matches ACPI-hid drivers
|
||||||
|
(ps2-bus) from reports. The `input` and `device-manager` scenarios are
|
||||||
|
the assertion. discovery.md + acpi.md + device-manager.md updated;
|
||||||
|
device-manager.md increment 8 closed.
|
||||||
|
- [ ] **merge** `feat/acpi-service` → main, push — **loop ends here**.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase notes
|
||||||
|
|
||||||
|
**M19.0 apertures:** the boot memory map already crosses the handoff
|
||||||
|
([boot-handoff]); the holes computation belongs where the bridge node is built
|
||||||
|
(`parseMcfg`). Sanity-check on QEMU q35: the xHCI BAR (`0xc0000000`-region
|
||||||
|
values seen in the M18 logs) must land inside a derived aperture, asserted in
|
||||||
|
the kernel unit test.
|
||||||
|
|
||||||
|
**M19.1 scanning without owning config access twice:** the driver reads config
|
||||||
|
space through its ECAM mmio_map grant of the *bridge* window — the same bytes
|
||||||
|
the kernel walk read. Vendor-id `0xFFFF` skip, header-type multifunction rule,
|
||||||
|
no bridge recursion (matches the kernel's current single-segment walk).
|
||||||
|
|
||||||
|
**M19.2 BAR sizing:** the classic size probe (write all-ones, read mask,
|
||||||
|
restore) is deferred — the BARs' current programmed values and types are
|
||||||
|
enough for containment-checked registration at bring-up; sizing lands with the
|
||||||
|
first driver that needs to *move* a BAR. Log what is registered so the
|
||||||
|
scenario can assert it.
|
||||||
|
|
||||||
|
**M19.3 what the manager still seeds from the snapshot:** everything the
|
||||||
|
kernel still enumerates (timers, ACPI nodes until M20.3). The PCI arm of
|
||||||
|
`pciDriverFor` switches source; `driverFor` doesn't move until M20.3.
|
||||||
|
|
||||||
|
**M20.1 Hal in ring 3:** `mapMmio` → `device.mmioMap` over the claimed
|
||||||
|
acpi-tables node (plus a table-offset map for blobs); `pioRead`/`pioWrite` →
|
||||||
|
`device.ioRead`/`ioWrite` against its io_port resource. The interpreter cannot
|
||||||
|
tell it moved — that is the assertion of `acpi-parse`.
|
||||||
|
|
||||||
|
**M20.2 containment for `_CRS`:** io ports fall inside the node's broad
|
||||||
|
io_port resource; MMIO windows (HPET, LAPIC ranges some firmwares list) fall
|
||||||
|
inside the memory-map holes added to the node in M20.1. Anything that doesn't
|
||||||
|
fit is logged and skipped, loudly — bring-up honesty over silent drops.
|
||||||
|
|
||||||
|
**M20.3 ps2 ordering:** ps2-bus binds nodes the acpi service now reports, so
|
||||||
|
its spawn moves behind the report (the manager's matching handles this once
|
||||||
|
the source flips); the `input` scenario proves the keyboard still types.
|
||||||
|
|
||||||
|
**Explicitly out of scope:** PCI bridge recursion (single segment, flat bus
|
||||||
|
walk stays); BAR reprogramming/sizing; disk/PCIe hotplug; interrupt routing
|
||||||
|
changes (`_PRT` stays wherever it is today); the USB descriptor track;
|
||||||
|
multi-segment ECAM; per-device power states (D-states, `_PSx`/`_PRx`,
|
||||||
|
suspend/resume — a future *lifecycle-vocabulary* extension, since "suspend"
|
||||||
|
has the shape of a signal every driver must answer, and it has no consumer
|
||||||
|
until laptop sleep); CPU P/C-states.
|
||||||
|
|
||||||
|
## M21 preview — ACPI events + system power (planned next, not in this loop)
|
||||||
|
|
||||||
|
The acpi service grows the event side (settled direction 2026-07-13; detailed
|
||||||
|
phases when M20 lands):
|
||||||
|
|
||||||
|
- **21.1 SCI + fixed events**: irq_bind the SCI (the resource M20.1 already
|
||||||
|
records), read/clear PM1 status, publish the power-button event to
|
||||||
|
subscribers (the same pub/sub shape the manager uses).
|
||||||
|
- **21.2 GPE + Notify**: Notify dispatch in the shared AML interpreter, GPE
|
||||||
|
block handling, `Notify(device, code)` published per reported node. The
|
||||||
|
acpi service is a **bus** here: battery (PNP0C0A), AC (ACPI0003), and lid
|
||||||
|
(PNP0C0D) nodes are reported children; small class drivers bind them and
|
||||||
|
speak an evaluate/subscribe protocol to the service — the xHCI split,
|
||||||
|
repeated. The embedded controller (`_Qxx` queries) rides this phase;
|
||||||
|
QEMU emulates no battery/EC, so those paths are interface-complete and
|
||||||
|
validated on real hardware (the laptop is the win condition), while the
|
||||||
|
plumbing is proven by the power button.
|
||||||
|
- **21.3 the capstone**: QEMU `system_powerdown` → acpi service event → init
|
||||||
|
runs the M17 stop sequence over its children → kernel `\_S5` — orderly
|
||||||
|
shutdown as the scenario that proves lifecycle + events compose. (The
|
||||||
|
harness grows a QMP poke to inject the event.)
|
||||||
@@ -17,6 +17,9 @@ pub const ipc = @import("ipc.zig");
|
|||||||
pub const start = @import("start.zig");
|
pub const start = @import("start.zig");
|
||||||
/// The VFS wire protocol (shared with the VFS server).
|
/// The VFS wire protocol (shared with the VFS server).
|
||||||
pub const vfs_protocol = @import("vfs-protocol");
|
pub const vfs_protocol = @import("vfs-protocol");
|
||||||
|
|
||||||
|
/// The device-manager protocol: hello + tree reports (docs/device-manager.md).
|
||||||
|
pub const device_manager_protocol = @import("device-manager-protocol");
|
||||||
/// Keyboard-event listening (subscribe/next) and broadcasting (publish), over the input
|
/// Keyboard-event listening (subscribe/next) and broadcasting (publish), over the input
|
||||||
/// service. See library/runtime/input.zig and system/services/input/.
|
/// service. See library/runtime/input.zig and system/services/input/.
|
||||||
pub const input = @import("input.zig");
|
pub const input = @import("input.zig");
|
||||||
|
|||||||
@@ -22,8 +22,10 @@ pub const Callbacks = struct {
|
|||||||
/// Return false to abort startup (the process exits).
|
/// Return false to abort startup (the process exits).
|
||||||
init: ?*const fn (endpoint: ipc.Handle) bool = null,
|
init: ?*const fn (endpoint: ipc.Handle) bool = null,
|
||||||
/// One protocol request from `sender` (a task id): write the reply into
|
/// One protocol request from `sender` (a task id): write the reply into
|
||||||
/// `reply`, return its length. The zero-length ping never reaches this.
|
/// `reply`, return its length. `capability` is the handle the request
|
||||||
on_message: *const fn (message: []const u8, reply: []u8, sender: u32) usize,
|
/// carried, if any (M13 cap passing — how a subscriber hands over its
|
||||||
|
/// endpoint). The zero-length ping never reaches this.
|
||||||
|
on_message: *const fn (message: []const u8, reply: []u8, sender: u32, capability: ?ipc.Handle) usize,
|
||||||
/// A notification that is not a signal — a subscribed exit event, a bound
|
/// A notification that is not a signal — a subscribed exit event, a bound
|
||||||
/// IRQ, a timer landing. The raw badge; decode with the ipc helpers.
|
/// IRQ, a timer landing. The raw badge; decode with the ipc helpers.
|
||||||
on_notification: ?*const fn (badge: u64) void = null,
|
on_notification: ?*const fn (badge: u64) void = null,
|
||||||
@@ -76,6 +78,6 @@ pub fn run(comptime maximum_message: usize, callbacks: Callbacks) void {
|
|||||||
reply_len = 0; // the universal ping: a zero-length reply, from the harness
|
reply_len = 0; // the universal ping: a zero-length reply, from the harness
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
reply_len = callbacks.on_message(receive[0..got.len], &reply_buffer, got.senderTaskId());
|
reply_len = callbacks.on_message(receive[0..got.len], &reply_buffer, got.senderTaskId(), got.cap);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -176,6 +176,7 @@ pub const ServiceId = enum(u32) {
|
|||||||
vfs = 1,
|
vfs = 1,
|
||||||
input = 2,
|
input = 2,
|
||||||
ps2_bus = 3, // the 8042 owner; child device drivers attach here for raw bytes
|
ps2_bus = 3, // the 8042 owner; child device drivers attach here for raw bytes
|
||||||
|
device_manager = 4, // the tree, the matcher, the supervisor (docs/device-manager.md)
|
||||||
_,
|
_,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -1,68 +1,172 @@
|
|||||||
//! /system/drivers/usb-xhci-bus — the xHCI (USB 3) host-controller bus driver.
|
//! /system/drivers/usb-xhci-bus — the xHCI (USB 3) host-controller bus driver.
|
||||||
//! The device manager spawns **one instance per controller** it discovers (a machine
|
//! The device manager spawns **one instance per controller** it discovers (a
|
||||||
//! can carry several), passing the controller's device-tree id as argv[1]; this
|
//! machine can carry several), passing the controller's device-tree id as
|
||||||
//! instance claims that device and no other, so multiple instances never fight over
|
//! argv[1]; this instance claims that device and no other, so multiple
|
||||||
//! hardware. This increment proves the plumbing: parse the id, claim the controller,
|
//! instances never fight over hardware.
|
||||||
//! and report its MMIO window. The next increments map the registers and bring the
|
//!
|
||||||
//! controller up (reset, rings, port scan), then enumerate the USB devices on the
|
//! M18.2 (this increment): after the hello, real hardware — map the xHC's
|
||||||
//! bus with the usb-abi request builders and publish each with `device_register`.
|
//! register window (the first memory BAR; resource 0 is the ECAM config
|
||||||
|
//! space), read the capability registers, and walk the root-hub ports: one
|
||||||
|
//! `child_added` report to the manager per connected port, carrying the port
|
||||||
|
//! number and the PORTSC speed class as identity. No transfer rings yet —
|
||||||
|
//! descriptors and USB class matching are the USB track; the connect bit and
|
||||||
|
//! speed come straight from PORTSC, which reflects hardware state whether or
|
||||||
|
//! not the controller is running.
|
||||||
|
|
||||||
const std = @import("std");
|
const std = @import("std");
|
||||||
const runtime = @import("runtime");
|
const runtime = @import("runtime");
|
||||||
|
const protocol = runtime.device_manager_protocol;
|
||||||
const device = runtime.device;
|
const device = runtime.device;
|
||||||
|
|
||||||
/// Format one whole log line and emit it in a single `debug_write`, so concurrent
|
/// Format one whole log line and emit it in a single `debug_write`, so
|
||||||
/// instances (one per controller) can never interleave mid-line.
|
/// concurrent instances (one per controller) can never interleave mid-line.
|
||||||
fn writeLine(comptime fmt: []const u8, arguments: anytype) void {
|
fn writeLine(comptime fmt: []const u8, arguments: anytype) void {
|
||||||
var line: [128]u8 = undefined;
|
var line: [128]u8 = undefined;
|
||||||
_ = runtime.system.write(std.fmt.bufPrint(&line, fmt, arguments) catch return);
|
_ = runtime.system.write(std.fmt.bufPrint(&line, fmt, arguments) catch return);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var controller_id: u64 = protocol.no_device;
|
||||||
|
|
||||||
|
/// Claim the assigned controller, find its register window, and hello the
|
||||||
|
/// manager. Any failure returns false: the process exits cleanly, which the
|
||||||
|
/// manager reads as "meant to stop" — a missing assignment is not a crash loop.
|
||||||
|
fn initialise(endpoint: runtime.ipc.Handle) bool {
|
||||||
|
_ = endpoint;
|
||||||
|
if (!device.claim(controller_id)) {
|
||||||
|
writeLine("usb-xhci-bus: unable to claim controller device {d}\n", .{controller_id});
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fetch our own descriptor back for the controller's resources.
|
||||||
|
const buffer = runtime.allocator().alloc(device.DeviceDescriptor, 64) catch {
|
||||||
|
_ = runtime.system.write("usb-xhci-bus: out of memory\n");
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
const total = device.enumerate(buffer);
|
||||||
|
const descriptor = for (buffer[0..@min(total, buffer.len)]) |d| {
|
||||||
|
if (d.id == controller_id) break d;
|
||||||
|
} else {
|
||||||
|
writeLine("usb-xhci-bus: device {d} not in the device tree\n", .{controller_id});
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
|
||||||
|
// The xHC's registers live behind the first memory BAR. Resource 0 is the
|
||||||
|
// function's ECAM configuration space (M15), so the walk starts at 1.
|
||||||
|
var register_index: u64 = 0;
|
||||||
|
const register_window = for (descriptor.resources[1..@intCast(descriptor.resource_count)], 1..) |resource, index| {
|
||||||
|
if (resource.kind == @intFromEnum(device.ResourceKind.memory)) {
|
||||||
|
register_index = index;
|
||||||
|
break resource;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
writeLine("usb-xhci-bus: controller device {d} has no register BAR\n", .{controller_id});
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
writeLine("usb-xhci-bus: claimed controller device {d} (registers at 0x{x}, {d} bytes)\n", .{
|
||||||
|
controller_id,
|
||||||
|
register_window.start,
|
||||||
|
register_window.len,
|
||||||
|
});
|
||||||
|
register_base = device.mmioMap(controller_id, register_index) orelse {
|
||||||
|
_ = runtime.system.write("usb-xhci-bus: mmio_map failed\n");
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
|
||||||
|
// The handshake: role, protocol version, assignment — inside the manager's
|
||||||
|
// deadline (the lookup retries cover the manager still registering).
|
||||||
|
var manager: ?runtime.ipc.Handle = null;
|
||||||
|
var tries: u32 = 0;
|
||||||
|
while (manager == null and tries < 100) : (tries += 1) {
|
||||||
|
manager = runtime.ipc.lookup(.device_manager);
|
||||||
|
if (manager == null) runtime.system.sleep(20);
|
||||||
|
}
|
||||||
|
const h = manager orelse {
|
||||||
|
_ = runtime.system.write("usb-xhci-bus: no device manager to hello\n");
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
const hello = protocol.Hello{ .role = @intFromEnum(protocol.Role.bus), .device_id = controller_id };
|
||||||
|
var reply: [protocol.message_maximum]u8 = undefined;
|
||||||
|
const n = runtime.ipc.call(h, std.mem.asBytes(&hello), &reply) catch {
|
||||||
|
_ = runtime.system.write("usb-xhci-bus: hello call failed\n");
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
if (n < protocol.reply_size or std.mem.bytesToValue(protocol.HelloReply, reply[0..protocol.reply_size]).status != 0) {
|
||||||
|
_ = runtime.system.write("usb-xhci-bus: hello refused\n");
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
_ = runtime.system.write("usb-xhci-bus: hello acknowledged\n");
|
||||||
|
|
||||||
|
scanPorts(h);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
var register_base: usize = 0;
|
||||||
|
|
||||||
|
/// One 32-bit volatile register read at `offset` from the mapped window.
|
||||||
|
fn readRegister(offset: usize) u32 {
|
||||||
|
const register: *volatile u32 = @ptrFromInt(register_base + offset);
|
||||||
|
return register.*;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The root-hub port scan: read the capability registers for the port count
|
||||||
|
/// and the operational-register offset, then one PORTSC per port. The connect
|
||||||
|
/// bit (CCS) and the speed field reflect hardware state directly — no
|
||||||
|
/// controller reset or run needed to *see* the devices; driving them needs the
|
||||||
|
/// rings (the USB track).
|
||||||
|
fn scanPorts(manager: runtime.ipc.Handle) void {
|
||||||
|
// Capability registers: CAPLENGTH is byte 0 of the first dword; HCSPARAMS1
|
||||||
|
// carries MaxPorts in bits 31:24.
|
||||||
|
const capability_length = readRegister(0) & 0xFF;
|
||||||
|
const structural = readRegister(0x04);
|
||||||
|
const maximum_ports: u32 = structural >> 24;
|
||||||
|
writeLine("usb-xhci-bus: {d} root-hub ports\n", .{maximum_ports});
|
||||||
|
|
||||||
|
// PORTSC registers: operational base + 0x400 + 0x10 per port (1-based).
|
||||||
|
var port: u32 = 1;
|
||||||
|
var connected: u32 = 0;
|
||||||
|
while (port <= maximum_ports) : (port += 1) {
|
||||||
|
const port_status = readRegister(capability_length + 0x400 + 0x10 * (port - 1));
|
||||||
|
if (port_status & 1 == 0) continue; // CCS: nothing connected
|
||||||
|
connected += 1;
|
||||||
|
const speed = (port_status >> 10) & 0xF; // the PORTSC port-speed class
|
||||||
|
writeLine("usb-xhci-bus: port {d} connected (speed class {d})\n", .{ port, speed });
|
||||||
|
|
||||||
|
const report = protocol.ChildAdded{
|
||||||
|
.parent = controller_id,
|
||||||
|
.bus_address = port,
|
||||||
|
.identity = speed,
|
||||||
|
};
|
||||||
|
var reply: [protocol.message_maximum]u8 = undefined;
|
||||||
|
_ = runtime.ipc.call(manager, std.mem.asBytes(&report), &reply) catch {
|
||||||
|
writeLine("usb-xhci-bus: child report for port {d} failed\n", .{port});
|
||||||
|
continue;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (connected == 0) _ = runtime.system.write("usb-xhci-bus: no devices connected\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
/// No bus protocol to serve yet — transfer requests arrive with the USB track.
|
||||||
|
fn onMessage(message: []const u8, reply: []u8, sender: u32, capability: ?runtime.ipc.Handle) usize {
|
||||||
|
_ = message;
|
||||||
|
_ = reply;
|
||||||
|
_ = sender;
|
||||||
|
_ = capability;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
pub fn main(init: runtime.process.Init) void {
|
pub fn main(init: runtime.process.Init) void {
|
||||||
const argument = init.arguments.get(1) orelse {
|
const argument = init.arguments.get(1) orelse {
|
||||||
_ = runtime.system.write("usb-xhci-bus: missing controller device id (argv[1])\n");
|
_ = runtime.system.write("usb-xhci-bus: missing controller device id (argv[1])\n");
|
||||||
return;
|
return;
|
||||||
};
|
};
|
||||||
const controller_id = std.fmt.parseInt(u64, argument, 10) catch {
|
controller_id = std.fmt.parseInt(u64, argument, 10) catch {
|
||||||
writeLine("usb-xhci-bus: malformed controller device id '{s}'\n", .{argument});
|
writeLine("usb-xhci-bus: malformed controller device id '{s}'\n", .{argument});
|
||||||
return;
|
return;
|
||||||
};
|
};
|
||||||
|
runtime.service.run(protocol.message_maximum, .{
|
||||||
if (!device.claim(controller_id)) {
|
.init = initialise,
|
||||||
writeLine("usb-xhci-bus: unable to claim controller device {d}\n", .{controller_id});
|
.on_message = onMessage,
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fetch our own descriptor back for the controller's resources.
|
|
||||||
const buffer = runtime.allocator().alloc(device.DeviceDescriptor, 64) catch {
|
|
||||||
_ = runtime.system.write("usb-xhci-bus: out of memory\n");
|
|
||||||
return;
|
|
||||||
};
|
|
||||||
const total = device.enumerate(buffer);
|
|
||||||
const descriptor = for (buffer[0..@min(total, buffer.len)]) |d| {
|
|
||||||
if (d.id == controller_id) break d;
|
|
||||||
} else {
|
|
||||||
writeLine("usb-xhci-bus: device {d} not in the device tree\n", .{controller_id});
|
|
||||||
return;
|
|
||||||
};
|
|
||||||
|
|
||||||
// The controller's operational registers live behind BAR0, enumerated as the
|
|
||||||
// device's first memory resource.
|
|
||||||
const register_window = for (descriptor.resources[0..@intCast(descriptor.resource_count)]) |resource| {
|
|
||||||
if (resource.kind == @intFromEnum(device.ResourceKind.memory)) break resource;
|
|
||||||
} else {
|
|
||||||
writeLine("usb-xhci-bus: controller device {d} has no MMIO window\n", .{controller_id});
|
|
||||||
return;
|
|
||||||
};
|
|
||||||
writeLine("usb-xhci-bus: claimed controller device {d} (registers at 0x{x}, {d} bytes)\n", .{
|
|
||||||
controller_id,
|
|
||||||
register_window.start,
|
|
||||||
register_window.len,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
// Controller bring-up (map the window, reset, rings, port scan) is the next
|
|
||||||
// increment; stay resident as the bus's supervisor in the meantime.
|
|
||||||
while (true) runtime.system.sleep(1000);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub const panic = runtime.panic;
|
pub const panic = runtime.panic;
|
||||||
|
|||||||
@@ -350,8 +350,9 @@ pub fn spawnUserLocked(aspace: u64, entry: u64, user_sp: u64, priority: Priority
|
|||||||
/// context switch and lock release.
|
/// context switch and lock release.
|
||||||
fn startUserTask() void {
|
fn startUserTask() void {
|
||||||
const t = current();
|
const t = current();
|
||||||
var buffer: [96]u8 = undefined;
|
// No serial chatter here: this runs on every spawn, unserialized against
|
||||||
architecture.serialWrite(std.fmt.bufPrint(&buffer, "DBG startUserTask ip=0x{x} sp=0x{x} aspace=0x{x} kstack=0x{x}\n", .{ t.user_ip, t.user_sp, t.aspace, t.kstack_top }) catch "");
|
// user-space writes, and its output used to shear concurrent log lines in
|
||||||
|
// half — the largest source of corrupted markers in the QEMU scenarios.
|
||||||
architecture.jumpToUser(t.user_ip, t.user_sp); // noreturn
|
architecture.jumpToUser(t.user_ip, t.user_sp); // noreturn
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -138,6 +138,12 @@ pub fn run(case: []const u8, boot_information: *const BootInformation) void {
|
|||||||
vfsClientDeathTest(boot_information);
|
vfsClientDeathTest(boot_information);
|
||||||
} else if (eql(case, "signals")) {
|
} else if (eql(case, "signals")) {
|
||||||
signalsTest(boot_information);
|
signalsTest(boot_information);
|
||||||
|
} else if (eql(case, "driver-restart")) {
|
||||||
|
driverRestartTest(boot_information);
|
||||||
|
} else if (eql(case, "usb-report")) {
|
||||||
|
usbReportTest(boot_information);
|
||||||
|
} else if (eql(case, "device-list")) {
|
||||||
|
deviceListTest(boot_information);
|
||||||
} else if (eql(case, "initial-ramdisk")) {
|
} else if (eql(case, "initial-ramdisk")) {
|
||||||
initialRamdiskTest(boot_information);
|
initialRamdiskTest(boot_information);
|
||||||
} else if (eql(case, "vfs")) {
|
} else if (eql(case, "vfs")) {
|
||||||
@@ -1654,6 +1660,111 @@ fn signalsTest(boot_information: *const BootInformation) void {
|
|||||||
result();
|
result();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// M18.1: the device manager's restart machinery, end to end. In test-restart
|
||||||
|
/// mode the manager also supervises crash-test: a fixture that claims device 0,
|
||||||
|
/// hellos, and faults. The scenario asserts three markers in order — the real
|
||||||
|
/// xHCI driver hellos clean and stays; crash-test is restarted with backoff
|
||||||
|
/// (each respawn re-claiming the device the dead instance held, M17.1 through
|
||||||
|
/// the manager's path); the crash loop caps and the manager gives up.
|
||||||
|
fn driverRestartTest(boot_information: *const BootInformation) void {
|
||||||
|
log("DANOS-TEST-BEGIN: driver-restart\n", .{});
|
||||||
|
if (boot_information.initial_ramdisk_len == 0) {
|
||||||
|
check("bootloader handed over an initial_ramdisk", false);
|
||||||
|
result();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const image = @as([*]const u8, @ptrFromInt(boot_handoff.physicalToVirtual(boot_information.initial_ramdisk_base)))[0..boot_information.initial_ramdisk_len];
|
||||||
|
const rd = initial_ramdisk.Reader.init(image) orelse {
|
||||||
|
check("initial_ramdisk image is valid", false);
|
||||||
|
result();
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
process.setInitialRamdisk(image); // the manager system_spawns drivers by name
|
||||||
|
process.write_count = 0;
|
||||||
|
var manager: u32 = 0;
|
||||||
|
var i: u32 = 0;
|
||||||
|
while (i < rd.count) : (i += 1) {
|
||||||
|
const item = rd.entry(i) orelse continue;
|
||||||
|
if (!eql(item.name, "device-manager")) continue;
|
||||||
|
manager = process.spawnProcessSupervised(item.blob, 4, &.{ "device-manager", "test-restart" }, scheduler.currentId(), null) catch 0;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
check("device-manager spawned in test-restart mode", manager != 0);
|
||||||
|
// The assertions live in the harness: its expect regex requires, in order,
|
||||||
|
// the xHCI hello ack, a crash-test restart, and the crash-loop cap — read
|
||||||
|
// from the whole serial capture, immune to the transient-line races a
|
||||||
|
// write_buffer poll would have here (many processes log concurrently).
|
||||||
|
result();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// M18.2: bus tree reports, end to end. The manager (test-usb-restart mode)
|
||||||
|
/// spawns the xHCI driver; the driver maps its BAR, scans the root-hub ports,
|
||||||
|
/// and reports the two QEMU devices; the manager mirrors them, kills the
|
||||||
|
/// reporter (the test trigger), prunes both children, restarts the driver with
|
||||||
|
/// backoff, and the respawned instance re-claims, re-scans, and re-reports.
|
||||||
|
/// The harness's ordered expect regex is the assertion; this test only
|
||||||
|
/// orchestrates the spawn.
|
||||||
|
fn usbReportTest(boot_information: *const BootInformation) void {
|
||||||
|
log("DANOS-TEST-BEGIN: usb-report\n", .{});
|
||||||
|
if (boot_information.initial_ramdisk_len == 0) {
|
||||||
|
check("bootloader handed over an initial_ramdisk", false);
|
||||||
|
result();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const image = @as([*]const u8, @ptrFromInt(boot_handoff.physicalToVirtual(boot_information.initial_ramdisk_base)))[0..boot_information.initial_ramdisk_len];
|
||||||
|
const rd = initial_ramdisk.Reader.init(image) orelse {
|
||||||
|
check("initial_ramdisk image is valid", false);
|
||||||
|
result();
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
process.setInitialRamdisk(image);
|
||||||
|
var manager: u32 = 0;
|
||||||
|
var i: u32 = 0;
|
||||||
|
while (i < rd.count) : (i += 1) {
|
||||||
|
const item = rd.entry(i) orelse continue;
|
||||||
|
if (!eql(item.name, "device-manager")) continue;
|
||||||
|
manager = process.spawnProcessSupervised(item.blob, 4, &.{ "device-manager", "test-usb-restart" }, scheduler.currentId(), null) catch 0;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
check("device-manager spawned in test-usb-restart mode", manager != 0);
|
||||||
|
result();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// M18.3: the application surface. device-list enumerates the manager's tree
|
||||||
|
/// over IPC, subscribes with its endpoint as a capability, and prints every
|
||||||
|
/// published event; the manager's delayed test-kill of the reporter produces a
|
||||||
|
/// removed/added storm the subscriber must observe. The harness's ordered
|
||||||
|
/// expect regex is the assertion.
|
||||||
|
fn deviceListTest(boot_information: *const BootInformation) void {
|
||||||
|
log("DANOS-TEST-BEGIN: device-list\n", .{});
|
||||||
|
if (boot_information.initial_ramdisk_len == 0) {
|
||||||
|
check("bootloader handed over an initial_ramdisk", false);
|
||||||
|
result();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const image = @as([*]const u8, @ptrFromInt(boot_handoff.physicalToVirtual(boot_information.initial_ramdisk_base)))[0..boot_information.initial_ramdisk_len];
|
||||||
|
const rd = initial_ramdisk.Reader.init(image) orelse {
|
||||||
|
check("initial_ramdisk image is valid", false);
|
||||||
|
result();
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
process.setInitialRamdisk(image);
|
||||||
|
var manager: u32 = 0;
|
||||||
|
var i: u32 = 0;
|
||||||
|
while (i < rd.count) : (i += 1) {
|
||||||
|
const item = rd.entry(i) orelse continue;
|
||||||
|
if (!eql(item.name, "device-manager")) continue;
|
||||||
|
manager = process.spawnProcessSupervised(item.blob, 4, &.{ "device-manager", "test-usb-restart" }, scheduler.currentId(), null) catch 0;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
check("device-manager spawned in test-usb-restart mode", manager != 0);
|
||||||
|
check("device-list spawned", spawnNamed(rd, "device-list"));
|
||||||
|
result();
|
||||||
|
}
|
||||||
|
|
||||||
/// The whole user-side surface at once: spawn process-test's supervisor role,
|
/// The whole user-side surface at once: spawn process-test's supervisor role,
|
||||||
/// which — entirely from ring 3 — creates an exit endpoint, spawns its two
|
/// which — entirely from ring 3 — creates an exit endpoint, spawns its two
|
||||||
/// children supervised, sees them in process_enumerate, kills them (one blocked,
|
/// children supervised, sees them in process_enumerate, kills them (one blocked,
|
||||||
|
|||||||
@@ -16,8 +16,11 @@
|
|||||||
pub const maximum_cpus = 128;
|
pub const maximum_cpus = 128;
|
||||||
|
|
||||||
/// Maximum tasks (kernel threads) alive at once — the static task-table size. Each
|
/// Maximum tasks (kernel threads) alive at once — the static task-table size. Each
|
||||||
/// online core consumes one slot for its idle task, plus task 0 on the BSP.
|
/// online core consumes one slot for its idle task, plus task 0 on the BSP. Sized
|
||||||
pub const maximum_tasks = 16;
|
/// for the initial-ramdisk sweep (15 bundled binaries spawned at once) plus the
|
||||||
|
/// device manager's supervised children with room to grow — at 16 the sweep
|
||||||
|
/// started failing spawns once the bundle passed a dozen binaries.
|
||||||
|
pub const maximum_tasks = 32;
|
||||||
|
|
||||||
/// Each task's kernel stack (also each AP's bring-up stack), in bytes.
|
/// Each task's kernel stack (also each AP's bring-up stack), in bytes.
|
||||||
pub const kernel_stack_size = 16 * 1024;
|
pub const kernel_stack_size = 16 * 1024;
|
||||||
|
|||||||
@@ -0,0 +1,30 @@
|
|||||||
|
//! /system/services/acpi — the ACPI discovery service: the x86 firmware
|
||||||
|
//! interpreter, moved out of ring 0 (docs/m19-m20-plan.md, M20). **Placeholder:
|
||||||
|
//! not implemented until M20.1** — it exists so the build's `-Ddiscovery`
|
||||||
|
//! option has both of its values and the ramdisk's neutral `discovery` slot is
|
||||||
|
//! wired before the implementation lands.
|
||||||
|
//!
|
||||||
|
//! What it becomes (the plan's decisions 5 and 7): claim the `acpi-tables`
|
||||||
|
//! node the kernel publishes (table blobs + the broad io_port grant + the SCI),
|
||||||
|
//! map the tables, and run the **shared AML module** in ring 3 behind a `Hal`
|
||||||
|
//! backed by `mmio_map` and `io_read`/`io_write` — the interpreter cannot tell
|
||||||
|
//! it moved. Then the bus-driver shape: `device_register` the namespace
|
||||||
|
//! devices (`_HID`, `_CRS` resources, containment against the node's
|
||||||
|
//! apertures), report each to the device manager, stay resident under its
|
||||||
|
//! supervision. M21 grows the event side on the same claim: the SCI, PM1 fixed
|
||||||
|
//! events, GPEs, Notify — published through the domain-named power protocol,
|
||||||
|
//! never an "ACPI events" protocol.
|
||||||
|
|
||||||
|
const runtime = @import("runtime");
|
||||||
|
|
||||||
|
pub fn main() void {
|
||||||
|
// Not implemented: exit cleanly and silently (a bare spawn by the
|
||||||
|
// initial-ramdisk sweep must not derange other tests' markers). The
|
||||||
|
// supervisor reads a clean exit as "meant to stop" — correct for a
|
||||||
|
// placeholder.
|
||||||
|
}
|
||||||
|
|
||||||
|
pub const panic = runtime.panic;
|
||||||
|
comptime {
|
||||||
|
_ = &runtime.start._start; // pull the runtime entry shim into the image
|
||||||
|
}
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
//! crash-test — a test fixture, not a driver: claims the device it is assigned,
|
||||||
|
//! hellos the device manager, announces itself, then faults on purpose. The
|
||||||
|
//! driver-restart scenario drives the manager's whole restart machinery with
|
||||||
|
//! it: fault → exit reason → backoff → respawn → the **same claim succeeding
|
||||||
|
//! again** (claim release on death, M17.1, through the manager's path) → the
|
||||||
|
//! crash-loop cap. Spawned bare (the initial-ramdisk sweep starts every bundled
|
||||||
|
//! binary), it exits silently so it cannot derange other tests.
|
||||||
|
|
||||||
|
const std = @import("std");
|
||||||
|
const runtime = @import("runtime");
|
||||||
|
const protocol = runtime.device_manager_protocol;
|
||||||
|
|
||||||
|
pub fn main(init: runtime.process.Init) void {
|
||||||
|
const argument = init.arguments.get(1) orelse return; // bare: stay silent
|
||||||
|
const assigned = std.fmt.parseInt(u64, argument, 10) catch return;
|
||||||
|
|
||||||
|
// The respawn only reaches this line because the kernel released the
|
||||||
|
// previous instance's claim at death. A failed claim exits cleanly — the
|
||||||
|
// manager reads "meant to stop" and the scenario fails loudly by silence.
|
||||||
|
if (!runtime.device.claim(assigned)) {
|
||||||
|
_ = runtime.system.write("crash-test: claim failed\n");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var manager: ?runtime.ipc.Handle = null;
|
||||||
|
var tries: u32 = 0;
|
||||||
|
while (manager == null and tries < 100) : (tries += 1) {
|
||||||
|
manager = runtime.ipc.lookup(.device_manager);
|
||||||
|
if (manager == null) runtime.system.sleep(20);
|
||||||
|
}
|
||||||
|
const h = manager orelse return;
|
||||||
|
const hello = protocol.Hello{ .role = @intFromEnum(protocol.Role.device), .device_id = assigned };
|
||||||
|
var reply: [protocol.message_maximum]u8 = undefined;
|
||||||
|
_ = runtime.ipc.call(h, std.mem.asBytes(&hello), &reply) catch return;
|
||||||
|
|
||||||
|
_ = runtime.system.write("crash-test: faulting now\n");
|
||||||
|
const poison: *volatile u32 = @ptrFromInt(0xdead0000);
|
||||||
|
poison.* = 1; // the restart machinery's fuel: a real segmentation fault
|
||||||
|
}
|
||||||
|
|
||||||
|
pub const panic = runtime.panic;
|
||||||
|
comptime {
|
||||||
|
_ = &runtime.start._start; // pull the runtime entry shim into the image
|
||||||
|
}
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
//! device-list — the `ps` analog for the device tree (docs/device-manager.md
|
||||||
|
//! M18.3): asks the device manager for the tree over IPC, prints it, then
|
||||||
|
//! subscribes and prints every published add/remove event. The manager is the
|
||||||
|
//! one answer to "what devices exist" for user space; nothing here touches a
|
||||||
|
//! device_* system call.
|
||||||
|
|
||||||
|
const std = @import("std");
|
||||||
|
const runtime = @import("runtime");
|
||||||
|
const protocol = runtime.device_manager_protocol;
|
||||||
|
|
||||||
|
fn writeLine(comptime fmt: []const u8, arguments: anytype) void {
|
||||||
|
var line: [96]u8 = undefined;
|
||||||
|
_ = runtime.system.write(std.fmt.bufPrint(&line, fmt, arguments) catch return);
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn main() void {
|
||||||
|
var manager: ?runtime.ipc.Handle = null;
|
||||||
|
var tries: u32 = 0;
|
||||||
|
while (manager == null and tries < 200) : (tries += 1) {
|
||||||
|
manager = runtime.ipc.lookup(.device_manager);
|
||||||
|
if (manager == null) runtime.system.sleep(20);
|
||||||
|
}
|
||||||
|
const h = manager orelse {
|
||||||
|
_ = runtime.system.write("device-list: no device manager\n");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
// The snapshot — polled briefly, because at boot the bus drivers may still
|
||||||
|
// be scanning: an empty first answer usually just means "too early".
|
||||||
|
var reply: [protocol.message_maximum]u8 = undefined;
|
||||||
|
var count: u32 = 0;
|
||||||
|
var length: usize = 0;
|
||||||
|
tries = 0;
|
||||||
|
while (tries < 20) : (tries += 1) {
|
||||||
|
const request = protocol.Enumerate{};
|
||||||
|
length = runtime.ipc.call(h, std.mem.asBytes(&request), &reply) catch 0;
|
||||||
|
if (length >= @sizeOf(protocol.EnumerateReply)) {
|
||||||
|
count = std.mem.bytesToValue(protocol.EnumerateReply, reply[0..@sizeOf(protocol.EnumerateReply)]).count;
|
||||||
|
if (count != 0) break;
|
||||||
|
}
|
||||||
|
runtime.system.sleep(100);
|
||||||
|
}
|
||||||
|
writeLine("device-list: {d} devices\n", .{count});
|
||||||
|
var offset: usize = @sizeOf(protocol.EnumerateReply);
|
||||||
|
var index: u32 = 0;
|
||||||
|
while (index < count and offset + @sizeOf(protocol.ChildEntry) <= length) : (index += 1) {
|
||||||
|
const entry = std.mem.bytesToValue(protocol.ChildEntry, reply[offset..][0..@sizeOf(protocol.ChildEntry)]);
|
||||||
|
writeLine("device-list: device {d} port {d} identity {d}\n", .{ entry.parent, entry.bus_address, entry.identity });
|
||||||
|
offset += @sizeOf(protocol.ChildEntry);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The subscription: our endpoint rides as the call's capability; events
|
||||||
|
// arrive as buffered messages carrying the same structs the bus sends.
|
||||||
|
const endpoint = runtime.ipc.createIpcEndpoint() orelse {
|
||||||
|
_ = runtime.system.write("device-list: no endpoint\n");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
const subscribe = protocol.Subscribe{};
|
||||||
|
_ = runtime.ipc.callCap(h, std.mem.asBytes(&subscribe), &reply, endpoint) catch {
|
||||||
|
_ = runtime.system.write("device-list: subscribe failed\n");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
_ = runtime.system.write("device-list: subscribed\n");
|
||||||
|
|
||||||
|
var receive: [protocol.message_maximum]u8 = undefined;
|
||||||
|
while (true) {
|
||||||
|
const got = runtime.ipc.replyWait(endpoint, &.{}, &receive, null);
|
||||||
|
if (!got.isMessage() or got.len < 1) continue;
|
||||||
|
switch (receive[0]) {
|
||||||
|
@intFromEnum(protocol.Operation.child_added) => {
|
||||||
|
if (got.len < protocol.child_added_size) continue;
|
||||||
|
const event = std.mem.bytesToValue(protocol.ChildAdded, receive[0..protocol.child_added_size]);
|
||||||
|
writeLine("device-list: added (device {d} port {d})\n", .{ event.parent, event.bus_address });
|
||||||
|
},
|
||||||
|
@intFromEnum(protocol.Operation.child_removed) => {
|
||||||
|
if (got.len < protocol.child_removed_size) continue;
|
||||||
|
const event = std.mem.bytesToValue(protocol.ChildRemoved, receive[0..protocol.child_removed_size]);
|
||||||
|
writeLine("device-list: removed (device {d} port {d})\n", .{ event.parent, event.bus_address });
|
||||||
|
},
|
||||||
|
else => {},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub const panic = runtime.panic;
|
||||||
|
comptime {
|
||||||
|
_ = &runtime.start._start; // pull the runtime entry shim into the image
|
||||||
|
}
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
//! The device-manager protocol (docs/device-manager.md): what drivers and
|
||||||
|
//! applications say to the device manager over its well-known endpoint. The
|
||||||
|
//! vfs-protocol pattern — extern-struct messages, a version in the handshake,
|
||||||
|
//! reserved fields — so both sides depend on the contract by name. Deliberately
|
||||||
|
//! contains nothing lifecycle-shaped: stopping, liveness (the zero-length ping),
|
||||||
|
//! and exit reasons are the universal vocabulary of
|
||||||
|
//! docs/process-lifecycle.md, not this protocol.
|
||||||
|
|
||||||
|
/// The protocol version a driver states in its hello. A manager that cannot
|
||||||
|
/// serve a driver's version refuses the hello, and the mismatch is loud at
|
||||||
|
/// startup instead of quiet corruption later.
|
||||||
|
pub const version: u16 = 1;
|
||||||
|
|
||||||
|
/// What kind of driver is talking (docs/driver-model.md's shapes).
|
||||||
|
pub const Role = enum(u8) {
|
||||||
|
/// Owns a controller and reports the devices behind it (`child_added`).
|
||||||
|
bus = 1,
|
||||||
|
/// Serves one device, reached through a bus's transfer protocol.
|
||||||
|
device = 2,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// The message kinds.
|
||||||
|
pub const Operation = enum(u8) {
|
||||||
|
hello = 1,
|
||||||
|
child_added = 2,
|
||||||
|
child_removed = 3,
|
||||||
|
enumerate = 4,
|
||||||
|
subscribe = 5,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// `Hello.device_id` for a driver that serves no enumerated device (a test
|
||||||
|
/// fixture, a synthetic source).
|
||||||
|
pub const no_device: u64 = ~@as(u64, 0);
|
||||||
|
|
||||||
|
/// The handshake, sent once by every driver the manager spawns — the manager's
|
||||||
|
/// one self-enforced deadline: spawned and silent past it means wrong binary,
|
||||||
|
/// wrong version, or wedged before main, and the stop sequence follows.
|
||||||
|
pub const Hello = extern struct {
|
||||||
|
operation: u8 = @intFromEnum(Operation.hello),
|
||||||
|
/// A Role value.
|
||||||
|
role: u8,
|
||||||
|
/// The protocol version this driver was built against (`version`).
|
||||||
|
version: u16 = version,
|
||||||
|
reserved: u32 = 0,
|
||||||
|
/// The device this driver was assigned (its argv[1]), or `no_device`.
|
||||||
|
device_id: u64,
|
||||||
|
};
|
||||||
|
|
||||||
|
pub const hello_size = @sizeOf(Hello);
|
||||||
|
|
||||||
|
/// The manager's answer to a hello. Nonzero status = refused (version mismatch,
|
||||||
|
/// unknown sender); a refused driver should exit cleanly.
|
||||||
|
pub const HelloReply = extern struct {
|
||||||
|
status: i32,
|
||||||
|
reserved: u32 = 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
pub const reply_size = @sizeOf(HelloReply);
|
||||||
|
|
||||||
|
/// A bus driver reporting one device it discovered behind its controller
|
||||||
|
/// (docs/device-manager.md "the tree"). Identity is the bus's native language —
|
||||||
|
/// for USB a port-speed class; the (class, subclass, protocol) triple joins it
|
||||||
|
/// once control transfers exist (the USB track). The manager mirrors the child
|
||||||
|
/// into its tree; when the reporting driver dies, the manager prunes everything
|
||||||
|
/// it reported (the children describe protocol state that died with it) and the
|
||||||
|
/// restarted instance rediscovers and re-reports.
|
||||||
|
pub const ChildAdded = extern struct {
|
||||||
|
operation: u8 = @intFromEnum(Operation.child_added),
|
||||||
|
reserved0: u8 = 0,
|
||||||
|
reserved1: u16 = 0,
|
||||||
|
reserved2: u32 = 0,
|
||||||
|
/// The reporting driver's own device (the controller) — the child's parent.
|
||||||
|
parent: u64,
|
||||||
|
/// Where on the bus (for USB: the root port number, 1-based).
|
||||||
|
bus_address: u64,
|
||||||
|
/// Bus-specific identity (for USB: the PORTSC port-speed class).
|
||||||
|
identity: u64,
|
||||||
|
};
|
||||||
|
|
||||||
|
pub const child_added_size = @sizeOf(ChildAdded);
|
||||||
|
|
||||||
|
/// A bus driver reporting a device gone (hot-unplug). Not yet sent by any
|
||||||
|
/// driver — the port scan has no unplug interrupt — but the manager handles it;
|
||||||
|
/// death-pruning covers removal until hotplug lands.
|
||||||
|
pub const ChildRemoved = extern struct {
|
||||||
|
operation: u8 = @intFromEnum(Operation.child_removed),
|
||||||
|
reserved0: u8 = 0,
|
||||||
|
reserved1: u16 = 0,
|
||||||
|
reserved2: u32 = 0,
|
||||||
|
parent: u64,
|
||||||
|
bus_address: u64,
|
||||||
|
};
|
||||||
|
|
||||||
|
pub const child_removed_size = @sizeOf(ChildRemoved);
|
||||||
|
|
||||||
|
/// The manager's answer to a tree report.
|
||||||
|
pub const ReportReply = extern struct {
|
||||||
|
status: i32,
|
||||||
|
reserved: u32 = 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// An application asking for the tree (M18.3): the reply is an EnumerateReply
|
||||||
|
/// header followed by `count` ChildEntry records.
|
||||||
|
pub const Enumerate = extern struct {
|
||||||
|
operation: u8 = @intFromEnum(Operation.enumerate),
|
||||||
|
reserved0: u8 = 0,
|
||||||
|
reserved1: u16 = 0,
|
||||||
|
reserved2: u32 = 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
pub const EnumerateReply = extern struct {
|
||||||
|
status: i32,
|
||||||
|
/// ChildEntry records following this header.
|
||||||
|
count: u32,
|
||||||
|
};
|
||||||
|
|
||||||
|
pub const ChildEntry = extern struct {
|
||||||
|
parent: u64,
|
||||||
|
bus_address: u64,
|
||||||
|
identity: u64,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// An application subscribing to published add/remove events (the input-service
|
||||||
|
/// pattern): the subscriber's endpoint rides as the call's **capability**, and
|
||||||
|
/// events arrive on it as buffered messages whose payload is the same
|
||||||
|
/// ChildAdded / ChildRemoved struct the bus drivers send — one encoding, both
|
||||||
|
/// directions.
|
||||||
|
pub const Subscribe = extern struct {
|
||||||
|
operation: u8 = @intFromEnum(Operation.subscribe),
|
||||||
|
reserved0: u8 = 0,
|
||||||
|
reserved1: u16 = 0,
|
||||||
|
reserved2: u32 = 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// Upper bound on any message in this protocol — sizes the endpoint buffers.
|
||||||
|
/// Capped by the kernel's IPC MESSAGE_MAXIMUM (256): an EnumerateReply carries
|
||||||
|
/// up to ten ChildEntry records per call, plenty for the mirror's current
|
||||||
|
/// bounds; paging joins the protocol if a tree ever outgrows one message.
|
||||||
|
pub const message_maximum = 256;
|
||||||
@@ -1,20 +1,24 @@
|
|||||||
//! /system/services/device-manager — the ring-3 process that turns the device
|
//! /system/services/device-manager — the ring-3 process that turns the device
|
||||||
//! tree into a running system. The kernel enumerates the hardware and enforces the
|
//! tree into a running system: **the matcher and the supervisor**
|
||||||
//! claim capability (mechanism); this decides *which driver serves which device*
|
//! (docs/device-manager.md). The kernel enumerates the hardware and enforces the
|
||||||
//! and, eventually, spawns it (policy). Keeping that split in user space is the
|
//! claim capability (mechanism); this decides which driver serves which device,
|
||||||
//! whole point of the microkernel: the manager is an ordinary, restartable process
|
//! spawns it, and keeps it alive (policy). Keeping that split in user space is
|
||||||
//! with no special privilege — it uses the same `device_*` system calls any process
|
//! the whole point of the microkernel: the manager is an ordinary, restartable
|
||||||
//! could ([drivers.md](../../../docs/drivers.md), [driver-model.md]).
|
//! process with no special privilege.
|
||||||
//!
|
//!
|
||||||
//! Increment 2 (this file): enumerate /system/devices, *match* each device to a
|
//! M18.1 (this increment): the manager is a harness service on the well-known
|
||||||
//! driver, and *spawn* it with `system_spawn` — the kernel loads the named binary
|
//! `.device_manager` endpoint. Every driver is spawned **supervised** — exit
|
||||||
//! from the initial-ramdisk as a fresh ring-3 process. On QEMU this discovers the
|
//! notifications land in the same loop as protocol messages. Drivers with an
|
||||||
//! HPET, decides `hpet` serves it, and brings that driver all the way up. (The
|
//! assignment must `hello` within a deadline or be stopped; a driver that dies
|
||||||
//! kernel still auto-spawns the whole initial-ramdisk at boot; increment 3 removes
|
//! is restarted with backoff, and a crash loop (three fast deaths) marks it
|
||||||
//! that redundancy so the manager is the sole owner of driver spawning.)
|
//! failed instead of respawning forever. Exit reasons (M17.2) drive the
|
||||||
|
//! decision: a clean exit meant to stop; only faults and missed deadlines
|
||||||
|
//! restart. Tree reports (`child_added`) land in M18.2.
|
||||||
|
|
||||||
const std = @import("std");
|
const std = @import("std");
|
||||||
const runtime = @import("runtime");
|
const runtime = @import("runtime");
|
||||||
const acpi_ids = @import("acpi-ids");
|
const acpi_ids = @import("acpi-ids");
|
||||||
|
const protocol = runtime.device_manager_protocol;
|
||||||
const device = runtime.device;
|
const device = runtime.device;
|
||||||
const system = runtime.system;
|
const system = runtime.system;
|
||||||
|
|
||||||
@@ -27,9 +31,8 @@ fn writeLine(comptime fmt: []const u8, arguments: anytype) void {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// The driver that serves each device — the policy table. In a fuller system
|
/// The driver that serves each device — the policy table. In a fuller system
|
||||||
/// this comes from the drivers describing what they bind (or a manifest under
|
/// this comes from a manifest (docs/device-manager.md: the third bus type
|
||||||
/// /system/drivers); for now it is a small static map, which is enough to prove the
|
/// triggers it); for now a static map. `null` = no driver for this class yet.
|
||||||
/// manager reads the tree and decides. `null` = no driver for this class yet.
|
|
||||||
fn driverFor(d: device.DeviceDescriptor) ?[]const u8 {
|
fn driverFor(d: device.DeviceDescriptor) ?[]const u8 {
|
||||||
// detect device via DeviceClass
|
// detect device via DeviceClass
|
||||||
if (d.class == @intFromEnum(device.DeviceClass.timer)) return "hpet";
|
if (d.class == @intFromEnum(device.DeviceClass.timer)) return "hpet";
|
||||||
@@ -47,10 +50,9 @@ fn driverFor(d: device.DeviceDescriptor) ?[]const u8 {
|
|||||||
/// pci-class.zig decodes.
|
/// pci-class.zig decodes.
|
||||||
const xhci_pci_class: u64 = 0x0C_03_30;
|
const xhci_pci_class: u64 = 0x0C_03_30;
|
||||||
|
|
||||||
/// The bus driver that serves a PCI function, or null. Unlike the singleton drivers
|
/// The bus driver that serves a PCI function, or null. A machine can carry
|
||||||
/// in `driverFor`, a machine can carry several identical controllers — so the caller
|
/// several identical controllers — one driver instance per device, the id as
|
||||||
/// spawns one driver instance *per device*, passing the device id as argv[1] for the
|
/// argv[1]. These drivers speak the protocol: a hello is expected.
|
||||||
/// instance to claim.
|
|
||||||
fn pciDriverFor(d: device.DeviceDescriptor) ?[]const u8 {
|
fn pciDriverFor(d: device.DeviceDescriptor) ?[]const u8 {
|
||||||
if (d.class != @intFromEnum(device.DeviceClass.pci_device)) return null;
|
if (d.class != @intFromEnum(device.DeviceClass.pci_device)) return null;
|
||||||
return switch (d.pci_class) {
|
return switch (d.pci_class) {
|
||||||
@@ -59,24 +61,254 @@ fn pciDriverFor(d: device.DeviceDescriptor) ?[]const u8 {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Spawn one instance of `driver_name` to serve the specific device `id` — the id
|
// --- supervision -------------------------------------------------------------
|
||||||
/// arrives as argv[1]. No isProcessRunning gate here: the name alone cannot tell two
|
|
||||||
/// instances apart, and this manager is the sole spawner of drivers.
|
/// How long a protocol driver has to hello after its spawn.
|
||||||
fn spawnForDevice(driver_name: []const u8, id: u64) void {
|
const hello_deadline_ms: u64 = 3000;
|
||||||
var text: [20]u8 = undefined;
|
/// Deaths faster than this count toward the crash loop; slower ones reset it.
|
||||||
const id_text = std.fmt.bufPrint(&text, "{d}", .{id}) catch return;
|
const fast_death_ns: u64 = 2_000_000_000;
|
||||||
if (system.spawnWithArguments(driver_name, &.{id_text}) != null) {
|
/// Consecutive fast deaths before the manager gives up on a driver.
|
||||||
writeLine("device-manager: spawned {s} for device {d}\n", .{ driver_name, id });
|
const crash_loop_cap: u32 = 3;
|
||||||
} else {
|
/// Restart backoff: base << (restarts - 1), so 300 ms, 600 ms, 1200 ms.
|
||||||
writeLine("device-manager: failed to spawn {s} for device {d}\n", .{ driver_name, id });
|
const backoff_base_ms: u64 = 300;
|
||||||
|
|
||||||
|
const DriverState = enum {
|
||||||
|
awaiting_hello, // spawned; the deadline is armed (protocol drivers only)
|
||||||
|
running,
|
||||||
|
restarting, // dead; respawn due at restart_due_ns
|
||||||
|
stopped, // exited cleanly — it meant to; not restarted
|
||||||
|
failed, // crash loop, or unspawnable; the manager gave up
|
||||||
|
};
|
||||||
|
|
||||||
|
const Driver = struct {
|
||||||
|
used: bool = false,
|
||||||
|
name_buffer: [24]u8 = undefined,
|
||||||
|
name_len: usize = 0,
|
||||||
|
// The assigned device id (becomes argv[1]), or protocol.no_device.
|
||||||
|
device_id: u64 = protocol.no_device,
|
||||||
|
// Whether this driver speaks the protocol (hello expected, deadline
|
||||||
|
// enforced). Legacy drivers (hpet, ps2-bus) are supervised and restarted
|
||||||
|
// but not yet required to hello.
|
||||||
|
speaks_protocol: bool = false,
|
||||||
|
process_id: u32 = 0,
|
||||||
|
state: DriverState = .running,
|
||||||
|
restarts: u32 = 0,
|
||||||
|
spawn_ns: u64 = 0,
|
||||||
|
hello_deadline_ns: u64 = 0,
|
||||||
|
restart_due_ns: u64 = 0,
|
||||||
|
|
||||||
|
fn name(driver: *const Driver) []const u8 {
|
||||||
|
return driver.name_buffer[0..driver.name_len];
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const maximum_drivers = 16;
|
||||||
|
var drivers: [maximum_drivers]Driver = .{Driver{}} ** maximum_drivers;
|
||||||
|
var manager_endpoint: runtime.ipc.Handle = 0;
|
||||||
|
var test_restart_mode = false;
|
||||||
|
var test_usb_restart_mode = false;
|
||||||
|
var test_usb_killed = false;
|
||||||
|
var test_kill_pid: u32 = 0;
|
||||||
|
var test_kill_due_ns: u64 = 0;
|
||||||
|
|
||||||
|
/// The application subscribers (M18.3, the input-service pattern): endpoints
|
||||||
|
/// handed over as capabilities, each receiving every child add/remove as a
|
||||||
|
/// buffered message. A subscriber whose endpoint stops accepting (it died) is
|
||||||
|
/// dropped on the failed send.
|
||||||
|
const maximum_subscribers = 8;
|
||||||
|
var subscribers: [maximum_subscribers]?runtime.ipc.Handle = .{null} ** maximum_subscribers;
|
||||||
|
|
||||||
|
/// Publish one event (a ChildAdded or ChildRemoved struct, the same encoding
|
||||||
|
/// the bus drivers send) to every subscriber.
|
||||||
|
fn publishEvent(event: []const u8) void {
|
||||||
|
for (&subscribers) |*slot| {
|
||||||
|
if (slot.*) |handle| {
|
||||||
|
if (!runtime.ipc.send(handle, event)) slot.* = null; // dead subscriber
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn main() void {
|
/// The manager's mirror of what bus drivers report (docs/device-manager.md "the
|
||||||
|
/// tree"): the children, keyed by (parent, bus address), each remembering which
|
||||||
|
/// driver instance reported it — that is what death-pruning sweeps by.
|
||||||
|
const Child = struct {
|
||||||
|
used: bool = false,
|
||||||
|
parent: u64 = 0,
|
||||||
|
bus_address: u64 = 0,
|
||||||
|
identity: u64 = 0,
|
||||||
|
reporter: u32 = 0, // the reporting driver instance's process id
|
||||||
|
};
|
||||||
|
|
||||||
|
const maximum_children = 32;
|
||||||
|
var children: [maximum_children]Child = .{Child{}} ** maximum_children;
|
||||||
|
|
||||||
|
/// Record (or refresh) a reported child. Refreshing matters: a restarted bus
|
||||||
|
/// driver re-reports what it rediscovers, and the same (parent, port) must not
|
||||||
|
/// duplicate.
|
||||||
|
fn addChild(parent: u64, bus_address: u64, identity: u64, reporter: u32) bool {
|
||||||
|
var free: ?*Child = null;
|
||||||
|
for (&children) |*child| {
|
||||||
|
if (child.used and child.parent == parent and child.bus_address == bus_address) {
|
||||||
|
child.identity = identity;
|
||||||
|
child.reporter = reporter;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
if (!child.used and free == null) free = child;
|
||||||
|
}
|
||||||
|
const slot = free orelse return false;
|
||||||
|
slot.* = .{ .used = true, .parent = parent, .bus_address = bus_address, .identity = identity, .reporter = reporter };
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Prune every child a dead driver instance reported: the children describe
|
||||||
|
/// protocol state (slots, rings) that died with the process — keeping the nodes
|
||||||
|
/// would be keeping a lie. The restarted instance rediscovers and re-reports.
|
||||||
|
/// Watchers hear the honest story: removed now, added again on rediscovery.
|
||||||
|
fn pruneChildrenOf(reporter: u32) void {
|
||||||
|
for (&children) |*child| {
|
||||||
|
if (child.used and child.reporter == reporter) {
|
||||||
|
writeLine("device-manager: child removed (device {d} port {d})\n", .{ child.parent, child.bus_address });
|
||||||
|
child.used = false;
|
||||||
|
const event = protocol.ChildRemoved{ .parent = child.parent, .bus_address = child.bus_address };
|
||||||
|
publishEvent(std.mem.asBytes(&event));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// How many children a driver instance has reported (the test-usb-restart
|
||||||
|
/// trigger counts these).
|
||||||
|
fn childCountOf(reporter: u32) u32 {
|
||||||
|
var n: u32 = 0;
|
||||||
|
for (&children) |*child| {
|
||||||
|
if (child.used and child.reporter == reporter) n += 1;
|
||||||
|
}
|
||||||
|
return n;
|
||||||
|
}
|
||||||
|
|
||||||
|
fn driverByProcess(process_id: u32) ?*Driver {
|
||||||
|
for (&drivers) |*driver| {
|
||||||
|
if (driver.used and driver.process_id == process_id) return driver;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Whether a singleton driver is already in the table (two ACPI nodes can both
|
||||||
|
/// map to ps2-bus; one instance serves both).
|
||||||
|
fn alreadySupervised(name: []const u8) bool {
|
||||||
|
for (&drivers) |*driver| {
|
||||||
|
if (driver.used and std.mem.eql(u8, driver.name(), name)) return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Record a driver in the table and spawn its first instance.
|
||||||
|
fn addDriver(name: []const u8, device_id: u64, speaks_protocol: bool) void {
|
||||||
|
for (&drivers) |*driver| {
|
||||||
|
if (driver.used) continue;
|
||||||
|
const n = @min(name.len, driver.name_buffer.len);
|
||||||
|
@memcpy(driver.name_buffer[0..n], name[0..n]);
|
||||||
|
driver.name_len = n;
|
||||||
|
driver.device_id = device_id;
|
||||||
|
driver.speaks_protocol = speaks_protocol;
|
||||||
|
driver.used = true;
|
||||||
|
spawnDriver(driver);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
writeLine("device-manager: driver table full; cannot supervise {s}\n", .{name});
|
||||||
|
}
|
||||||
|
|
||||||
|
/// (Re)spawn a driver instance: supervised on the manager's own endpoint, the
|
||||||
|
/// device id as argv[1] when it has one, the hello deadline armed when it
|
||||||
|
/// speaks the protocol.
|
||||||
|
fn spawnDriver(driver: *Driver) void {
|
||||||
|
var id_text: [20]u8 = undefined;
|
||||||
|
var arguments: [1][]const u8 = undefined;
|
||||||
|
var argument_count: usize = 0;
|
||||||
|
if (driver.device_id != protocol.no_device) {
|
||||||
|
arguments[0] = std.fmt.bufPrint(&id_text, "{d}", .{driver.device_id}) catch return;
|
||||||
|
argument_count = 1;
|
||||||
|
}
|
||||||
|
const child = system.spawnSupervised(driver.name(), arguments[0..argument_count], manager_endpoint) orelse {
|
||||||
|
writeLine("device-manager: failed to spawn {s}\n", .{driver.name()});
|
||||||
|
driver.state = .failed;
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
driver.process_id = child;
|
||||||
|
driver.spawn_ns = system.clock();
|
||||||
|
if (driver.speaks_protocol) {
|
||||||
|
driver.state = .awaiting_hello;
|
||||||
|
driver.hello_deadline_ns = driver.spawn_ns + hello_deadline_ms * 1_000_000;
|
||||||
|
_ = system.timerOnce(manager_endpoint, hello_deadline_ms + 100);
|
||||||
|
} else {
|
||||||
|
driver.state = .running;
|
||||||
|
}
|
||||||
|
if (driver.device_id != protocol.no_device) {
|
||||||
|
writeLine("device-manager: spawned {s} for device {d}\n", .{ driver.name(), driver.device_id });
|
||||||
|
} else {
|
||||||
|
writeLine("device-manager: spawned {s}\n", .{driver.name()});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A driver died. Prune what it reported first — then the exit reason (M17.2)
|
||||||
|
/// is the whole restart decision: a clean exit meant to stop; anything else
|
||||||
|
/// restarts with backoff until the crash-loop cap.
|
||||||
|
fn onDriverExit(driver: *Driver) void {
|
||||||
|
pruneChildrenOf(driver.process_id);
|
||||||
|
const reason = runtime.process.exitReason(driver.process_id) orelse .fault;
|
||||||
|
if (reason == .exited) {
|
||||||
|
driver.state = .stopped;
|
||||||
|
writeLine("device-manager: {s} exited cleanly; not restarting\n", .{driver.name()});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const now = system.clock();
|
||||||
|
const alive_ns = now - driver.spawn_ns;
|
||||||
|
driver.restarts = if (alive_ns < fast_death_ns) driver.restarts + 1 else 1;
|
||||||
|
if (driver.restarts >= crash_loop_cap) {
|
||||||
|
driver.state = .failed;
|
||||||
|
writeLine("device-manager: {s} is failing repeatedly (crash loop); giving up\n", .{driver.name()});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const delay_ms = backoff_base_ms << @intCast(driver.restarts - 1);
|
||||||
|
driver.state = .restarting;
|
||||||
|
driver.restart_due_ns = now + delay_ms * 1_000_000;
|
||||||
|
writeLine("device-manager: restarting {s} in {d} ms (died: {s})\n", .{ driver.name(), delay_ms, @tagName(reason) });
|
||||||
|
_ = system.timerOnce(manager_endpoint, delay_ms + 50);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A timer landed: sweep every deadline. Overdue hellos are killed (the exit
|
||||||
|
/// notification then routes through the normal restart policy); due restarts
|
||||||
|
/// respawn. Timers carry no id on purpose — the table is the state, and one
|
||||||
|
/// sweep serves every armed deadline.
|
||||||
|
fn sweepDeadlines() void {
|
||||||
|
const now = system.clock();
|
||||||
|
if (test_kill_pid != 0 and now >= test_kill_due_ns) {
|
||||||
|
writeLine("device-manager: test mode: killing the reporter\n", .{});
|
||||||
|
_ = system.kill(test_kill_pid);
|
||||||
|
test_kill_pid = 0;
|
||||||
|
}
|
||||||
|
for (&drivers) |*driver| {
|
||||||
|
if (!driver.used) continue;
|
||||||
|
switch (driver.state) {
|
||||||
|
.awaiting_hello => if (now >= driver.hello_deadline_ns) {
|
||||||
|
writeLine("device-manager: {s} missed its hello deadline\n", .{driver.name()});
|
||||||
|
_ = system.kill(driver.process_id);
|
||||||
|
// The exit notification finishes the job via onDriverExit.
|
||||||
|
},
|
||||||
|
.restarting => if (now >= driver.restart_due_ns) spawnDriver(driver),
|
||||||
|
else => {},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- the harness callbacks -----------------------------------------------------
|
||||||
|
|
||||||
|
fn initialise(endpoint: runtime.ipc.Handle) bool {
|
||||||
|
manager_endpoint = endpoint;
|
||||||
|
|
||||||
// Enumerate into a heap buffer (too big for the one-page user stack).
|
// Enumerate into a heap buffer (too big for the one-page user stack).
|
||||||
const buffer = runtime.allocator().alloc(device.DeviceDescriptor, 64) catch {
|
const buffer = runtime.allocator().alloc(device.DeviceDescriptor, 64) catch {
|
||||||
_ = runtime.system.write("device-manager: out of memory\n");
|
_ = runtime.system.write("device-manager: out of memory\n");
|
||||||
return;
|
return false;
|
||||||
};
|
};
|
||||||
const total = device.enumerate(buffer);
|
const total = device.enumerate(buffer);
|
||||||
const count = @min(total, buffer.len);
|
const count = @min(total, buffer.len);
|
||||||
@@ -85,28 +317,162 @@ pub fn main() void {
|
|||||||
for (buffer[0..count]) |descriptor| {
|
for (buffer[0..count]) |descriptor| {
|
||||||
if (pciDriverFor(descriptor)) |driver_name| {
|
if (pciDriverFor(descriptor)) |driver_name| {
|
||||||
matched += 1;
|
matched += 1;
|
||||||
spawnForDevice(driver_name, descriptor.id);
|
addDriver(driver_name, descriptor.id, true);
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
const driver_name = driverFor(descriptor) orelse continue;
|
const driver_name = driverFor(descriptor) orelse continue;
|
||||||
matched += 1;
|
matched += 1;
|
||||||
if (!system.isProcessRunning(driver_name)) {
|
// Skip a singleton that is already alive (the initial-ramdisk sweep test
|
||||||
if (runtime.system.spawn(driver_name) != null) {
|
// starts every bundled binary bare, this manager included) — spawning a
|
||||||
writeLine("device-manager: spawned {s}\n", .{driver_name});
|
// second instance would only lose the claim race and churn the log.
|
||||||
} else {
|
if (!alreadySupervised(driver_name) and !system.isProcessRunning(driver_name)) {
|
||||||
writeLine("device-manager: failed to spawn {s}\n", .{driver_name});
|
addDriver(driver_name, protocol.no_device, false);
|
||||||
}
|
}
|
||||||
} else {
|
|
||||||
writeLine("device-manager: already spawned {s}\n", .{driver_name});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (test_restart_mode) {
|
||||||
|
// The driver-restart scenario's fixture: claims device 0 (the tree
|
||||||
|
// root, otherwise unclaimed), hellos, then faults — driving backoff,
|
||||||
|
// re-claim-after-death, and the crash-loop cap deterministically.
|
||||||
|
addDriver("crash-test", 0, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (matched == 0) {
|
if (matched == 0) {
|
||||||
_ = runtime.system.write("device-manager: no matchable devices\n");
|
_ = runtime.system.write("device-manager: no matchable devices\n");
|
||||||
|
} else {
|
||||||
|
_ = runtime.system.write("device-manager: ok\n");
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
fn onMessage(message: []const u8, reply: []u8, sender: u32, capability: ?runtime.ipc.Handle) usize {
|
||||||
|
if (message.len < 1) return 0;
|
||||||
|
switch (message[0]) {
|
||||||
|
@intFromEnum(protocol.Operation.child_added) => return onChildAdded(message, reply, sender),
|
||||||
|
@intFromEnum(protocol.Operation.child_removed) => return onChildRemoved(message, reply, sender),
|
||||||
|
@intFromEnum(protocol.Operation.enumerate) => return onEnumerate(reply),
|
||||||
|
@intFromEnum(protocol.Operation.subscribe) => return onSubscribe(reply, capability),
|
||||||
|
@intFromEnum(protocol.Operation.hello) => {},
|
||||||
|
else => return 0,
|
||||||
|
}
|
||||||
|
if (message.len < protocol.hello_size) return 0;
|
||||||
|
const hello = std.mem.bytesToValue(protocol.Hello, message[0..protocol.hello_size]);
|
||||||
|
|
||||||
|
var status: i32 = 0;
|
||||||
|
if (hello.version != protocol.version) {
|
||||||
|
status = -1;
|
||||||
|
writeLine("device-manager: refused hello (version {d}) from process {d}\n", .{ hello.version, sender });
|
||||||
|
} else if (driverByProcess(sender)) |driver| {
|
||||||
|
driver.state = .running;
|
||||||
|
writeLine("device-manager: hello from {s} (device {d})\n", .{ driver.name(), hello.device_id });
|
||||||
|
} else {
|
||||||
|
status = -1;
|
||||||
|
writeLine("device-manager: hello from unknown process {d}\n", .{sender});
|
||||||
|
}
|
||||||
|
const hello_reply = protocol.HelloReply{ .status = status };
|
||||||
|
@memcpy(reply[0..protocol.reply_size], std.mem.asBytes(&hello_reply));
|
||||||
|
return protocol.reply_size;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A bus driver reported a discovered device: mirror it, and in
|
||||||
|
/// test-usb-restart mode kill the reporter once after its second child — the
|
||||||
|
/// deterministic trigger for prune -> backoff -> respawn -> re-report.
|
||||||
|
fn onChildAdded(message: []const u8, reply: []u8, sender: u32) usize {
|
||||||
|
if (message.len < protocol.child_added_size) return 0;
|
||||||
|
const report = std.mem.bytesToValue(protocol.ChildAdded, message[0..protocol.child_added_size]);
|
||||||
|
var status: i32 = 0;
|
||||||
|
if (driverByProcess(sender)) |driver| {
|
||||||
|
if (!addChild(report.parent, report.bus_address, report.identity, sender)) status = -1;
|
||||||
|
writeLine("device-manager: child added (device {d} port {d}, identity {d}) by {s}\n", .{ report.parent, report.bus_address, report.identity, driver.name() });
|
||||||
|
if (status == 0) publishEvent(message[0..protocol.child_added_size]);
|
||||||
|
} else {
|
||||||
|
status = -1;
|
||||||
|
}
|
||||||
|
const report_reply = protocol.ReportReply{ .status = status };
|
||||||
|
@memcpy(reply[0..@sizeOf(protocol.ReportReply)], std.mem.asBytes(&report_reply));
|
||||||
|
if (test_usb_restart_mode and !test_usb_killed and childCountOf(sender) >= 2) {
|
||||||
|
// Delayed, not immediate: the device-list scenario's subscriber needs a
|
||||||
|
// window to enumerate and subscribe before the events start.
|
||||||
|
test_usb_killed = true;
|
||||||
|
test_kill_pid = sender;
|
||||||
|
test_kill_due_ns = system.clock() + 2_000_000_000;
|
||||||
|
_ = system.timerOnce(manager_endpoint, 2100);
|
||||||
|
}
|
||||||
|
return @sizeOf(protocol.ReportReply);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A bus driver reported a device gone (hot-unplug; no sender exists yet, but
|
||||||
|
/// the handler is protocol-complete — death-pruning covers removal until then).
|
||||||
|
fn onChildRemoved(message: []const u8, reply: []u8, sender: u32) usize {
|
||||||
|
if (message.len < protocol.child_removed_size) return 0;
|
||||||
|
const report = std.mem.bytesToValue(protocol.ChildRemoved, message[0..protocol.child_removed_size]);
|
||||||
|
var status: i32 = -1;
|
||||||
|
for (&children) |*child| {
|
||||||
|
if (child.used and child.parent == report.parent and child.bus_address == report.bus_address and child.reporter == sender) {
|
||||||
|
writeLine("device-manager: child removed (device {d} port {d})\n", .{ child.parent, child.bus_address });
|
||||||
|
child.used = false;
|
||||||
|
status = 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const report_reply = protocol.ReportReply{ .status = status };
|
||||||
|
@memcpy(reply[0..@sizeOf(protocol.ReportReply)], std.mem.asBytes(&report_reply));
|
||||||
|
return @sizeOf(protocol.ReportReply);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// An application asked for the tree: the mirror, as a header plus entries.
|
||||||
|
fn onEnumerate(reply: []u8) usize {
|
||||||
|
var count: u32 = 0;
|
||||||
|
var offset: usize = @sizeOf(protocol.EnumerateReply);
|
||||||
|
for (&children) |*child| {
|
||||||
|
if (!child.used) continue;
|
||||||
|
if (offset + @sizeOf(protocol.ChildEntry) > reply.len) break;
|
||||||
|
const entry = protocol.ChildEntry{ .parent = child.parent, .bus_address = child.bus_address, .identity = child.identity };
|
||||||
|
@memcpy(reply[offset..][0..@sizeOf(protocol.ChildEntry)], std.mem.asBytes(&entry));
|
||||||
|
offset += @sizeOf(protocol.ChildEntry);
|
||||||
|
count += 1;
|
||||||
|
}
|
||||||
|
const header = protocol.EnumerateReply{ .status = 0, .count = count };
|
||||||
|
@memcpy(reply[0..@sizeOf(protocol.EnumerateReply)], std.mem.asBytes(&header));
|
||||||
|
return offset;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// An application subscribed: its endpoint arrived as the call's capability.
|
||||||
|
fn onSubscribe(reply: []u8, capability: ?runtime.ipc.Handle) usize {
|
||||||
|
var status: i32 = -1;
|
||||||
|
if (capability) |handle| {
|
||||||
|
for (&subscribers) |*slot| {
|
||||||
|
if (slot.* == null) {
|
||||||
|
slot.* = handle;
|
||||||
|
status = 0;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const report_reply = protocol.ReportReply{ .status = status };
|
||||||
|
@memcpy(reply[0..@sizeOf(protocol.ReportReply)], std.mem.asBytes(&report_reply));
|
||||||
|
return @sizeOf(protocol.ReportReply);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn onNotification(badge: u64) void {
|
||||||
|
if (badge & runtime.ipc.notify_exit_bit != 0) {
|
||||||
|
const dead: u32 = @intCast(badge & ~(runtime.ipc.notify_badge_bit | runtime.ipc.notify_exit_bit));
|
||||||
|
if (driverByProcess(dead)) |driver| onDriverExit(driver);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
_ = runtime.system.write("device-manager: ok\n");
|
if (badge & runtime.ipc.notify_timer_bit != 0) sweepDeadlines();
|
||||||
while (true) runtime.system.sleep(1000);
|
}
|
||||||
|
|
||||||
|
pub fn main(init: runtime.process.Init) void {
|
||||||
|
if (init.arguments.get(1)) |mode| {
|
||||||
|
test_restart_mode = std.mem.eql(u8, mode, "test-restart");
|
||||||
|
test_usb_restart_mode = std.mem.eql(u8, mode, "test-usb-restart");
|
||||||
|
}
|
||||||
|
runtime.service.run(protocol.message_maximum, .{
|
||||||
|
.service = .device_manager,
|
||||||
|
.init = initialise,
|
||||||
|
.on_message = onMessage,
|
||||||
|
.on_notification = onNotification,
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
pub const panic = runtime.panic;
|
pub const panic = runtime.panic;
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
//! /system/services/fdt — the devicetree discovery service: the ARM twin of the
|
||||||
|
//! acpi service (docs/m19-m20-plan.md decision 7). **Placeholder: not
|
||||||
|
//! implemented.** It exists so the build's `-Ddiscovery` option has both of its
|
||||||
|
//! values from day one; the implementation lands with the Raspberry Pi
|
||||||
|
//! bring-up (docs/arm.md).
|
||||||
|
//!
|
||||||
|
//! What it becomes: the per-firmware discoverer for boots that hand over a
|
||||||
|
//! flattened device tree instead of ACPI tables. It claims the
|
||||||
|
//! `devicetree-blob` node the kernel publishes (the FDT the loader received),
|
||||||
|
//! walks the tree — pure data, no bytecode, so unlike the acpi service it
|
||||||
|
//! needs no port grant and no interpreter — and, like any bus-shaped driver:
|
||||||
|
//! `device_register`s what it finds (containment against the blob node's
|
||||||
|
//! recorded apertures), reports each child to the device manager
|
||||||
|
//! (`child_added`, identity = the node's `compatible` string), and stays
|
||||||
|
//! resident under the manager's supervision (hello, restart, the usual
|
||||||
|
//! contract).
|
||||||
|
//!
|
||||||
|
//! Known prerequisite recorded in the plan: `DeviceDescriptor`'s 8-byte `hid`
|
||||||
|
//! cannot hold an FDT `compatible` string ("brcm,bcm2835-aux-uart") — identity
|
||||||
|
//! widens before this file grows a body.
|
||||||
|
|
||||||
|
const runtime = @import("runtime");
|
||||||
|
|
||||||
|
pub fn main() void {
|
||||||
|
// Not implemented: exit cleanly and silently (a bare spawn by the
|
||||||
|
// initial-ramdisk sweep must not derange other tests' markers). The
|
||||||
|
// supervisor reads a clean exit as "meant to stop" — correct for a
|
||||||
|
// placeholder.
|
||||||
|
}
|
||||||
|
|
||||||
|
pub const panic = runtime.panic;
|
||||||
|
comptime {
|
||||||
|
_ = &runtime.start._start; // pull the runtime entry shim into the image
|
||||||
|
}
|
||||||
@@ -51,8 +51,9 @@ fn awaitChildExit(endpoint: runtime.ipc.Handle) u32 {
|
|||||||
/// The harness-run child of the signals test: echoes requests, logs the two
|
/// The harness-run child of the signals test: echoes requests, logs the two
|
||||||
/// signals it handles. Terminate makes run() return, and returning from main is
|
/// signals it handles. Terminate makes run() return, and returning from main is
|
||||||
/// the clean exit the parent reads as ExitReason.exited.
|
/// the clean exit the parent reads as ExitReason.exited.
|
||||||
fn echo(message: []const u8, reply: []u8, sender: u32) usize {
|
fn echo(message: []const u8, reply: []u8, sender: u32, capability: ?runtime.ipc.Handle) usize {
|
||||||
_ = sender;
|
_ = sender;
|
||||||
|
_ = capability;
|
||||||
const n = @min(message.len, reply.len);
|
const n = @min(message.len, reply.len);
|
||||||
@memcpy(reply[0..n], message[0..n]);
|
@memcpy(reply[0..n], message[0..n]);
|
||||||
return n;
|
return n;
|
||||||
|
|||||||
@@ -91,7 +91,8 @@ fn releaseClientHandles(client: u32) void {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Handle one request from `sender`; write the reply into `out`, return its length.
|
/// Handle one request from `sender`; write the reply into `out`, return its length.
|
||||||
fn handle(message: []const u8, out: []u8, sender: u32) usize {
|
fn handle(message: []const u8, out: []u8, sender: u32, capability: ?runtime.ipc.Handle) usize {
|
||||||
|
_ = capability;
|
||||||
if (message.len < protocol.request_size) return fail(out);
|
if (message.len < protocol.request_size) return fail(out);
|
||||||
const request = std.mem.bytesToValue(protocol.Request, message[0..protocol.request_size]);
|
const request = std.mem.bytesToValue(protocol.Request, message[0..protocol.request_size]);
|
||||||
const payload = message[protocol.request_size..];
|
const payload = message[protocol.request_size..];
|
||||||
|
|||||||
@@ -258,6 +258,50 @@ CASES = [
|
|||||||
"smp": 4,
|
"smp": 4,
|
||||||
"expect": r"DANOS-TEST-RESULT: PASS",
|
"expect": r"DANOS-TEST-RESULT: PASS",
|
||||||
"fail": r"DANOS-TEST-RESULT: FAIL"},
|
"fail": r"DANOS-TEST-RESULT: FAIL"},
|
||||||
|
# M18.2: bus tree reports — the xHCI driver scans its root-hub ports and
|
||||||
|
# reports both QEMU devices; the manager mirrors, prunes on the reporter's
|
||||||
|
# death, and the respawned driver re-reports (docs/device-manager.md).
|
||||||
|
{"name": "usb-report",
|
||||||
|
"smp": 4,
|
||||||
|
"timeout": 90,
|
||||||
|
"qemu_extra": ["-device", "qemu-xhci,id=xhci",
|
||||||
|
"-device", "usb-kbd,bus=xhci.0",
|
||||||
|
"-device", "usb-mouse,bus=xhci.0"],
|
||||||
|
"expect": r"device-manager: child added[\s\S]*"
|
||||||
|
r"device-manager: child added[\s\S]*"
|
||||||
|
r"device-manager: test mode: killing the reporter[\s\S]*"
|
||||||
|
r"device-manager: child removed[\s\S]*"
|
||||||
|
r"device-manager: restarting usb-xhci-bus[\s\S]*"
|
||||||
|
r"device-manager: child added",
|
||||||
|
"fail": r"DANOS-TEST-RESULT: FAIL"},
|
||||||
|
# M18.3: the application surface — device-list enumerates the tree over IPC,
|
||||||
|
# subscribes (endpoint as capability), and observes the removed/added events
|
||||||
|
# the reporter's test-kill produces (docs/device-manager.md).
|
||||||
|
{"name": "device-list",
|
||||||
|
"smp": 4,
|
||||||
|
"timeout": 90,
|
||||||
|
"qemu_extra": ["-device", "qemu-xhci,id=xhci",
|
||||||
|
"-device", "usb-kbd,bus=xhci.0",
|
||||||
|
"-device", "usb-mouse,bus=xhci.0"],
|
||||||
|
"expect": r"device-list: 2 devices[\s\S]*"
|
||||||
|
r"device-list: subscribed[\s\S]*"
|
||||||
|
r"device-manager: test mode: killing the reporter[\s\S]*"
|
||||||
|
r"device-list: removed \(device[\s\S]*"
|
||||||
|
r"device-list: added \(device",
|
||||||
|
"fail": r"DANOS-TEST-RESULT: FAIL"},
|
||||||
|
# M18.1: the device manager's hello + restart policy — xHCI hellos clean and
|
||||||
|
# stays; crash-test faults, is restarted with backoff (re-claiming its device
|
||||||
|
# each time), and hits the crash-loop cap (docs/device-manager.md).
|
||||||
|
{"name": "driver-restart",
|
||||||
|
"smp": 4,
|
||||||
|
"timeout": 90,
|
||||||
|
"qemu_extra": ["-device", "qemu-xhci,id=xhci",
|
||||||
|
"-device", "usb-kbd,bus=xhci.0",
|
||||||
|
"-device", "usb-mouse,bus=xhci.0"],
|
||||||
|
"expect": r"usb-xhci-bus: hello acknowledged[\s\S]*"
|
||||||
|
r"device-manager: restarting crash-test[\s\S]*"
|
||||||
|
r"device-manager: crash-test is failing repeatedly",
|
||||||
|
"fail": r"DANOS-TEST-RESULT: FAIL"},
|
||||||
# The initial_ramdisk: the loader ferries a bundle of user binaries; the kernel parses
|
# The initial_ramdisk: the loader ferries a bundle of user binaries; the kernel parses
|
||||||
# it and spawns each as a ring-3 process (here the VFS-server stub heartbeats).
|
# it and spawns each as a ring-3 process (here the VFS-server stub heartbeats).
|
||||||
{"name": "initial-ramdisk",
|
{"name": "initial-ramdisk",
|
||||||
|
|||||||
Reference in New Issue
Block a user