rsemu 0.0.3

//! The device trait, its lifecycle, and the re-entrancy contract.
//!
//! A device is anything a machine is built from: RAM, a CPU, an interrupt
//! controller, a whole chipset. `ROADMAP.md` §4.4 fixes the shape; this module
//! is where the pieces built separately — [`space`](crate::core::space),
//! [`wire`](crate::core::wire), [`clock`](crate::core::clock),
//! [`props`](crate::core::props), [`state`](crate::core::state) — meet.
//!
//! # Two-phase construction
//!
//! `DeviceClass::construct` validates properties and allocates. [`Device::realize`]
//! performs every outward action: mapping regions, connecting wires, attaching
//! to buses. **Nothing observable happens before realize**, which is what lets a
//! resolver build the whole graph and then fail cleanly without having half-wired
//! a machine.
//!
//! # The re-entrancy contract
//!
//! Device methods take `&self`, so state lives behind interior mutability. The
//! naive rule — "never hold a lock across a call into another device" — is
//! unimplementable: an MMIO write to a DMA controller's GO register *must* issue
//! reads while the handler runs, and a PCI config write that moves a BAR remaps
//! memory from inside the device's own write path. Forbidding that forbids the
//! NES.
//!
//! The rule instead: mutate your own state in a short critical section, release
//! it, and *then* act outward — or push the action onto a [`Deferred`] queue and
//! let the caller run it once your handler has returned. See [`Deferred`].

use alloc::boxed::Box;
use alloc::string::{String, ToString};
use alloc::sync::{Arc, Weak};
use alloc::vec::Vec;
use core::any::Any;
use core::fmt;

use crate::core::error::{Error, Result};
use crate::core::hosts::HostObjects;
use crate::core::props::{Props, ValueKind};
use crate::core::sched::{Budget, Consumed, LazyHandle, TickCursor};
use crate::core::space::{RegionRef, RequesterId};
use crate::core::state::{ChunkReader, ChunkWriter};
use crate::core::sync::AtomicU64;
use crate::core::wire::{DmaPeripheral, IntAck, WireId, WireSink, WireSource};

/// How deep a reset goes.
///
/// Distinct kinds because devices genuinely differ: an RTC keeps time across a
/// warm reset but not a cold one, and a bus reset touches only what hangs off
/// that bus.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ResetKind {
    /// Power-on. Every register returns to its documented reset value.
    Cold,
    /// A reset line pulse. Battery-backed and always-on state survives.
    Warm,
    /// A bus-level reset affecting only devices on that bus.
    Bus,
}

/// One declared property of a device class.
///
/// The class declares these once; the registry uses them for `rsemu describe`,
/// and the machine-description validator uses them to reject a typo'd property
/// before the device is ever constructed.
#[derive(Debug, Clone, Copy)]
pub struct PropertySpec {
    /// Property name as it appears in a `.machine` file.
    pub name: &'static str,
    /// What kind of value it takes.
    pub kind: ValueKind,
    /// Whether omitting it is an error.
    pub required: bool,
    /// One line explaining what it does, for `rsemu describe`.
    pub summary: &'static str,
}

/// The static description of a kind of device, plus its constructor.
///
/// Held by value in a `static`, so a class costs nothing at runtime and the
/// registry is a list of references rather than an allocation per class.
pub struct DeviceClass {
    /// Dotted name used in machine files and by the registry (`pci.nvme`).
    pub name: &'static str,
    /// Snapshot version for this class's chunk encoding.
    ///
    /// Bump when `save`/`load` change shape, and register a migration step
    /// (`state::Migrations`) — a version bump with no migration makes every
    /// existing snapshot unloadable.
    pub version: u32,
    /// One line for `rsemu devices`.
    pub summary: &'static str,
    /// Every property this class accepts.
    pub properties: &'static [PropertySpec],
    /// Validate properties and allocate. Performs no outward action.
    pub construct: fn(&Props) -> Result<Box<dyn Device>>,
}

impl fmt::Debug for DeviceClass {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        // The `construct` fn pointer is not Debug and would be noise anyway.
        f.debug_struct("DeviceClass")
            .field("name", &self.name)
            .field("version", &self.version)
            .field("properties", &self.properties.len())
            .finish()
    }
}

/// A device's input pin: the sink to deliver to, and the line the device knows
/// it by.
///
/// The `Arc` is the device's own — **a net holds only a weak reference to its
/// sinks**, because the machine owns devices and a wire merely refers to them.
/// That is `ROADMAP.md` §4.3's weak edge, and it is what stops an IRQ/ack loop
/// leaking.
pub struct SinkPin {
    /// The sink to deliver to.
    pub sink: Arc<dyn WireSink>,
    /// Which of the device's own input lines this is.
    pub line: u32,
}

impl fmt::Debug for SinkPin {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        // `WireSink` is a behaviour, not data; the line number is the part
        // worth printing.
        f.debug_struct("SinkPin").field("line", &self.line).finish()
    }
}

