rustdv-sim 0.3.0

The cocotb-analog core: simulator-driven async executor, tasks, triggers, typed handles, clock, sim-aware queues (design-doc §4).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! # rustdv-sim
//!
//! The cocotb-analog core (design-doc §4): a bespoke single-threaded
//! executor driven by simulator callbacks (D4.1 — not tokio), the task
//! model, the trigger inventory, typed signal handles with buffered
//! writes, `Clock`, and sim-aware `Event`/`Lock`/`Queue`.
//!
//! Control-flow contract (§4.1): a GPI/VPI callback fires → subscribed
//! tasks are woken → the run queue is drained to exhaustion
//! ([`Executor::run_until_idle`]) → control returns to the simulator.

// Test executables need vpi_* symbol definitions (the simulator provides
// them for the real cdylib) — see rustdv-vpi-stubs.
#[cfg(test)]
use rustdv_vpi_stubs as _;

pub mod clock;
pub mod combinators;
pub mod executor;
pub mod handle;
pub mod log;
pub mod path;
pub mod phase;
pub mod queue;
pub mod rng;
pub mod simulator_trace;
pub mod sync;
pub mod testing;
pub mod time;
pub mod triggers;
pub mod verilator_trace;

pub use clock::Clock;
pub use combinators::{Either, TimeoutError, first2, join_all, join2, with_timeout};
pub use executor::{Executor, TaskError, TaskHandle, TaskId, TaskState, spawn, spawn_named};
pub use handle::{
    AggregateHandle, HierarchyHandle, LogicHandle, RealHandle, SimHandle, StringHandle,
};
pub use path::RustdvPath;
pub use phase::{next_time_step, read_only, read_write, service_read_only};
pub use queue::Queue;
pub use rng::Rng;
pub use sync::{Event, Lock, LockGuard};
pub use time::{SimDuration, sim_time_ns, sim_time_steps};
pub use triggers::{NullTrigger, Timer};

pub use rustdv_gpi::{BigUint, HandleError, Logic, LogicArray, ValueError};

/// Initialize the sim context: install a fresh executor and phase hub on
/// this thread. Called once by the runner at start-of-simulation.
pub fn init() -> Executor {
    phase::init_hub();
    executor::init()
}