Skip to main content

TieredBackend

Struct TieredBackend 

Source
pub struct TieredBackend { /* private fields */ }
Expand description

A SimBackend that interprets immediately and promotes to generated code as soon as background compilation completes.

Implementations§

Source§

impl TieredBackend

Source

pub fn new(laid_out: &LaidOutProgram, options: &SimulatorOptions) -> Self

Build a tiered simulation targeting this host’s default compiled tier: ready to run immediately on the interpreter while the compiled tier is prepared in the background.

The native tier observes cancellation (see TieredBackend::cancel_background_compilation); the Cranelift tier runs to completion once started.

Source

pub fn is_compiled(&self) -> bool

Whether the compiled tier has been adopted.

Source

pub fn execution_stats(&self) -> TieredExecutionStats

Return deterministic lifecycle and execution measurements.

Source

pub fn start_execution_timing(&mut self)

Start measuring time to promotion for a benchmark workload.

Source

pub fn finish_execution_timing(&mut self) -> Option<TieredExecutionTiming>

Stop timing and return the observed promotion interval.

Source

pub fn promotion_error(&self) -> Option<&SimulatorError>

Why promotion has not happened yet, for diagnostics.

Returns None once running fully compiled or while background compilation is still in progress.

Source

pub fn cancel_background_compilation(&mut self) -> bool

Request cancellation of background compilation.

The native-tier worker unwinds at its next task boundary and the simulation stays on the interpreter permanently; the reason becomes retrievable through TieredBackend::promotion_error. A result that already reached the channel (or arrives afterwards, for example from a tier that ignores the token) is rejected so cancellation is honored regardless of compiler timing. Returns whether a background compilation was still pending, so callers that only want to reclaim a finished worker can ignore the call cheaply.

Trait Implementations§

Source§

impl Drop for TieredBackend

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl SimBackend for TieredBackend

Source§

type Event = TieredEventRef

The event handle type produced by this backend.
Source§

fn eval_comb(&mut self) -> Result<(), SimulatorErrorCode>

Source§

fn eval_apply_ff_at( &mut self, event: TieredEventRef, ) -> Result<(), SimulatorErrorCode>

Evaluate and apply a flip-flop domain for the given event.
Source§

fn eval_comb_apply_ff_at( &mut self, event: TieredEventRef, ) -> Result<(), SimulatorErrorCode>

Evaluate combinational logic and then evaluate/apply one flip-flop domain. Backends may override this to compile the two phases as one function; the default preserves the same ordering with two calls.
Source§

fn eval_comb_apply_ff_many_at( &mut self, event: TieredEventRef, count: u64, ) -> (u64, Result<(), SimulatorErrorCode>)

Execute up to count identical fused ticks. The returned count is the number of iterations completed before a runtime event or error forced a return to the host. Backends without an in-function loop execute one iteration so the caller can preserve per-tick observation semantics.
Source§

fn eval_only_ff_at( &mut self, event: TieredEventRef, ) -> Result<(), SimulatorErrorCode>

Evaluate FF domain without applying (for cascaded clocks).
Source§

fn apply_ff_at( &mut self, event: TieredEventRef, ) -> Result<(), SimulatorErrorCode>

Apply (commit) an already-evaluated FF domain.
Source§

fn resolve_signal(&self, addr: &AbsoluteAddr) -> SignalRef

Source§

fn resolve_event(&self, addr: &AbsoluteAddr) -> TieredEventRef

Source§

fn resolve_event_opt(&self, addr: &AbsoluteAddr) -> Option<TieredEventRef>

Source§

fn resolve_eval_only_event(&self, addr: &AbsoluteAddr) -> Option<TieredEventRef>

Source§

fn resolve_apply_event(&self, addr: &AbsoluteAddr) -> Option<TieredEventRef>

Source§

fn set<T: Copy>(&mut self, signal: SignalRef, value: T)

Source§

fn set_wide(&mut self, signal: SignalRef, value: BigUint)

Source§

fn set_four_state(&mut self, signal: SignalRef, value: BigUint, mask: BigUint)

Source§

fn get(&self, signal: SignalRef) -> BigUint

Source§

fn get_as<T: Default + Copy>(&self, signal: SignalRef) -> T

Source§

fn get_four_state(&self, signal: SignalRef) -> (BigUint, BigUint)

Source§

fn memory_as_ptr(&self) -> (*const u8, usize)

Source§

fn memory_as_mut_ptr(&mut self) -> (*mut u8, usize)

Exposing a retained writable view must permanently disable sparse VCD tracking in backend-owned state outside the returned memory range.
Source§

fn memory_owner(&self) -> Option<Arc<dyn Any + Send + Sync>>

Return an opaque owner that keeps the memory allocation alive. Read more
Source§

fn vcd_tracking_enabled(&self) -> bool

Opt into generated write notifications only while no raw mutable view has escaped. The default keeps other backend implementations correct.
Source§

fn runtime_event_buffer_as_ptr(&self) -> (*const u8, usize)

Source§

fn runtime_event_buffer(&self) -> Option<Arc<RuntimeEventBuffer>>

Source§

fn set_comb_capture_event_enabled(&mut self, active_sites: &[bool])

Source§

fn stable_region_size(&self) -> usize

Source§

fn layout(&self) -> &MemoryLayout

Source§

fn id_to_addr_slice(&self) -> &[AbsoluteAddr] ⓘ

Source§

fn id_to_event_slice(&self) -> &[TieredEventRef]

Source§

fn num_events(&self) -> usize

Source§

fn clear_triggered_bits(&mut self)

Source§

fn mark_triggered_bit(&mut self, id: usize)

Source§

fn get_triggered_bits(&self) -> BitSet

Source§

fn take_vcd_activity(&mut self, groups: &mut Vec<usize>) -> bool

Consume waveform activity independently of clock trigger processing. Returns false when full scanning is required (including raw host views).
Source§

fn mark_vcd_signal(&mut self, signal: SignalRef)

Called by host setters, which share the generated-store notification ABI.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more