// ---------------------------------------------------------------------------
// exports: a typed handle one device publishes and another holds
// ---------------------------------------------------------------------------

/// Which handle a device is being asked for.
///
/// An open id space rather than an enum, the `pktkit` `EtherType` pattern
/// (`CLAUDE.md`, *Type conventions*): a new kind of handle is a `pub const`
/// somewhere in the tree, not a variant every `match` in the crate has to grow.
///
/// The ids are what a *consumer* names in its own code — a hart asks for
/// [`TIMEBASE`](ExportId::TIMEBASE) — so unlike [`Device::region`] and
/// [`Device::sink`], whose names a human writes in a machine file, a typed
/// constant is the right selector here rather than a string.
///
/// A device with several handles *of one kind* — a two-head display
/// controller — publishes them from child devices with their own instance
/// paths (§4.4's composition). The consumer selects the publisher by path and
/// the kind by id, and those two together are already enough.
///
/// Ids below `0x8000` are this crate's; `0x8000` and above are free for an
/// embedder that adds device classes of its own.
#[repr(transparent)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ExportId(pub u16);

impl ExportId {
    /// The publisher's free-running time counter, counted in the publisher's
    /// own timebase. Transported as [`Export::Cell`].
    ///
    /// The RISC-V case is the motivating one: `mtime` belongs to the CLINT, and
    /// a hart's `time` CSR is architecturally a *view of the platform timer*
    /// rather than a counter the hart owns. Handing the hart the same cell the
    /// CLINT stores into is what makes the two agree, and nothing else in the
    /// framework can express that — a wire carries a level and an address space
    /// carries an access, neither of which is a shared counter.
    pub const TIMEBASE: ExportId = ExportId(1);

    /// The publisher's `/RDY`-style cycle arbiter. Transported as
    /// [`Export::Gate`].
    ///
    /// How a cycle-stealing DMA unit reaches the core it halts without either
    /// naming the other's type. The RP2A03's is the motivating case: OAM DMA
    /// and the DMC's sample fetch are one arbiter, and what it does to the bus
    /// on each stolen cycle is guest-visible.
    pub const CYCLE_GATE: ExportId = ExportId(2);

    /// The APU's DMC sample-fetch seam. Transported as [`Export::Opaque`].
    ///
    /// A contract between two device classes that `core` deliberately does not
    /// learn the type of — the id is named here so an error message can say
    /// what was asked for, and nothing more.
    pub const DMC_FETCH: ExportId = ExportId(3);

    /// The name this id is known by, for an error message.
    ///
    /// `None` for an id nothing in this crate defines, which an embedder's own
    /// ids are.
    #[must_use]
    pub fn name(self) -> Option<&'static str> {
        match self {
            ExportId::TIMEBASE => Some("timebase"),
            ExportId::CYCLE_GATE => Some("cycle gate"),
            ExportId::DMC_FETCH => Some("DMC sample fetch"),
            _ => None,
        }
    }
}

impl fmt::Display for ExportId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self.name() {
            Some(name) => f.write_str(name),
            None => write!(f, "export #{}", self.0),
        }
    }
}

/// A handle a device publishes for another device to hold.
///
/// # Why a closed enum of transports
///
/// [`Device`] has no `Any` in its supertrait chain and is not going to grow
/// one, so there is no route from a `dyn Device` to a concrete device type. The
/// three consumers that have wanted one — a debugger reaching a core's
/// registers, a display reaching a frame buffer, a hart reaching a platform
/// timer — do not actually want the *device*; each wants one narrow, shareable
/// thing it holds. So the **kind** of handle is open ([`ExportId`]) and the
/// **shape** it travels in is closed, which is what keeps the core generic:
/// `core` must never name `NesPpu` (`ROADMAP.md` §0), and it does not have to,
/// because a frame buffer and a register file are shapes long before they are
/// devices.
///
/// # Why only one shape so far
///
/// A variant with no implementor is a guess, and this project's own rule is
/// that an unexecuted design is a plausible-looking guess. The other two
/// consumers are converted separately, and each brings its variant with it:
///
/// * **A frame buffer** — `host::display` today intercepts the `nes.ppu`
///   constructor to keep an `Arc<NesPpu>` of its own. It becomes a `Frames`
///   variant carrying a pull-model view: geometry, a frame serial, and a
///   copy-into-the-caller's-buffer call. That is the `Scanout` trait
///   `host::display` already defines, minus its `std` types — the trait is
///   already the right shape, and only the *acquisition* is a hack.
/// * **A register file** — `host::gdb` today reads byte offsets into the
///   device's snapshot chunk, each table pinned to the class version it was
///   verified against. It becomes a `Regs` variant carrying a descriptor table
///   plus indexed get and set. gdb writes registers as well as reading them, so
///   that shape is read/write where the two above are read-only, and it is why
///   the enum cannot collapse into "a shared buffer".
///
/// Neither is added here: an unused variant fixes its shape before the code
/// that has to live with it exists, which is the mistake this seam is being
/// built to correct.
///
/// The enum is `#[non_exhaustive]`, so adding those variants breaks no
/// downstream `match`.
#[derive(Debug, Clone)]
#[non_exhaustive]
pub enum Export {
    /// A shared 64-bit cell: the publisher stores into it, the consumer samples
    /// it, and neither takes a lock to do so.
    ///
    /// Deliberately a *cell* rather than a monotonic counter — a guest can
    /// write RISC-V's `mtime` backwards, and a shape promising monotonicity
    /// would be lying about the one case it exists for.
    Cell(Arc<AtomicU64>),

