Enum Rvalue

pub enum Rvalue<'tcx> {
    Use(Operand<'tcx>),
    Repeat(Operand<'tcx>, Const<'tcx>),
    Ref(Region<'tcx>, BorrowKind, Place<'tcx>),
    ThreadLocalRef(DefId),
    RawPtr(RawPtrKind, Place<'tcx>),
    Len(Place<'tcx>),
    Cast(CastKind, Operand<'tcx>, Ty<'tcx>),
    BinaryOp(BinOp, Box<(Operand<'tcx>, Operand<'tcx>)>),
    NullaryOp(NullOp<'tcx>, Ty<'tcx>),
    UnaryOp(UnOp, Operand<'tcx>),
    Discriminant(Place<'tcx>),
    Aggregate(Box<AggregateKind<'tcx>>, IndexVec<FieldIdx, Operand<'tcx>>),
    ShallowInitBox(Operand<'tcx>, Ty<'tcx>),
    CopyForDeref(Place<'tcx>),
    WrapUnsafeBinder(Operand<'tcx>, Ty<'tcx>),
}

The various kinds of rvalues that can appear in MIR.

Not all of these are allowed at every MirPhase - when this is the case, it’s stated below.

Computing any rvalue begins by evaluating the places and operands in some order (Needs clarification: Which order?). These are then used to produce a “value” - the same kind of value that an Operand produces.

Variants

Use(Operand<'tcx>)

Yields the operand unchanged

Repeat(Operand<'tcx>, Const<'tcx>)

Creates an array where each element is the value of the operand.

This is the cause of a bug in the case where the repetition count is zero because the value is not dropped, see #74836.

Corresponds to source code like [x; 32].

Ref(Region<'tcx>, BorrowKind, Place<'tcx>)

Creates a reference of the indicated kind to the place.

There is not much to document here, because besides the obvious parts the semantics of this are essentially entirely a part of the aliasing model. There are many UCG issues discussing exactly what the behavior of this operation should be.

Shallow borrows are disallowed after drop lowering.

ThreadLocalRef(DefId)

Creates a pointer/reference to the given thread local.

The yielded type is a *mut T if the static is mutable, otherwise if the static is extern a *const T, and if neither of those apply a &T.

Note: This is a runtime operation that actually executes code and is in this sense more like a function call. Also, eliminating dead stores of this rvalue causes fn main() {} to SIGILL for some reason that I (JakobDegen) never got a chance to look into.

Needs clarification: Are there weird additional semantics here related to the runtime nature of this operation?

RawPtr(RawPtrKind, Place<'tcx>)

Creates a raw pointer with the indicated mutability to the place.

This is generated by pointer casts like &v as *const _ or raw borrow expressions like &raw const v.

Like with references, the semantics of this operation are heavily dependent on the aliasing model.

Len(Place<'tcx>)

Yields the length of the place, as a usize.

If the type of the place is an array, this is the array length. For slices ([T], not &[T]) this accesses the place’s metadata to determine the length. This rvalue is ill-formed for places of other types.

This cannot be a UnOp(PtrMetadata, _) because that expects a value, and we only have a place, and UnOp(PtrMetadata, RawPtr(place)) is not a thing.

Cast(CastKind, Operand<'tcx>, Ty<'tcx>)

Performs essentially all of the casts that can be performed via as.

This allows for casts from/to a variety of types.

FIXME: Document exactly which CastKinds allow which types of casts.

BinaryOp(BinOp, Box<(Operand<'tcx>, Operand<'tcx>)>)

• Offset has the same semantics as offset, except that the second parameter may be a usize as well.
• The comparison operations accept bools, chars, signed or unsigned integers, floats, raw pointers, or function pointers and return a bool. The types of the operands must be matching, up to the usual caveat of the lifetimes in function pointers.
• Left and right shift operations accept signed or unsigned integers not necessarily of the same type and return a value of the same type as their LHS. Like in Rust, the RHS is truncated as needed.
• The Bit* operations accept signed integers, unsigned integers, or bools with matching types and return a value of that type.
• The FooWithOverflow are like the Foo, but returning (T, bool) instead of just T, where the bool is true if the result is not equal to the infinite-precision result.
• The remaining operations accept signed integers, unsigned integers, or floats with matching types and return a value of that type.

NullaryOp(NullOp<'tcx>, Ty<'tcx>)

Computes a value as described by the operation.

UnaryOp(UnOp, Operand<'tcx>)

Exactly like BinaryOp, but less operands.

Also does two’s-complement arithmetic. Negation requires a signed integer or a float; bitwise not requires a signed integer, unsigned integer, or bool. Both operation kinds return a value with the same type as their operand.

Discriminant(Place<'tcx>)

Computes the discriminant of the place, returning it as an integer of type discriminant_ty. Returns zero for types without discriminant.

The validity requirements for the underlying value are undecided for this rvalue, see #91095. Note too that the value of the discriminant is not the same thing as the variant index; use discriminant_for_variant to convert.

Aggregate(Box<AggregateKind<'tcx>>, IndexVec<FieldIdx, Operand<'tcx>>)

Creates an aggregate value, like a tuple or struct.

This is needed because dataflow analysis needs to distinguish dest = Foo { x: ..., y: ... } from dest.x = ...; dest.y = ...; in the case that Foo has a destructor.

Disallowed after deaggregation for all aggregate kinds except Array and Coroutine. After coroutine lowering, Coroutine aggregate kinds are disallowed too.

ShallowInitBox(Operand<'tcx>, Ty<'tcx>)

Transmutes a *mut u8 into shallow-initialized Box<T>.

This is different from a normal transmute because dataflow analysis will treat the box as initialized but its content as uninitialized. Like other pointer casts, this in general affects alias analysis.

CopyForDeref(Place<'tcx>)

A CopyForDeref is equivalent to a read from a place at the codegen level, but is treated specially by drop elaboration. When such a read happens, it is guaranteed (via nature of the mir_opt Derefer in rustc_mir_transform/src/deref_separator) that the only use of the returned value is a deref operation, immediately followed by one or more projections. Drop elaboration treats this rvalue as if the read never happened and just projects further. This allows simplifying various MIR optimizations and codegen backends that previously had to handle deref operations anywhere in a place.

WrapUnsafeBinder(Operand<'tcx>, Ty<'tcx>)

Wraps a value in an unsafe binder.

Implementations

impl<'tcx> Rvalue<'tcx>

pub fn is_safe_to_remove(&self) -> bool

Returns true if rvalue can be safely removed when the result is unused.

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

where D: HasLocalDecls<'tcx> + ?Sized,

pub fn initialization_state(&self) -> RvalueInitializationState

Returns true if this rvalue is deeply initialized (most rvalues) or whether its only shallowly initialized (Rvalue::Box).

Trait Implementations

impl<'tcx> Clone for Rvalue<'tcx>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for Rvalue<'tcx>

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

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<'tcx>> Decodable<__D> for Rvalue<'tcx>

fn decode(__decoder: &mut __D) -> Self

impl<'tcx, __E: TyEncoder<'tcx>> Encodable<__E> for Rvalue<'tcx>

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

impl<'tcx> Hash for Rvalue<'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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

impl<'tcx> PartialEq for Rvalue<'tcx>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for Rvalue<'tcx>

fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'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<TyCtxt<'tcx>>>(self, __folder: &mut __F) -> Self

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

impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for Rvalue<'tcx>

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

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

impl<'tcx> StructuralPartialEq for Rvalue<'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: 40 bytes

Size for each variant:

• Use: 32 bytes
• Repeat: 40 bytes
• Ref: 40 bytes
• ThreadLocalRef: 16 bytes
• RawPtr: 32 bytes
• Len: 24 bytes
• Cast: 40 bytes
• BinaryOp: 24 bytes
• NullaryOp: 32 bytes
• UnaryOp: 40 bytes
• Discriminant: 24 bytes
• Aggregate: 40 bytes
• ShallowInitBox: 40 bytes
• CopyForDeref: 24 bytes
• WrapUnsafeBinder: 40 bytes