1use std::fmt;
23use itertools::Either;
4use rustc_abias abi;
5use rustc_abi::{
6Align, BackendRepr, FIRST_VARIANT, FieldIdx, Primitive, Size, TagEncoding, VariantIdx, Variants,
7};
8use rustc_hir::LangItem;
9use rustc_middle::mir::interpret::{Pointer, Scalar, alloc_range};
10use rustc_middle::mir::{self, ConstValue};
11use rustc_middle::ty::layout::{LayoutOf, TyAndLayout};
12use rustc_middle::ty::{self, Ty};
13use rustc_middle::{bug, span_bug};
14use rustc_session::config::{AnnotateMoves, DebugInfo, OptLevel};
15use tracing::{debug, instrument};
1617use super::place::{PlaceRef, PlaceValue};
18use super::rvalue::transmute_scalar;
19use super::{FunctionCx, LocalRef};
20use crate::MemFlags;
21use crate::common::IntPredicate;
22use crate::traits::*;
2324/// The representation of a Rust value. The enum variant is in fact
25/// uniquely determined by the value's type, but is kept as a
26/// safety check.
27#[derive(#[automatically_derived]
impl<V: ::core::marker::Copy> ::core::marker::Copy for OperandValue<V> { }Copy, #[automatically_derived]
impl<V: ::core::clone::Clone> ::core::clone::Clone for OperandValue<V> {
#[inline]
fn clone(&self) -> OperandValue<V> {
match self {
OperandValue::Ref(__self_0) =>
OperandValue::Ref(::core::clone::Clone::clone(__self_0)),
OperandValue::Immediate(__self_0) =>
OperandValue::Immediate(::core::clone::Clone::clone(__self_0)),
OperandValue::Pair(__self_0, __self_1) =>
OperandValue::Pair(::core::clone::Clone::clone(__self_0),
::core::clone::Clone::clone(__self_1)),
OperandValue::ZeroSized => OperandValue::ZeroSized,
}
}
}Clone, #[automatically_derived]
impl<V: ::core::fmt::Debug> ::core::fmt::Debug for OperandValue<V> {
#[inline]
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
match self {
OperandValue::Ref(__self_0) =>
::core::fmt::Formatter::debug_tuple_field1_finish(f, "Ref",
&__self_0),
OperandValue::Immediate(__self_0) =>
::core::fmt::Formatter::debug_tuple_field1_finish(f,
"Immediate", &__self_0),
OperandValue::Pair(__self_0, __self_1) =>
::core::fmt::Formatter::debug_tuple_field2_finish(f, "Pair",
__self_0, &__self_1),
OperandValue::ZeroSized =>
::core::fmt::Formatter::write_str(f, "ZeroSized"),
}
}
}Debug)]
28pub enum OperandValue<V> {
29/// A reference to the actual operand. The data is guaranteed
30 /// to be valid for the operand's lifetime.
31 /// The second value, if any, is the extra data (vtable or length)
32 /// which indicates that it refers to an unsized rvalue.
33 ///
34 /// An `OperandValue` *must* be this variant for any type for which
35 /// [`LayoutTypeCodegenMethods::is_backend_ref`] returns `true`.
36 /// (That basically amounts to "isn't one of the other variants".)
37 ///
38 /// This holds a [`PlaceValue`] (like a [`PlaceRef`] does) with a pointer
39 /// to the location holding the value. The type behind that pointer is the
40 /// one returned by [`LayoutTypeCodegenMethods::backend_type`].
41Ref(PlaceValue<V>),
42/// A single LLVM immediate value.
43 ///
44 /// An `OperandValue` *must* be this variant for any type for which
45 /// [`LayoutTypeCodegenMethods::is_backend_immediate`] returns `true`.
46 /// The backend value in this variant must be the *immediate* backend type,
47 /// as returned by [`LayoutTypeCodegenMethods::immediate_backend_type`].
48Immediate(V),
49/// A pair of immediate LLVM values. Used by wide pointers too.
50 ///
51 /// # Invariants
52 /// - For `Pair(a, b)`, `a` is always at offset 0, but may have `FieldIdx(1..)`
53 /// - `b` is not at offset 0, because `V` is not a 1ZST type.
54 /// - `a` and `b` will have a different FieldIdx, but otherwise `b`'s may be lower
55 /// or they may not be adjacent, due to arbitrary numbers of 1ZST fields that
56 /// will not affect the shape of the data which determines if `Pair` will be used.
57 /// - An `OperandValue` *must* be this variant for any type for which
58 /// [`LayoutTypeCodegenMethods::is_backend_scalar_pair`] returns `true`.
59 /// - The backend values in this variant must be the *immediate* backend types,
60 /// as returned by [`LayoutTypeCodegenMethods::scalar_pair_element_backend_type`]
61 /// with `immediate: true`.
62Pair(V, V),
63/// A value taking no bytes, and which therefore needs no LLVM value at all.
64 ///
65 /// If you ever need a `V` to pass to something, get a fresh poison value
66 /// from [`ConstCodegenMethods::const_poison`].
67 ///
68 /// An `OperandValue` *must* be this variant for any type for which
69 /// `is_zst` on its `Layout` returns `true`. Note however that
70 /// these values can still require alignment.
71ZeroSized,
72}
7374impl<V: CodegenObject> OperandValue<V> {
75/// Return the data pointer and optional metadata as backend values
76 /// if this value can be treat as a pointer.
77pub(crate) fn try_pointer_parts(self) -> Option<(V, Option<V>)> {
78match self {
79 OperandValue::Immediate(llptr) => Some((llptr, None)),
80 OperandValue::Pair(llptr, llextra) => Some((llptr, Some(llextra))),
81 OperandValue::Ref(_) | OperandValue::ZeroSized => None,
82 }
83 }
8485/// Treat this value as a pointer and return the data pointer and
86 /// optional metadata as backend values.
87 ///
88 /// If you're making a place, use [`Self::deref`] instead.
89pub(crate) fn pointer_parts(self) -> (V, Option<V>) {
90self.try_pointer_parts()
91 .unwrap_or_else(|| ::rustc_middle::util::bug::bug_fmt(format_args!("OperandValue cannot be a pointer: {0:?}",
self))bug!("OperandValue cannot be a pointer: {self:?}"))
92 }
9394/// Treat this value as a pointer and return the place to which it points.
95 ///
96 /// The pointer immediate doesn't inherently know its alignment,
97 /// so you need to pass it in. If you want to get it from a type's ABI
98 /// alignment, then maybe you want [`OperandRef::deref`] instead.
99 ///
100 /// This is the inverse of [`PlaceValue::address`].
101pub(crate) fn deref(self, align: Align) -> PlaceValue<V> {
102let (llval, llextra) = self.pointer_parts();
103PlaceValue { llval, llextra, align }
104 }
105106#[must_use]
107pub(crate) fn is_expected_variant_for_type<'tcx, Cx: LayoutTypeCodegenMethods<'tcx>>(
108&self,
109 cx: &Cx,
110 ty: TyAndLayout<'tcx>,
111 ) -> bool {
112match self {
113 OperandValue::ZeroSized => ty.is_zst(),
114 OperandValue::Immediate(_) => cx.is_backend_immediate(ty),
115 OperandValue::Pair(_, _) => cx.is_backend_scalar_pair(ty),
116 OperandValue::Ref(_) => cx.is_backend_ref(ty),
117 }
118 }
119}
120121/// An `OperandRef` is an "SSA" reference to a Rust value, along with
122/// its type.
123///
124/// NOTE: unless you know a value's type exactly, you should not
125/// generate LLVM opcodes acting on it and instead act via methods,
126/// to avoid nasty edge cases. In particular, using `Builder::store`
127/// directly is sure to cause problems -- use `OperandRef::store`
128/// instead.
129#[derive(#[automatically_derived]
impl<'tcx, V: ::core::marker::Copy> ::core::marker::Copy for
OperandRef<'tcx, V> {
}Copy, #[automatically_derived]
impl<'tcx, V: ::core::clone::Clone> ::core::clone::Clone for
OperandRef<'tcx, V> {
#[inline]
fn clone(&self) -> OperandRef<'tcx, V> {
OperandRef {
val: ::core::clone::Clone::clone(&self.val),
layout: ::core::clone::Clone::clone(&self.layout),
move_annotation: ::core::clone::Clone::clone(&self.move_annotation),
}
}
}Clone)]
130pub struct OperandRef<'tcx, V> {
131/// The value.
132pub val: OperandValue<V>,
133134/// The layout of value, based on its Rust type.
135pub layout: TyAndLayout<'tcx>,
136137/// Annotation for profiler visibility of move/copy operations.
138 /// When set, the store operation should appear as an inlined call to this function.
139pub move_annotation: Option<ty::Instance<'tcx>>,
140}
141142impl<V: CodegenObject> fmt::Debugfor OperandRef<'_, V> {
143fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
144f.write_fmt(format_args!("OperandRef({0:?} @ {1:?})", self.val, self.layout))write!(f, "OperandRef({:?} @ {:?})", self.val, self.layout)145 }
146}
147148impl<'a, 'tcx, V: CodegenObject> OperandRef<'tcx, V> {
149pub fn zero_sized(layout: TyAndLayout<'tcx>) -> OperandRef<'tcx, V> {
150if !layout.is_zst() {
::core::panicking::panic("assertion failed: layout.is_zst()")
};assert!(layout.is_zst());
151OperandRef { val: OperandValue::ZeroSized, layout, move_annotation: None }
152 }
153154pub(crate) fn from_const<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
155 bx: &mut Bx,
156 val: mir::ConstValue,
157 ty: Ty<'tcx>,
158 ) -> Self {
159let layout = bx.layout_of(ty);
160161let val = match val {
162 ConstValue::Scalar(x) => {
163let BackendRepr::Scalar(scalar) = layout.backend_repr else {
164::rustc_middle::util::bug::bug_fmt(format_args!("from_const: invalid ByVal layout: {0:#?}",
layout));bug!("from_const: invalid ByVal layout: {:#?}", layout);
165 };
166let llval = bx.scalar_to_backend(x, scalar, bx.immediate_backend_type(layout));
167 OperandValue::Immediate(llval)
168 }
169 ConstValue::ZeroSized => return OperandRef::zero_sized(layout),
170 ConstValue::Slice { alloc_id, meta } => {
171let BackendRepr::ScalarPair(a_scalar, _) = layout.backend_repr else {
172::rustc_middle::util::bug::bug_fmt(format_args!("from_const: invalid ScalarPair layout: {0:#?}",
layout));bug!("from_const: invalid ScalarPair layout: {:#?}", layout);
173 };
174let a = Scalar::from_pointer(Pointer::new(alloc_id.into(), Size::ZERO), &bx.tcx());
175let a_llval = bx.scalar_to_backend(
176a,
177a_scalar,
178bx.scalar_pair_element_backend_type(layout, 0, true),
179 );
180let b_llval = bx.const_usize(meta);
181 OperandValue::Pair(a_llval, b_llval)
182 }
183 ConstValue::Indirect { alloc_id, offset } => {
184let alloc = bx.tcx().global_alloc(alloc_id).unwrap_memory();
185return Self::from_const_alloc(bx, layout, alloc, offset);
186 }
187 };
188189OperandRef { val, layout, move_annotation: None }
190 }
191192fn from_const_alloc<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
193 bx: &mut Bx,
194 layout: TyAndLayout<'tcx>,
195 alloc: rustc_middle::mir::interpret::ConstAllocation<'tcx>,
196 offset: Size,
197 ) -> Self {
198let alloc_align = alloc.inner().align;
199if !(alloc_align >= layout.align.abi) {
{
::core::panicking::panic_fmt(format_args!("{1:?} < {0:?}",
layout.align.abi, alloc_align));
}
};assert!(alloc_align >= layout.align.abi, "{alloc_align:?} < {:?}", layout.align.abi);
200201let read_scalar = |start, size, s: abi::Scalar, ty| {
202match alloc.0.read_scalar(
203bx,
204alloc_range(start, size),
205/*read_provenance*/ #[allow(non_exhaustive_omitted_patterns)] match s.primitive() {
abi::Primitive::Pointer(_) => true,
_ => false,
}matches!(s.primitive(), abi::Primitive::Pointer(_)),
206 ) {
207Ok(val) => bx.scalar_to_backend(val, s, ty),
208Err(_) => bx.const_poison(ty),
209 }
210 };
211212// It may seem like all types with `Scalar` or `ScalarPair` ABI are fair game at this point.
213 // However, `MaybeUninit<u64>` is considered a `Scalar` as far as its layout is concerned --
214 // and yet cannot be represented by an interpreter `Scalar`, since we have to handle the
215 // case where some of the bytes are initialized and others are not. So, we need an extra
216 // check that walks over the type of `mplace` to make sure it is truly correct to treat this
217 // like a `Scalar` (or `ScalarPair`).
218match layout.backend_repr {
219 BackendRepr::Scalar(s @ abi::Scalar::Initialized { .. }) => {
220let size = s.size(bx);
221{
match (&size, &layout.size) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val,
::core::option::Option::Some(format_args!("abi::Scalar size does not match layout size")));
}
}
}
};assert_eq!(size, layout.size, "abi::Scalar size does not match layout size");
222let val = read_scalar(offset, size, s, bx.immediate_backend_type(layout));
223OperandRef { val: OperandValue::Immediate(val), layout, move_annotation: None }
224 }
225 BackendRepr::ScalarPair(
226 a @ abi::Scalar::Initialized { .. },
227 b @ abi::Scalar::Initialized { .. },
228 ) => {
229let (a_size, b_size) = (a.size(bx), b.size(bx));
230let b_offset = (offset + a_size).align_to(b.default_align(bx).abi);
231if !(b_offset.bytes() > 0) {
::core::panicking::panic("assertion failed: b_offset.bytes() > 0")
};assert!(b_offset.bytes() > 0);
232let a_val = read_scalar(
233offset,
234a_size,
235a,
236bx.scalar_pair_element_backend_type(layout, 0, true),
237 );
238let b_val = read_scalar(
239b_offset,
240b_size,
241b,
242bx.scalar_pair_element_backend_type(layout, 1, true),
243 );
244OperandRef { val: OperandValue::Pair(a_val, b_val), layout, move_annotation: None }
245 }
246_ if layout.is_zst() => OperandRef::zero_sized(layout),
247_ => {
248// Neither a scalar nor scalar pair. Load from a place
249let base_addr = bx.static_addr_of(alloc, None);
250251let llval = bx.const_ptr_byte_offset(base_addr, offset);
252bx.load_operand(PlaceRef::new_sized(llval, layout))
253 }
254 }
255 }
256257/// Asserts that this operand refers to a scalar and returns
258 /// a reference to its value.
259pub fn immediate(self) -> V {
260match self.val {
261 OperandValue::Immediate(s) => s,
262_ => ::rustc_middle::util::bug::bug_fmt(format_args!("not immediate: {0:?}", self))bug!("not immediate: {:?}", self),
263 }
264 }
265266/// Asserts that this operand is a pointer (or reference) and returns
267 /// the place to which it points. (This requires no code to be emitted
268 /// as we represent places using the pointer to the place.)
269 ///
270 /// This uses [`Ty::builtin_deref`] to include the type of the place and
271 /// assumes the place is aligned to the pointee's usual ABI alignment.
272 ///
273 /// If you don't need the type, see [`OperandValue::pointer_parts`]
274 /// or [`OperandValue::deref`].
275pub fn deref<Cx: CodegenMethods<'tcx>>(self, cx: &Cx) -> PlaceRef<'tcx, V> {
276if self.layout.ty.is_box() {
277// Derefer should have removed all Box derefs
278::rustc_middle::util::bug::bug_fmt(format_args!("dereferencing {0:?} in codegen",
self.layout.ty));bug!("dereferencing {:?} in codegen", self.layout.ty);
279 }
280281let projected_ty = self282 .layout
283 .ty
284 .builtin_deref(true)
285 .unwrap_or_else(|| ::rustc_middle::util::bug::bug_fmt(format_args!("deref of non-pointer {0:?}",
self))bug!("deref of non-pointer {:?}", self));
286287let layout = cx.layout_of(projected_ty);
288self.val.deref(layout.align.abi).with_type(layout)
289 }
290291/// Store this operand into a place, applying move/copy annotation if present.
292 ///
293 /// This is the preferred method for storing operands, as it automatically
294 /// applies profiler annotations for tracked move/copy operations.
295pub fn store_with_annotation<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
296self,
297 bx: &mut Bx,
298 dest: PlaceRef<'tcx, V>,
299 ) {
300self.store_with_annotation_and_flags(bx, dest, MemFlags::empty())
301 }
302303/// Same as store_with_annotation(), but also specify flags for the store.
304pub fn store_with_annotation_and_flags<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
305self,
306 bx: &mut Bx,
307 dest: PlaceRef<'tcx, V>,
308 flags: MemFlags,
309 ) {
310if let Some(instance) = self.move_annotation {
311bx.with_move_annotation(instance, |bx| self.val.store_with_flags(bx, dest, flags))
312 } else {
313self.val.store_with_flags(bx, dest, flags)
314 }
315 }
316317/// If this operand is a `Pair`, we return an aggregate with the two values.
318 /// For other cases, see `immediate`.
319 ///
320 /// Note: The use of this is discouraged outside cg_llvm, as some other backends
321 /// don't natively support packing multiple things into one like this.
322pub fn immediate_or_packed_pair<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
323self,
324 bx: &mut Bx,
325 ) -> V {
326if let OperandValue::Pair(a, b) = self.val {
327let llty = bx.cx().immediate_backend_type(self.layout);
328{
use ::tracing::__macro_support::Callsite as _;
static __CALLSITE: ::tracing::callsite::DefaultCallsite =
{
static META: ::tracing::Metadata<'static> =
{
::tracing_core::metadata::Metadata::new("event compiler/rustc_codegen_ssa/src/mir/operand.rs:328",
"rustc_codegen_ssa::mir::operand", ::tracing::Level::DEBUG,
::tracing_core::__macro_support::Option::Some("compiler/rustc_codegen_ssa/src/mir/operand.rs"),
::tracing_core::__macro_support::Option::Some(328u32),
::tracing_core::__macro_support::Option::Some("rustc_codegen_ssa::mir::operand"),
::tracing_core::field::FieldSet::new(&["message"],
::tracing_core::callsite::Identifier(&__CALLSITE)),
::tracing::metadata::Kind::EVENT)
};
::tracing::callsite::DefaultCallsite::new(&META)
};
let enabled =
::tracing::Level::DEBUG <= ::tracing::level_filters::STATIC_MAX_LEVEL
&&
::tracing::Level::DEBUG <=
::tracing::level_filters::LevelFilter::current() &&
{
let interest = __CALLSITE.interest();
!interest.is_never() &&
::tracing::__macro_support::__is_enabled(__CALLSITE.metadata(),
interest)
};
if enabled {
(|value_set: ::tracing::field::ValueSet|
{
let meta = __CALLSITE.metadata();
::tracing::Event::dispatch(meta, &value_set);
;
})({
#[allow(unused_imports)]
use ::tracing::field::{debug, display, Value};
let mut iter = __CALLSITE.metadata().fields().iter();
__CALLSITE.metadata().fields().value_set(&[(&::tracing::__macro_support::Iterator::next(&mut iter).expect("FieldSet corrupted (this is a bug)"),
::tracing::__macro_support::Option::Some(&format_args!("Operand::immediate_or_packed_pair: packing {0:?} into {1:?}",
self, llty) as &dyn Value))])
});
} else { ; }
};debug!("Operand::immediate_or_packed_pair: packing {:?} into {:?}", self, llty);
329// Reconstruct the immediate aggregate.
330let mut llpair = bx.cx().const_poison(llty);
331llpair = bx.insert_value(llpair, a, 0);
332llpair = bx.insert_value(llpair, b, 1);
333llpair334 } else {
335self.immediate()
336 }
337 }
338339/// If the type is a pair, we return a `Pair`, otherwise, an `Immediate`.
340 ///
341 /// Note: The use of this is discouraged outside cg_llvm, as some other backends
342 /// don't natively support packing multiple things into one like this.
343pub fn from_immediate_or_packed_pair<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
344 bx: &mut Bx,
345 llval: V,
346 layout: TyAndLayout<'tcx>,
347 ) -> Self {
348let val = if let BackendRepr::ScalarPair(..) = layout.backend_repr {
349{
use ::tracing::__macro_support::Callsite as _;
static __CALLSITE: ::tracing::callsite::DefaultCallsite =
{
static META: ::tracing::Metadata<'static> =
{
::tracing_core::metadata::Metadata::new("event compiler/rustc_codegen_ssa/src/mir/operand.rs:349",
"rustc_codegen_ssa::mir::operand", ::tracing::Level::DEBUG,
::tracing_core::__macro_support::Option::Some("compiler/rustc_codegen_ssa/src/mir/operand.rs"),
::tracing_core::__macro_support::Option::Some(349u32),
::tracing_core::__macro_support::Option::Some("rustc_codegen_ssa::mir::operand"),
::tracing_core::field::FieldSet::new(&["message"],
::tracing_core::callsite::Identifier(&__CALLSITE)),
::tracing::metadata::Kind::EVENT)
};
::tracing::callsite::DefaultCallsite::new(&META)
};
let enabled =
::tracing::Level::DEBUG <= ::tracing::level_filters::STATIC_MAX_LEVEL
&&
::tracing::Level::DEBUG <=
::tracing::level_filters::LevelFilter::current() &&
{
let interest = __CALLSITE.interest();
!interest.is_never() &&
::tracing::__macro_support::__is_enabled(__CALLSITE.metadata(),
interest)
};
if enabled {
(|value_set: ::tracing::field::ValueSet|
{
let meta = __CALLSITE.metadata();
::tracing::Event::dispatch(meta, &value_set);
;
})({
#[allow(unused_imports)]
use ::tracing::field::{debug, display, Value};
let mut iter = __CALLSITE.metadata().fields().iter();
__CALLSITE.metadata().fields().value_set(&[(&::tracing::__macro_support::Iterator::next(&mut iter).expect("FieldSet corrupted (this is a bug)"),
::tracing::__macro_support::Option::Some(&format_args!("Operand::from_immediate_or_packed_pair: unpacking {0:?} @ {1:?}",
llval, layout) as &dyn Value))])
});
} else { ; }
};debug!("Operand::from_immediate_or_packed_pair: unpacking {:?} @ {:?}", llval, layout);
350351// Deconstruct the immediate aggregate.
352let a_llval = bx.extract_value(llval, 0);
353let b_llval = bx.extract_value(llval, 1);
354 OperandValue::Pair(a_llval, b_llval)
355 } else {
356 OperandValue::Immediate(llval)
357 };
358OperandRef { val, layout, move_annotation: None }
359 }
360361pub(crate) fn extract_field<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
362&self,
363 fx: &mut FunctionCx<'a, 'tcx, Bx>,
364 bx: &mut Bx,
365 i: usize,
366 ) -> Self {
367let field = self.layout.field(bx.cx(), i);
368let offset = self.layout.fields.offset(i);
369370if !bx.is_backend_ref(self.layout) && bx.is_backend_ref(field) {
371// Part of https://github.com/rust-lang/compiler-team/issues/838
372::rustc_middle::util::bug::span_bug_fmt(fx.mir.span,
format_args!("Non-ref type {0:?} cannot project to ref field type {1:?}",
self, field));span_bug!(
373 fx.mir.span,
374"Non-ref type {self:?} cannot project to ref field type {field:?}",
375 );
376 }
377378let val = if field.is_zst() {
379 OperandValue::ZeroSized380 } else if field.size == self.layout.size {
381{
match (&offset.bytes(), &0) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val, ::core::option::Option::None);
}
}
}
};assert_eq!(offset.bytes(), 0);
382fx.codegen_transmute_operand(bx, *self, field)
383 } else {
384let (in_scalar, imm) = match (self.val, self.layout.backend_repr) {
385// Extract a scalar component from a pair.
386(OperandValue::Pair(a_llval, b_llval), BackendRepr::ScalarPair(a, b)) => {
387if offset.bytes() == 0 {
388{
match (&field.size, &a.size(bx.cx())) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val, ::core::option::Option::None);
}
}
}
};assert_eq!(field.size, a.size(bx.cx()));
389 (Some(a), a_llval)
390 } else {
391{
match (&offset, &a.size(bx.cx()).align_to(b.default_align(bx.cx()).abi)) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val, ::core::option::Option::None);
}
}
}
};assert_eq!(offset, a.size(bx.cx()).align_to(b.default_align(bx.cx()).abi));
392{
match (&field.size, &b.size(bx.cx())) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val, ::core::option::Option::None);
}
}
}
};assert_eq!(field.size, b.size(bx.cx()));
393 (Some(b), b_llval)
394 }
395 }
396397_ => {
398::rustc_middle::util::bug::span_bug_fmt(fx.mir.span,
format_args!("OperandRef::extract_field({0:?}): not applicable", self))span_bug!(fx.mir.span, "OperandRef::extract_field({:?}): not applicable", self)399 }
400 };
401 OperandValue::Immediate(match field.backend_repr {
402 BackendRepr::SimdVector { .. } => imm,
403 BackendRepr::Scalar(out_scalar) => {
404let Some(in_scalar) = in_scalarelse {
405::rustc_middle::util::bug::span_bug_fmt(fx.mir.span,
format_args!("OperandRef::extract_field({0:?}): missing input scalar for output scalar",
self))span_bug!(
406 fx.mir.span,
407"OperandRef::extract_field({:?}): missing input scalar for output scalar",
408self
409)410 };
411if in_scalar != out_scalar {
412// If the backend and backend_immediate types might differ,
413 // flip back to the backend type then to the new immediate.
414 // This avoids nop truncations, but still handles things like
415 // Bools in union fields needs to be truncated.
416let backend = bx.from_immediate(imm);
417bx.to_immediate_scalar(backend, out_scalar)
418 } else {
419imm420 }
421 }
422 BackendRepr::ScalarPair(_, _)
423 | BackendRepr::Memory { .. }
424 | BackendRepr::SimdScalableVector { .. } => ::rustc_middle::util::bug::bug_fmt(format_args!("impossible case reached"))bug!(),
425 })
426 };
427428OperandRef { val, layout: field, move_annotation: None }
429 }
430431/// Obtain the actual discriminant of a value.
432#[allow(clippy :: suspicious_else_formatting)]
{
let __tracing_attr_span;
let __tracing_attr_guard;
if ::tracing::Level::TRACE <= ::tracing::level_filters::STATIC_MAX_LEVEL
&&
::tracing::Level::TRACE <=
::tracing::level_filters::LevelFilter::current() ||
{ false } {
__tracing_attr_span =
{
use ::tracing::__macro_support::Callsite as _;
static __CALLSITE: ::tracing::callsite::DefaultCallsite =
{
static META: ::tracing::Metadata<'static> =
{
::tracing_core::metadata::Metadata::new("codegen_get_discr",
"rustc_codegen_ssa::mir::operand", ::tracing::Level::TRACE,
::tracing_core::__macro_support::Option::Some("compiler/rustc_codegen_ssa/src/mir/operand.rs"),
::tracing_core::__macro_support::Option::Some(432u32),
::tracing_core::__macro_support::Option::Some("rustc_codegen_ssa::mir::operand"),
::tracing_core::field::FieldSet::new(&["self", "cast_to"],
::tracing_core::callsite::Identifier(&__CALLSITE)),
::tracing::metadata::Kind::SPAN)
};
::tracing::callsite::DefaultCallsite::new(&META)
};
let mut interest = ::tracing::subscriber::Interest::never();
if ::tracing::Level::TRACE <=
::tracing::level_filters::STATIC_MAX_LEVEL &&
::tracing::Level::TRACE <=
::tracing::level_filters::LevelFilter::current() &&
{ interest = __CALLSITE.interest(); !interest.is_never() }
&&
::tracing::__macro_support::__is_enabled(__CALLSITE.metadata(),
interest) {
let meta = __CALLSITE.metadata();
::tracing::Span::new(meta,
&{
#[allow(unused_imports)]
use ::tracing::field::{debug, display, Value};
let mut iter = meta.fields().iter();
meta.fields().value_set(&[(&::tracing::__macro_support::Iterator::next(&mut iter).expect("FieldSet corrupted (this is a bug)"),
::tracing::__macro_support::Option::Some(&::tracing::field::debug(&self)
as &dyn Value)),
(&::tracing::__macro_support::Iterator::next(&mut iter).expect("FieldSet corrupted (this is a bug)"),
::tracing::__macro_support::Option::Some(&::tracing::field::debug(&cast_to)
as &dyn Value))])
})
} else {
let span =
::tracing::__macro_support::__disabled_span(__CALLSITE.metadata());
{};
span
}
};
__tracing_attr_guard = __tracing_attr_span.enter();
}
#[warn(clippy :: suspicious_else_formatting)]
{
#[allow(unknown_lints, unreachable_code, clippy ::
diverging_sub_expression, clippy :: empty_loop, clippy ::
let_unit_value, clippy :: let_with_type_underscore, clippy ::
needless_return, clippy :: unreachable)]
if false {
let __tracing_attr_fake_return: V = loop {};
return __tracing_attr_fake_return;
}
{
let dl = &bx.tcx().data_layout;
let cast_to_layout = bx.cx().layout_of(cast_to);
let cast_to = bx.cx().immediate_backend_type(cast_to_layout);
if self.layout.is_uninhabited() {
return bx.cx().const_poison(cast_to);
}
let (tag_scalar, tag_encoding, tag_field) =
match self.layout.variants {
Variants::Empty => {
::core::panicking::panic_fmt(format_args!("internal error: entered unreachable code: {0}",
format_args!("we already handled uninhabited types")));
}
Variants::Single { index } => {
let discr_val =
if let Some(discr) =
self.layout.ty.discriminant_for_variant(bx.tcx(), index) {
discr.val
} else {
{
match (&index, &FIRST_VARIANT) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val, ::core::option::Option::None);
}
}
}
};
0
};
return bx.cx().const_uint_big(cast_to, discr_val);
}
Variants::Multiple { tag, ref tag_encoding, tag_field, .. }
=> {
(tag, tag_encoding, tag_field)
}
};
let tag_op =
match self.val {
OperandValue::ZeroSized =>
::rustc_middle::util::bug::bug_fmt(format_args!("impossible case reached")),
OperandValue::Immediate(_) | OperandValue::Pair(_, _) => {
self.extract_field(fx, bx, tag_field.as_usize())
}
OperandValue::Ref(place) => {
let tag =
place.with_type(self.layout).project_field(bx,
tag_field.as_usize());
bx.load_operand(tag)
}
};
let tag_imm = tag_op.immediate();
match *tag_encoding {
TagEncoding::Direct => {
let signed =
match tag_scalar.primitive() {
Primitive::Int(_, signed) =>
!tag_scalar.is_bool() && signed,
_ => false,
};
bx.intcast(tag_imm, cast_to, signed)
}
TagEncoding::Niche {
untagged_variant, ref niche_variants, niche_start } => {
let (tag, tag_llty) =
match tag_scalar.primitive() {
Primitive::Pointer(_) => {
let t = bx.type_from_integer(dl.ptr_sized_integer());
let tag = bx.ptrtoint(tag_imm, t);
(tag, t)
}
_ =>
(tag_imm, bx.cx().immediate_backend_type(tag_op.layout)),
};
let relative_max =
niche_variants.last.as_u32() -
niche_variants.start.as_u32();
let niche_start_const =
bx.cx().const_uint_big(tag_llty, niche_start);
let (is_niche, tagged_discr, delta) =
if relative_max == 0 {
let is_niche =
bx.icmp(IntPredicate::IntEQ, tag, niche_start_const);
let tagged_discr =
bx.cx().const_uint(cast_to,
niche_variants.start.as_u32() as u64);
(is_niche, tagged_discr, 0)
} else {
if niche_variants.contains(&untagged_variant) &&
bx.cx().sess().opts.optimize != OptLevel::No {
let impossible =
niche_start.wrapping_add(u128::from(untagged_variant.as_u32())).wrapping_sub(u128::from(niche_variants.start.as_u32()));
let impossible =
bx.cx().const_uint_big(tag_llty, impossible);
let ne = bx.icmp(IntPredicate::IntNE, tag, impossible);
bx.assume(ne);
}
let tag_range = tag_scalar.valid_range(&dl);
let tag_size = tag_scalar.size(&dl);
let niche_end =
u128::from(relative_max).wrapping_add(niche_start);
let niche_end = tag_size.truncate(niche_end);
let relative_discr = bx.sub(tag, niche_start_const);
let cast_tag = bx.intcast(relative_discr, cast_to, false);
let is_niche =
if tag_range.no_unsigned_wraparound(tag_size) == Ok(true) {
if niche_start == tag_range.start {
let niche_end_const =
bx.cx().const_uint_big(tag_llty, niche_end);
bx.icmp(IntPredicate::IntULE, tag, niche_end_const)
} else {
{
match (&niche_end, &tag_range.end) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val, ::core::option::Option::None);
}
}
}
};
bx.icmp(IntPredicate::IntUGE, tag, niche_start_const)
}
} else if tag_range.no_signed_wraparound(tag_size) ==
Ok(true) {
if niche_start == tag_range.start {
let niche_end_const =
bx.cx().const_uint_big(tag_llty, niche_end);
bx.icmp(IntPredicate::IntSLE, tag, niche_end_const)
} else {
{
match (&niche_end, &tag_range.end) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val, ::core::option::Option::None);
}
}
}
};
bx.icmp(IntPredicate::IntSGE, tag, niche_start_const)
}
} else {
bx.icmp(IntPredicate::IntULE, relative_discr,
bx.cx().const_uint(tag_llty, relative_max as u64))
};
(is_niche, cast_tag, niche_variants.start.as_u32() as u128)
};
let tagged_discr =
if delta == 0 {
tagged_discr
} else {
bx.add(tagged_discr, bx.cx().const_uint_big(cast_to, delta))
};
let untagged_variant_const =
bx.cx().const_uint(cast_to,
u64::from(untagged_variant.as_u32()));
let discr =
bx.select(is_niche, tagged_discr, untagged_variant_const);
discr
}
}
}
}
}#[instrument(level = "trace", skip(fx, bx))]433pub fn codegen_get_discr<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
434self,
435 fx: &mut FunctionCx<'a, 'tcx, Bx>,
436 bx: &mut Bx,
437 cast_to: Ty<'tcx>,
438 ) -> V {
439let dl = &bx.tcx().data_layout;
440let cast_to_layout = bx.cx().layout_of(cast_to);
441let cast_to = bx.cx().immediate_backend_type(cast_to_layout);
442443// We check uninhabitedness separately because a type like
444 // `enum Foo { Bar(i32, !) }` is still reported as `Variants::Single`,
445 // *not* as `Variants::Empty`.
446if self.layout.is_uninhabited() {
447return bx.cx().const_poison(cast_to);
448 }
449450let (tag_scalar, tag_encoding, tag_field) = match self.layout.variants {
451 Variants::Empty => unreachable!("we already handled uninhabited types"),
452 Variants::Single { index } => {
453let discr_val =
454if let Some(discr) = self.layout.ty.discriminant_for_variant(bx.tcx(), index) {
455 discr.val
456 } else {
457// This arm is for types which are neither enums nor coroutines,
458 // and thus for which the only possible "variant" should be the first one.
459assert_eq!(index, FIRST_VARIANT);
460// There's thus no actual discriminant to return, so we return
461 // what it would have been if this was a single-variant enum.
4620
463};
464return bx.cx().const_uint_big(cast_to, discr_val);
465 }
466 Variants::Multiple { tag, ref tag_encoding, tag_field, .. } => {
467 (tag, tag_encoding, tag_field)
468 }
469 };
470471// Read the tag/niche-encoded discriminant from memory.
472let tag_op = match self.val {
473 OperandValue::ZeroSized => bug!(),
474 OperandValue::Immediate(_) | OperandValue::Pair(_, _) => {
475self.extract_field(fx, bx, tag_field.as_usize())
476 }
477 OperandValue::Ref(place) => {
478let tag = place.with_type(self.layout).project_field(bx, tag_field.as_usize());
479 bx.load_operand(tag)
480 }
481 };
482let tag_imm = tag_op.immediate();
483484// Decode the discriminant (specifically if it's niche-encoded).
485match *tag_encoding {
486 TagEncoding::Direct => {
487let signed = match tag_scalar.primitive() {
488// We use `i1` for bytes that are always `0` or `1`,
489 // e.g., `#[repr(i8)] enum E { A, B }`, but we can't
490 // let LLVM interpret the `i1` as signed, because
491 // then `i1 1` (i.e., `E::B`) is effectively `i8 -1`.
492Primitive::Int(_, signed) => !tag_scalar.is_bool() && signed,
493_ => false,
494 };
495 bx.intcast(tag_imm, cast_to, signed)
496 }
497 TagEncoding::Niche { untagged_variant, ref niche_variants, niche_start } => {
498// Cast to an integer so we don't have to treat a pointer as a
499 // special case.
500let (tag, tag_llty) = match tag_scalar.primitive() {
501// FIXME(erikdesjardins): handle non-default addrspace ptr sizes
502Primitive::Pointer(_) => {
503let t = bx.type_from_integer(dl.ptr_sized_integer());
504let tag = bx.ptrtoint(tag_imm, t);
505 (tag, t)
506 }
507_ => (tag_imm, bx.cx().immediate_backend_type(tag_op.layout)),
508 };
509510// `layout_sanity_check` ensures that we only get here for cases where the discriminant
511 // value and the variant index match, since that's all `Niche` can encode.
512513let relative_max = niche_variants.last.as_u32() - niche_variants.start.as_u32();
514let niche_start_const = bx.cx().const_uint_big(tag_llty, niche_start);
515516// We have a subrange `niche_start..=niche_end` inside `range`.
517 // If the value of the tag is inside this subrange, it's a
518 // "niche value", an increment of the discriminant. Otherwise it
519 // indicates the untagged variant.
520 // A general algorithm to extract the discriminant from the tag
521 // is:
522 // relative_tag = tag - niche_start
523 // is_niche = relative_tag <= (ule) relative_max
524 // discr = if is_niche {
525 // cast(relative_tag) + niche_variants.start()
526 // } else {
527 // untagged_variant
528 // }
529 // However, we will likely be able to emit simpler code.
530let (is_niche, tagged_discr, delta) = if relative_max == 0 {
531// Best case scenario: only one tagged variant. This will
532 // likely become just a comparison and a jump.
533 // The algorithm is:
534 // is_niche = tag == niche_start
535 // discr = if is_niche {
536 // niche_start
537 // } else {
538 // untagged_variant
539 // }
540let is_niche = bx.icmp(IntPredicate::IntEQ, tag, niche_start_const);
541let tagged_discr =
542 bx.cx().const_uint(cast_to, niche_variants.start.as_u32() as u64);
543 (is_niche, tagged_discr, 0)
544 } else {
545// Thanks to parameter attributes and load metadata, LLVM already knows
546 // the general valid range of the tag. It's possible, though, for there
547 // to be an impossible value *in the middle*, which those ranges don't
548 // communicate, so it's worth an `assume` to let the optimizer know.
549 // Most importantly, this means when optimizing a variant test like
550 // `SELECT(is_niche, complex, CONST) == CONST` it's ok to simplify that
551 // to `!is_niche` because the `complex` part can't possibly match.
552 //
553 // This was previously asserted on `tagged_discr` below, where the
554 // impossible value is more obvious, but that caused an intermediate
555 // value to become multi-use and thus not optimize, so instead this
556 // assumes on the original input which is always multi-use. See
557 // <https://github.com/llvm/llvm-project/issues/134024#issuecomment-3131782555>
558 //
559 // FIXME: If we ever get range assume operand bundles in LLVM (so we
560 // don't need the `icmp`s in the instruction stream any more), it
561 // might be worth moving this back to being on the switch argument
562 // where it's more obviously applicable.
563if niche_variants.contains(&untagged_variant)
564 && bx.cx().sess().opts.optimize != OptLevel::No
565 {
566let impossible = niche_start
567 .wrapping_add(u128::from(untagged_variant.as_u32()))
568 .wrapping_sub(u128::from(niche_variants.start.as_u32()));
569let impossible = bx.cx().const_uint_big(tag_llty, impossible);
570let ne = bx.icmp(IntPredicate::IntNE, tag, impossible);
571 bx.assume(ne);
572 }
573574// With multiple niched variants we'll have to actually compute
575 // the variant index from the stored tag.
576 //
577 // However, there's still one small optimization we can often do for
578 // determining *whether* a tag value is a natural value or a niched
579 // variant. The general algorithm involves a subtraction that often
580 // wraps in practice, making it tricky to analyse. However, in cases
581 // where there are few enough possible values of the tag that it doesn't
582 // need to wrap around, we can instead just look for the contiguous
583 // tag values on the end of the range with a single comparison.
584 //
585 // For example, take the type `enum Demo { A, B, Untagged(bool) }`.
586 // The `bool` is {0, 1}, and the two other variants are given the
587 // tags {2, 3} respectively. That means the `tag_range` is
588 // `[0, 3]`, which doesn't wrap as unsigned (nor as signed), so
589 // we can test for the niched variants with just `>= 2`.
590 //
591 // That means we're looking either for the niche values *above*
592 // the natural values of the untagged variant:
593 //
594 // niche_start niche_end
595 // | |
596 // v v
597 // MIN -------------+---------------------------+---------- MAX
598 // ^ | is niche |
599 // | +---------------------------+
600 // | |
601 // tag_range.start tag_range.end
602 //
603 // Or *below* the natural values:
604 //
605 // niche_start niche_end
606 // | |
607 // v v
608 // MIN ----+-----------------------+---------------------- MAX
609 // | is niche | ^
610 // +-----------------------+ |
611 // | |
612 // tag_range.start tag_range.end
613 //
614 // With those two options and having the flexibility to choose
615 // between a signed or unsigned comparison on the tag, that
616 // covers most realistic scenarios. The tests have a (contrived)
617 // example of a 1-byte enum with over 128 niched variants which
618 // wraps both as signed as unsigned, though, and for something
619 // like that we're stuck with the general algorithm.
620621let tag_range = tag_scalar.valid_range(&dl);
622let tag_size = tag_scalar.size(&dl);
623let niche_end = u128::from(relative_max).wrapping_add(niche_start);
624let niche_end = tag_size.truncate(niche_end);
625626let relative_discr = bx.sub(tag, niche_start_const);
627let cast_tag = bx.intcast(relative_discr, cast_to, false);
628let is_niche = if tag_range.no_unsigned_wraparound(tag_size) == Ok(true) {
629if niche_start == tag_range.start {
630let niche_end_const = bx.cx().const_uint_big(tag_llty, niche_end);
631 bx.icmp(IntPredicate::IntULE, tag, niche_end_const)
632 } else {
633assert_eq!(niche_end, tag_range.end);
634 bx.icmp(IntPredicate::IntUGE, tag, niche_start_const)
635 }
636 } else if tag_range.no_signed_wraparound(tag_size) == Ok(true) {
637if niche_start == tag_range.start {
638let niche_end_const = bx.cx().const_uint_big(tag_llty, niche_end);
639 bx.icmp(IntPredicate::IntSLE, tag, niche_end_const)
640 } else {
641assert_eq!(niche_end, tag_range.end);
642 bx.icmp(IntPredicate::IntSGE, tag, niche_start_const)
643 }
644 } else {
645 bx.icmp(
646 IntPredicate::IntULE,
647 relative_discr,
648 bx.cx().const_uint(tag_llty, relative_max as u64),
649 )
650 };
651652 (is_niche, cast_tag, niche_variants.start.as_u32() as u128)
653 };
654655let tagged_discr = if delta == 0 {
656 tagged_discr
657 } else {
658 bx.add(tagged_discr, bx.cx().const_uint_big(cast_to, delta))
659 };
660661let untagged_variant_const =
662 bx.cx().const_uint(cast_to, u64::from(untagged_variant.as_u32()));
663664let discr = bx.select(is_niche, tagged_discr, untagged_variant_const);
665666// In principle we could insert assumes on the possible range of `discr`, but
667 // currently in LLVM this isn't worth it because the original `tag` will
668 // have either a `range` parameter attribute or `!range` metadata,
669 // or come from a `transmute` that already `assume`d it.
670671discr
672 }
673 }
674 }
675}
676677/// Each of these variants starts out as `Either::Right` when it's uninitialized,
678/// then setting the field changes that to `Either::Left` with the backend value.
679#[derive(#[automatically_derived]
impl<V: ::core::fmt::Debug> ::core::fmt::Debug for OperandValueBuilder<V> {
#[inline]
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
match self {
OperandValueBuilder::ZeroSized =>
::core::fmt::Formatter::write_str(f, "ZeroSized"),
OperandValueBuilder::Immediate(__self_0) =>
::core::fmt::Formatter::debug_tuple_field1_finish(f,
"Immediate", &__self_0),
OperandValueBuilder::Pair(__self_0, __self_1) =>
::core::fmt::Formatter::debug_tuple_field2_finish(f, "Pair",
__self_0, &__self_1),
OperandValueBuilder::Vector(__self_0) =>
::core::fmt::Formatter::debug_tuple_field1_finish(f, "Vector",
&__self_0),
}
}
}Debug, #[automatically_derived]
impl<V: ::core::marker::Copy> ::core::marker::Copy for OperandValueBuilder<V>
{
}Copy, #[automatically_derived]
impl<V: ::core::clone::Clone> ::core::clone::Clone for OperandValueBuilder<V>
{
#[inline]
fn clone(&self) -> OperandValueBuilder<V> {
match self {
OperandValueBuilder::ZeroSized => OperandValueBuilder::ZeroSized,
OperandValueBuilder::Immediate(__self_0) =>
OperandValueBuilder::Immediate(::core::clone::Clone::clone(__self_0)),
OperandValueBuilder::Pair(__self_0, __self_1) =>
OperandValueBuilder::Pair(::core::clone::Clone::clone(__self_0),
::core::clone::Clone::clone(__self_1)),
OperandValueBuilder::Vector(__self_0) =>
OperandValueBuilder::Vector(::core::clone::Clone::clone(__self_0)),
}
}
}Clone)]
680enum OperandValueBuilder<V> {
681 ZeroSized,
682 Immediate(Either<V, abi::Scalar>),
683 Pair(Either<V, abi::Scalar>, Either<V, abi::Scalar>),
684/// `repr(simd)` types need special handling because they each have a non-empty
685 /// array field (which uses [`OperandValue::Ref`]) despite the SIMD type itself
686 /// using [`OperandValue::Immediate`] which for any other kind of type would
687 /// mean that its one non-ZST field would also be [`OperandValue::Immediate`].
688Vector(Either<V, ()>),
689}
690691/// Allows building up an `OperandRef` by setting fields one at a time.
692#[derive(#[automatically_derived]
impl<'tcx, V: ::core::fmt::Debug> ::core::fmt::Debug for
OperandRefBuilder<'tcx, V> {
#[inline]
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
::core::fmt::Formatter::debug_struct_field2_finish(f,
"OperandRefBuilder", "val", &self.val, "layout", &&self.layout)
}
}Debug, #[automatically_derived]
impl<'tcx, V: ::core::marker::Copy> ::core::marker::Copy for
OperandRefBuilder<'tcx, V> {
}Copy, #[automatically_derived]
impl<'tcx, V: ::core::clone::Clone> ::core::clone::Clone for
OperandRefBuilder<'tcx, V> {
#[inline]
fn clone(&self) -> OperandRefBuilder<'tcx, V> {
OperandRefBuilder {
val: ::core::clone::Clone::clone(&self.val),
layout: ::core::clone::Clone::clone(&self.layout),
}
}
}Clone)]
693pub(super) struct OperandRefBuilder<'tcx, V> {
694 val: OperandValueBuilder<V>,
695 layout: TyAndLayout<'tcx>,
696}
697698impl<'a, 'tcx, V: CodegenObject> OperandRefBuilder<'tcx, V> {
699/// Creates an uninitialized builder for an instance of the `layout`.
700 ///
701 /// ICEs for [`BackendRepr::Memory`] types (other than ZSTs), which should
702 /// be built up inside a [`PlaceRef`] instead as they need an allocated place
703 /// into which to write the values of the fields.
704pub(super) fn new(layout: TyAndLayout<'tcx>) -> Self {
705let val = match layout.backend_repr {
706 BackendRepr::Memory { .. } if layout.is_zst() => OperandValueBuilder::ZeroSized,
707 BackendRepr::Scalar(s) => OperandValueBuilder::Immediate(Either::Right(s)),
708 BackendRepr::ScalarPair(a, b) => {
709 OperandValueBuilder::Pair(Either::Right(a), Either::Right(b))
710 }
711 BackendRepr::SimdVector { .. } | BackendRepr::SimdScalableVector { .. } => {
712 OperandValueBuilder::Vector(Either::Right(()))
713 }
714 BackendRepr::Memory { .. } => {
715::rustc_middle::util::bug::bug_fmt(format_args!("Cannot use non-ZST Memory-ABI type in operand builder: {0:?}",
layout));bug!("Cannot use non-ZST Memory-ABI type in operand builder: {layout:?}");
716 }
717 };
718OperandRefBuilder { val, layout }
719 }
720721/// Creates an initialized builder for updating an existing `operand`.
722 ///
723 /// ICEs for [`BackendRepr::Memory`] types (other than ZSTs), which use
724 /// which use [`OperandValue::Ref`]. In this case, updates should be
725 /// performed by writing into the place
726pub(super) fn from_existing(operand: OperandRef<'tcx, V>) -> Self {
727let layout = operand.layout;
728let val = match (operand.val, layout.backend_repr) {
729 (OperandValue::ZeroSized, _) => OperandValueBuilder::ZeroSized,
730 (OperandValue::Immediate(v), BackendRepr::Scalar(_)) => {
731 OperandValueBuilder::Immediate(Either::Left(v))
732 }
733 (OperandValue::Immediate(v), BackendRepr::SimdVector { .. }) => {
734 OperandValueBuilder::Vector(Either::Left(v))
735 }
736 (OperandValue::Pair(a, b), BackendRepr::ScalarPair(_, _)) => {
737 OperandValueBuilder::Pair(Either::Left(a), Either::Left(b))
738 }
739 (_, BackendRepr::Memory { .. }) => {
740::rustc_middle::util::bug::bug_fmt(format_args!("Cannot use non-ZST Memory-ABI type in operand builder: {0:?}",
layout));bug!("Cannot use non-ZST Memory-ABI type in operand builder: {layout:?}");
741 }
742_ => {
743::rustc_middle::util::bug::bug_fmt(format_args!("Operand cannot be used with `from_existing`: {0:?}",
operand))bug!("Operand cannot be used with `from_existing`: {operand:?}")744 }
745 };
746OperandRefBuilder { val, layout }
747 }
748749pub(super) fn insert_field<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
750&mut self,
751 bx: &mut Bx,
752 variant: VariantIdx,
753 field: FieldIdx,
754 field_operand: OperandRef<'tcx, V>,
755 ) {
756if let OperandValue::ZeroSized = field_operand.val {
757// A ZST never adds any state, so just ignore it.
758 // This special-casing is worth it because of things like
759 // `Result<!, !>` where `Ok(never)` is legal to write,
760 // but the type shows as FieldShape::Primitive so we can't
761 // actually look at the layout for the field being set.
762return;
763 }
764765let is_zero_offset = if let abi::FieldsShape::Primitive = self.layout.fields {
766// The other branch looking at field layouts ICEs for primitives,
767 // so we need to handle them separately.
768 // Because we handled ZSTs above (like the metadata in a thin pointer),
769 // the only possibility is that we're setting the one-and-only field.
770if !!self.layout.is_zst() {
::core::panicking::panic("assertion failed: !self.layout.is_zst()")
};assert!(!self.layout.is_zst());
771{
match (&variant, &FIRST_VARIANT) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val, ::core::option::Option::None);
}
}
}
};assert_eq!(variant, FIRST_VARIANT);
772{
match (&field, &FieldIdx::ZERO) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val, ::core::option::Option::None);
}
}
}
};assert_eq!(field, FieldIdx::ZERO);
773true
774} else {
775let variant_layout = self.layout.for_variant(bx.cx(), variant);
776let field_offset = variant_layout.fields.offset(field.as_usize());
777field_offset == Size::ZERO778 };
779780let mut update = |tgt: &mut Either<V, abi::Scalar>, src, from_scalar| {
781let to_scalar = tgt.unwrap_right();
782// We transmute here (rather than just `from_immediate`) because in
783 // `Result<usize, *const ()>` the field of the `Ok` is an integer,
784 // but the corresponding scalar in the enum is a pointer.
785let imm = transmute_scalar(bx, src, from_scalar, to_scalar);
786*tgt = Either::Left(imm);
787 };
788789match (field_operand.val, field_operand.layout.backend_repr) {
790 (OperandValue::ZeroSized, _) => {
::core::panicking::panic_fmt(format_args!("internal error: entered unreachable code: {0}",
format_args!("Handled above")));
}unreachable!("Handled above"),
791 (OperandValue::Immediate(v), BackendRepr::Scalar(from_scalar)) => match &mut self.val {
792 OperandValueBuilder::Immediate(val @ Either::Right(_)) if is_zero_offset => {
793update(val, v, from_scalar);
794 }
795 OperandValueBuilder::Pair(fst @ Either::Right(_), _) if is_zero_offset => {
796update(fst, v, from_scalar);
797 }
798 OperandValueBuilder::Pair(_, snd @ Either::Right(_)) if !is_zero_offset => {
799update(snd, v, from_scalar);
800 }
801_ => {
802::rustc_middle::util::bug::bug_fmt(format_args!("Tried to insert {0:?} into {1:?}.{2:?} of {3:?}",
field_operand, variant, field, self))bug!("Tried to insert {field_operand:?} into {variant:?}.{field:?} of {self:?}")803 }
804 },
805 (OperandValue::Immediate(v), BackendRepr::SimdVector { .. }) => match &mut self.val {
806 OperandValueBuilder::Vector(val @ Either::Right(())) if is_zero_offset => {
807*val = Either::Left(v);
808 }
809_ => {
810::rustc_middle::util::bug::bug_fmt(format_args!("Tried to insert {0:?} into {1:?}.{2:?} of {3:?}",
field_operand, variant, field, self))bug!("Tried to insert {field_operand:?} into {variant:?}.{field:?} of {self:?}")811 }
812 },
813 (OperandValue::Pair(a, b), BackendRepr::ScalarPair(from_sa, from_sb)) => {
814match &mut self.val {
815 OperandValueBuilder::Pair(fst @ Either::Right(_), snd @ Either::Right(_)) => {
816update(fst, a, from_sa);
817update(snd, b, from_sb);
818 }
819_ => ::rustc_middle::util::bug::bug_fmt(format_args!("Tried to insert {0:?} into {1:?}.{2:?} of {3:?}",
field_operand, variant, field, self))bug!(
820"Tried to insert {field_operand:?} into {variant:?}.{field:?} of {self:?}"
821),
822 }
823 }
824 (OperandValue::Ref(place), BackendRepr::Memory { .. }) => match &mut self.val {
825 OperandValueBuilder::Vector(val @ Either::Right(())) => {
826let ibty = bx.cx().immediate_backend_type(self.layout);
827let simd = bx.load_from_place(ibty, place);
828*val = Either::Left(simd);
829 }
830_ => {
831::rustc_middle::util::bug::bug_fmt(format_args!("Tried to insert {0:?} into {1:?}.{2:?} of {3:?}",
field_operand, variant, field, self))bug!("Tried to insert {field_operand:?} into {variant:?}.{field:?} of {self:?}")832 }
833 },
834_ => ::rustc_middle::util::bug::bug_fmt(format_args!("Operand cannot be used with `insert_field`: {0:?}",
field_operand))bug!("Operand cannot be used with `insert_field`: {field_operand:?}"),
835 }
836 }
837838/// Insert the immediate value `imm` for field `f` in the *type itself*,
839 /// rather than into one of the variants.
840 ///
841 /// Most things want [`Self::insert_field`] instead, but this one is
842 /// necessary for writing things like enum tags that aren't in any variant.
843pub(super) fn insert_imm(&mut self, f: FieldIdx, imm: V) {
844let field_offset = self.layout.fields.offset(f.as_usize());
845let is_zero_offset = field_offset == Size::ZERO;
846match &mut self.val {
847 OperandValueBuilder::Immediate(val @ Either::Right(_)) if is_zero_offset => {
848*val = Either::Left(imm);
849 }
850 OperandValueBuilder::Pair(fst @ Either::Right(_), _) if is_zero_offset => {
851*fst = Either::Left(imm);
852 }
853 OperandValueBuilder::Pair(_, snd @ Either::Right(_)) if !is_zero_offset => {
854*snd = Either::Left(imm);
855 }
856_ => ::rustc_middle::util::bug::bug_fmt(format_args!("Tried to insert {0:?} into field {1:?} of {2:?}",
imm, f, self))bug!("Tried to insert {imm:?} into field {f:?} of {self:?}"),
857 }
858 }
859860/// Replaces the current immediate value at the offset `offset`
861 /// with the value `imm`. A value must already be present.
862 ///
863 /// This is used along with [`Self::from_existing`] to perform in-place updates
864 /// of any operand.
865pub(super) fn update_imm(&mut self, offset: Size, imm: V) {
866let is_zero_offset = offset == Size::ZERO;
867match &mut self.val {
868 OperandValueBuilder::Immediate(val @ Either::Left(_)) if is_zero_offset => {
869*val = Either::Left(imm);
870 }
871 OperandValueBuilder::Pair(fst @ Either::Left(_), _) if is_zero_offset => {
872*fst = Either::Left(imm);
873 }
874 OperandValueBuilder::Pair(_, snd @ Either::Left(_)) if !is_zero_offset => {
875*snd = Either::Left(imm);
876 }
877_ => ::rustc_middle::util::bug::bug_fmt(format_args!("Tried to update {0:?} at offset {1:?} of {2:?}",
imm, offset, self))bug!("Tried to update {imm:?} at offset {offset:?} of {self:?}"),
878 }
879 }
880881/// After having set all necessary fields, this converts the builder back
882 /// to the normal `OperandRef`.
883 ///
884 /// ICEs if any required fields were not set.
885pub(super) fn build(&self, cx: &impl CodegenMethods<'tcx, Value = V>) -> OperandRef<'tcx, V> {
886let OperandRefBuilder { val, layout } = *self;
887888// For something like `Option::<u32>::None`, it's expected that the
889 // payload scalar will not actually have been set, so this converts
890 // unset scalars to corresponding `undef` values so long as the scalar
891 // from the layout allows uninit.
892let unwrap = |r: Either<V, abi::Scalar>| match r {
893 Either::Left(v) => v,
894 Either::Right(s) if s.is_uninit_valid() => {
895let bty = cx.type_from_scalar(s);
896cx.const_undef(bty)
897 }
898 Either::Right(_) => ::rustc_middle::util::bug::bug_fmt(format_args!("OperandRef::build called while fields are missing {0:?}",
self))bug!("OperandRef::build called while fields are missing {self:?}"),
899 };
900901let val = match val {
902 OperandValueBuilder::ZeroSized => OperandValue::ZeroSized,
903 OperandValueBuilder::Immediate(v) => OperandValue::Immediate(unwrap(v)),
904 OperandValueBuilder::Pair(a, b) => OperandValue::Pair(unwrap(a), unwrap(b)),
905 OperandValueBuilder::Vector(v) => match v {
906 Either::Left(v) => OperandValue::Immediate(v),
907 Either::Right(())
908if let BackendRepr::SimdVector { element, .. } = layout.backend_repr
909 && element.is_uninit_valid() =>
910 {
911let bty = cx.immediate_backend_type(layout);
912 OperandValue::Immediate(cx.const_undef(bty))
913 }
914 Either::Right(()) => {
915::rustc_middle::util::bug::bug_fmt(format_args!("OperandRef::build called while fields are missing {0:?}",
self))bug!("OperandRef::build called while fields are missing {self:?}")916 }
917 },
918 };
919OperandRef { val, layout, move_annotation: None }
920 }
921}
922923/// Default size limit for move/copy annotations (in bytes). 64 bytes is a common size of a cache
924/// line, and the assumption is that anything this size or below is very cheap to move/copy, so only
925/// annotate copies larger than this.
926const MOVE_ANNOTATION_DEFAULT_LIMIT: u64 = 65;
927928impl<'a, 'tcx, V: CodegenObject> OperandValue<V> {
929/// Returns an `OperandValue` that's generally UB to use in any way.
930 ///
931 /// Depending on the `layout`, returns `ZeroSized` for ZSTs, an `Immediate` or
932 /// `Pair` containing poison value(s), or a `Ref` containing a poison pointer.
933 ///
934 /// Supports sized types only.
935pub fn poison<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
936 bx: &mut Bx,
937 layout: TyAndLayout<'tcx>,
938 ) -> OperandValue<V> {
939if !layout.is_sized() {
::core::panicking::panic("assertion failed: layout.is_sized()")
};assert!(layout.is_sized());
940if layout.is_zst() {
941 OperandValue::ZeroSized942 } else if bx.cx().is_backend_immediate(layout) {
943let ibty = bx.cx().immediate_backend_type(layout);
944 OperandValue::Immediate(bx.const_poison(ibty))
945 } else if bx.cx().is_backend_scalar_pair(layout) {
946let ibty0 = bx.cx().scalar_pair_element_backend_type(layout, 0, true);
947let ibty1 = bx.cx().scalar_pair_element_backend_type(layout, 1, true);
948 OperandValue::Pair(bx.const_poison(ibty0), bx.const_poison(ibty1))
949 } else {
950let ptr = bx.cx().type_ptr();
951 OperandValue::Ref(PlaceValue::new_sized(bx.const_poison(ptr), layout.align.abi))
952 }
953 }
954955pub fn store<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
956self,
957 bx: &mut Bx,
958 dest: PlaceRef<'tcx, V>,
959 ) {
960self.store_with_flags(bx, dest, MemFlags::empty());
961 }
962963pub fn volatile_store<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
964self,
965 bx: &mut Bx,
966 dest: PlaceRef<'tcx, V>,
967 ) {
968self.store_with_flags(bx, dest, MemFlags::VOLATILE);
969 }
970971pub fn unaligned_volatile_store<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
972self,
973 bx: &mut Bx,
974 dest: PlaceRef<'tcx, V>,
975 ) {
976self.store_with_flags(bx, dest, MemFlags::VOLATILE | MemFlags::UNALIGNED);
977 }
978979pub fn nontemporal_store<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
980self,
981 bx: &mut Bx,
982 dest: PlaceRef<'tcx, V>,
983 ) {
984self.store_with_flags(bx, dest, MemFlags::NONTEMPORAL);
985 }
986987pub(crate) fn store_with_flags<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
988self,
989 bx: &mut Bx,
990 dest: PlaceRef<'tcx, V>,
991 flags: MemFlags,
992 ) {
993{
use ::tracing::__macro_support::Callsite as _;
static __CALLSITE: ::tracing::callsite::DefaultCallsite =
{
static META: ::tracing::Metadata<'static> =
{
::tracing_core::metadata::Metadata::new("event compiler/rustc_codegen_ssa/src/mir/operand.rs:993",
"rustc_codegen_ssa::mir::operand", ::tracing::Level::DEBUG,
::tracing_core::__macro_support::Option::Some("compiler/rustc_codegen_ssa/src/mir/operand.rs"),
::tracing_core::__macro_support::Option::Some(993u32),
::tracing_core::__macro_support::Option::Some("rustc_codegen_ssa::mir::operand"),
::tracing_core::field::FieldSet::new(&["message"],
::tracing_core::callsite::Identifier(&__CALLSITE)),
::tracing::metadata::Kind::EVENT)
};
::tracing::callsite::DefaultCallsite::new(&META)
};
let enabled =
::tracing::Level::DEBUG <= ::tracing::level_filters::STATIC_MAX_LEVEL
&&
::tracing::Level::DEBUG <=
::tracing::level_filters::LevelFilter::current() &&
{
let interest = __CALLSITE.interest();
!interest.is_never() &&
::tracing::__macro_support::__is_enabled(__CALLSITE.metadata(),
interest)
};
if enabled {
(|value_set: ::tracing::field::ValueSet|
{
let meta = __CALLSITE.metadata();
::tracing::Event::dispatch(meta, &value_set);
;
})({
#[allow(unused_imports)]
use ::tracing::field::{debug, display, Value};
let mut iter = __CALLSITE.metadata().fields().iter();
__CALLSITE.metadata().fields().value_set(&[(&::tracing::__macro_support::Iterator::next(&mut iter).expect("FieldSet corrupted (this is a bug)"),
::tracing::__macro_support::Option::Some(&format_args!("OperandRef::store: operand={0:?}, dest={1:?}",
self, dest) as &dyn Value))])
});
} else { ; }
};debug!("OperandRef::store: operand={:?}, dest={:?}", self, dest);
994match self {
995 OperandValue::ZeroSized => {
996// Avoid generating stores of zero-sized values, because the only way to have a
997 // zero-sized value is through `undef`/`poison`, and the store itself is useless.
998}
999 OperandValue::Ref(val) => {
1000if !dest.layout.is_sized() {
{
::core::panicking::panic_fmt(format_args!("cannot directly store unsized values"));
}
};assert!(dest.layout.is_sized(), "cannot directly store unsized values");
1001if val.llextra.is_some() {
1002::rustc_middle::util::bug::bug_fmt(format_args!("cannot directly store unsized values"));bug!("cannot directly store unsized values");
1003 }
1004bx.typed_place_copy_with_flags(dest.val, val, dest.layout, flags);
1005 }
1006 OperandValue::Immediate(s) => {
1007let val = bx.from_immediate(s);
1008bx.store_with_flags(val, dest.val.llval, dest.val.align, flags);
1009 }
1010 OperandValue::Pair(a, b) => {
1011let BackendRepr::ScalarPair(a_scalar, b_scalar) = dest.layout.backend_repr else {
1012::rustc_middle::util::bug::bug_fmt(format_args!("store_with_flags: invalid ScalarPair layout: {0:#?}",
dest.layout));bug!("store_with_flags: invalid ScalarPair layout: {:#?}", dest.layout);
1013 };
1014let b_offset = a_scalar.size(bx).align_to(b_scalar.default_align(bx).abi);
10151016let val = bx.from_immediate(a);
1017let align = dest.val.align;
1018bx.store_with_flags(val, dest.val.llval, align, flags);
10191020let llptr = bx.inbounds_ptradd(dest.val.llval, bx.const_usize(b_offset.bytes()));
1021let val = bx.from_immediate(b);
1022let align = dest.val.align.restrict_for_offset(b_offset);
1023// The CAPTURES_READ_ONLY flag only applies to the first element.
1024bx.store_with_flags(val, llptr, align, flags & !MemFlags::CAPTURES_READ_ONLY);
1025 }
1026 }
1027 }
1028}
10291030impl<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>> FunctionCx<'a, 'tcx, Bx> {
1031fn maybe_codegen_consume_direct(
1032&mut self,
1033 bx: &mut Bx,
1034 place_ref: mir::PlaceRef<'tcx>,
1035 ) -> Option<OperandRef<'tcx, Bx::Value>> {
1036{
use ::tracing::__macro_support::Callsite as _;
static __CALLSITE: ::tracing::callsite::DefaultCallsite =
{
static META: ::tracing::Metadata<'static> =
{
::tracing_core::metadata::Metadata::new("event compiler/rustc_codegen_ssa/src/mir/operand.rs:1036",
"rustc_codegen_ssa::mir::operand", ::tracing::Level::DEBUG,
::tracing_core::__macro_support::Option::Some("compiler/rustc_codegen_ssa/src/mir/operand.rs"),
::tracing_core::__macro_support::Option::Some(1036u32),
::tracing_core::__macro_support::Option::Some("rustc_codegen_ssa::mir::operand"),
::tracing_core::field::FieldSet::new(&["message"],
::tracing_core::callsite::Identifier(&__CALLSITE)),
::tracing::metadata::Kind::EVENT)
};
::tracing::callsite::DefaultCallsite::new(&META)
};
let enabled =
::tracing::Level::DEBUG <= ::tracing::level_filters::STATIC_MAX_LEVEL
&&
::tracing::Level::DEBUG <=
::tracing::level_filters::LevelFilter::current() &&
{
let interest = __CALLSITE.interest();
!interest.is_never() &&
::tracing::__macro_support::__is_enabled(__CALLSITE.metadata(),
interest)
};
if enabled {
(|value_set: ::tracing::field::ValueSet|
{
let meta = __CALLSITE.metadata();
::tracing::Event::dispatch(meta, &value_set);
;
})({
#[allow(unused_imports)]
use ::tracing::field::{debug, display, Value};
let mut iter = __CALLSITE.metadata().fields().iter();
__CALLSITE.metadata().fields().value_set(&[(&::tracing::__macro_support::Iterator::next(&mut iter).expect("FieldSet corrupted (this is a bug)"),
::tracing::__macro_support::Option::Some(&format_args!("maybe_codegen_consume_direct(place_ref={0:?})",
place_ref) as &dyn Value))])
});
} else { ; }
};debug!("maybe_codegen_consume_direct(place_ref={:?})", place_ref);
10371038match self.locals[place_ref.local] {
1039 LocalRef::Operand(mut o) => {
1040// We only need to handle the projections that
1041 // `LocalAnalyzer::process_place` let make it here.
1042for elem in place_ref.projection {
1043match *elem {
1044 mir::ProjectionElem::Field(f, _) => {
1045if !!o.layout.ty.is_any_ptr() {
{
::core::panicking::panic_fmt(format_args!("Bad PlaceRef: destructing pointers should use cast/PtrMetadata, but tried to access field {0:?} of pointer {1:?}",
f, o));
}
};assert!(
1046 !o.layout.ty.is_any_ptr(),
1047"Bad PlaceRef: destructing pointers should use cast/PtrMetadata, \
1048 but tried to access field {f:?} of pointer {o:?}",
1049 );
1050 o = o.extract_field(self, bx, f.index());
1051 }
1052 mir::PlaceElem::Downcast(_, vidx) => {
1053if true {
{
match (&o.layout.variants, &abi::Variants::Single { index: vidx }) {
(left_val, right_val) => {
if !(*left_val == *right_val) {
let kind = ::core::panicking::AssertKind::Eq;
::core::panicking::assert_failed(kind, &*left_val,
&*right_val, ::core::option::Option::None);
}
}
}
};
};debug_assert_eq!(
1054 o.layout.variants,
1055 abi::Variants::Single { index: vidx },
1056 );
1057let layout = o.layout.for_variant(bx.cx(), vidx);
1058 o = OperandRef { layout, ..o }
1059 }
1060_ => return None,
1061 }
1062 }
10631064Some(o)
1065 }
1066 LocalRef::PendingOperand => {
1067::rustc_middle::util::bug::bug_fmt(format_args!("use of {0:?} before def",
place_ref));bug!("use of {:?} before def", place_ref);
1068 }
1069 LocalRef::Place(..) | LocalRef::UnsizedPlace(..) => {
1070// watch out for locals that do not have an
1071 // alloca; they are handled somewhat differently
1072None1073 }
1074 }
1075 }
10761077pub fn codegen_consume(
1078&mut self,
1079 bx: &mut Bx,
1080 place_ref: mir::PlaceRef<'tcx>,
1081 ) -> OperandRef<'tcx, Bx::Value> {
1082{
use ::tracing::__macro_support::Callsite as _;
static __CALLSITE: ::tracing::callsite::DefaultCallsite =
{
static META: ::tracing::Metadata<'static> =
{
::tracing_core::metadata::Metadata::new("event compiler/rustc_codegen_ssa/src/mir/operand.rs:1082",
"rustc_codegen_ssa::mir::operand", ::tracing::Level::DEBUG,
::tracing_core::__macro_support::Option::Some("compiler/rustc_codegen_ssa/src/mir/operand.rs"),
::tracing_core::__macro_support::Option::Some(1082u32),
::tracing_core::__macro_support::Option::Some("rustc_codegen_ssa::mir::operand"),
::tracing_core::field::FieldSet::new(&["message"],
::tracing_core::callsite::Identifier(&__CALLSITE)),
::tracing::metadata::Kind::EVENT)
};
::tracing::callsite::DefaultCallsite::new(&META)
};
let enabled =
::tracing::Level::DEBUG <= ::tracing::level_filters::STATIC_MAX_LEVEL
&&
::tracing::Level::DEBUG <=
::tracing::level_filters::LevelFilter::current() &&
{
let interest = __CALLSITE.interest();
!interest.is_never() &&
::tracing::__macro_support::__is_enabled(__CALLSITE.metadata(),
interest)
};
if enabled {
(|value_set: ::tracing::field::ValueSet|
{
let meta = __CALLSITE.metadata();
::tracing::Event::dispatch(meta, &value_set);
;
})({
#[allow(unused_imports)]
use ::tracing::field::{debug, display, Value};
let mut iter = __CALLSITE.metadata().fields().iter();
__CALLSITE.metadata().fields().value_set(&[(&::tracing::__macro_support::Iterator::next(&mut iter).expect("FieldSet corrupted (this is a bug)"),
::tracing::__macro_support::Option::Some(&format_args!("codegen_consume(place_ref={0:?})",
place_ref) as &dyn Value))])
});
} else { ; }
};debug!("codegen_consume(place_ref={:?})", place_ref);
10831084let ty = self.monomorphized_place_ty(place_ref);
1085let layout = bx.cx().layout_of(ty);
10861087// ZSTs don't require any actual memory access.
1088if layout.is_zst() {
1089return OperandRef::zero_sized(layout);
1090 }
10911092if let Some(o) = self.maybe_codegen_consume_direct(bx, place_ref) {
1093return o;
1094 }
10951096// for most places, to consume them we just load them
1097 // out from their home
1098let place = self.codegen_place(bx, place_ref);
1099bx.load_operand(place)
1100 }
11011102pub fn codegen_operand(
1103&mut self,
1104 bx: &mut Bx,
1105 operand: &mir::Operand<'tcx>,
1106 ) -> OperandRef<'tcx, Bx::Value> {
1107{
use ::tracing::__macro_support::Callsite as _;
static __CALLSITE: ::tracing::callsite::DefaultCallsite =
{
static META: ::tracing::Metadata<'static> =
{
::tracing_core::metadata::Metadata::new("event compiler/rustc_codegen_ssa/src/mir/operand.rs:1107",
"rustc_codegen_ssa::mir::operand", ::tracing::Level::DEBUG,
::tracing_core::__macro_support::Option::Some("compiler/rustc_codegen_ssa/src/mir/operand.rs"),
::tracing_core::__macro_support::Option::Some(1107u32),
::tracing_core::__macro_support::Option::Some("rustc_codegen_ssa::mir::operand"),
::tracing_core::field::FieldSet::new(&["message"],
::tracing_core::callsite::Identifier(&__CALLSITE)),
::tracing::metadata::Kind::EVENT)
};
::tracing::callsite::DefaultCallsite::new(&META)
};
let enabled =
::tracing::Level::DEBUG <= ::tracing::level_filters::STATIC_MAX_LEVEL
&&
::tracing::Level::DEBUG <=
::tracing::level_filters::LevelFilter::current() &&
{
let interest = __CALLSITE.interest();
!interest.is_never() &&
::tracing::__macro_support::__is_enabled(__CALLSITE.metadata(),
interest)
};
if enabled {
(|value_set: ::tracing::field::ValueSet|
{
let meta = __CALLSITE.metadata();
::tracing::Event::dispatch(meta, &value_set);
;
})({
#[allow(unused_imports)]
use ::tracing::field::{debug, display, Value};
let mut iter = __CALLSITE.metadata().fields().iter();
__CALLSITE.metadata().fields().value_set(&[(&::tracing::__macro_support::Iterator::next(&mut iter).expect("FieldSet corrupted (this is a bug)"),
::tracing::__macro_support::Option::Some(&format_args!("codegen_operand(operand={0:?})",
operand) as &dyn Value))])
});
} else { ; }
};debug!("codegen_operand(operand={:?})", operand);
11081109match *operand {
1110 mir::Operand::Copy(ref place) | mir::Operand::Move(ref place) => {
1111let kind = match operand {
1112 mir::Operand::Move(_) => LangItem::CompilerMove,
1113 mir::Operand::Copy(_) => LangItem::CompilerCopy,
1114_ => ::core::panicking::panic("internal error: entered unreachable code")unreachable!(),
1115 };
11161117// Check if we should annotate this move/copy for profiling
1118let move_annotation = self.move_copy_annotation_instance(bx, place.as_ref(), kind);
11191120OperandRef { move_annotation, ..self.codegen_consume(bx, place.as_ref()) }
1121 }
11221123 mir::Operand::RuntimeChecks(checks) => {
1124let layout = bx.layout_of(bx.tcx().types.bool);
1125let BackendRepr::Scalar(scalar) = layout.backend_repr else {
1126::rustc_middle::util::bug::bug_fmt(format_args!("from_const: invalid ByVal layout: {0:#?}",
layout));bug!("from_const: invalid ByVal layout: {:#?}", layout);
1127 };
1128let x = Scalar::from_bool(checks.value(bx.tcx().sess));
1129let llval = bx.scalar_to_backend(x, scalar, bx.immediate_backend_type(layout));
1130let val = OperandValue::Immediate(llval);
1131OperandRef { val, layout, move_annotation: None }
1132 }
11331134 mir::Operand::Constant(ref constant) => {
1135let constant_ty = self.monomorphize(constant.ty());
1136// Most SIMD vector constants should be passed as immediates.
1137 // (In particular, some intrinsics really rely on this.)
1138if constant_ty.is_simd() {
1139// However, some SIMD types do not actually use the vector ABI
1140 // (in particular, packed SIMD types do not). Ensure we exclude those.
1141 //
1142 // We also have to exclude vectors of pointers because `immediate_const_vector`
1143 // does not work for those.
1144let layout = bx.layout_of(constant_ty);
1145let (_, element_ty) = constant_ty.simd_size_and_type(bx.tcx());
1146if let BackendRepr::SimdVector { .. } = layout.backend_repr
1147 && element_ty.is_numeric()
1148 {
1149let (llval, ty) = self.immediate_const_vector(bx, constant);
1150return OperandRef {
1151 val: OperandValue::Immediate(llval),
1152 layout: bx.layout_of(ty),
1153 move_annotation: None,
1154 };
1155 }
1156 }
1157self.eval_mir_constant_to_operand(bx, constant)
1158 }
1159 }
1160 }
11611162/// Creates an `Instance` for annotating a move/copy operation at codegen time.
1163 ///
1164 /// Returns `Some(instance)` if the operation should be annotated with debug info, `None`
1165 /// otherwise. The instance represents a monomorphized `compiler_move<T, SIZE>` or
1166 /// `compiler_copy<T, SIZE>` function that can be used to create debug scopes.
1167 ///
1168 /// There are a number of conditions that must be met for an annotation to be created, but aside
1169 /// from the basics (annotation is enabled, we're generating debuginfo), the primary concern is
1170 /// moves/copies which could result in a real `memcpy`. So we check for the size limit, but also
1171 /// that the underlying representation of the type is in memory.
1172fn move_copy_annotation_instance(
1173&self,
1174 bx: &Bx,
1175 place: mir::PlaceRef<'tcx>,
1176 kind: LangItem,
1177 ) -> Option<ty::Instance<'tcx>> {
1178let tcx = bx.tcx();
1179let sess = tcx.sess;
11801181// Skip if we're not generating debuginfo
1182if sess.opts.debuginfo == DebugInfo::None {
1183return None;
1184 }
11851186// Check if annotation is enabled and get size limit (otherwise skip)
1187let size_limit = match sess.opts.unstable_opts.annotate_moves {
1188 AnnotateMoves::Disabled => return None,
1189 AnnotateMoves::Enabled(None) => MOVE_ANNOTATION_DEFAULT_LIMIT,
1190 AnnotateMoves::Enabled(Some(limit)) => limit,
1191 };
11921193let ty = self.monomorphized_place_ty(place);
1194let layout = bx.cx().layout_of(ty);
1195let ty_size = layout.size.bytes();
11961197// Only annotate if type has a memory representation and exceeds size limit (and has a
1198 // non-zero size)
1199if layout.is_zst()
1200 || ty_size < size_limit1201 || !#[allow(non_exhaustive_omitted_patterns)] match layout.backend_repr {
BackendRepr::Memory { .. } => true,
_ => false,
}matches!(layout.backend_repr, BackendRepr::Memory { .. })1202 {
1203return None;
1204 }
12051206// Look up the DefId for compiler_move or compiler_copy lang item
1207let def_id = tcx.lang_items().get(kind)?;
12081209// Create generic args: compiler_move<T, SIZE> or compiler_copy<T, SIZE>
1210let size_const = ty::Const::from_target_usize(tcx, ty_size);
1211let generic_args = tcx.mk_args(&[ty.into(), size_const.into()]);
12121213// Create the Instance
1214let typing_env = self.mir.typing_env(tcx);
1215let instance = ty::Instance::expect_resolve(
1216tcx,
1217typing_env,
1218def_id,
1219generic_args,
1220 rustc_span::DUMMY_SP, // span only used for error messages
1221);
12221223Some(instance)
1224 }
1225}