    /// A cycle arbiter, for a publisher that can halt a core between bus
    /// cycles. Typed, because [`CycleGate`] is `core`'s own trait.
    Gate(Arc<dyn CycleGate>),

    /// A handle whose type is a contract between the two device classes and
    /// not `core`'s business.
    ///
    /// The escape hatch, and deliberately the least convenient of the three:
    /// the consumer downcasts through
    /// [`BindCtx::export_as`](crate::machine::BindCtx::export_as), and a
    /// mismatch is a configuration error naming both sides. Reach for it only
    /// when the handle's type genuinely cannot live in `core` — the RP2A03's
    /// DMC sample fetch is the case it exists for. A shape that turns up twice
    /// should become a variant of its own instead.
    Opaque(Arc<dyn Any + Send + Sync>),
}

impl Export {
    /// The cycle arbiter, if that is the shape this handle came back in.
    #[must_use]
    pub fn gate(&self) -> Option<&Arc<dyn CycleGate>> {
        match self {
            Export::Gate(g) => Some(g),
            _ => None,
        }
    }

    /// The opaque handle, if that is the shape this handle came back in.
    #[must_use]
    pub fn opaque(&self) -> Option<&Arc<dyn Any + Send + Sync>> {
        match self {
            Export::Opaque(h) => Some(h),
            _ => None,
        }
    }

    /// The cell, if that is the shape this handle came back in.
    #[must_use]
    pub fn cell(&self) -> Option<&Arc<AtomicU64>> {
        match self {
            Export::Cell(cell) => Some(cell),
            _ => None,
        }
    }

    /// What shape this handle came back in, for an error that has to say so.
    #[must_use]
    pub fn shape(&self) -> &'static str {
        match self {
            Export::Cell(_) => "a 64-bit cell",
            Export::Gate(_) => "a cycle gate",
            Export::Opaque(_) => "an opaque handle",
        }
    }
}

/// Anything a machine is built from.
///
/// `Send + Sync` from the first commit rather than once threading "is needed":
/// retrofitting it is a rewrite, and the threading mode is a machine property
/// (`ROADMAP.md` §0).
pub trait Device: Send + Sync + fmt::Debug {
    /// The class this device is an instance of.
    fn class(&self) -> &'static DeviceClass;

