Enum rustc_middle::mir::Rvalue

pub enum Rvalue<'tcx> {
    Use(Operand<'tcx>),
    Repeat(Operand<'tcx>, Const<'tcx>),
    Ref(Region<'tcx>, BorrowKind, Place<'tcx>),
    ThreadLocalRef(DefId),
    AddressOf(Mutability, Place<'tcx>),
    Len(Place<'tcx>),
    Cast(CastKind, Operand<'tcx>, Ty<'tcx>),
    BinaryOp(BinOp, Box<(Operand<'tcx>, Operand<'tcx>)>),
    CheckedBinaryOp(BinOp, Box<(Operand<'tcx>, Operand<'tcx>)>),
    NullaryOp(NullOp, Ty<'tcx>),
    UnaryOp(UnOp, Operand<'tcx>),
    Discriminant(Place<'tcx>),
    Aggregate(Box<AggregateKind<'tcx>>, Vec<Operand<'tcx>>),
    ShallowInitBox(Operand<'tcx>, Ty<'tcx>),
    CopyForDeref(Place<'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?

AddressOf(Mutability, Place<'tcx>)

Creates a pointer with the indicated mutability to the place.

This is generated by pointer casts like &v as *const _ or raw address of expressions like &raw v or addr_of!(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.

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. Figure out why ArrayToPointer and MutToConstPointer are special.

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 remaining operations accept signed integers, unsigned integers, or floats with matching types and return a value of that type.

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

Same as BinaryOp, but yields (T, bool) with a bool indicating an error condition.

When overflow checking is disabled and we are generating run-time code, the error condition is false. Otherwise, and always during CTFE, the error condition is determined as described below.

For addition, subtraction, and multiplication on integers the error condition is set when the infinite precision result would be unequal to the actual result.

For shift operations on integers the error condition is set when the value of right-hand side is greater than or equal to the number of bits in the type of the left-hand side, or when the value of right-hand side is negative.

Other combinations of types and operators are unsupported.

NullaryOp(NullOp, 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>>, Vec<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 Generator. After generator lowering, Generator 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.

Implementations

impl<'tcx> Rvalue<'tcx>

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

pub fn initialization_state(&self) -> RvalueInitializationState

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

impl<'tcx> Rvalue<'tcx>

Rvalues

pub fn is_safe_to_remove(&self) -> bool

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

Trait Implementations

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

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

Returns a copy 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<I = TyCtxt<'tcx>>> Decodable<__D> for Rvalue<'tcx>

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

impl<'tcx, __E: TyEncoder<I = TyCtxt<'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,

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<Rvalue<'tcx>> for Rvalue<'tcx>

fn eq(&self, other: &Rvalue<'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 Rvalue<'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 Rvalue<'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> 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
• AddressOf: 32 bytes
• Len: 24 bytes
• Cast: 40 bytes
• BinaryOp: 24 bytes
• CheckedBinaryOp: 24 bytes
• NullaryOp: 24 bytes
• UnaryOp: 40 bytes
• Discriminant: 24 bytes
• Aggregate: 40 bytes
• ShallowInitBox: 40 bytes
• CopyForDeref: 24 bytes