[][src]Trait rustc_mir::interpret::Machine

pub trait Machine<'mir, 'tcx>: Sized {
    type MemoryKinds: Debug + MayLeak + Eq + 'static;
    type PointerTag: Debug + Copy + Eq + Hash + 'static;
    type ExtraFnVal: Debug + Copy;
    type FrameExtra;
    type MemoryExtra;
    type AllocExtra: AllocationExtra<Self::PointerTag> + 'static;
    type MemoryMap: AllocMap<AllocId, (MemoryKind<Self::MemoryKinds>, Allocation<Self::PointerTag, Self::AllocExtra>)> + Default + Clone;

    const STATIC_KIND: Option<Self::MemoryKinds>;
    const CHECK_ALIGN: bool;

    fn enforce_validity(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool;
fn before_terminator(
        ecx: &mut InterpCx<'mir, 'tcx, Self>
    ) -> InterpResult<'tcx>;
fn find_mir_or_eval_fn(
        ecx: &mut InterpCx<'mir, 'tcx, Self>,
        span: Span,
        instance: Instance<'tcx>,
        args: &[OpTy<'tcx, Self::PointerTag>],
        ret: Option<(PlaceTy<'tcx, Self::PointerTag>, BasicBlock)>,
        unwind: Option<BasicBlock>
    ) -> InterpResult<'tcx, Option<&'mir Body<'tcx>>>;
fn call_extra_fn(
        ecx: &mut InterpCx<'mir, 'tcx, Self>,
        fn_val: Self::ExtraFnVal,
        args: &[OpTy<'tcx, Self::PointerTag>],
        ret: Option<(PlaceTy<'tcx, Self::PointerTag>, BasicBlock)>,
        unwind: Option<BasicBlock>
    ) -> InterpResult<'tcx>;
fn call_intrinsic(
        ecx: &mut InterpCx<'mir, 'tcx, Self>,
        span: Span,
        instance: Instance<'tcx>,
        args: &[OpTy<'tcx, Self::PointerTag>],
        ret: Option<(PlaceTy<'tcx, Self::PointerTag>, BasicBlock)>,
        unwind: Option<BasicBlock>
    ) -> InterpResult<'tcx>;
fn assert_panic(
        ecx: &mut InterpCx<'mir, 'tcx, Self>,
        span: Span,
        msg: &AssertMessage<'tcx>,
        unwind: Option<BasicBlock>
    ) -> InterpResult<'tcx>;
fn find_foreign_static(
        tcx: TyCtxt<'tcx>,
        def_id: DefId
    ) -> InterpResult<'tcx, Cow<'tcx, Allocation>>;
fn binary_ptr_op(
        ecx: &InterpCx<'mir, 'tcx, Self>,
        bin_op: BinOp,
        left: ImmTy<'tcx, Self::PointerTag>,
        right: ImmTy<'tcx, Self::PointerTag>
    ) -> InterpResult<'tcx, (Scalar<Self::PointerTag>, bool, Ty<'tcx>)>;
fn box_alloc(
        ecx: &mut InterpCx<'mir, 'tcx, Self>,
        dest: PlaceTy<'tcx, Self::PointerTag>
    ) -> InterpResult<'tcx>;
fn init_allocation_extra<'b>(
        memory_extra: &Self::MemoryExtra,
        id: AllocId,
        alloc: Cow<'b, Allocation>,
        kind: Option<MemoryKind<Self::MemoryKinds>>
    ) -> (Cow<'b, Allocation<Self::PointerTag, Self::AllocExtra>>, Self::PointerTag);
fn tag_static_base_pointer(
        memory_extra: &Self::MemoryExtra,
        id: AllocId
    ) -> Self::PointerTag;
fn stack_push(
        ecx: &mut InterpCx<'mir, 'tcx, Self>
    ) -> InterpResult<'tcx, Self::FrameExtra>;
fn ptr_to_int(
        _mem: &Memory<'mir, 'tcx, Self>,
        _ptr: Pointer<Self::PointerTag>
    ) -> InterpResult<'tcx, u64>; fn access_local(
        _ecx: &InterpCx<'mir, 'tcx, Self>,
        frame: &Frame<'mir, 'tcx, Self::PointerTag, Self::FrameExtra>,
        local: Local
    ) -> InterpResult<'tcx, Operand<Self::PointerTag>> { ... }
fn before_access_static(
        _memory_extra: &Self::MemoryExtra,
        _allocation: &Allocation
    ) -> InterpResult<'tcx> { ... }
fn retag(
        _ecx: &mut InterpCx<'mir, 'tcx, Self>,
        _kind: RetagKind,
        _place: PlaceTy<'tcx, Self::PointerTag>
    ) -> InterpResult<'tcx> { ... }
fn stack_pop(
        _ecx: &mut InterpCx<'mir, 'tcx, Self>,
        _extra: Self::FrameExtra,
        _unwinding: bool
    ) -> InterpResult<'tcx, StackPopInfo> { ... }
fn int_to_ptr(
        _mem: &Memory<'mir, 'tcx, Self>,
        int: u64
    ) -> InterpResult<'tcx, Pointer<Self::PointerTag>> { ... } }
⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Methods of this trait signifies a point where CTFE evaluation would fail and some use case dependent behaviour can instead be applied.

Associated Types

type MemoryKinds: Debug + MayLeak + Eq + 'static

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

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

type PointerTag: Debug + Copy + Eq + Hash + 'static

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Tag tracked alongside every pointer. This is used to implement "Stacked Borrows" https://www.ralfj.de/blog/2018/08/07/stacked-borrows.html. The default() is used for pointers to consts, statics, vtables and functions.

type ExtraFnVal: Debug + Copy

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

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 FrameExtra

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Extra data stored in every call frame.

type MemoryExtra

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Extra data stored in memory. A reference to this is available when AllocExtra gets initialized, so you can e.g., have an Rc here if there is global state you need access to in the AllocExtra hooks.

type AllocExtra: AllocationExtra<Self::PointerTag> + 'static

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Extra data stored in every allocation.

type MemoryMap: AllocMap<AllocId, (MemoryKind<Self::MemoryKinds>, Allocation<Self::PointerTag, Self::AllocExtra>)> + Default + Clone

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Memory's allocation map

Loading content...

Associated Constants

const STATIC_KIND: Option<Self::MemoryKinds>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

The memory kind to use for copied statics -- or None if statics 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 tag_allocation or find_foreign_static (see below) returns an owned allocation that is added to the memory so that the work is not done twice.

const CHECK_ALIGN: bool

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Whether memory accesses should be alignment-checked.

Loading content...

Required methods

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

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Whether to enforce the validity invariant

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

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Called before a basic block terminator is executed. You can use this to detect endlessly running programs.

fn find_mir_or_eval_fn(
    ecx: &mut InterpCx<'mir, 'tcx, Self>,
    span: Span,
    instance: Instance<'tcx>,
    args: &[OpTy<'tcx, Self::PointerTag>],
    ret: Option<(PlaceTy<'tcx, Self::PointerTag>, BasicBlock)>,
    unwind: Option<BasicBlock>
) -> InterpResult<'tcx, Option<&'mir Body<'tcx>>>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

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 destand ret in the same Option proved very annoying when only one of them was used.

fn call_extra_fn(
    ecx: &mut InterpCx<'mir, 'tcx, Self>,
    fn_val: Self::ExtraFnVal,
    args: &[OpTy<'tcx, Self::PointerTag>],
    ret: Option<(PlaceTy<'tcx, Self::PointerTag>, BasicBlock)>,
    unwind: Option<BasicBlock>
) -> InterpResult<'tcx>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

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

fn call_intrinsic(
    ecx: &mut InterpCx<'mir, 'tcx, Self>,
    span: Span,
    instance: Instance<'tcx>,
    args: &[OpTy<'tcx, Self::PointerTag>],
    ret: Option<(PlaceTy<'tcx, Self::PointerTag>, BasicBlock)>,
    unwind: Option<BasicBlock>
) -> InterpResult<'tcx>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

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<'mir, 'tcx, Self>,
    span: Span,
    msg: &AssertMessage<'tcx>,
    unwind: Option<BasicBlock>
) -> InterpResult<'tcx>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Called to evaluate Assert MIR terminators that trigger a panic.

fn find_foreign_static(
    tcx: TyCtxt<'tcx>,
    def_id: DefId
) -> InterpResult<'tcx, Cow<'tcx, Allocation>>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Called for read access to a foreign static item.

This will only be called once per static and machine; the result is cached in the machine memory. (This relies on AllocMap::get_or being able to add the owned allocation to the map even when the map is shared.)

This allocation will then be fed to tag_allocation to initialize the "extra" state.

fn binary_ptr_op(
    ecx: &InterpCx<'mir, 'tcx, Self>,
    bin_op: BinOp,
    left: ImmTy<'tcx, Self::PointerTag>,
    right: ImmTy<'tcx, Self::PointerTag>
) -> InterpResult<'tcx, (Scalar<Self::PointerTag>, bool, Ty<'tcx>)>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

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

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

fn box_alloc(
    ecx: &mut InterpCx<'mir, 'tcx, Self>,
    dest: PlaceTy<'tcx, Self::PointerTag>
) -> InterpResult<'tcx>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Heap allocations via the box keyword.

fn init_allocation_extra<'b>(
    memory_extra: &Self::MemoryExtra,
    id: AllocId,
    alloc: Cow<'b, Allocation>,
    kind: Option<MemoryKind<Self::MemoryKinds>>
) -> (Cow<'b, Allocation<Self::PointerTag, Self::AllocExtra>>, Self::PointerTag)

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Called to initialize the "extra" state of an allocation and make the pointers it contains (in relocations) tagged. 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 statics, and allocations ceated by Miri during evaluation.

kind is the kind of the allocation being tagged; it can be None when it's a static and STATIC_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 add tags or metadata), 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.)

Also return the "base" tag to use for this allocation: the one that is used for direct accesses to this allocation. If kind == STATIC_KIND, this tag must be consistent with tag_static_base_pointer.

fn tag_static_base_pointer(
    memory_extra: &Self::MemoryExtra,
    id: AllocId
) -> Self::PointerTag

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Return the "base" tag for the given static allocation: the one that is used for direct accesses to this static/const/fn allocation. If id is not a static allocation, this will return an unusable tag (i.e., accesses will be UB)!

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

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Called immediately before a new stack frame got pushed

fn ptr_to_int(
    _mem: &Memory<'mir, 'tcx, Self>,
    _ptr: Pointer<Self::PointerTag>
) -> InterpResult<'tcx, u64>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Loading content...

Provided methods

fn access_local(
    _ecx: &InterpCx<'mir, 'tcx, Self>,
    frame: &Frame<'mir, 'tcx, Self::PointerTag, Self::FrameExtra>,
    local: Local
) -> InterpResult<'tcx, Operand<Self::PointerTag>>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Called to read the specified local from the frame.

fn before_access_static(
    _memory_extra: &Self::MemoryExtra,
    _allocation: &Allocation
) -> InterpResult<'tcx>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Called before a Static value is accessed.

fn retag(
    _ecx: &mut InterpCx<'mir, 'tcx, Self>,
    _kind: RetagKind,
    _place: PlaceTy<'tcx, Self::PointerTag>
) -> InterpResult<'tcx>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Executes a retagging operation

fn stack_pop(
    _ecx: &mut InterpCx<'mir, 'tcx, Self>,
    _extra: Self::FrameExtra,
    _unwinding: bool
) -> InterpResult<'tcx, StackPopInfo>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Called immediately after a stack frame gets popped

fn int_to_ptr(
    _mem: &Memory<'mir, 'tcx, Self>,
    int: u64
) -> InterpResult<'tcx, Pointer<Self::PointerTag>>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Loading content...

Implementors

impl<'mir, 'tcx> Machine<'mir, 'tcx> for CompileTimeInterpreter<'mir, 'tcx>[src]

type MemoryKinds = !

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type PointerTag = ()

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type ExtraFnVal = !

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type FrameExtra = ()

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type MemoryExtra = MemoryExtra

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type AllocExtra = ()

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type MemoryMap = FxHashMap<AllocId, (MemoryKind<!>, Allocation)>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

impl<'mir, 'tcx> Machine<'mir, 'tcx> for ConstPropMachine[src]

type MemoryKinds = !

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type PointerTag = ()

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type ExtraFnVal = !

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type FrameExtra = ()

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type MemoryExtra = ()

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type AllocExtra = ()

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

type MemoryMap = FxHashMap<AllocId, (MemoryKind<!>, Allocation)>

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Loading content...