    /// Perform every outward action: map regions, connect wires, attach to buses.
    ///
    /// Nothing observable may happen before this is called.
    fn realize(&self, ctx: &mut RealizeCtx<'_>) -> Result<()>;

    /// Undo [`realize`](Device::realize): unmap, disconnect, cancel pending work.
    ///
    /// Defaults to doing nothing, which is correct for a device that maps and
    /// wires nothing. A device that *does* must override it or hot-unplug leaks
    /// a mapping (`ROADMAP.md` §4.4).
    fn unrealize(&self, _ctx: &mut RealizeCtx<'_>) -> Result<()> {
        Ok(())
    }

    /// Return to a documented reset state.
    fn reset(&self, kind: ResetKind);

    /// Serialize architectural state — never derived caches (invariant 3).
    ///
    /// Defaults to writing nothing, for a genuinely stateless device. Anything
    /// with state must override this *and* [`load`](Device::load), and ship the
    /// round-trip test that proves they agree (invariant 6).
    fn save(&self, _w: &mut ChunkWriter<'_>) -> Result<()> {
        Ok(())
    }

    /// Restore what [`save`](Device::save) wrote.
    fn load(&self, _r: &mut ChunkReader<'_>) -> Result<()> {
        Ok(())
    }

    // ---------------------------------------------------------------------
    // How this device connects to the rest of the machine.
    //
    // These live on `Device` rather than in a second trait beside it. The
    // machine layer originally had to invent one, because there is no route
    // from a `dyn Device` to another trait object without `Any` in the
    // supertrait chain — and the cost was that every class had to be
    // registered twice, once for construction and once for connection, with
    // nothing keeping the two tables in step. Every method below is defaulted,
    // so a device implements only what it actually has.
    // ---------------------------------------------------------------------

    /// A region a `map` statement may name.
    ///
    /// `""` is the device's whole aperture, which is what
    /// `map cpubus 0 size 2K = wram` asks for.
    fn region(&self, _name: &str) -> Option<RegionRef> {
        None
    }

    /// The sink for input pin `port`, and the line the device knows it by.
    ///
    /// `sources` is every id that will drive this pin's net. §4.3 requires a
    /// sink to track *which* sources are asserting — that is what makes
    /// wired-OR correct when one source deasserts — and a `FanIn` is told its
    /// sources at construction, while a device is constructed long before any
    /// `WireId` exists. This call is the only moment both are known.
    fn sink(&self, _port: &str, _sources: &[WireId]) -> Option<SinkPin> {
        None
    }

    /// A typed handle this device publishes, for another device to hold.
    ///
    /// Answerable from the moment the device is constructed and for the rest of
    /// its life: the machine layer resolves these while binding, in declaration
    /// order, so a device must not require that it has been bound, realized or
    /// reset first. In practice the handle is allocated in `new` and handed out
    /// by `Arc::clone`.
    ///
    /// A handle is **wiring, not guest state**. It is never serialized, and it
    /// must survive [`reset`](Device::reset). A consumer that keeps one beside
    /// its address space rather than inside its architectural state gets that
    /// right by construction; one that keeps it in the state it replaces on
    /// reset silently unplugs itself the first time the machine reboots.
    ///
    /// This is the **only** route from one device to another's handle. Nearly
    /// every connection between two devices is a region, a wire or a clock
    /// domain, and those stay the way to do it; this covers the few that are
    /// none of the three — a shared counter, a cycle arbiter, a sample fetch.
    /// There were briefly three separate mechanisms for that job and they have
    /// been merged into this one, so a fourth is a design review rather than a
    /// commit.
    ///
    /// Defaults to publishing nothing.
    fn export(&self, _which: ExportId) -> Option<Export> {
        None
    }

    /// Take the output port for pin `port`.
    ///
    /// Called once per net the pin drives; a pin driving two nets is handed two
    /// sources and must drive both.
    ///
    /// # Errors
    ///
    /// If the device drives no such pin.
    fn connect(&self, port: &str, _source: WireSource) -> Result<()> {
        Err(Error::Config {
            at: port.to_string(),
            message: "this device drives no such pin".to_string(),
        })
    }

    /// The acknowledge handler this device offers on output pin `port`.
    ///
    /// **The device must own the `Arc`**, exactly as it owns the one behind a
    /// [`SinkPin`]: what reaches the sink is a `Weak`, so a handler built on
    /// the fly would arrive already dead.
    ///
    /// An interrupt controller returns one here; everything else returns
    /// `None`, which is the answer for a line that carries a level and nothing
    /// more. The realizer asks every driver on a net and hands what it gets to
    /// that net's sinks — see [`IntAck`] for why the vector travels with the
    /// wire rather than through a device handle.
    fn int_ack(&self, _port: &str) -> Option<Arc<dyn IntAck>> {
        None
    }

    /// Told what answers the acknowledge cycle on input pin `port`.
    ///
    /// A CPU with a vectored interrupt input keeps this and calls
    /// [`IntAck::acknowledge`] when it takes the interrupt. The reference is
    /// **weak**: the machine owns both devices, and a CPU that kept its
    /// controller alive would close a cycle nothing could drop.
    ///
    /// Called once per driver on the net, before reset and before the realize
    /// sweep — so a device may be handed **several**, and must keep them all:
    /// two 68000 controllers on different `IPL` pins are two calls, and one
    /// controller driving two pins of the same encoding is two calls naming the
    /// same object. [`IntAckHandlers`](crate::core::wire::IntAckHandlers) is
    /// that list, ready made.
    fn attach_int_ack(&self, _port: &str, _ack: Weak<dyn IntAck>) {}

    /// The DMA transfer interface this device offers on output pin `port`.
    ///
    /// A peripheral that raises `DRQ` returns one here; the realizer hands it
    /// to the controller that is the sink on that net. As with
    /// [`int_ack`](Device::int_ack), **the device must own the `Arc`** — what
    /// reaches the controller is a `Weak`.
    fn dma_peripheral(&self, _port: &str) -> Option<Arc<dyn DmaPeripheral>> {
        None
    }

    /// Told which peripheral raises `DRQ` on input pin `port`.
    ///
    /// A DMA controller keeps this and moves bytes through it when the channel
    /// is unmasked and the request arrives. Weak, for the same reason
    /// [`attach_int_ack`](Device::attach_int_ack) is.
    fn attach_dma_peripheral(&self, _port: &str, _peer: Weak<dyn DmaPeripheral>) {}

    /// Announce the level `port` idles at — the realize sweep (§4.3).
    ///
    /// A device whose outputs idle low may ignore this, since a fresh net is
    /// already low. An inverter, or anything whose output is a function of its
    /// inputs, must drive here or the machine comes up inconsistent.
    fn announce(&self, _port: &str) {}

    /// Whether this device forwards a level within one instant, with no state.
    ///
    /// Feeds the realize ordering: a cycle of *combinational* devices has no
    /// topological order and is rejected, while a cycle through a stateful one
    /// is an ordinary handshake (§4.3). A device is sequential until it says
    /// otherwise, which is the safe default — claiming to be combinational
    /// when you are not turns a legitimate handshake into a rejected machine.
    fn combinational(&self) -> bool {
        false
    }

    /// Whether the scheduler should hand this device execution budgets.
    ///
    /// True for a CPU, a DMA engine, a coprocessor. Such a device needs a clock
    /// domain, and realize refuses one without.
    fn is_runnable(&self) -> bool {
        false
    }

    /// Run until the budget is exhausted, and report what was consumed (§4.2).
    ///
    /// Takes `&self`: a device is shared, and holds its state behind interior
    /// mutability.
    fn run(&self, _budget: Budget) -> Consumed {
        Consumed::default()
    }

    /// Told where to publish its own tick counter as it runs.
    ///
    /// A core that is sampled mid-budget — every CPU on a machine with a
    /// lazily-advanced PPU — writes its cycle count here on each cycle, so
    /// catch-up aims at the tick the access really happened on rather than at
    /// the start of the quantum (`ROADMAP.md` §4.2, and
    /// [`TickCursor`]). Called once, by the
    /// machine layer, for every runnable device; ignoring it is legitimate and
    /// costs only accuracy inside one quantum.
    fn attach_cursor(&self, cursor: TickCursor) {
        let _ = cursor;
    }

    /// An event this device posted has come due.
    ///
    /// Outward actions — driving a wire, starting a burst — go on `deferred`,
    /// which the caller drains the moment this returns (§4.7).
    fn event(&self, _token: u64, _deferred: &mut Deferred) {}

    // ---------------------------------------------------------------------
    // Lazily advanced devices — sync-on-access (`ROADMAP.md` §4.2).
    //
    // The queue handles *scheduled* behaviour; it cannot handle *sampled*
    // behaviour. A 6502 reads `$2002` at an arbitrary cycle and the PPU has to
    // be at exactly that dot. So a device may declare that it holds its own
    // tick and is caught up before it is touched, and the machine layer
    // registers it with the scheduler on its clock domain.
    //
    // Every method here takes `&self`, like the rest of the surface: a device
    // is shared and its state lives behind interior mutability. The scheduler's
    // `LazyDevice` takes `&mut self` instead, and the machine layer adapts
    // between the two — which is also where the `&mut` exclusivity that makes
    // `advance_to` non-re-entrant comes from.
    //
    // # What an implementation must guarantee
    //
    // [`current_tick`](Device::current_tick) and
    // [`next_event_tick`](Device::next_event_tick) are called with the
    // scheduler's slot lock held, at
    // [`LockRank::LEAF`](crate::core::sync::LockRank::LEAF) — the rank nothing
    // nests under. **Neither may take a lock**: publish the two numbers into
    // atomics as the device advances. `advance_to` is called with no lock held
    // at all, so it is free to take its own and to reach its own bus.
    // ---------------------------------------------------------------------

    /// Whether this device advances only when somebody looks at it.
    ///
    /// A device that says yes needs a clock domain, and realize refuses one
    /// without — its tick is counted in that domain and catch-up has no target
    /// otherwise.
    fn is_lazy(&self) -> bool {
        false
    }

    /// The tick, in the device's own clock domain, that it has simulated up to.
    ///
    /// Must not take a lock — see the note above.
    fn current_tick(&self) -> u64 {
        0
    }

    /// Simulate forward until [`current_tick`](Device::current_tick) reaches
    /// `tick`.
    ///
    /// Never called with a tick in the past, and never with any lock held, so
    /// an implementation may take its own state lock and reach its own bus.
    /// Running backwards is a no-op, not an error.
    fn advance_to(&self, tick: u64) {
        let _ = tick;
    }

    /// The device's own next internal event, if it has one.
    ///
    /// Catch-up never crosses it: past that tick the device's behaviour
    /// changes, and simulating through it in one step would compute the wrong
    /// answer. It is also what the scheduler bounds a round by, so that a
    /// CPU is not let run thousands of cycles past the dot an NMI was raised
    /// on. `None` means "nothing pending" and catch-up runs to the present.
    ///
    /// **Must be strictly greater than [`current_tick`](Device::current_tick)**
    /// or catch-up makes no progress and the device stalls where it stands.
    /// Must not take a lock — see the note above.
    fn next_event_tick(&self) -> Option<u64> {
        None
    }

    /// Whether this device has to be caught up on **every** cycle of whatever
    /// is running, rather than only at its own next event.
    ///
    /// [`next_event_tick`](Device::next_event_tick) is enough for a device
    /// whose outputs change only at instants it can name. It is not enough for
    /// one whose output is *sampled* continuously by a core it does not know
    /// about: the NES PPU drives `/NMI`, the 6502 looks at that pin once per
    /// CPU cycle, and whether the pin was up or down on a given cycle is a
    /// question with a different answer three dots later. A device that says
    /// yes is caught up from inside the core's own cycle loop
    /// ([`TickCursor`]), which costs a catch-up
    /// per cycle and buys dot-exact sampling.
    ///
    /// Default false, because most lazily-advanced devices are read rather than
    /// watched, and the ones that are read are caught up by the access itself.
    fn sampled_every_cycle(&self) -> bool {
        false
    }

    /// Told the handle that catches this device up.
    ///
    /// This is how sync-on-access reaches the code that answers an access:
    /// `MemOps::read` takes `&self` and runs several frames below whoever owns
    /// the scheduler, so the device keeps the handle and calls
    /// [`LazyHandle::sync`] at the top of its own read and write paths. Called
    /// once, by the machine layer, after the device is registered.
    ///
    /// A device that is not lazy never gets one.
    fn attach_lazy(&self, handle: LazyHandle) {
        let _ = handle;
    }
}

/// What a `/RDY`-style arbiter does with the cycle *after* the one a core has
/// just charged.
///
/// The three outcomes are the three things a halted 6502's bus can be doing,
/// and keeping them apart is the whole point: a stolen cycle is invisible to
/// the core's own address, while a held one repeats the core's read on the bus
/// where devices can see it.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Arbitration {
    /// Nothing is pending. The core keeps the bus.
    Release,
    /// The arbiter is holding the core but is not driving the bus itself, so
    /// the core's own read happens again and is externally visible — which is
    /// how a DMA's halt and alignment cycles clock a NES controller port or
    /// advance `$2007`.
    Hold,
    /// The arbiter held the core for the cycle it has just charged and is
    /// letting go now.
    ///
    /// The difference from [`Arbitration::Release`] is one cycle: the read the
    /// core just made was a *halt* cycle, so it has to make it again, and the
    /// core loses exactly one cycle and no more. A DMA that is scheduled and
    /// then withdrawn before it can do anything — the NES's aborted DMC fetch —
    /// costs precisely this.
    Halted,
    /// The arbiter drove the bus this cycle, leaving this byte on it. The core
    /// charges a cycle, makes no access of its own, and takes the byte into its
    /// own data-bus latch — a DMA cycle is a bus cycle, and the next open-bus
    /// read the core makes answers with whatever the DMA left there.
    Steal(u8),
}

