Struct JitBackend
pub struct JitBackend { /* private fields */ }node-api and node only.Expand description
JIT compilation backend with O(1) compiled-function lookup.
Created via JitBackend::new or JitBackend::disabled.
This type is cheaply cloneable (backed by Arc).
All clones share the same backend thread, resident map, and statistics.
Implementations§
§impl JitBackend
impl JitBackend
pub fn disabled() -> JitBackend
Available on crate feature evm only.
pub fn disabled() -> JitBackend
evm only.Creates a disabled backend that performs no compilation and spawns no threads.
All lookup calls return
LookupDecision::Unavailable(LookupMissReason::Disabled).
Call set_enabled to lazily spawn the backend thread with
a default RuntimeConfig.
pub fn new(config: RuntimeConfig) -> Result<JitBackend, Report>
Available on crate feature evm only.
pub fn new(config: RuntimeConfig) -> Result<JitBackend, Report>
evm only.Creates a backend from the given config.
If enabled is true, the backend thread is spawned
immediately and AOT artifacts are preloaded. Otherwise, both are deferred until the
first set_enabled(true) call.
pub fn lookup(&self, req: LookupRequest) -> LookupDecision
Available on crate feature evm only.
pub fn lookup(&self, req: LookupRequest) -> LookupDecision
evm only.Looks up a compiled function for the given request.
In normal mode this never blocks. In blocking mode,
a miss triggers synchronous JIT compilation and the call blocks until it completes.
pub fn get_compiled(
&self,
code_hash: FixedBytes<32>,
spec_id: SpecId,
) -> Option<Arc<CompiledProgram>>
Available on crate feature evm only.
pub fn get_compiled( &self, code_hash: FixedBytes<32>, spec_id: SpecId, ) -> Option<Arc<CompiledProgram>>
evm only.Checks the resident map for a compiled program without enqueuing an event.
pub fn get_compiled_tracked(
&self,
code_hash: FixedBytes<32>,
spec_id: SpecId,
) -> Option<Arc<CompiledProgram>>
Available on crate feature evm only.
pub fn get_compiled_tracked( &self, code_hash: FixedBytes<32>, spec_id: SpecId, ) -> Option<Arc<CompiledProgram>>
evm only.Like get_compiled, but also records hit/miss stats.
pub fn lookup_blocking(&self, req: LookupRequest) -> LookupDecision
Available on crate feature evm only.
pub fn lookup_blocking(&self, req: LookupRequest) -> LookupDecision
evm only.Looks up a compiled function, blocking until compilation completes if not yet ready.
If the function is already compiled, returns it immediately. Otherwise, enqueues
a synchronous JIT compilation request and blocks until the result is available.
Returns [LookupDecision::Unavailable] if the bytecode is ineligible for
compilation (see RuntimeTuning::should_compile) or compilation does not produce a
resident program. Each such miss is counted in
interpreter_fallbacks.
pub fn compile_jit(&self, req: LookupRequest)
Available on crate feature evm only.
pub fn compile_jit(&self, req: LookupRequest)
evm only.Enqueues an explicit JIT compilation request for the given bytecode.
Blocks if the command channel is full to guarantee delivery. If the backend could not be started, the request is dropped and a warning is logged.
pub fn compile_jit_sync(&self, req: LookupRequest) -> Result<(), Report>
Available on crate feature evm only.
pub fn compile_jit_sync(&self, req: LookupRequest) -> Result<(), Report>
evm only.Enqueues a JIT compilation request and blocks until the compilation completes.
Returns Ok(()) when the compiled function is available in the resident map,
or when the compilation fails. Use get_compiled to
retrieve the result after this returns.
pub fn prepare_aot(&self, req: AotRequest)
Available on crate feature evm only.
pub fn prepare_aot(&self, req: AotRequest)
evm only.Enqueues a single AOT preparation request.
Compilation happens asynchronously on the worker pool. The resulting artifact is
persisted via [ArtifactStore::store] and loaded into the resident map.
May block during startup or when the command channel is full. If startup fails,
the request is dropped and a warning is logged.
pub fn prepare_aot_sync(&self, req: AotRequest) -> Result<(), Report>
Available on crate feature evm only.
pub fn prepare_aot_sync(&self, req: AotRequest) -> Result<(), Report>
evm only.Enqueues a single AOT preparation request and blocks until it completes.
Returns Ok(()) when the preparation attempt completed, whether it
succeeded or failed. Use get_compiled to retrieve
the result after this returns.
pub fn prepare_aot_batch(&self, reqs: Vec<AotRequest>)
Available on crate feature evm only.
pub fn prepare_aot_batch(&self, reqs: Vec<AotRequest>)
evm only.Enqueues a batch of AOT preparation requests.
Blocks if the command channel is full to guarantee delivery. If the backend could not be started, the requests are dropped and a warning is logged.
pub fn prepare_aot_batch_sync(
&self,
reqs: Vec<AotRequest>,
) -> Result<(), Report>
Available on crate feature evm only.
pub fn prepare_aot_batch_sync( &self, reqs: Vec<AotRequest>, ) -> Result<(), Report>
evm only.Enqueues a batch of AOT preparation requests and blocks until they complete.
Returns Ok(()) when all preparation attempts completed, whether they
succeeded or failed. Use get_compiled to retrieve
the results after this returns.
pub fn clear_resident(&self)
Available on crate feature evm only.
pub fn clear_resident(&self)
evm only.Clears the in-memory resident compiled map.
All compiled programs are removed from the map. Active references held by callers remain valid until dropped.
Before startup, clears the map in place instead of queueing an undrained command. May block waiting for startup or for space in the running backend’s command channel.
pub fn clear_persisted(&self)
Available on crate feature evm only.
pub fn clear_persisted(&self)
evm only.Clears persisted artifacts from the artifact store.
Before startup, clears the store in place instead of queueing an undrained command. May block on store I/O, startup, or the running backend’s command channel.
pub fn clear_all(&self)
Available on crate feature evm only.
pub fn clear_all(&self)
evm only.Clears both the resident map and persisted artifacts.
Before startup, clears both in place instead of queueing an undrained command. May block on store I/O, startup, or the running backend’s command channel.
pub fn enabled(&self) -> bool
Available on crate feature evm only.
pub fn enabled(&self) -> bool
evm only.Returns whether the runtime is enabled.
pub fn pause(&self)
Available on crate feature evm only.
pub fn pause(&self)
evm only.Pauses out-of-process helper execution.
Resident compiled functions are still returned by lookup, and lookup
events are still processed for stats, hotness tracking, and compilation dispatch. In
out-of-process mode, the helper process group is stopped until the pause depth returns to
zero, so dispatched helper requests remain buffered and resume once the helper continues.
In in-process mode, pause only tracks pause depth. In
blocking mode the helper is never stopped, because the caller
itself waits on compilation: pause only tracks pause depth there too.
Pause delivery is best-effort and never blocks: callers pause around block validation on the engine’s critical path. If the backend thread is not running or the command channel is full, the command is skipped or dropped instead of blocking.
pub fn resume(&self)
Available on crate feature evm only.
pub fn resume(&self)
evm only.Resumes out-of-process helper execution once all active pauses have been released.
Resume delivery is best-effort and never blocks, like pause.
pub fn is_paused(&self) -> bool
Available on crate feature evm only.
pub fn is_paused(&self) -> bool
evm only.Returns whether out-of-process helper execution is paused.
pub fn set_enabled(&self, enabled: bool) -> Result<(), Report>
Available on crate feature evm only.
pub fn set_enabled(&self, enabled: bool) -> Result<(), Report>
evm only.Sets whether the runtime is enabled, spawning the backend thread on first enable.
When enabled is true and the backend thread has not been spawned yet, this
lazily starts it using the config provided at construction time.
pub fn stats(&self) -> RuntimeStatsSnapshot
Available on crate feature evm only.
pub fn stats(&self) -> RuntimeStatsSnapshot
evm only.Returns a point-in-time snapshot of runtime statistics.
Trait Implementations§
§impl Clone for JitBackend
impl Clone for JitBackend
§fn clone(&self) -> JitBackend
fn clone(&self) -> JitBackend
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl !RefUnwindSafe for JitBackend
impl !UnwindSafe for JitBackend
impl Freeze for JitBackend
impl Send for JitBackend
impl Sync for JitBackend
impl Unpin for JitBackend
impl UnsafeUnpin for JitBackend
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request§impl<L> LayerExt<L> for L
impl<L> LayerExt<L> for L
§fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
Layered].impl<T> MaybeDebug for Twhere
T: Debug,
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
Source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
Source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
Source§fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 8 bytes