Struct rustc_middle::mir::syntax::Place

pub struct Place<'tcx> {
    pub local: Local,
    pub projection: &'tcx List<PlaceElem<'tcx>>,
}

Places roughly correspond to a “location in memory.” Places in MIR are the same mathematical object as places in Rust. This of course means that what exactly they are is undecided and part of the Rust memory model. However, they will likely contain at least the following pieces of information in some form:

1. The address in memory that the place refers to.
2. The provenance with which the place is being accessed.
3. The type of the place and an optional variant index. See PlaceTy.
4. Optionally, some metadata. This exists if and only if the type of the place is not Sized.

We’ll give a description below of how all pieces of the place except for the provenance are calculated. We cannot give a description of the provenance, because that is part of the undecided aliasing model - we only include it here at all to acknowledge its existence.

Each local naturally corresponds to the place Place { local, projection: [] }. This place has the address of the local’s allocation and the type of the local.

Needs clarification: Unsized locals seem to present a bit of an issue. Their allocation can’t actually be created on StorageLive, because it’s unclear how big to make the allocation. Furthermore, MIR produces assignments to unsized locals, although that is not permitted under #![feature(unsized_locals)] in Rust. Besides just putting “unsized locals are special and different” in a bunch of places, I (JakobDegen) don’t know how to incorporate this behavior into the current MIR semantics in a clean way - possibly this needs some design work first.

For places that are not locals, ie they have a non-empty list of projections, we define the values as a function of the parent place, that is the place with its last ProjectionElem stripped. The way this is computed of course depends on the kind of that last projection element:

• Downcast: This projection sets the place’s variant index to the given one, and makes no other changes. A Downcast projection on a place with its variant index already set is not well-formed.

• Field: Field projections take their parent place and create a place referring to one of the fields of the type. The resulting address is the parent address, plus the offset of the field. The type becomes the type of the field. If the parent was unsized and so had metadata associated with it, then the metadata is retained if the field is unsized and thrown out if it is sized.

  These projections are only legal for tuples, ADTs, closures, and generators. If the ADT or generator has more than one variant, the parent place’s variant index must be set, indicating which variant is being used. If it has just one variant, the variant index may or may not be included - the single possible variant is inferred if it is not included.

• ConstantIndex: Computes an offset in units of T into the place as described in the documentation for the ProjectionElem. The resulting address is the parent’s address plus that offset, and the type is T. This is only legal if the parent place has type [T; N] or [T] (not &[T]). Since such a T is always sized, any resulting metadata is thrown out.

• Subslice: This projection calculates an offset and a new address in a similar manner as ConstantIndex. It is also only legal on [T; N] and [T]. However, this yields a Place of type [T], and additionally sets the metadata to be the length of the subslice.

• Index: Like ConstantIndex, only legal on [T; N] or [T]. However, Index additionally takes a local from which the value of the index is computed at runtime. Computing the value of the index involves interpreting the Local as a Place { local, projection: [] }, and then computing its value as if done via Operand::Copy. The array/slice is then indexed with the resulting value. The local must have type usize.

• Deref: Derefs are the last type of projection, and the most complicated. They are only legal on parent places that are references, pointers, or Box. A Deref projection begins by loading a value from the parent place, as if by Operand::Copy. It then dereferences the resulting pointer, creating a place of the pointee’s type. The resulting address is the address that was stored in the pointer. If the pointee type is unsized, the pointer additionally stored the value of the metadata.

Computing a place may cause UB. One possibility is that the pointer used for a Deref may not be suitably aligned. Another possibility is that the place is not in bounds, meaning it does not point to an actual allocation.

However, if this is actually UB and when the UB kicks in is undecided. This is being discussed in UCG#319. The options include that every place must obey those rules, that only some places must obey them, or that places impose no rules of their own.

Rust currently requires that every place obey those two rules. This is checked by MIRI and taken advantage of by codegen (via gep inbounds). That is possibly subject to change.

Fields

local: Local

projection: &'tcx List<PlaceElem<'tcx>>

projection out of a place (access a field, deref a pointer, etc)

Implementations

impl<'tcx> Place<'tcx>

