Struct Frame

pub struct Frame<'tcx, Prov: Provenance = CtfeProvenance, Extra = ()> {
    pub(super) body: &'tcx Body<'tcx>,
    pub(super) instance: Instance<'tcx>,
    pub extra: Extra,
    return_to_block: StackPopCleanup,
    pub return_place: MPlaceTy<'tcx, Prov>,
    pub locals: IndexVec<Local, LocalState<'tcx, Prov>>,
    tracing_span: SpanGuard,
    pub(super) loc: Either<Location, Span>,
}

A stack frame.

Fields

body: &'tcx Body<'tcx>

The MIR for the function called on this frame.

instance: Instance<'tcx>

The def_id and args of the current function.

extra: Extra

Extra data for the machine.

return_to_block: StackPopCleanup

Work to perform when returning from this function.

return_place: MPlaceTy<'tcx, Prov>

The location where the result of the current stack frame should be written to, and its layout in the caller.

locals: IndexVec<Local, LocalState<'tcx, Prov>>

The list of locals for this stack frame, stored in order as [return_ptr, arguments..., variables..., temporaries...]. The locals are stored as Option<Value>s. None represents a local that is currently dead, while a live local can either directly contain Scalar or refer to some part of an Allocation.

Do not access this directly; always go through the machine hook!

tracing_span: SpanGuard

The span of the tracing crate is stored here. When the guard is dropped, the span is exited. This gives us a full stack trace on all tracing statements.

loc: Either<Location, Span>

If this is Right, we are not currently executing any particular statement in this frame (can happen e.g. during frame initialization, and during unwinding on frames without cleanup code).

Needs to be public because ConstProp does unspeakable things to it.

Implementations

impl<'tcx, Prov: Provenance> Frame<'tcx, Prov>

pub fn with_extra<Extra>(self, extra: Extra) -> Frame<'tcx, Prov, Extra>

impl<'tcx, Prov: Provenance, Extra> Frame<'tcx, Prov, Extra>

pub fn current_loc(&self) -> Either<Location, Span>

Get the current location within the Frame.

If this is Right, we are not currently executing any particular statement in this frame (can happen e.g. during frame initialization, and during unwinding on frames without cleanup code).

Used by priroda.

pub fn body(&self) -> &'tcx Body<'tcx>

pub fn instance(&self) -> Instance<'tcx>

pub fn current_source_info(&self) -> Option<&SourceInfo>

Return the SourceInfo of the current instruction.

pub fn current_span(&self) -> Span

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

pub(super) fn locals_addr(&self) -> usize

Returns the address of the buffer where the locals are stored. This is used by Place as a sanity check to detect bugs where we mix up which stack frame a place refers to.

pub fn generate_stacktrace_from_stack(stack: &[Self]) -> Vec<FrameInfo<'tcx>>

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.