/// A bus master that can stop a core mid-instruction: the `/RDY` pin.
///
/// A cycle-stealing DMA unit is not a device that runs on its own schedule —
/// it runs *instead of* the core, cycle by cycle, and what it does to the bus
/// on each of those cycles is guest-visible. So the core consults its arbiter
/// after every bus cycle it charges, and the arbiter answers with what happens
/// to the next one.
///
/// The core may only be halted on a **read**: that is a property of the 6502's
/// `/RDY` input and of every part that copies it, and it is why `write` is a
/// parameter rather than something the arbiter has to infer. An arbiter that
/// wants the bus during a write cycle says [`Arbitration::Release`] and asks
/// again next cycle.
///
/// # Sources
///
/// NESdev wiki, [DMA](https://www.nesdev.org/wiki/DMA): "the 6502 core repeats
/// the last read cycle indefinitely, making no forward progress nor handling
/// interrupts", and "the CPU only permits halting during read cycles".
pub trait CycleGate: Send + Sync + fmt::Debug {
    /// Consulted after every bus cycle a core charges.
    ///
    /// `cycle` is the core's own cycle counter *after* that cycle, `held` is
    /// the address the core is driving, `bus` is the byte the core last left on
    /// the data bus — an arbiter that reads an undecoded address gets it back —
    /// and `write` says whether the cycle was a write.
    fn arbitrate(&self, cycle: u64, held: u64, bus: u8, write: bool) -> Arbitration;
}