pub fn ty_from<D>(
    local: Local,
    projection: &[PlaceElem<'tcx>],
    local_decls: &D,
    tcx: TyCtxt<'tcx>
) -> PlaceTy<'tcx>where
    D: HasLocalDecls<'tcx>,

pub fn ty<D>(&self, local_decls: &D, tcx: TyCtxt<'tcx>) -> PlaceTy<'tcx>where
    D: HasLocalDecls<'tcx>,

impl<'tcx> Place<'tcx>

pub fn return_place() -> Place<'tcx>

pub fn is_indirect(&self) -> bool

Returns true if this Place contains a Deref projection.

If Place::is_indirect returns false, the caller knows that the Place refers to the same region of memory as its base.

pub fn has_deref(&self) -> bool

If MirPhase >= Derefered and if projection contains Deref, It’s guaranteed to be in the first place

pub fn local_or_deref_local(&self) -> Option<Local>

Finds the innermost Local from this Place, if it is either a local itself or a single deref of a local.

pub fn as_local(&self) -> Option<Local>

If this place represents a local variable like _X with no projections, return Some(_X).

pub fn as_ref(&self) -> PlaceRef<'tcx>

pub fn iter_projections(
    self
) -> impl Iterator<Item = (PlaceRef<'tcx>, PlaceElem<'tcx>)> + DoubleEndedIterator

Iterate over the projections in evaluation order, i.e., the first element is the base with its projection and then subsequently more projections are added. As a concrete example, given the place a.b.c, this would yield:

• (a, .b)
• (a.b, .c)

Given a place without projections, the iterator is empty.

pub fn project_deeper(
    self,
    more_projections: &[PlaceElem<'tcx>],
    tcx: TyCtxt<'tcx>
) -> Self

Generates a new place by appending more_projections to the existing ones and interning the result.

Trait Implementations

impl<'tcx> Clone for Place<'tcx>

fn clone(&self) -> Place<'tcx>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Place<'_>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'tcx, D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<D> for Place<'tcx>

fn decode(decoder: &mut D) -> Self

impl<'tcx, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for Place<'tcx>

fn encode(&self, __encoder: &mut __E)

impl From<Local> for Place<'_>

fn from(local: Local) -> Self

Converts to this type from the input type.

impl<'tcx> Hash for Place<'tcx>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for Place<'tcx>

fn hash_stable(
    &self,
    __hcx: &mut StableHashingContext<'__ctx>,
    __hasher: &mut StableHasher
)

impl<'tcx> PartialEq<Place<'tcx>> for Place<'tcx>

fn eq(&self, other: &Place<'tcx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'tcx> TypeFoldable<'tcx> for Place<'tcx>

fn try_fold_with<__F: FallibleTypeFolder<'tcx>>(
    self,
    __folder: &mut __F
) -> Result<Self, __F::Error>

The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f).

fn fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.

impl<'tcx> TypeVisitable<'tcx> for Place<'tcx>

fn visit_with<__V: TypeVisitor<'tcx>>(
    &self,
    __visitor: &mut __V
) -> ControlFlow<__V::BreakTy>

The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v).

fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool

Returns true if self has any late-bound regions that are either bound by binder or bound by some binder outside of binder. If binder is ty::INNERMOST, this indicates whether there are any late-bound regions that appear free.

fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool

Returns true if this self has any regions that escape binder (and hence are not bound by it).

fn has_escaping_bound_vars(&self) -> bool

fn has_type_flags(&self, flags: TypeFlags) -> bool

fn has_projections(&self) -> bool

fn has_opaque_types(&self) -> bool

fn references_error(&self) -> bool

fn error_reported(&self) -> Option<ErrorGuaranteed>

fn has_param_types_or_consts(&self) -> bool

fn has_infer_regions(&self) -> bool

fn has_infer_types(&self) -> bool

fn has_infer_types_or_consts(&self) -> bool

fn needs_infer(&self) -> bool

fn has_placeholders(&self) -> bool

fn needs_subst(&self) -> bool

fn has_free_regions(&self) -> bool

“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound.

fn has_erased_regions(&self) -> bool

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.

fn is_global(&self) -> bool

Indicates whether this value references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching.

fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions

fn still_further_specializable(&self) -> bool

Indicates whether this value still has parameters/placeholders/inference variables which could be replaced later, in a way that would change the results of impl specialization.

impl<'tcx> Copy for Place<'tcx>

impl<'tcx> Eq for Place<'tcx>

impl<'tcx> StructuralEq for Place<'tcx>

impl<'tcx> StructuralPartialEq for Place<'tcx>

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