pub enum StatementKind<'tcx> {
    Assign(Box<(Place<'tcx>, Rvalue<'tcx>)>),
    FakeRead(Box<(FakeReadCause, Place<'tcx>)>),
    SetDiscriminant {
        place: Box<Place<'tcx>>,
        variant_index: VariantIdx,
    },
    Deinit(Box<Place<'tcx>>),
    StorageLive(Local),
    StorageDead(Local),
    Retag(RetagKindBox<Place<'tcx>>),
    AscribeUserType(Box<(Place<'tcx>, UserTypeProjection)>, Variance),
    Coverage(Box<Coverage>),
    Intrinsic(Box<NonDivergingIntrinsic<'tcx>>),
    Nop,
}
Expand description

The various kinds of statements that can appear in MIR.

Not all of these are allowed at every MirPhase. Check the documentation there to see which ones you do not have to worry about. The MIR validator will generally enforce such restrictions, causing an ICE if they are violated.

Variants

Assign(Box<(Place<'tcx>, Rvalue<'tcx>)>)

Assign statements roughly correspond to an assignment in Rust proper (x = ...) except without the possibility of dropping the previous value (that must be done separately, if at all). The exact way this works is undecided. It probably does something like evaluating the LHS to a place and the RHS to a value, and then storing the value to the place. Various parts of this may do type specific things that are more complicated than simply copying bytes.

Needs clarification: The implication of the above idea would be that assignment implies that the resulting value is initialized. I believe we could commit to this separately from committing to whatever part of the memory model we would need to decide on to make the above paragragh precise. Do we want to?

Assignments in which the types of the place and rvalue differ are not well-formed.

Needs clarification: Do we ever want to worry about non-free (in the body) lifetimes for the typing requirement in post drop-elaboration MIR? I think probably not - I’m not sure we could meaningfully require this anyway. How about free lifetimes? Is ignoring this interesting for optimizations? Do we want to allow such optimizations?

Needs clarification: We currently require that the LHS place not overlap with any place read as part of computation of the RHS for some rvalues (generally those not producing primitives). This requirement is under discussion in #68364. As a part of this discussion, it is also unclear in what order the components are evaluated.

See Rvalue documentation for details on each of those.

FakeRead(Box<(FakeReadCause, Place<'tcx>)>)

This represents all the reading that a pattern match may do (e.g., inspecting constants and discriminant values), and the kind of pattern it comes from. This is in order to adapt potential error messages to these specific patterns.

Note that this also is emitted for regular let bindings to ensure that locals that are never accessed still get some sanity checks for, e.g., let x: ! = ..;

When executed at runtime this is a nop.

Disallowed after drop elaboration.

SetDiscriminant

Fields

place: Box<Place<'tcx>>
variant_index: VariantIdx

Write the discriminant for a variant to the enum Place.

This is permitted for both generators and ADTs. This does not necessarily write to the entire place; instead, it writes to the minimum set of bytes as required by the layout for the type.

Deinit(Box<Place<'tcx>>)

Deinitializes the place.

This writes uninit bytes to the entire place.

StorageLive(Local)

StorageLive and StorageDead statements mark the live range of a local.

At any point during the execution of a function, each local is either allocated or unallocated. Except as noted below, all locals except function parameters are initially unallocated. StorageLive statements cause memory to be allocated for the local while StorageDead statements cause the memory to be freed. Using a local in any way (not only reading/writing from it) while it is unallocated is UB.

Some locals have no StorageLive or StorageDead statements within the entire MIR body. These locals are implicitly allocated for the full duration of the function. There is a convenience method at rustc_mir_dataflow::storage::always_storage_live_locals for computing these locals.

If the local is already allocated, calling StorageLive again is UB. However, for an unallocated local an additional StorageDead all is simply a nop.

StorageDead(Local)

See StorageLive above.

Retag(RetagKindBox<Place<'tcx>>)

Retag references in the given place, ensuring they got fresh tags.

This is part of the Stacked Borrows model. These statements are currently only interpreted by miri and only generated when -Z mir-emit-retag is passed. See https://internals.rust-lang.org/t/stacked-borrows-an-aliasing-model-for-rust/8153/ for more details.

For code that is not specific to stacked borrows, you should consider retags to read and modify the place in an opaque way.

AscribeUserType(Box<(Place<'tcx>, UserTypeProjection)>, Variance)

Encodes a user’s type ascription. These need to be preserved intact so that NLL can respect them. For example:

let a: T = y;

The effect of this annotation is to relate the type T_y of the place y to the user-given type T. The effect depends on the specified variance:

  • Covariant – requires that T_y <: T
  • Contravariant – requires that T_y :> T
  • Invariant – requires that T_y == T
  • Bivariant – no effect

When executed at runtime this is a nop.

Disallowed after drop elaboration.

Coverage(Box<Coverage>)

Marks the start of a “coverage region”, injected with ‘-Cinstrument-coverage’. A Coverage statement carries metadata about the coverage region, used to inject a coverage map into the binary. If Coverage::kind is a Counter, the statement also generates executable code, to increment a counter variable at runtime, each time the code region is executed.

Intrinsic(Box<NonDivergingIntrinsic<'tcx>>)

Denotes a call to an intrinsic that does not require an unwind path and always returns. This avoids adding a new block and a terminator for simple intrinsics.

Nop

No-op. Useful for deleting instructions without affecting statement indices.

Implementations

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f). Read more
A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with. Read more
The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v). Read more
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. Read more
Returns true if this self has any regions that escape binder (and hence are not bound by it). Read more
“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound. Read more
True if there are any un-erased free regions.
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. Read more
True if there are any late-bound regions
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. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
This method turns the parameters of a DepNodeConstructor into an opaque Fingerprint to be used in DepNode. Not all DepNodeParams support being turned into a Fingerprint (they don’t need to if the corresponding DepNode is anonymous). Read more
This method tries to recover the query key from the given DepNode, something which is needed when forcing DepNodes during red-green evaluation. The query system will only call this method if fingerprint_style() is not FingerprintStyle::Opaque. It is always valid to return None here, in which case incremental compilation will treat the query as having changed instead of forcing it. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.

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

Size for each variant:

  • Assign: 15 bytes
  • FakeRead: 15 bytes
  • SetDiscriminant: 15 bytes
  • Deinit: 15 bytes
  • StorageLive: 7 bytes
  • StorageDead: 7 bytes
  • Retag: 15 bytes
  • AscribeUserType: 15 bytes
  • Coverage: 15 bytes
  • Intrinsic: 15 bytes
  • Nop: 0 bytes