/// A device that performs its own accesses: DMA engines, bus masters, host
/// controllers, and every CPU.
///
/// A device that can only *respond* cannot model NES OAM DMA, an 8237, a PCI
/// bus master, virtio descriptor fetch, or a USB controller walking transfer
/// rings — which is most devices from the PC phase onward, and two in the NES.
/// The requester id travels in `MemAttrs` so an IOMMU can translate it.
pub trait Initiator {
    /// This initiator's identity, as it appears in `MemAttrs::requester`.
    fn requester(&self) -> RequesterId;
}

/// An action a device wants performed *after* its handler returns.
///
/// The payload is deliberately a closure rather than an enum of known actions:
/// the core must not know what devices exist (invariant 1), and a DMA burst, a
/// wire change and a remap have nothing in common but their timing.
type Action = Box<dyn FnOnce() + Send>;

/// The deferred-action queue that makes the re-entrancy contract workable.
///
/// A handler that needs to act outward — start a DMA burst, drop an interrupt
/// line, remap a BAR — pushes the action here instead of doing it inline. The
/// caller drains the queue once the handler has returned and its critical
/// section is released.
///
/// This is what turns re-entrancy from an accident into a decision. Without it,
/// the same code deadlocks under the `native-std` sync backend and panics under
/// `single`, which is a miserable way to discover a design problem.
#[derive(Default)]
pub struct Deferred {
    actions: Vec<Action>,
    /// Set while [`drain`](Deferred::drain) is running, so an action that
    /// defers further work is queued rather than recursing.
    draining: bool,
}

