# Trait miri::interpret::Machine

source ·

    pub trait Machine<'mir, 'tcx>: Sizedwhere
        'tcx: 'mir,{
        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 40 methods
        // Required methods
        fn enforce_alignment(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool;
        fn enforce_validity(
            ecx: &InterpCx<'mir, 'tcx, Self>,
            layout: TyAndLayout<'tcx, Ty<'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: Abi,
            args: &[FnArg<'tcx, Self::Provenance>],
            destination: &MPlaceTy<'tcx, Self::Provenance>,
            target: Option<BasicBlock>,
            unwind: UnwindAction
        ) -> Result<Option<(&'mir Body<'tcx>, Instance<'tcx>)>, InterpErrorInfo<'tcx>>;
        fn call_extra_fn(
            ecx: &mut InterpCx<'mir, 'tcx, Self>,
            fn_val: Self::ExtraFnVal,
            abi: Abi,
            args: &[FnArg<'tcx, Self::Provenance>],
            destination: &MPlaceTy<'tcx, Self::Provenance>,
            target: Option<BasicBlock>,
            unwind: UnwindAction
        ) -> Result<(), InterpErrorInfo<'tcx>>;
        fn call_intrinsic(
            ecx: &mut InterpCx<'mir, 'tcx, Self>,
            instance: Instance<'tcx>,
            args: &[OpTy<'tcx, Self::Provenance>],
            destination: &MPlaceTy<'tcx, Self::Provenance>,
            target: Option<BasicBlock>,
            unwind: UnwindAction
        ) -> Result<(), InterpErrorInfo<'tcx>>;
        fn assert_panic(
            ecx: &mut InterpCx<'mir, 'tcx, Self>,
            msg: &AssertKind<Operand<'tcx>>,
            unwind: UnwindAction
        ) -> Result<(), InterpErrorInfo<'tcx>>;
        fn panic_nounwind(
            _ecx: &mut InterpCx<'mir, 'tcx, Self>,
            msg: &str
        ) -> Result<(), InterpErrorInfo<'tcx>>;
        fn unwind_terminate(
            ecx: &mut InterpCx<'mir, 'tcx, Self>,
            reason: UnwindTerminateReason
        ) -> Result<(), InterpErrorInfo<'tcx>>;
        fn binary_ptr_op(
            ecx: &InterpCx<'mir, 'tcx, Self>,
            bin_op: BinOp,
            left: &ImmTy<'tcx, Self::Provenance>,
            right: &ImmTy<'tcx, Self::Provenance>
        ) -> Result<(ImmTy<'tcx, Self::Provenance>, bool), InterpErrorInfo<'tcx>>;
        fn extern_static_base_pointer(
            ecx: &InterpCx<'mir, 'tcx, Self>,
            def_id: DefId
        ) -> Result<Pointer<Self::Provenance>, InterpErrorInfo<'tcx>>;
        fn adjust_alloc_base_pointer(
            ecx: &InterpCx<'mir, 'tcx, Self>,
            ptr: Pointer
        ) -> Result<Pointer<Self::Provenance>, InterpErrorInfo<'tcx>>;
        fn ptr_from_addr_cast(
            ecx: &InterpCx<'mir, 'tcx, Self>,
            addr: u64
        ) -> Result<Pointer<Option<Self::Provenance>>, InterpErrorInfo<'tcx>>;
        fn expose_ptr(
            ecx: &mut InterpCx<'mir, 'tcx, Self>,
            ptr: Pointer<Self::Provenance>
        ) -> Result<(), InterpErrorInfo<'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>>
        ) -> Result<Cow<'b, Allocation<Self::Provenance, Self::AllocExtra, Self::Bytes>>, InterpErrorInfo<'tcx>>;
        fn init_frame_extra(
            ecx: &mut InterpCx<'mir, 'tcx, Self>,
            frame: Frame<'mir, 'tcx, Self::Provenance>
        ) -> Result<Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>, InterpErrorInfo<'tcx>>;
        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 alignment_check(
            _ecx: &InterpCx<'mir, 'tcx, Self>,
            _alloc_id: AllocId,
            _alloc_align: Align,
            _alloc_kind: AllocKind,
            _offset: Size,
            _align: Align
        ) -> Option<Misalignment> { ... }
        fn enforce_abi(_ecx: &InterpCx<'mir, 'tcx, Self>) -> bool { ... }
        fn load_mir(
            ecx: &InterpCx<'mir, 'tcx, Self>,
            instance: InstanceDef<'tcx>
        ) -> Result<&'tcx Body<'tcx>, InterpErrorInfo<'tcx>> { ... }
        fn generate_nan<F1, F2>(
            _ecx: &InterpCx<'mir, 'tcx, Self>,
            _inputs: &[F1]
        ) -> F2
           where F1: Float + FloatConvert<F2>,
                 F2: Float { ... }
        fn before_terminator(
            _ecx: &mut InterpCx<'mir, 'tcx, Self>
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn increment_const_eval_counter(
            _ecx: &mut InterpCx<'mir, 'tcx, Self>
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn before_access_global(
            _tcx: TyCtxtAt<'tcx>,
            _machine: &Self,
            _alloc_id: AllocId,
            _allocation: ConstAllocation<'tcx>,
            _static_def_id: Option<DefId>,
            _is_write: bool
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn thread_local_static_base_pointer(
            _ecx: &mut InterpCx<'mir, 'tcx, Self>,
            def_id: DefId
        ) -> Result<Pointer<Self::Provenance>, InterpErrorInfo<'tcx>> { ... }
        fn eval_inline_asm(
            _ecx: &mut InterpCx<'mir, 'tcx, Self>,
            _template: &'tcx [InlineAsmTemplatePiece],
            _operands: &[InlineAsmOperand<'tcx>],
            _options: InlineAsmOptions,
            _targets: &[BasicBlock]
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn before_memory_read(
            _tcx: TyCtxtAt<'tcx>,
            _machine: &Self,
            _alloc_extra: &Self::AllocExtra,
            _prov: (AllocId, Self::ProvenanceExtra),
            _range: AllocRange
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn before_alloc_read(
            _ecx: &InterpCx<'mir, 'tcx, Self>,
            _alloc_id: AllocId
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn before_memory_write(
            _tcx: TyCtxtAt<'tcx>,
            _machine: &mut Self,
            _alloc_extra: &mut Self::AllocExtra,
            _prov: (AllocId, Self::ProvenanceExtra),
            _range: AllocRange
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn before_memory_deallocation(
            _tcx: TyCtxtAt<'tcx>,
            _machine: &mut Self,
            _alloc_extra: &mut Self::AllocExtra,
            _prov: (AllocId, Self::ProvenanceExtra),
            _size: Size,
            _align: Align
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn retag_ptr_value(
            _ecx: &mut InterpCx<'mir, 'tcx, Self>,
            _kind: RetagKind,
            val: &ImmTy<'tcx, Self::Provenance>
        ) -> Result<ImmTy<'tcx, Self::Provenance>, InterpErrorInfo<'tcx>> { ... }
        fn retag_place_contents(
            _ecx: &mut InterpCx<'mir, 'tcx, Self>,
            _kind: RetagKind,
            _place: &PlaceTy<'tcx, Self::Provenance>
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn protect_in_place_function_argument(
            ecx: &mut InterpCx<'mir, 'tcx, Self>,
            mplace: &MPlaceTy<'tcx, Self::Provenance>
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn after_stack_push(
            _ecx: &mut InterpCx<'mir, 'tcx, Self>
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn before_stack_pop(
            _ecx: &InterpCx<'mir, 'tcx, Self>,
            _frame: &Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn after_stack_pop(
            _ecx: &mut InterpCx<'mir, 'tcx, Self>,
            _frame: Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>,
            unwinding: bool
        ) -> Result<StackPopJump, InterpErrorInfo<'tcx>> { ... }
        fn after_local_allocated(
            _ecx: &mut InterpCx<'mir, 'tcx, Self>,
            _local: Local,
            _mplace: &MPlaceTy<'tcx, Self::Provenance>
        ) -> Result<(), InterpErrorInfo<'tcx>> { ... }
        fn eval_mir_constant<F>(
            ecx: &InterpCx<'mir, 'tcx, Self>,
            val: Const<'tcx>,
            span: Span,
            layout: Option<TyAndLayout<'tcx, Ty<'tcx>>>,
            eval: F
        ) -> Result<OpTy<'tcx, Self::Provenance>, InterpErrorInfo<'tcx>>
           where F: Fn(&InterpCx<'mir, 'tcx, Self>, Const<'tcx>, Span, Option<TyAndLayout<'tcx, Ty<'tcx>>>) -> Result<OpTy<'tcx, Self::Provenance>, InterpErrorInfo<'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§

source

#### type MemoryKind: Debug + Display + MayLeak + Eq + 'static

Additional memory kinds a machine wishes to distinguish from the builtin ones

source

#### type Provenance: Provenance + Eq + Hash + 'static

Pointers are “tagged” with provenance information; typically the `AllocId` they belong to.

source

#### 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.

source

#### 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.

source

#### type FrameExtra

Extra data stored in every call frame.

source

#### type AllocExtra: Debug + Clone + 'tcx

Extra data stored in every allocation.

source

#### type Bytes: AllocBytes + 'static

Type for the bytes of the allocation.

source

#### type MemoryMap: AllocMap<AllocId, (MemoryKind<Self::MemoryKind>, Allocation<Self::Provenance, Self::AllocExtra, Self::Bytes>)> + Default + Clone

Memory’s allocation map

## Required Associated Constants§

source

#### 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.

source

#### const PANIC_ON_ALLOC_FAIL: bool

Should the machine panic on allocation failures?

## Provided Associated Constants§

source

#### const POST_MONO_CHECKS: bool = true

Should post-monomorphization checks be run when a stack frame is pushed?

## Required Methods§

source

#### fn enforce_alignment(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool

Whether memory accesses should be alignment-checked.

source

#### fn enforce_validity( ecx: &InterpCx<'mir, 'tcx, Self>, layout: TyAndLayout<'tcx, Ty<'tcx>> ) -> bool

Whether to enforce the validity invariant for a specific layout.

source

#### fn ignore_optional_overflow_checks(_ecx: &InterpCx<'mir, 'tcx, Self>) -> bool

Whether Assert(OverflowNeg) and Assert(Overflow) MIR terminators should actually check for overflow.

source

#### fn find_mir_or_eval_fn( ecx: &mut InterpCx<'mir, 'tcx, Self>, instance: Instance<'tcx>, abi: Abi, args: &[FnArg<'tcx, Self::Provenance>], destination: &MPlaceTy<'tcx, Self::Provenance>, target: Option<BasicBlock>, unwind: UnwindAction ) -> Result<Option<(&'mir Body<'tcx>, Instance<'tcx>)>, InterpErrorInfo<'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.

source

#### fn call_extra_fn( ecx: &mut InterpCx<'mir, 'tcx, Self>, fn_val: Self::ExtraFnVal, abi: Abi, args: &[FnArg<'tcx, Self::Provenance>], destination: &MPlaceTy<'tcx, Self::Provenance>, target: Option<BasicBlock>, unwind: UnwindAction ) -> Result<(), InterpErrorInfo<'tcx>>

Execute `fn_val`. It is the hook’s responsibility to advance the instruction pointer as appropriate.

source

#### fn call_intrinsic( ecx: &mut InterpCx<'mir, 'tcx, Self>, instance: Instance<'tcx>, args: &[OpTy<'tcx, Self::Provenance>], destination: &MPlaceTy<'tcx, Self::Provenance>, target: Option<BasicBlock>, unwind: UnwindAction ) -> Result<(), InterpErrorInfo<'tcx>>

Directly process an intrinsic without pushing a stack frame. It is the hook’s responsibility to advance the instruction pointer as appropriate.

source

#### fn assert_panic( ecx: &mut InterpCx<'mir, 'tcx, Self>, msg: &AssertKind<Operand<'tcx>>, unwind: UnwindAction ) -> Result<(), InterpErrorInfo<'tcx>>

Called to evaluate `Assert` MIR terminators that trigger a panic.

source

#### fn panic_nounwind( _ecx: &mut InterpCx<'mir, 'tcx, Self>, msg: &str ) -> Result<(), InterpErrorInfo<'tcx>>

Called to trigger a non-unwinding panic.

source

#### fn unwind_terminate( ecx: &mut InterpCx<'mir, 'tcx, Self>, reason: UnwindTerminateReason ) -> Result<(), InterpErrorInfo<'tcx>>

Called when unwinding reached a state where execution should be terminated.

source

#### fn binary_ptr_op( ecx: &InterpCx<'mir, 'tcx, Self>, bin_op: BinOp, left: &ImmTy<'tcx, Self::Provenance>, right: &ImmTy<'tcx, Self::Provenance> ) -> Result<(ImmTy<'tcx, Self::Provenance>, bool), InterpErrorInfo<'tcx>>

Called for all binary operations where the LHS has pointer type.

Returns a (value, overflowed) pair if the operation succeeded

source

#### fn extern_static_base_pointer( ecx: &InterpCx<'mir, 'tcx, Self>, def_id: DefId ) -> Result<Pointer<Self::Provenance>, InterpErrorInfo<'tcx>>

Return the root pointer for the given `extern static`.

source

#### fn adjust_alloc_base_pointer( ecx: &InterpCx<'mir, 'tcx, Self>, ptr: Pointer ) -> Result<Pointer<Self::Provenance>, InterpErrorInfo<'tcx>>

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).

source

#### fn ptr_from_addr_cast( ecx: &InterpCx<'mir, 'tcx, Self>, addr: u64 ) -> Result<Pointer<Option<Self::Provenance>>, InterpErrorInfo<'tcx>>

“Int-to-pointer cast”

source

#### fn expose_ptr( ecx: &mut InterpCx<'mir, 'tcx, Self>, ptr: Pointer<Self::Provenance> ) -> Result<(), InterpErrorInfo<'tcx>>

Marks a pointer as exposed, allowing it’s provenance to be recovered. “Pointer-to-int cast”

source

#### 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.

source

#### fn adjust_allocation<'b>( ecx: &InterpCx<'mir, 'tcx, Self>, id: AllocId, alloc: Cow<'b, Allocation>, kind: Option<MemoryKind<Self::MemoryKind>> ) -> Result<Cow<'b, Allocation<Self::Provenance, Self::AllocExtra, Self::Bytes>>, InterpErrorInfo<'tcx>>

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.

source

#### fn init_frame_extra( ecx: &mut InterpCx<'mir, 'tcx, Self>, frame: Frame<'mir, 'tcx, Self::Provenance> ) -> Result<Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>, InterpErrorInfo<'tcx>>

Called immediately before a new stack frame gets pushed.

source

#### fn stack<'a>( ecx: &'a InterpCx<'mir, 'tcx, Self> ) -> &'a [Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>]

Borrow the current thread’s stack.

source

#### 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§

source

#### fn alignment_check( _ecx: &InterpCx<'mir, 'tcx, Self>, _alloc_id: AllocId, _alloc_align: Align, _alloc_kind: AllocKind, _offset: Size, _align: Align ) -> Option<Misalignment>

Gives the machine a chance to detect more misalignment than the built-in checks would catch.

source

#### fn enforce_abi(_ecx: &InterpCx<'mir, 'tcx, Self>) -> bool

Whether function calls should be ABI-checked.

source

#### fn load_mir( ecx: &InterpCx<'mir, 'tcx, Self>, instance: InstanceDef<'tcx> ) -> Result<&'tcx Body<'tcx>, InterpErrorInfo<'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, …

source

#### fn generate_nan<F1, F2>(_ecx: &InterpCx<'mir, 'tcx, Self>, _inputs: &[F1]) -> F2
where F1: Float + FloatConvert<F2>, F2: Float,

Generate the NaN returned by a float operation, given the list of inputs. (This is all inputs, not just NaN inputs!)

source

#### fn before_terminator( _ecx: &mut InterpCx<'mir, 'tcx, Self> ) -> Result<(), InterpErrorInfo<'tcx>>

Called before a basic block terminator is executed.

source

#### fn increment_const_eval_counter( _ecx: &mut InterpCx<'mir, 'tcx, Self> ) -> Result<(), InterpErrorInfo<'tcx>>

Called when the interpreter encounters a `StatementKind::ConstEvalCounter` instruction. You can use this to detect long or endlessly running programs.

source

#### fn before_access_global( _tcx: TyCtxtAt<'tcx>, _machine: &Self, _alloc_id: AllocId, _allocation: ConstAllocation<'tcx>, _static_def_id: Option<DefId>, _is_write: bool ) -> Result<(), InterpErrorInfo<'tcx>>

Called before a global allocation is accessed. `def_id` is `Some` if this is the “lazy” allocation of a static.

source

#### fn thread_local_static_base_pointer( _ecx: &mut InterpCx<'mir, 'tcx, Self>, def_id: DefId ) -> Result<Pointer<Self::Provenance>, InterpErrorInfo<'tcx>>

Return the `AllocId` for the given thread-local static in the current thread.

source

#### fn eval_inline_asm( _ecx: &mut InterpCx<'mir, 'tcx, Self>, _template: &'tcx [InlineAsmTemplatePiece], _operands: &[InlineAsmOperand<'tcx>], _options: InlineAsmOptions, _targets: &[BasicBlock] ) -> Result<(), InterpErrorInfo<'tcx>>

Evaluate the inline assembly.

This should take care of jumping to the next block (one of `targets`) when asm goto is triggered, `targets[0]` when the assembly falls through, or diverge in case of `InlineAsmOptions::NORETURN` being set.

source

#### fn before_memory_read( _tcx: TyCtxtAt<'tcx>, _machine: &Self, _alloc_extra: &Self::AllocExtra, _prov: (AllocId, Self::ProvenanceExtra), _range: AllocRange ) -> Result<(), InterpErrorInfo<'tcx>>

Hook for performing extra checks on a memory read access.

This will not be called during validation!

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.

This is not invoked for ZST accesses, as no read actually happens.

source

#### fn before_alloc_read( _ecx: &InterpCx<'mir, 'tcx, Self>, _alloc_id: AllocId ) -> Result<(), InterpErrorInfo<'tcx>>

Hook for performing extra checks on any memory read access, that involves an allocation, even ZST reads.

This will not be called during validation!

Used to prevent statics from self-initializing by reading from their own memory as it is being initialized.

source

#### fn before_memory_write( _tcx: TyCtxtAt<'tcx>, _machine: &mut Self, _alloc_extra: &mut Self::AllocExtra, _prov: (AllocId, Self::ProvenanceExtra), _range: AllocRange ) -> Result<(), InterpErrorInfo<'tcx>>

Hook for performing extra checks on a memory write access. This is not invoked for ZST accesses, as no write actually happens.

source

#### fn before_memory_deallocation( _tcx: TyCtxtAt<'tcx>, _machine: &mut Self, _alloc_extra: &mut Self::AllocExtra, _prov: (AllocId, Self::ProvenanceExtra), _size: Size, _align: Align ) -> Result<(), InterpErrorInfo<'tcx>>

Hook for performing extra operations on a memory deallocation.

source

#### fn retag_ptr_value( _ecx: &mut InterpCx<'mir, 'tcx, Self>, _kind: RetagKind, val: &ImmTy<'tcx, Self::Provenance> ) -> Result<ImmTy<'tcx, Self::Provenance>, InterpErrorInfo<'tcx>>

Executes a retagging operation for a single pointer. Returns the possibly adjusted pointer.

source

#### fn retag_place_contents( _ecx: &mut InterpCx<'mir, 'tcx, Self>, _kind: RetagKind, _place: &PlaceTy<'tcx, Self::Provenance> ) -> Result<(), InterpErrorInfo<'tcx>>

Executes a retagging operation on a compound value. Replaces all pointers stored in the given place.

source

#### fn protect_in_place_function_argument( ecx: &mut InterpCx<'mir, 'tcx, Self>, mplace: &MPlaceTy<'tcx, Self::Provenance> ) -> Result<(), InterpErrorInfo<'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..

source

#### fn after_stack_push( _ecx: &mut InterpCx<'mir, 'tcx, Self> ) -> Result<(), InterpErrorInfo<'tcx>>

Called immediately after a stack frame got pushed and its locals got initialized.

source

#### fn before_stack_pop( _ecx: &InterpCx<'mir, 'tcx, Self>, _frame: &Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra> ) -> Result<(), InterpErrorInfo<'tcx>>

Called just before the return value is copied to the caller-provided return place.

source

#### fn after_stack_pop( _ecx: &mut InterpCx<'mir, 'tcx, Self>, _frame: Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>, unwinding: bool ) -> Result<StackPopJump, InterpErrorInfo<'tcx>>

Called immediately after a stack frame got popped, but before jumping back to the caller. The `locals` have already been destroyed!

source

#### fn after_local_allocated( _ecx: &mut InterpCx<'mir, 'tcx, Self>, _local: Local, _mplace: &MPlaceTy<'tcx, Self::Provenance> ) -> Result<(), InterpErrorInfo<'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.

source

#### fn eval_mir_constant<F>( ecx: &InterpCx<'mir, 'tcx, Self>, val: Const<'tcx>, span: Span, layout: Option<TyAndLayout<'tcx, Ty<'tcx>>>, eval: F ) -> Result<OpTy<'tcx, Self::Provenance>, InterpErrorInfo<'tcx>>
where F: Fn(&InterpCx<'mir, 'tcx, Self>, Const<'tcx>, Span, Option<TyAndLayout<'tcx, Ty<'tcx>>>) -> Result<OpTy<'tcx, Self::Provenance>, InterpErrorInfo<'tcx>>,

Evaluate the given constant. The `eval` function will do all the required evaluation, but this hook has the chance to do some pre/postprocessing.

## Object Safety§

This trait is not object safe.

## Implementors§

source§

### impl<'mir, 'tcx> Machine<'mir, 'tcx> for CompileTimeInterpreter<'mir, 'tcx>

§

#### type Provenance = CtfeProvenance

§

#### type ProvenanceExtra = bool

§

#### type ExtraFnVal = !

§

#### type MemoryMap = IndexMap<AllocId, (MemoryKind<<CompileTimeInterpreter<'mir, 'tcx> as Machine<'mir, 'tcx>>::MemoryKind>, Allocation), BuildHasherDefault<FxHasher>>

source§

#### const GLOBAL_KIND: Option<<CompileTimeInterpreter<'mir, 'tcx> as Machine<'mir, 'tcx>>::MemoryKind> = None

§

#### type AllocExtra = ()

§

#### type FrameExtra = ()

§

#### type Bytes = Box<[u8]>

§

#### type MemoryKind = MemoryKind

source§

#### const PANIC_ON_ALLOC_FAIL: bool = false

source§

### impl<'mir, 'tcx> Machine<'mir, 'tcx> for MiriMachine<'mir, 'tcx>

Machine hook implementations.

§

#### type MemoryKind = MiriMemoryKind

§

#### type ExtraFnVal = DynSym

§

#### type FrameExtra = FrameExtra<'tcx>

§

#### type AllocExtra = AllocExtra<'tcx>

§

#### type Provenance = Provenance

§

#### type ProvenanceExtra = ProvenanceExtra

§

#### type Bytes = Box<[u8]>

§

#### type MemoryMap = MonoHashMap<AllocId, (MemoryKind<MiriMemoryKind>, Allocation<Provenance, <MiriMachine<'mir, 'tcx> as Machine<'mir, 'tcx>>::AllocExtra, <MiriMachine<'mir, 'tcx> as Machine<'mir, 'tcx>>::Bytes>)>

source§

#### const GLOBAL_KIND: Option<MiriMemoryKind> = _

source§

#### const PANIC_ON_ALLOC_FAIL: bool = false