Struct CompileTimeMachine

pub struct CompileTimeMachine<'tcx> {
    pub(super) num_evaluated_steps: usize,
    pub(super) stack: Vec<Frame<'tcx>>,
    pub(super) can_access_mut_global: CanAccessMutGlobal,
    pub(super) check_alignment: CheckAlignment,
    pub(crate) static_root_ids: Option<(AllocId, LocalDefId)>,
    union_data_ranges: FxHashMap<Ty<'tcx>, RangeSet>,
}

Extra machine state for CTFE, and the Machine instance.

Fields

num_evaluated_steps: usize

The number of terminators that have been evaluated.

This is used to produce lints informing the user that the compiler is not stuck. Set to usize::MAX to never report anything.

stack: Vec<Frame<'tcx>>

The virtual call stack.

can_access_mut_global: CanAccessMutGlobal

Pattern matching on consts with references would be unsound if those references could point to anything mutable. Therefore, when evaluating consts and when constructing valtrees, we ensure that only immutable global memory can be accessed.

check_alignment: CheckAlignment

Whether to check alignment during evaluation.

static_root_ids: Option<(AllocId, LocalDefId)>

If Some, we are evaluating the initializer of the static with the given LocalDefId, storing the result in the given AllocId. Used to prevent reads from a static’s base allocation, as that may allow for self-initialization loops.

union_data_ranges: FxHashMap<Ty<'tcx>, RangeSet>

A cache of “data range” computations for unions (i.e., the offsets of non-padding bytes).

Implementations

impl<'tcx> CompileTimeMachine<'tcx>

pub(crate) fn new( can_access_mut_global: CanAccessMutGlobal, check_alignment: CheckAlignment, ) -> Self

impl<'tcx> CompileTimeMachine<'tcx>