impl fmt::Debug for Deferred {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Deferred")
            .field("pending", &self.actions.len())
            .field("draining", &self.draining)
            .finish()
    }
}

impl Deferred {
    /// An empty queue.
    pub fn new() -> Deferred {
        Deferred {
            actions: Vec::new(),
            draining: false,
        }
    }

    /// Queue an action to run once the current handler has returned.
    pub fn push(&mut self, action: impl FnOnce() + Send + 'static) {
        self.actions.push(Box::new(action));
    }

    /// Whether anything is queued.
    pub fn is_empty(&self) -> bool {
        self.actions.is_empty()
    }

    /// How many actions are queued.
    pub fn len(&self) -> usize {
        self.actions.len()
    }

    /// Run every queued action, in the order they were pushed.
    ///
    /// Actions queued *by* an action run in the same drain, after the ones
    /// already present — the queue is drained iteratively rather than
    /// recursively, so a device that defers work from a deferred action costs
    /// no stack. Returns the number of actions run.
    ///
    /// Re-entering `drain` is a no-op returning zero, which keeps a nested call
    /// from running actions out of order.
    pub fn drain(&mut self) -> usize {
        if self.draining {
            return 0;
        }
        self.draining = true;
        let mut ran = 0;
        // Not a `for` over `actions`: an action may push more, and those must
        // run in this drain rather than being stranded until the next one.
        while !self.actions.is_empty() {
            let batch = core::mem::take(&mut self.actions);
            for action in batch {
                action();
                ran += 1;
            }
        }
        self.draining = false;
        ran
    }
}

/// What a device is handed during [`Device::realize`].
///
/// Holds the instance's identity and its deferred queue. Access to address
/// spaces, the clock forest and wires is added as the machine assembly layer
/// lands; realize is where those connections are made, so this is the type that
/// grows.
#[derive(Debug)]
pub struct RealizeCtx<'a> {
    path: &'a str,
    requester: RequesterId,
    deferred: &'a mut Deferred,
    hosts: &'a HostObjects,
}

impl<'a> RealizeCtx<'a> {
    /// Build a context for the instance at `path`.
    pub fn new(
        path: &'a str,
        requester: RequesterId,
        deferred: &'a mut Deferred,
        hosts: &'a HostObjects,
    ) -> Self {
        RealizeCtx {
            path,
            requester,
            deferred,
            hosts,
        }
    }

    /// The instance path of the device being realized (`cpu`, `pci.0.nvme`).
    ///
    /// This is the snapshot chunk key (`ROADMAP.md` §4.5), so it is stable for
    /// the life of the machine.
    pub fn path(&self) -> &str {
        self.path
    }

    /// This device's requester id, for accesses it initiates.
    pub fn requester(&self) -> RequesterId {
        self.requester
    }

