Daniel Samson
1d7850239d
P2 of docs/establishment-planes-plan.md. usb-storage serves nameless — one process per stick cannot share an exclusive bind, and a second stick used to die silently on -EBUSY before ever helloing. Its one hello now moves both directions at once: the block-serving endpoint up, its controller channel down. fat finds its volume through the manager — a new `.consumer` role asks for the channel of the driver BOUND TO a device (distinct from the device's reporter), found by enumerating the tree for the mass-storage identity. fat stays single-volume; the boot-volume-by-content choice is M21. The conversion immediately caught a live truncation of exactly the audit's shape: ChildEntry grew to 32 bytes, one enumerate reply holds ~7, and a real tree carries a dozen ACPI nodes before the first USB child — the storage entry silently never fit (the protocol comment already said "paging joins the protocol if a tree ever outgrows one packet"). enumerate is now paged: Header.target is the start cursor, a short page is the end; device-list's page-0 read is unchanged. Grant rows move with the code: the block bind and fat's block open die, fat gains open device-manager. Gate: 18 cases green including the registry trio, device-list, and both IOMMU storage variants.
80 lines
3.9 KiB
Zig
80 lines
3.9 KiB
Zig
//! Block-device client: the helper a filesystem uses to read and write a block
|
|
//! device (a USB stick, via usb-storage) without hand-rolling the block-protocol
|
|
//! IPC. Layered over `ipc` and the shared `block-protocol` wire format, like
|
|
//! `runtime.usb` over the transfer protocol.
|
|
//!
|
|
//! Transfers name a caller-owned DMA buffer by physical address (from
|
|
//! `runtime.dma.alloc`), so whole sectors move without crossing the IPC size
|
|
//! limit — the same handoff usb-storage uses toward the controller.
|
|
|
|
const envelope = @import("envelope");
|
|
const ipc = @import("ipc");
|
|
const block_protocol = @import("block-protocol");
|
|
|
|
const Protocol = block_protocol.Protocol;
|
|
|
|
pub const Geometry = struct { block_size: u32, block_count: u64 };
|
|
|
|
pub const Device = struct {
|
|
endpoint: ipc.Handle,
|
|
|
|
/// The device's block size and total block count.
|
|
pub fn geometry(self: Device) ?Geometry {
|
|
var reply: [block_protocol.message_maximum]u8 = undefined;
|
|
const answered = self.call(.geometry, {}, null, &reply) orelse return null;
|
|
const result = Protocol.decodeReply(.geometry, answered) orelse return null;
|
|
return .{ .block_size = result.block_size, .block_count = result.block_count };
|
|
}
|
|
|
|
/// Hand the block server a DMA-region capability (`handle` — from a `shareable`
|
|
/// dma_alloc) so it forwards it to the controller and the buffer's physical
|
|
/// addresses become reachable by the device. Call once per buffer before naming it
|
|
/// in `read`/`write`. Harmless success when no IOMMU is enforcing.
|
|
pub fn attach(self: Device, handle: ipc.Handle) bool {
|
|
var reply: [block_protocol.message_maximum]u8 = undefined;
|
|
return self.call(.attach, {}, handle, &reply) != null;
|
|
}
|
|
|
|
/// Read `count` blocks starting at `lba` into the DMA buffer at `physical`.
|
|
pub fn read(self: Device, lba: u64, count: u32, physical: u64) bool {
|
|
var reply: [block_protocol.message_maximum]u8 = undefined;
|
|
return self.call(.read, .{ .lba = lba, .count = count, .physical = physical }, null, &reply) != null;
|
|
}
|
|
|
|
/// Write `count` blocks starting at `lba` from the DMA buffer at `physical`.
|
|
pub fn write(self: Device, lba: u64, count: u32, physical: u64) bool {
|
|
var reply: [block_protocol.message_maximum]u8 = undefined;
|
|
return self.call(.write, .{ .lba = lba, .count = count, .physical = physical }, null, &reply) != null;
|
|
}
|
|
|
|
/// Commit any device write cache to stable media (SCSI SYNCHRONIZE CACHE), so
|
|
/// prior writes survive a power-off. A filesystem calls this before the machine
|
|
/// goes down; no data transfer, so the buffer arguments are unused.
|
|
pub fn flush(self: Device) bool {
|
|
var reply: [block_protocol.message_maximum]u8 = undefined;
|
|
return self.call(.flush, {}, null, &reply) != null;
|
|
}
|
|
|
|
/// One request at the driver. `target` is always 0: one endpoint per device, so
|
|
/// there is no object within the peer to address.
|
|
fn call(
|
|
self: Device,
|
|
comptime operation: Protocol.Operation,
|
|
request: Protocol.RequestOf(operation),
|
|
capability: ?ipc.Handle,
|
|
reply: []u8,
|
|
) ?[]u8 {
|
|
var packet: [block_protocol.message_maximum]u8 = undefined;
|
|
const framed = Protocol.encodeRequest(operation, 0, request, &.{}, &packet) orelse return null;
|
|
const answer = ipc.callCap(self.endpoint, framed, reply, capability) catch return null;
|
|
const status = envelope.statusOf(reply[0..answer.len]) orelse return null;
|
|
if (status.status != 0) return null;
|
|
return reply[0..answer.len];
|
|
}
|
|
};
|
|
|
|
// There is deliberately no open-by-name here: `block` is not a registry name.
|
|
// One storage process serves each volume, and a consumer receives its volume's
|
|
// channel from the device manager (establishment by lineage, communication.md
|
|
// "Establishment: two planes"), then wraps it: `block.Device{ .endpoint = c }`.
|