Trait rustc_const_eval::interpret::machine::Machine
source · pub trait Machine<'mir, 'tcx: 'mir>: Sized {
type MemoryKind: Debug + Display + MayLeak + Eq + 'static;
type Provenance: Provenance + Eq + Hash + 'static;
type ProvenanceExtra: Copy + 'static;
type ExtraFnVal: Debug + Copy;
type FrameExtra;
type AllocExtra: Debug + Clone + 'tcx;
type Bytes: AllocBytes + 'static;
type MemoryMap: AllocMap<AllocId, (MemoryKind<Self::MemoryKind>, Allocation<Self::Provenance, Self::AllocExtra, Self::Bytes>)> + Default + Clone;
const GLOBAL_KIND: Option<Self::MemoryKind>;
const PANIC_ON_ALLOC_FAIL: bool;
const POST_MONO_CHECKS: bool = true;
Show 39 methods
// Required methods
fn enforce_alignment(ecx: &InterpCx<'mir, 'tcx, Self>) -> CheckAlignment;
fn use_addr_for_alignment_check(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool;
fn alignment_check_failed(
ecx: &InterpCx<'mir, 'tcx, Self>,
has: Align,
required: Align,
check: CheckAlignment
) -> InterpResult<'tcx, ()>;
fn enforce_validity(
ecx: &InterpCx<'mir, 'tcx, Self>,
layout: TyAndLayout<'tcx>
) -> bool;
fn ignore_optional_overflow_checks(
_ecx: &InterpCx<'mir, 'tcx, Self>
) -> bool;
fn find_mir_or_eval_fn(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
instance: Instance<'tcx>,
abi: CallAbi,
args: &[FnArg<'tcx, Self::Provenance>],
destination: &PlaceTy<'tcx, Self::Provenance>,
target: Option<BasicBlock>,
unwind: UnwindAction
) -> InterpResult<'tcx, Option<(&'mir Body<'tcx>, Instance<'tcx>)>>;
fn call_extra_fn(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
fn_val: Self::ExtraFnVal,
abi: CallAbi,
args: &[FnArg<'tcx, Self::Provenance>],
destination: &PlaceTy<'tcx, Self::Provenance>,
target: Option<BasicBlock>,
unwind: UnwindAction
) -> InterpResult<'tcx>;
fn call_intrinsic(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
instance: Instance<'tcx>,
args: &[OpTy<'tcx, Self::Provenance>],
destination: &PlaceTy<'tcx, Self::Provenance>,
target: Option<BasicBlock>,
unwind: UnwindAction
) -> InterpResult<'tcx>;
fn assert_panic(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
msg: &AssertMessage<'tcx>,
unwind: UnwindAction
) -> InterpResult<'tcx>;
fn panic_nounwind(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
msg: &str
) -> InterpResult<'tcx>;
fn unwind_terminate(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
reason: UnwindTerminateReason
) -> InterpResult<'tcx>;
fn binary_ptr_op(
ecx: &InterpCx<'mir, 'tcx, Self>,
bin_op: BinOp,
left: &ImmTy<'tcx, Self::Provenance>,
right: &ImmTy<'tcx, Self::Provenance>
) -> InterpResult<'tcx, (ImmTy<'tcx, Self::Provenance>, bool)>;
fn extern_static_base_pointer(
ecx: &InterpCx<'mir, 'tcx, Self>,
def_id: DefId
) -> InterpResult<'tcx, Pointer<Self::Provenance>>;
fn adjust_alloc_base_pointer(
ecx: &InterpCx<'mir, 'tcx, Self>,
ptr: Pointer
) -> InterpResult<'tcx, Pointer<Self::Provenance>>;
fn ptr_from_addr_cast(
ecx: &InterpCx<'mir, 'tcx, Self>,
addr: u64
) -> InterpResult<'tcx, Pointer<Option<Self::Provenance>>>;
fn expose_ptr(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
ptr: Pointer<Self::Provenance>
) -> InterpResult<'tcx>;
fn ptr_get_alloc(
ecx: &InterpCx<'mir, 'tcx, Self>,
ptr: Pointer<Self::Provenance>
) -> Option<(AllocId, Size, Self::ProvenanceExtra)>;
fn adjust_allocation<'b>(
ecx: &InterpCx<'mir, 'tcx, Self>,
id: AllocId,
alloc: Cow<'b, Allocation>,
kind: Option<MemoryKind<Self::MemoryKind>>
) -> InterpResult<'tcx, Cow<'b, Allocation<Self::Provenance, Self::AllocExtra, Self::Bytes>>>;
fn init_frame_extra(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
frame: Frame<'mir, 'tcx, Self::Provenance>
) -> InterpResult<'tcx, Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>>;
fn stack<'a>(
ecx: &'a InterpCx<'mir, 'tcx, Self>
) -> &'a [Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>];
fn stack_mut<'a>(
ecx: &'a mut InterpCx<'mir, 'tcx, Self>
) -> &'a mut Vec<Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>>;
// Provided methods
fn enforce_abi(_ecx: &InterpCx<'mir, 'tcx, Self>) -> bool { ... }
fn load_mir(
ecx: &InterpCx<'mir, 'tcx, Self>,
instance: InstanceDef<'tcx>
) -> InterpResult<'tcx, &'tcx Body<'tcx>> { ... }
fn before_access_local_mut<'a>(
_ecx: &'a mut InterpCx<'mir, 'tcx, Self>,
_frame: usize,
_local: Local
) -> InterpResult<'tcx>
where 'tcx: 'mir { ... }
fn before_terminator(
_ecx: &mut InterpCx<'mir, 'tcx, Self>
) -> InterpResult<'tcx> { ... }
fn increment_const_eval_counter(
_ecx: &mut InterpCx<'mir, 'tcx, Self>
) -> InterpResult<'tcx> { ... }
fn before_access_global(
_tcx: TyCtxt<'tcx>,
_machine: &Self,
_alloc_id: AllocId,
_allocation: ConstAllocation<'tcx>,
_static_def_id: Option<DefId>,
_is_write: bool
) -> InterpResult<'tcx> { ... }
fn thread_local_static_base_pointer(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
def_id: DefId
) -> InterpResult<'tcx, Pointer<Self::Provenance>> { ... }
fn eval_inline_asm(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
_template: &'tcx [InlineAsmTemplatePiece],
_operands: &[InlineAsmOperand<'tcx>],
_options: InlineAsmOptions
) -> InterpResult<'tcx> { ... }
fn before_memory_read(
_tcx: TyCtxt<'tcx>,
_machine: &Self,
_alloc_extra: &Self::AllocExtra,
_prov: (AllocId, Self::ProvenanceExtra),
_range: AllocRange
) -> InterpResult<'tcx> { ... }
fn before_memory_write(
_tcx: TyCtxt<'tcx>,
_machine: &mut Self,
_alloc_extra: &mut Self::AllocExtra,
_prov: (AllocId, Self::ProvenanceExtra),
_range: AllocRange
) -> InterpResult<'tcx> { ... }
fn before_memory_deallocation(
_tcx: TyCtxt<'tcx>,
_machine: &mut Self,
_alloc_extra: &mut Self::AllocExtra,
_prov: (AllocId, Self::ProvenanceExtra),
_range: AllocRange
) -> InterpResult<'tcx> { ... }
fn retag_ptr_value(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
_kind: RetagKind,
val: &ImmTy<'tcx, Self::Provenance>
) -> InterpResult<'tcx, ImmTy<'tcx, Self::Provenance>> { ... }
fn retag_place_contents(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
_kind: RetagKind,
_place: &PlaceTy<'tcx, Self::Provenance>
) -> InterpResult<'tcx> { ... }
fn protect_in_place_function_argument(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
place: &PlaceTy<'tcx, Self::Provenance>
) -> InterpResult<'tcx> { ... }
fn after_stack_push(
_ecx: &mut InterpCx<'mir, 'tcx, Self>
) -> InterpResult<'tcx> { ... }
fn before_stack_pop(
_ecx: &InterpCx<'mir, 'tcx, Self>,
_frame: &Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>
) -> InterpResult<'tcx> { ... }
fn after_stack_pop(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
_frame: Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>,
unwinding: bool
) -> InterpResult<'tcx, StackPopJump> { ... }
fn after_local_allocated(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
_frame: usize,
_local: Local,
_mplace: &MPlaceTy<'tcx, Self::Provenance>
) -> InterpResult<'tcx> { ... }
}
Expand description
Methods of this trait signifies a point where CTFE evaluation would fail and some use case dependent behaviour can instead be applied.
Required Associated Types§
sourcetype MemoryKind: Debug + Display + MayLeak + Eq + 'static
type MemoryKind: Debug + Display + MayLeak + Eq + 'static
Additional memory kinds a machine wishes to distinguish from the builtin ones
sourcetype Provenance: Provenance + Eq + Hash + 'static
type Provenance: Provenance + Eq + Hash + 'static
Pointers are “tagged” with provenance information; typically the AllocId
they belong to.
sourcetype ProvenanceExtra: Copy + 'static
type ProvenanceExtra: Copy + 'static
When getting the AllocId of a pointer, some extra data is also obtained from the provenance that is passed to memory access hooks so they can do things with it.
sourcetype ExtraFnVal: Debug + Copy
type ExtraFnVal: Debug + Copy
Machines can define extra (non-instance) things that represent values of function pointers.
For example, Miri uses this to return a function pointer from dlsym
that can later be called to execute the right thing.
sourcetype FrameExtra
type FrameExtra
Extra data stored in every call frame.
sourcetype AllocExtra: Debug + Clone + 'tcx
type AllocExtra: Debug + Clone + 'tcx
Extra data stored in every allocation.
sourcetype Bytes: AllocBytes + 'static
type Bytes: AllocBytes + 'static
Type for the bytes of the allocation.
sourcetype MemoryMap: AllocMap<AllocId, (MemoryKind<Self::MemoryKind>, Allocation<Self::Provenance, Self::AllocExtra, Self::Bytes>)> + Default + Clone
type MemoryMap: AllocMap<AllocId, (MemoryKind<Self::MemoryKind>, Allocation<Self::Provenance, Self::AllocExtra, Self::Bytes>)> + Default + Clone
Memory’s allocation map
Required Associated Constants§
sourceconst GLOBAL_KIND: Option<Self::MemoryKind>
const GLOBAL_KIND: Option<Self::MemoryKind>
The memory kind to use for copied global memory (held in tcx
) –
or None if such memory should not be mutated and thus any such attempt will cause
a ModifiedStatic
error to be raised.
Statics are copied under two circumstances: When they are mutated, and when
adjust_allocation
(see below) returns an owned allocation
that is added to the memory so that the work is not done twice.
sourceconst PANIC_ON_ALLOC_FAIL: bool
const PANIC_ON_ALLOC_FAIL: bool
Should the machine panic on allocation failures?
Provided Associated Constants§
sourceconst POST_MONO_CHECKS: bool = true
const POST_MONO_CHECKS: bool = true
Should post-monomorphization checks be run when a stack frame is pushed?
Required Methods§
sourcefn enforce_alignment(ecx: &InterpCx<'mir, 'tcx, Self>) -> CheckAlignment
fn enforce_alignment(ecx: &InterpCx<'mir, 'tcx, Self>) -> CheckAlignment
Whether memory accesses should be alignment-checked.
sourcefn use_addr_for_alignment_check(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool
fn use_addr_for_alignment_check(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool
Whether, when checking alignment, we should look at the actual address and thus support custom alignment logic based on whatever the integer address happens to be.
If this returns true, Provenance::OFFSET_IS_ADDR must be true.
fn alignment_check_failed( ecx: &InterpCx<'mir, 'tcx, Self>, has: Align, required: Align, check: CheckAlignment ) -> InterpResult<'tcx, ()>
sourcefn enforce_validity(
ecx: &InterpCx<'mir, 'tcx, Self>,
layout: TyAndLayout<'tcx>
) -> bool
fn enforce_validity( ecx: &InterpCx<'mir, 'tcx, Self>, layout: TyAndLayout<'tcx> ) -> bool
Whether to enforce the validity invariant for a specific layout.
sourcefn ignore_optional_overflow_checks(_ecx: &InterpCx<'mir, 'tcx, Self>) -> bool
fn ignore_optional_overflow_checks(_ecx: &InterpCx<'mir, 'tcx, Self>) -> bool
Whether Assert(OverflowNeg) and Assert(Overflow) MIR terminators should actually check for overflow.
sourcefn find_mir_or_eval_fn(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
instance: Instance<'tcx>,
abi: CallAbi,
args: &[FnArg<'tcx, Self::Provenance>],
destination: &PlaceTy<'tcx, Self::Provenance>,
target: Option<BasicBlock>,
unwind: UnwindAction
) -> InterpResult<'tcx, Option<(&'mir Body<'tcx>, Instance<'tcx>)>>
fn find_mir_or_eval_fn( ecx: &mut InterpCx<'mir, 'tcx, Self>, instance: Instance<'tcx>, abi: CallAbi, args: &[FnArg<'tcx, Self::Provenance>], destination: &PlaceTy<'tcx, Self::Provenance>, target: Option<BasicBlock>, unwind: UnwindAction ) -> InterpResult<'tcx, Option<(&'mir Body<'tcx>, Instance<'tcx>)>>
Entry point to all function calls.
Returns either the mir to use for the call, or None
if execution should
just proceed (which usually means this hook did all the work that the
called function should usually have done). In the latter case, it is
this hook’s responsibility to advance the instruction pointer!
(This is to support functions like __rust_maybe_catch_panic
that neither find a MIR
nor just jump to ret
, but instead push their own stack frame.)
Passing dest
and ret
in the same Option
proved very annoying when only one of them
was used.
sourcefn call_extra_fn(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
fn_val: Self::ExtraFnVal,
abi: CallAbi,
args: &[FnArg<'tcx, Self::Provenance>],
destination: &PlaceTy<'tcx, Self::Provenance>,
target: Option<BasicBlock>,
unwind: UnwindAction
) -> InterpResult<'tcx>
fn call_extra_fn( ecx: &mut InterpCx<'mir, 'tcx, Self>, fn_val: Self::ExtraFnVal, abi: CallAbi, args: &[FnArg<'tcx, Self::Provenance>], destination: &PlaceTy<'tcx, Self::Provenance>, target: Option<BasicBlock>, unwind: UnwindAction ) -> InterpResult<'tcx>
Execute fn_val
. It is the hook’s responsibility to advance the instruction
pointer as appropriate.
sourcefn call_intrinsic(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
instance: Instance<'tcx>,
args: &[OpTy<'tcx, Self::Provenance>],
destination: &PlaceTy<'tcx, Self::Provenance>,
target: Option<BasicBlock>,
unwind: UnwindAction
) -> InterpResult<'tcx>
fn call_intrinsic( ecx: &mut InterpCx<'mir, 'tcx, Self>, instance: Instance<'tcx>, args: &[OpTy<'tcx, Self::Provenance>], destination: &PlaceTy<'tcx, Self::Provenance>, target: Option<BasicBlock>, unwind: UnwindAction ) -> InterpResult<'tcx>
Directly process an intrinsic without pushing a stack frame. It is the hook’s responsibility to advance the instruction pointer as appropriate.
sourcefn assert_panic(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
msg: &AssertMessage<'tcx>,
unwind: UnwindAction
) -> InterpResult<'tcx>
fn assert_panic( ecx: &mut InterpCx<'mir, 'tcx, Self>, msg: &AssertMessage<'tcx>, unwind: UnwindAction ) -> InterpResult<'tcx>
Called to evaluate Assert
MIR terminators that trigger a panic.
sourcefn panic_nounwind(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
msg: &str
) -> InterpResult<'tcx>
fn panic_nounwind( _ecx: &mut InterpCx<'mir, 'tcx, Self>, msg: &str ) -> InterpResult<'tcx>
Called to trigger a non-unwinding panic.
sourcefn unwind_terminate(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
reason: UnwindTerminateReason
) -> InterpResult<'tcx>
fn unwind_terminate( ecx: &mut InterpCx<'mir, 'tcx, Self>, reason: UnwindTerminateReason ) -> InterpResult<'tcx>
Called when unwinding reached a state where execution should be terminated.
sourcefn binary_ptr_op(
ecx: &InterpCx<'mir, 'tcx, Self>,
bin_op: BinOp,
left: &ImmTy<'tcx, Self::Provenance>,
right: &ImmTy<'tcx, Self::Provenance>
) -> InterpResult<'tcx, (ImmTy<'tcx, Self::Provenance>, bool)>
fn binary_ptr_op( ecx: &InterpCx<'mir, 'tcx, Self>, bin_op: BinOp, left: &ImmTy<'tcx, Self::Provenance>, right: &ImmTy<'tcx, Self::Provenance> ) -> InterpResult<'tcx, (ImmTy<'tcx, Self::Provenance>, bool)>
Called for all binary operations where the LHS has pointer type.
Returns a (value, overflowed) pair if the operation succeeded
sourcefn extern_static_base_pointer(
ecx: &InterpCx<'mir, 'tcx, Self>,
def_id: DefId
) -> InterpResult<'tcx, Pointer<Self::Provenance>>
fn extern_static_base_pointer( ecx: &InterpCx<'mir, 'tcx, Self>, def_id: DefId ) -> InterpResult<'tcx, Pointer<Self::Provenance>>
Return the root pointer for the given extern static
.
sourcefn adjust_alloc_base_pointer(
ecx: &InterpCx<'mir, 'tcx, Self>,
ptr: Pointer
) -> InterpResult<'tcx, Pointer<Self::Provenance>>
fn adjust_alloc_base_pointer( ecx: &InterpCx<'mir, 'tcx, Self>, ptr: Pointer ) -> InterpResult<'tcx, Pointer<Self::Provenance>>
Return a “base” pointer for the given allocation: the one that is used for direct accesses to this static/const/fn allocation, or the one returned from the heap allocator.
Not called on extern
or thread-local statics (those use the methods above).
sourcefn ptr_from_addr_cast(
ecx: &InterpCx<'mir, 'tcx, Self>,
addr: u64
) -> InterpResult<'tcx, Pointer<Option<Self::Provenance>>>
fn ptr_from_addr_cast( ecx: &InterpCx<'mir, 'tcx, Self>, addr: u64 ) -> InterpResult<'tcx, Pointer<Option<Self::Provenance>>>
“Int-to-pointer cast”
sourcefn expose_ptr(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
ptr: Pointer<Self::Provenance>
) -> InterpResult<'tcx>
fn expose_ptr( ecx: &mut InterpCx<'mir, 'tcx, Self>, ptr: Pointer<Self::Provenance> ) -> InterpResult<'tcx>
Marks a pointer as exposed, allowing it’s provenance to be recovered. “Pointer-to-int cast”
sourcefn ptr_get_alloc(
ecx: &InterpCx<'mir, 'tcx, Self>,
ptr: Pointer<Self::Provenance>
) -> Option<(AllocId, Size, Self::ProvenanceExtra)>
fn ptr_get_alloc( ecx: &InterpCx<'mir, 'tcx, Self>, ptr: Pointer<Self::Provenance> ) -> Option<(AllocId, Size, Self::ProvenanceExtra)>
Convert a pointer with provenance into an allocation-offset pair and extra provenance info.
The returned AllocId
must be the same as ptr.provenance.get_alloc_id()
.
When this fails, that means the pointer does not point to a live allocation.
sourcefn adjust_allocation<'b>(
ecx: &InterpCx<'mir, 'tcx, Self>,
id: AllocId,
alloc: Cow<'b, Allocation>,
kind: Option<MemoryKind<Self::MemoryKind>>
) -> InterpResult<'tcx, Cow<'b, Allocation<Self::Provenance, Self::AllocExtra, Self::Bytes>>>
fn adjust_allocation<'b>( ecx: &InterpCx<'mir, 'tcx, Self>, id: AllocId, alloc: Cow<'b, Allocation>, kind: Option<MemoryKind<Self::MemoryKind>> ) -> InterpResult<'tcx, Cow<'b, Allocation<Self::Provenance, Self::AllocExtra, Self::Bytes>>>
Called to adjust allocations to the Provenance and AllocExtra of this machine.
The way we construct allocations is to always first construct it without extra and then add the extra. This keeps uniform code paths for handling both allocations created by CTFE for globals, and allocations created by Miri during evaluation.
kind
is the kind of the allocation being adjusted; it can be None
when
it’s a global and GLOBAL_KIND
is None
.
This should avoid copying if no work has to be done! If this returns an owned
allocation (because a copy had to be done to adjust things), machine memory will
cache the result. (This relies on AllocMap::get_or
being able to add the
owned allocation to the map even when the map is shared.)
This must only fail if alloc
contains provenance.
sourcefn init_frame_extra(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
frame: Frame<'mir, 'tcx, Self::Provenance>
) -> InterpResult<'tcx, Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>>
fn init_frame_extra( ecx: &mut InterpCx<'mir, 'tcx, Self>, frame: Frame<'mir, 'tcx, Self::Provenance> ) -> InterpResult<'tcx, Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>>
Called immediately before a new stack frame gets pushed.
sourcefn stack<'a>(
ecx: &'a InterpCx<'mir, 'tcx, Self>
) -> &'a [Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>]
fn stack<'a>( ecx: &'a InterpCx<'mir, 'tcx, Self> ) -> &'a [Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>]
Borrow the current thread’s stack.
sourcefn stack_mut<'a>(
ecx: &'a mut InterpCx<'mir, 'tcx, Self>
) -> &'a mut Vec<Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>>
fn stack_mut<'a>( ecx: &'a mut InterpCx<'mir, 'tcx, Self> ) -> &'a mut Vec<Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>>
Mutably borrow the current thread’s stack.
Provided Methods§
sourcefn enforce_abi(_ecx: &InterpCx<'mir, 'tcx, Self>) -> bool
fn enforce_abi(_ecx: &InterpCx<'mir, 'tcx, Self>) -> bool
Whether function calls should be ABI-checked.
sourcefn load_mir(
ecx: &InterpCx<'mir, 'tcx, Self>,
instance: InstanceDef<'tcx>
) -> InterpResult<'tcx, &'tcx Body<'tcx>>
fn load_mir( ecx: &InterpCx<'mir, 'tcx, Self>, instance: InstanceDef<'tcx> ) -> InterpResult<'tcx, &'tcx Body<'tcx>>
Entry point for obtaining the MIR of anything that should get evaluated. So not just functions and shims, but also const/static initializers, anonymous constants, …
sourcefn before_access_local_mut<'a>(
_ecx: &'a mut InterpCx<'mir, 'tcx, Self>,
_frame: usize,
_local: Local
) -> InterpResult<'tcx>where
'tcx: 'mir,
fn before_access_local_mut<'a>( _ecx: &'a mut InterpCx<'mir, 'tcx, Self>, _frame: usize, _local: Local ) -> InterpResult<'tcx>where 'tcx: 'mir,
Called before writing the specified local
of the frame
.
Since writing a ZST is not actually accessing memory or locals, this is never invoked
for ZST reads.
Due to borrow checker trouble, we indicate the frame
as an index rather than an &mut Frame
.
sourcefn before_terminator(
_ecx: &mut InterpCx<'mir, 'tcx, Self>
) -> InterpResult<'tcx>
fn before_terminator( _ecx: &mut InterpCx<'mir, 'tcx, Self> ) -> InterpResult<'tcx>
Called before a basic block terminator is executed.
sourcefn increment_const_eval_counter(
_ecx: &mut InterpCx<'mir, 'tcx, Self>
) -> InterpResult<'tcx>
fn increment_const_eval_counter( _ecx: &mut InterpCx<'mir, 'tcx, Self> ) -> InterpResult<'tcx>
Called when the interpreter encounters a StatementKind::ConstEvalCounter
instruction.
You can use this to detect long or endlessly running programs.
sourcefn before_access_global(
_tcx: TyCtxt<'tcx>,
_machine: &Self,
_alloc_id: AllocId,
_allocation: ConstAllocation<'tcx>,
_static_def_id: Option<DefId>,
_is_write: bool
) -> InterpResult<'tcx>
fn before_access_global( _tcx: TyCtxt<'tcx>, _machine: &Self, _alloc_id: AllocId, _allocation: ConstAllocation<'tcx>, _static_def_id: Option<DefId>, _is_write: bool ) -> InterpResult<'tcx>
Called before a global allocation is accessed.
def_id
is Some
if this is the “lazy” allocation of a static.
sourcefn thread_local_static_base_pointer(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
def_id: DefId
) -> InterpResult<'tcx, Pointer<Self::Provenance>>
fn thread_local_static_base_pointer( _ecx: &mut InterpCx<'mir, 'tcx, Self>, def_id: DefId ) -> InterpResult<'tcx, Pointer<Self::Provenance>>
Return the AllocId
for the given thread-local static in the current thread.
fn eval_inline_asm( _ecx: &mut InterpCx<'mir, 'tcx, Self>, _template: &'tcx [InlineAsmTemplatePiece], _operands: &[InlineAsmOperand<'tcx>], _options: InlineAsmOptions ) -> InterpResult<'tcx>
sourcefn before_memory_read(
_tcx: TyCtxt<'tcx>,
_machine: &Self,
_alloc_extra: &Self::AllocExtra,
_prov: (AllocId, Self::ProvenanceExtra),
_range: AllocRange
) -> InterpResult<'tcx>
fn before_memory_read( _tcx: TyCtxt<'tcx>, _machine: &Self, _alloc_extra: &Self::AllocExtra, _prov: (AllocId, Self::ProvenanceExtra), _range: AllocRange ) -> InterpResult<'tcx>
Hook for performing extra checks on a memory read access.
Takes read-only access to the allocation so we can keep all the memory read
operations take &self
. Use a RefCell
in AllocExtra
if you
need to mutate.
sourcefn before_memory_write(
_tcx: TyCtxt<'tcx>,
_machine: &mut Self,
_alloc_extra: &mut Self::AllocExtra,
_prov: (AllocId, Self::ProvenanceExtra),
_range: AllocRange
) -> InterpResult<'tcx>
fn before_memory_write( _tcx: TyCtxt<'tcx>, _machine: &mut Self, _alloc_extra: &mut Self::AllocExtra, _prov: (AllocId, Self::ProvenanceExtra), _range: AllocRange ) -> InterpResult<'tcx>
Hook for performing extra checks on a memory write access.
sourcefn before_memory_deallocation(
_tcx: TyCtxt<'tcx>,
_machine: &mut Self,
_alloc_extra: &mut Self::AllocExtra,
_prov: (AllocId, Self::ProvenanceExtra),
_range: AllocRange
) -> InterpResult<'tcx>
fn before_memory_deallocation( _tcx: TyCtxt<'tcx>, _machine: &mut Self, _alloc_extra: &mut Self::AllocExtra, _prov: (AllocId, Self::ProvenanceExtra), _range: AllocRange ) -> InterpResult<'tcx>
Hook for performing extra operations on a memory deallocation.
sourcefn retag_ptr_value(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
_kind: RetagKind,
val: &ImmTy<'tcx, Self::Provenance>
) -> InterpResult<'tcx, ImmTy<'tcx, Self::Provenance>>
fn retag_ptr_value( _ecx: &mut InterpCx<'mir, 'tcx, Self>, _kind: RetagKind, val: &ImmTy<'tcx, Self::Provenance> ) -> InterpResult<'tcx, ImmTy<'tcx, Self::Provenance>>
Executes a retagging operation for a single pointer. Returns the possibly adjusted pointer.
sourcefn retag_place_contents(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
_kind: RetagKind,
_place: &PlaceTy<'tcx, Self::Provenance>
) -> InterpResult<'tcx>
fn retag_place_contents( _ecx: &mut InterpCx<'mir, 'tcx, Self>, _kind: RetagKind, _place: &PlaceTy<'tcx, Self::Provenance> ) -> InterpResult<'tcx>
Executes a retagging operation on a compound value. Replaces all pointers stored in the given place.
sourcefn protect_in_place_function_argument(
ecx: &mut InterpCx<'mir, 'tcx, Self>,
place: &PlaceTy<'tcx, Self::Provenance>
) -> InterpResult<'tcx>
fn protect_in_place_function_argument( ecx: &mut InterpCx<'mir, 'tcx, Self>, place: &PlaceTy<'tcx, Self::Provenance> ) -> InterpResult<'tcx>
Called on places used for in-place function argument and return value handling.
These places need to be protected to make sure the program cannot tell whether the argument/return value was actually copied or passed in-place..
sourcefn after_stack_push(_ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx>
fn after_stack_push(_ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx>
Called immediately after a stack frame got pushed and its locals got initialized.
sourcefn before_stack_pop(
_ecx: &InterpCx<'mir, 'tcx, Self>,
_frame: &Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>
) -> InterpResult<'tcx>
fn before_stack_pop( _ecx: &InterpCx<'mir, 'tcx, Self>, _frame: &Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra> ) -> InterpResult<'tcx>
Called just before the return value is copied to the caller-provided return place.
sourcefn after_stack_pop(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
_frame: Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>,
unwinding: bool
) -> InterpResult<'tcx, StackPopJump>
fn after_stack_pop( _ecx: &mut InterpCx<'mir, 'tcx, Self>, _frame: Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>, unwinding: bool ) -> InterpResult<'tcx, StackPopJump>
Called immediately after a stack frame got popped, but before jumping back to the caller.
The locals
have already been destroyed!
sourcefn after_local_allocated(
_ecx: &mut InterpCx<'mir, 'tcx, Self>,
_frame: usize,
_local: Local,
_mplace: &MPlaceTy<'tcx, Self::Provenance>
) -> InterpResult<'tcx>
fn after_local_allocated( _ecx: &mut InterpCx<'mir, 'tcx, Self>, _frame: usize, _local: Local, _mplace: &MPlaceTy<'tcx, Self::Provenance> ) -> InterpResult<'tcx>
Called immediately after actual memory was allocated for a local but before the local’s stack frame is updated to point to that memory.