Enum hir_ty::mir::Rvalue

pub enum Rvalue {
    Use(Operand),
    Repeat(Operand, Const),
    Ref(BorrowKind, Place),
    ThreadLocalRef(Infallible),
    AddressOf(Infallible),
    Len(Place),
    Cast(CastKind, Operand, Ty),
    BinaryOp(Infallible),
    CheckedBinaryOp(BinOp, Operand, Operand),
    NullaryOp(Infallible),
    UnaryOp(UnOp, Operand),
    Discriminant(Place),
    Aggregate(AggregateKind, Box<[Operand]>),
    ShallowInitBox(Operand, Ty),
    ShallowInitBoxWithAlloc(Ty),
    CopyForDeref(Place),
}

Variants

Use(Operand)

Yields the operand unchanged

Repeat(Operand, Const)

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

Corresponds to source code like [x; 32].

Ref(BorrowKind, Place)

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(Infallible)

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(Infallible)

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)

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, Ty)

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(Infallible)

• Offset has the same semantics as pointer::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, Operand, Operand)

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(Infallible)

Computes a value as described by the operation.

UnaryOp(UnOp, Operand)

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)

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(AggregateKind, Box<[Operand]>)

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, Ty)

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.

ShallowInitBoxWithAlloc(Ty)

NON STANDARD: allocates memory with the type’s layout, and shallow init the box with the resulting pointer.

CopyForDeref(Place)

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.

Trait Implementations

impl Clone for Rvalue

fn clone(&self) -> Rvalue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rvalue

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

Formats the value using the given formatter.

impl From<Operand> for Rvalue

fn from(x: Operand) -> Self

Converts to this type from the input type.

impl PartialEq for Rvalue

fn eq(&self, other: &Rvalue) -> 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 Eq for Rvalue

impl StructuralPartialEq for Rvalue