pub fn best_lint_scope(&self, tcx: TyCtxt<'tcx>) -> HirId

Find the first stack frame that is within the current crate, if any. Otherwise, return the crate’s HirId

Trait Implementations

impl HasStaticRootDefId for CompileTimeMachine<'_>

fn static_def_id(&self) -> Option<LocalDefId>

Returns the DefId of the static item that is currently being evaluated. Used for interning to be able to handle nested allocations.

impl<'tcx> Machine<'tcx> for CompileTimeMachine<'tcx>

const GLOBAL_KIND: Option<Self::MemoryKind> = None

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.

const PANIC_ON_ALLOC_FAIL: bool = false

Should the machine panic on allocation failures?

type Provenance = CtfeProvenance

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

type ProvenanceExtra = bool

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.

type ExtraFnVal = !

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.

type MemoryMap = IndexMap<AllocId, (MemoryKind<MemoryKind>, Allocation), BuildHasherDefault<FxHasher>>

Memory’s allocation map

type AllocExtra = ()

Extra data stored in every allocation.

type FrameExtra = ()

Extra data stored in every call frame.

type Bytes = Box<[u8]>

Type for the bytes of the allocation.

type MemoryKind = MemoryKind

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

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

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

fn unwind_terminate( _ecx: &mut InterpCx<'tcx, Self>, _reason: UnwindTerminateReason, ) -> InterpResult<'tcx>

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

fn check_fn_target_features( _ecx: &InterpCx<'tcx, Self>, _instance: Instance<'tcx>, ) -> InterpResult<'tcx>

Check whether the given function may be executed on the current machine, in terms of the target features is requires.

fn call_extra_fn( _ecx: &mut InterpCx<'tcx, Self>, fn_val: !, _abi: &FnAbi<'tcx, Ty<'tcx>>, _args: &[FnArg<'tcx>], _destination: &MPlaceTy<'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.

fn ub_checks(_ecx: &InterpCx<'tcx, Self>) -> InterpResult<'tcx, bool>

Determines the result of a NullaryOp::UbChecks invocation.

fn adjust_global_allocation<'b>( _ecx: &InterpCx<'tcx, Self>, _id: AllocId, alloc: &'b Allocation, ) -> InterpResult<'tcx, Cow<'b, Allocation<Self::Provenance>>>

Called to adjust global allocations to the Provenance and AllocExtra of this machine.

fn init_alloc_extra( _ecx: &InterpCx<'tcx, Self>, _id: AllocId, _kind: MemoryKind<Self::MemoryKind>, _size: Size, _align: Align, ) -> InterpResult<'tcx, Self::AllocExtra>

Initialize the extra state of an allocation.

fn extern_static_pointer( ecx: &InterpCx<'tcx, Self>, def_id: DefId, ) -> InterpResult<'tcx, Pointer>

Return the AllocId for the given extern static.

fn adjust_alloc_root_pointer( _ecx: &InterpCx<'tcx, Self>, ptr: Pointer<CtfeProvenance>, _kind: Option<MemoryKind<Self::MemoryKind>>, ) -> InterpResult<'tcx, Pointer<CtfeProvenance>>

Return a “root” 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.

fn ptr_from_addr_cast( _ecx: &InterpCx<'tcx, Self>, addr: u64, ) -> InterpResult<'tcx, Pointer<Option<CtfeProvenance>>>

“Int-to-pointer cast”

fn ptr_get_alloc( _ecx: &InterpCx<'tcx, Self>, ptr: Pointer<CtfeProvenance>, _size: i64, ) -> Option<(AllocId, Size, Self::ProvenanceExtra)>

Convert a pointer with provenance into an allocation-offset pair and extra provenance info. size says how many bytes of memory are expected at that pointer. The sign of size can be used to disambiguate situations where a wildcard pointer sits right in between two allocations.

fn get_global_alloc_salt( _ecx: &InterpCx<'tcx, Self>, _instance: Option<Instance<'tcx>>, ) -> usize

Returns the salt to be used for a deduplicated global alloation. If the allocation is for a function, the instance is provided as well (this lets Miri ensure unique addresses for some functions).

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

Whether memory accesses should be alignment-checked.

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

Whether to enforce the validity invariant for a specific layout.

fn load_mir( ecx: &InterpCx<'tcx, Self>, instance: InstanceKind<'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, …

fn find_mir_or_eval_fn( ecx: &mut InterpCx<'tcx, Self>, orig_instance: Instance<'tcx>, _abi: &FnAbi<'tcx, Ty<'tcx>>, args: &[FnArg<'tcx>], dest: &MPlaceTy<'tcx>, ret: Option<BasicBlock>, _unwind: UnwindAction, ) -> InterpResult<'tcx, Option<(&'tcx Body<'tcx>, Instance<'tcx>)>>

Entry point to all function calls.

fn panic_nounwind( ecx: &mut InterpCx<'tcx, Self>, msg: &str, ) -> InterpResult<'tcx>

Called to trigger a non-unwinding panic.

fn call_intrinsic( ecx: &mut InterpCx<'tcx, Self>, instance: Instance<'tcx>, args: &[OpTy<'tcx>], dest: &MPlaceTy<'tcx, Self::Provenance>, target: Option<BasicBlock>, _unwind: UnwindAction, ) -> InterpResult<'tcx, Option<Instance<'tcx>>>

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

fn assert_panic( ecx: &mut InterpCx<'tcx, Self>, msg: &AssertMessage<'tcx>, _unwind: UnwindAction, ) -> InterpResult<'tcx>

Called to evaluate Assert MIR terminators that trigger a panic.

fn binary_ptr_op( _ecx: &InterpCx<'tcx, Self>, _bin_op: BinOp, _left: &ImmTy<'tcx>, _right: &ImmTy<'tcx>, ) -> InterpResult<'tcx, ImmTy<'tcx>>

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

fn increment_const_eval_counter( ecx: &mut InterpCx<'tcx, Self>, ) -> InterpResult<'tcx>

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

fn expose_provenance( _ecx: &InterpCx<'tcx, Self>, _provenance: Self::Provenance, ) -> InterpResult<'tcx>

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

fn init_frame( ecx: &mut InterpCx<'tcx, Self>, frame: Frame<'tcx>, ) -> InterpResult<'tcx, Frame<'tcx>>

Called immediately before a new stack frame gets pushed.

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

Borrow the current thread’s stack.

fn stack_mut<'a>( ecx: &'a mut InterpCx<'tcx, Self>, ) -> &'a mut Vec<Frame<'tcx, Self::Provenance, Self::FrameExtra>>

Mutably borrow the current thread’s stack.

fn before_access_global( _tcx: TyCtxtAt<'tcx>, machine: &Self, alloc_id: AllocId, alloc: 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.

fn retag_ptr_value( ecx: &mut InterpCx<'tcx, Self>, _kind: RetagKind, val: &ImmTy<'tcx, CtfeProvenance>, ) -> InterpResult<'tcx, ImmTy<'tcx, CtfeProvenance>>

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

fn before_memory_write( _tcx: TyCtxtAt<'tcx>, _machine: &mut Self, _alloc_extra: &mut Self::AllocExtra, (_alloc_id, immutable): (AllocId, bool), range: AllocRange, ) -> InterpResult<'tcx>

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

fn before_alloc_read( ecx: &InterpCx<'tcx, Self>, alloc_id: AllocId, ) -> InterpResult<'tcx>

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

fn cached_union_data_range<'e>( ecx: &'e mut InterpCx<'tcx, Self>, ty: Ty<'tcx>, compute_range: impl FnOnce() -> RangeSet, ) -> Cow<'e, RangeSet>

const ALL_CONSTS_ARE_PRECHECKED: bool = true

Determines whether eval_mir_constant can never fail because all required consts have already been checked before.

fn alignment_check( _ecx: &InterpCx<'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.

fn enforce_validity_recursively( _ecx: &InterpCx<'tcx, Self>, _layout: TyAndLayout<'tcx>, ) -> bool

Whether to enforce the validity invariant recursively.

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

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

fn before_terminator(_ecx: &mut InterpCx<'tcx, Self>) -> InterpResult<'tcx>

Called before a basic block terminator is executed.

fn thread_local_static_pointer( _ecx: &mut InterpCx<'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<'tcx, Self>, _template: &'tcx [InlineAsmTemplatePiece], _operands: &[InlineAsmOperand<'tcx>], _options: InlineAsmOptions, _targets: &[BasicBlock], ) -> InterpResult<'tcx>

Evaluate the inline assembly.

fn before_memory_read( _tcx: TyCtxtAt<'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.

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

Hook for performing extra operations on a memory deallocation.

fn retag_place_contents( _ecx: &mut InterpCx<'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.

fn protect_in_place_function_argument( ecx: &mut InterpCx<'tcx, Self>, mplace: &MPlaceTy<'tcx, Self::Provenance>, ) -> InterpResult<'tcx>

Called on places used for in-place function argument and return value handling.

fn after_stack_push(_ecx: &mut InterpCx<'tcx, Self>) -> InterpResult<'tcx>

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

fn before_stack_pop( _ecx: &InterpCx<'tcx, Self>, _frame: &Frame<'tcx, Self::Provenance, Self::FrameExtra>, ) -> InterpResult<'tcx>

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

fn after_stack_pop( _ecx: &mut InterpCx<'tcx, Self>, _frame: Frame<'tcx, Self::Provenance, Self::FrameExtra>, unwinding: bool, ) -> InterpResult<'tcx, ReturnAction>

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

fn after_local_read( _ecx: &InterpCx<'tcx, Self>, _frame: &Frame<'tcx, Self::Provenance, Self::FrameExtra>, _local: Local, ) -> InterpResult<'tcx>

Called immediately after an “immediate” local variable is read in a given frame (i.e., this is called for reads that do not end up accessing addressable memory).

fn after_local_write( _ecx: &mut InterpCx<'tcx, Self>, _local: Local, _storage_live: bool, ) -> InterpResult<'tcx>

Called immediately after an “immediate” local variable is assigned a new value (i.e., this is called for writes that do not end up in memory). storage_live indicates whether this is the initial write upon StorageLive.

fn after_local_moved_to_memory( _ecx: &mut InterpCx<'tcx, Self>, _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.

fn eval_mir_constant<F>( ecx: &InterpCx<'tcx, Self>, val: Const<'tcx>, span: Span, layout: Option<TyAndLayout<'tcx>>, eval: F, ) -> InterpResult<'tcx, OpTy<'tcx, Self::Provenance>>

where F: Fn(&InterpCx<'tcx, Self>, Const<'tcx>, Span, Option<TyAndLayout<'tcx>>) -> InterpResult<'tcx, OpTy<'tcx, Self::Provenance>>,

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

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: 88 bytes