    /// The build's host objects.
    ///
    /// The same table `new(props)` acquired ports and pads from
    /// ([`core::hosts`](crate::core::hosts)), reachable here for the other half
    /// of the problem: **announcing** yourself into something a sibling will
    /// read. That is an outward action and belongs in this phase, which is why
    /// `dev::riscv::dt` publishes its device-tree describer from here and not
    /// from a constructor.
    pub fn hosts(&self) -> &'a HostObjects {
        self.hosts
    }

    /// Queue an action to run after realize completes.
    pub fn defer(&mut self, action: impl FnOnce() + Send + 'static) {
        self.deferred.push(action);
    }

    /// A realize-time failure that names the instance.
    ///
    /// "cannot map at 0x2000" is unactionable in a machine with forty devices;
    /// the path is what makes it a bug report.
    pub fn error(&self, message: impl Into<String>) -> Error {
        Error::Config {
            at: String::from(self.path),
            message: message.into(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use alloc::string::ToString;
    use alloc::sync::Arc;
    use core::sync::atomic::{AtomicU32, Ordering};

    #[test]
    fn deferred_actions_run_in_push_order() {
        let log = Arc::new(AtomicU32::new(0));
        let mut q = Deferred::new();
        for i in 1..=3u32 {
            let log = Arc::clone(&log);
            // Base-10 shifting records order, not just occurrence.
            q.push(move || {
                log.store(log.load(Ordering::Relaxed) * 10 + i, Ordering::Relaxed);
            });
        }
        assert_eq!(q.len(), 3);
        assert_eq!(q.drain(), 3);
        assert_eq!(log.load(Ordering::Relaxed), 123);
        assert!(q.is_empty());
    }

    #[test]
    fn an_action_may_queue_more_work_without_recursing() {
        // The case the contract exists for: a deferred DMA completion raising an
        // interrupt, which defers again. It must run in this drain, not the next.
        let count = Arc::new(AtomicU32::new(0));
        let mut q = Deferred::new();
        let c = Arc::clone(&count);
        q.push(move || {
            c.fetch_add(1, Ordering::Relaxed);
        });
        assert_eq!(q.drain(), 1);
        assert_eq!(count.load(Ordering::Relaxed), 1);
    }

    #[test]
    fn draining_an_empty_queue_is_free() {
        let mut q = Deferred::new();
        assert_eq!(q.drain(), 0);
        assert!(q.is_empty());
    }

    /// A device that publishes one cell and nothing else.
    #[derive(Debug)]
    struct Publisher {
        cell: Arc<AtomicU64>,
    }

    static PUBLISHER_CLASS: DeviceClass = DeviceClass {
        name: "test.publisher",
        version: 1,
        summary: "publishes a timebase cell, for the export tests",
        properties: &[],
        construct: |_| {
            Ok(Box::new(Publisher {
                cell: Arc::new(AtomicU64::new(0)),
            }))
        },
    };

    impl Device for Publisher {
        fn class(&self) -> &'static DeviceClass {
            &PUBLISHER_CLASS
        }
        fn realize(&self, _ctx: &mut RealizeCtx<'_>) -> Result<()> {
            Ok(())
        }
        fn reset(&self, _kind: ResetKind) {
            // The point of the reset test below: a reset must not replace the
            // published cell, only what the device counts into it.
            self.cell.store(0, Ordering::Relaxed);
        }
        fn export(&self, which: ExportId) -> Option<Export> {
            (which == ExportId::TIMEBASE).then(|| Export::Cell(Arc::clone(&self.cell)))
        }
    }

    #[test]
    fn a_device_publishes_nothing_unless_it_says_so() {
        let d = Publisher {
            cell: Arc::new(AtomicU64::new(0)),
        };
        assert!(d.export(ExportId(0x8000)).is_none(), "an unknown id");
        assert!(d.export(ExportId::TIMEBASE).is_some());
    }

    #[test]
    fn an_exported_cell_is_shared_and_survives_a_reset() {
        let d = Publisher {
            cell: Arc::new(AtomicU64::new(0)),
        };
        let held = d
            .export(ExportId::TIMEBASE)
            .expect("published")
            .cell()
            .expect("a cell")
            .clone();
        d.cell.store(42, Ordering::Relaxed);
        assert_eq!(held.load(Ordering::Relaxed), 42, "the consumer sees writes");
        // Wiring, not guest state: the handle still points at the device's own
        // cell afterwards, which is what stops a reboot unplugging the clock.
        d.reset(ResetKind::Cold);
        d.cell.store(7, Ordering::Relaxed);
        assert_eq!(held.load(Ordering::Relaxed), 7);
    }

    #[test]
    fn export_ids_name_themselves_for_an_error_message() {
        assert_eq!(ExportId::TIMEBASE.to_string(), "timebase");
        assert_eq!(ExportId(0x8001).to_string(), "export #32769");
        assert_eq!(ExportId(0x8001).name(), None);
        assert_eq!(
            Export::Cell(Arc::new(AtomicU64::new(0))).shape(),
            "a 64-bit cell"
        );
    }

    #[test]
    fn realize_errors_name_the_instance() {
        let mut q = Deferred::new();
        let ctx_hosts = crate::core::HostObjects::new();
        let ctx = RealizeCtx::new("pci.0.nvme", RequesterId(7), &mut q, &ctx_hosts);
        assert_eq!(ctx.path(), "pci.0.nvme");
        assert_eq!(ctx.requester(), RequesterId(7));
        let e = ctx.error("cannot map at 0x2000").to_string();
        assert!(e.contains("pci.0.nvme"), "{e}");
        assert!(e.contains("cannot map"), "{e}");
    }

    #[test]
    fn a_context_can_defer_during_realize() {
        let ran = Arc::new(AtomicU32::new(0));
        let mut q = Deferred::new();
        {
            let ctx_hosts = crate::core::HostObjects::new();
            let mut ctx = RealizeCtx::new("cpu", RequesterId::ANONYMOUS, &mut q, &ctx_hosts);
            let r = Arc::clone(&ran);
            ctx.defer(move || {
                r.fetch_add(1, Ordering::Relaxed);
            });
            // Nothing has happened yet — that is the whole point of deferring.
            assert_eq!(ran.load(Ordering::Relaxed), 0);
        }
        q.drain();
        assert_eq!(ran.load(Ordering::Relaxed), 1);
    }
}