en reference feature map

源文档 / Source · 中文

Features, scenarios, and regressions

This index connects user needs to guides, runnable examples, and behavior regressions. Test links identify relevant groups and what they check; file existence and test counts are not substitutes for behavioral verification.

Feature	Scenario and guide	Example / corresponding tests
Getting started	Assertions, clocks, boundaries, components, models, pipelining, failures, coverage	Tutorial; examples/getting_started joins default regression; test_quickstart_tutorial checks snippets and failure exercises; native_lab runs explicitly
Simulation lifecycle	Execution: Backend reuse, pauses, exclusive lease, settling, cleanup	runtime, observer: order, cancellation, external-task isolation, non-settling errors
Clocks and conditions	Triggers: stable phases, default sampling, enter/change/each_sample, ValueChange, simulation/wall timeouts	basic_execution, native regression: real XClock, wide signals, X/Z, registration baselines, phases
Composed events and external inputs	AnyOf/AllOf, Queue/Event/TaskComplete, explicit HTTP/external-task synchronization	adapters, HTTP: composition, timeouts, shield ownership
Compiled patterns	Conditions and Sequence/FSM: compilation, windows, holds, restart, branch priority	runtime, native: matching, caching, native execution; pattern boundaries: windows, expiry restart, interrupted holds
Persistent subscriptions	Synchronous capture and async handlers, no registration gaps, lossless/latest, errors	example, regression: snapshots, order, capacity, failure cleanup
Data and binding	Bundle/Field/packed: snapshots, widths, metadata, dimensions, bit order, stride, offset, four-state data	data regression: shape, direction, signal identity; native tests: live subviews, padding, widths
Drivers	Templates: synchronous calls/immediate submission, single/fixed-stage timing, capacity/max_active, locks, idle, cancellation	pipeline examples; Sync, Async, staged, handoffs: acceptance ticks, overlap, exclusion, fairness, no bubbles, cleanup
Monitors	Sampling and passive observations: explicit triggers, immutable records, capacity, closing, failures	sampling, lifecycle: both built-in Monitors, both Backends, all-waiter wakeup
Agents and models	Instances and connect: Driver kinds, state updates, shared models, batches, one consumer, lifecycle	stateful example, native integration, unit cleanup: acceptance, expected overrides, unawaited errors, startup rollback
Scoreboard and transactions	Direct and response checking: differences, FIFO/key/fixed latency, cycle windows, drain/finish, cancellation	example, association, XTransfer, native deadlines: missing/late/duplicate responses, response before acceptance notification, deadline priority, active-table release
Optional protocol helpers	ReadyValid/Decoupled, role views, ReadyValidMonitor, drive helper	protocols, data/native regressions: handshake acceptance, backpressure, candidate sampling, cleanup
Functional coverage	Requirements across cases, bins/crosses/gates/goals, illegal hits, snapshot fields, atomic sampling, persistence/merge/reset	example, regression: hit priority, gates, overlap, cross limits, weighting, schema, merge
Reports and artifacts	Run recipe: seeds, budgets, one-consumer coverage, failure export, JSON/HTML/LCOV	recipe tests, artifacts, reports: failure retention, counts, escaping, directory protection, source pages

Run the corresponding regressions

After installing the test extra from the repository root, python3 -m pytest -q runs framework regressions, the beginner tutorial, and artifact examples. Native cases skip without xspcomm; releases and complete acceptance must use:

python3 -m pytest -q --require-xspcomm
mkdocs build --strict

To check a feature, pass its test file, for example:

python3 -m pytest -q tests/interfaces/test_agent.py tests/integration/test_agent_native.py --require-xspcomm
python3 -m pytest -q tests/coverage

MemoryBackend tests check Python semantics; native XClock tests check actual Backend sampling and scheduling. Neither replaces the other. Real DUT build/artifact dependencies such as e203/cache are outside the default regression; see project examples. This table does not claim arbitrary RTL has been verified.

New capabilities should update their guide, minimal runnable scenario, and behavior regression. Prose-only edits do not need tests mirroring implementation. See API for exports and limitations for supported boundaries.