rustc_mir_transform/
gvn.rs

1//! Global value numbering.
2//!
3//! MIR may contain repeated and/or redundant computations. The objective of this pass is to detect
4//! such redundancies and re-use the already-computed result when possible.
5//!
6//! From those assignments, we construct a mapping `VnIndex -> Vec<(Local, Location)>` of available
7//! values, the locals in which they are stored, and the assignment location.
8//!
9//! We traverse all assignments `x = rvalue` and operands.
10//!
11//! For each SSA one, we compute a symbolic representation of values that are assigned to SSA
12//! locals. This symbolic representation is defined by the `Value` enum. Each produced instance of
13//! `Value` is interned as a `VnIndex`, which allows us to cheaply compute identical values.
14//!
15//! For each non-SSA
16//! one, we compute the `VnIndex` of the rvalue. If this `VnIndex` is associated to a constant, we
17//! replace the rvalue/operand by that constant. Otherwise, if there is an SSA local `y`
18//! associated to this `VnIndex`, and if its definition location strictly dominates the assignment
19//! to `x`, we replace the assignment by `x = y`.
20//!
21//! By opportunity, this pass simplifies some `Rvalue`s based on the accumulated knowledge.
22//!
23//! # Operational semantic
24//!
25//! Operationally, this pass attempts to prove bitwise equality between locals. Given this MIR:
26//! ```ignore (MIR)
27//! _a = some value // has VnIndex i
28//! // some MIR
29//! _b = some other value // also has VnIndex i
30//! ```
31//!
32//! We consider it to be replaceable by:
33//! ```ignore (MIR)
34//! _a = some value // has VnIndex i
35//! // some MIR
36//! _c = some other value // also has VnIndex i
37//! assume(_a bitwise equal to _c) // follows from having the same VnIndex
38//! _b = _a // follows from the `assume`
39//! ```
40//!
41//! Which is simplifiable to:
42//! ```ignore (MIR)
43//! _a = some value // has VnIndex i
44//! // some MIR
45//! _b = _a
46//! ```
47//!
48//! # Handling of references
49//!
50//! We handle references by assigning a different "provenance" index to each Ref/RawPtr rvalue.
51//! This ensure that we do not spuriously merge borrows that should not be merged. Meanwhile, we
52//! consider all the derefs of an immutable reference to a freeze type to give the same value:
53//! ```ignore (MIR)
54//! _a = *_b // _b is &Freeze
55//! _c = *_b // replaced by _c = _a
56//! ```
57//!
58//! # Determinism of constant propagation
59//!
60//! When registering a new `Value`, we attempt to opportunistically evaluate it as a constant.
61//! The evaluated form is inserted in `evaluated` as an `OpTy` or `None` if evaluation failed.
62//!
63//! The difficulty is non-deterministic evaluation of MIR constants. Some `Const` can have
64//! different runtime values each time they are evaluated. This is the case with
65//! `Const::Slice` which have a new pointer each time they are evaluated, and constants that
66//! contain a fn pointer (`AllocId` pointing to a `GlobalAlloc::Function`) pointing to a different
67//! symbol in each codegen unit.
68//!
69//! Meanwhile, we want to be able to read indirect constants. For instance:
70//! ```
71//! static A: &'static &'static u8 = &&63;
72//! fn foo() -> u8 {
73//!     **A // We want to replace by 63.
74//! }
75//! fn bar() -> u8 {
76//!     b"abc"[1] // We want to replace by 'b'.
77//! }
78//! ```
79//!
80//! The `Value::Constant` variant stores a possibly unevaluated constant. Evaluating that constant
81//! may be non-deterministic. When that happens, we assign a disambiguator to ensure that we do not
82//! merge the constants. See `duplicate_slice` test in `gvn.rs`.
83//!
84//! Second, when writing constants in MIR, we do not write `Const::Slice` or `Const`
85//! that contain `AllocId`s.
86
87use std::borrow::Cow;
88use std::hash::{Hash, Hasher};
89
90use either::Either;
91use hashbrown::hash_table::{Entry, HashTable};
92use itertools::Itertools as _;
93use rustc_abi::{self as abi, BackendRepr, FIRST_VARIANT, FieldIdx, Primitive, Size, VariantIdx};
94use rustc_arena::DroplessArena;
95use rustc_const_eval::const_eval::DummyMachine;
96use rustc_const_eval::interpret::{
97    ImmTy, Immediate, InterpCx, MemPlaceMeta, MemoryKind, OpTy, Projectable, Scalar,
98    intern_const_alloc_for_constprop,
99};
100use rustc_data_structures::fx::FxHasher;
101use rustc_data_structures::graph::dominators::Dominators;
102use rustc_hir::def::DefKind;
103use rustc_index::bit_set::DenseBitSet;
104use rustc_index::{IndexVec, newtype_index};
105use rustc_middle::bug;
106use rustc_middle::mir::interpret::GlobalAlloc;
107use rustc_middle::mir::visit::*;
108use rustc_middle::mir::*;
109use rustc_middle::ty::layout::HasTypingEnv;
110use rustc_middle::ty::{self, Ty, TyCtxt};
111use rustc_span::DUMMY_SP;
112use smallvec::SmallVec;
113use tracing::{debug, instrument, trace};
114
115use crate::ssa::SsaLocals;
116
117pub(super) struct GVN;
118
119impl<'tcx> crate::MirPass<'tcx> for GVN {
120    fn is_enabled(&self, sess: &rustc_session::Session) -> bool {
121        sess.mir_opt_level() >= 2
122    }
123
124    #[instrument(level = "trace", skip(self, tcx, body))]
125    fn run_pass(&self, tcx: TyCtxt<'tcx>, body: &mut Body<'tcx>) {
126        debug!(def_id = ?body.source.def_id());
127
128        let typing_env = body.typing_env(tcx);
129        let ssa = SsaLocals::new(tcx, body, typing_env);
130        // Clone dominators because we need them while mutating the body.
131        let dominators = body.basic_blocks.dominators().clone();
132        let maybe_loop_headers = loops::maybe_loop_headers(body);
133
134        let arena = DroplessArena::default();
135        let mut state =
136            VnState::new(tcx, body, typing_env, &ssa, dominators, &body.local_decls, &arena);
137
138        for local in body.args_iter().filter(|&local| ssa.is_ssa(local)) {
139            let opaque = state.new_opaque(body.local_decls[local].ty);
140            state.assign(local, opaque);
141        }
142
143        let reverse_postorder = body.basic_blocks.reverse_postorder().to_vec();
144        for bb in reverse_postorder {
145            // N.B. With loops, reverse postorder cannot produce a valid topological order.
146            // A statement or terminator from inside the loop, that is not processed yet, may have performed an indirect write.
147            if maybe_loop_headers.contains(bb) {
148                state.invalidate_derefs();
149            }
150            let data = &mut body.basic_blocks.as_mut_preserves_cfg()[bb];
151            state.visit_basic_block_data(bb, data);
152        }
153
154        // For each local that is reused (`y` above), we remove its storage statements do avoid any
155        // difficulty. Those locals are SSA, so should be easy to optimize by LLVM without storage
156        // statements.
157        StorageRemover { tcx, reused_locals: state.reused_locals }.visit_body_preserves_cfg(body);
158    }
159
160    fn is_required(&self) -> bool {
161        false
162    }
163}
164
165newtype_index! {
166    /// This represents a `Value` in the symbolic execution.
167    #[debug_format = "_v{}"]
168    struct VnIndex {}
169}
170
171/// Marker type to forbid hashing and comparing opaque values.
172/// This struct should only be constructed by `ValueSet::insert_unique` to ensure we use that
173/// method to create non-unifiable values. It will ICE if used in `ValueSet::insert`.
174#[derive(Copy, Clone, Debug, Eq)]
175struct VnOpaque;
176impl PartialEq for VnOpaque {
177    fn eq(&self, _: &VnOpaque) -> bool {
178        // ICE if we try to compare unique values
179        unreachable!()
180    }
181}
182impl Hash for VnOpaque {
183    fn hash<T: Hasher>(&self, _: &mut T) {
184        // ICE if we try to hash unique values
185        unreachable!()
186    }
187}
188
189#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
190enum AddressKind {
191    Ref(BorrowKind),
192    Address(RawPtrKind),
193}
194
195#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
196enum AddressBase {
197    /// This address is based on this local.
198    Local(Local),
199    /// This address is based on the deref of this pointer.
200    Deref(VnIndex),
201}
202
203#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
204enum Value<'a, 'tcx> {
205    // Root values.
206    /// Used to represent values we know nothing about.
207    /// The `usize` is a counter incremented by `new_opaque`.
208    Opaque(VnOpaque),
209    /// Evaluated or unevaluated constant value.
210    Constant {
211        value: Const<'tcx>,
212        /// Some constants do not have a deterministic value. To avoid merging two instances of the
213        /// same `Const`, we assign them an additional integer index.
214        // `disambiguator` is `None` iff the constant is deterministic.
215        disambiguator: Option<VnOpaque>,
216    },
217
218    // Aggregates.
219    /// An aggregate value, either tuple/closure/struct/enum.
220    /// This does not contain unions, as we cannot reason with the value.
221    Aggregate(VariantIdx, &'a [VnIndex]),
222    /// A union aggregate value.
223    Union(FieldIdx, VnIndex),
224    /// A raw pointer aggregate built from a thin pointer and metadata.
225    RawPtr {
226        /// Thin pointer component. This is field 0 in MIR.
227        pointer: VnIndex,
228        /// Metadata component. This is field 1 in MIR.
229        metadata: VnIndex,
230    },
231    /// This corresponds to a `[value; count]` expression.
232    Repeat(VnIndex, ty::Const<'tcx>),
233    /// The address of a place.
234    Address {
235        base: AddressBase,
236        // We do not use a plain `Place` as we want to be able to reason about indices.
237        // This does not contain any `Deref` projection.
238        projection: &'a [ProjectionElem<VnIndex, Ty<'tcx>>],
239        kind: AddressKind,
240        /// Give each borrow and pointer a different provenance, so we don't merge them.
241        provenance: VnOpaque,
242    },
243
244    // Extractions.
245    /// This is the *value* obtained by projecting another value.
246    Projection(VnIndex, ProjectionElem<VnIndex, ()>),
247    /// Discriminant of the given value.
248    Discriminant(VnIndex),
249
250    // Operations.
251    NullaryOp(NullOp),
252    UnaryOp(UnOp, VnIndex),
253    BinaryOp(BinOp, VnIndex, VnIndex),
254    Cast {
255        kind: CastKind,
256        value: VnIndex,
257    },
258}
259
260/// Stores and deduplicates pairs of `(Value, Ty)` into in `VnIndex` numbered values.
261///
262/// This data structure is mostly a partial reimplementation of `FxIndexMap<VnIndex, (Value, Ty)>`.
263/// We do not use a regular `FxIndexMap` to skip hashing values that are unique by construction,
264/// like opaque values, address with provenance and non-deterministic constants.
265struct ValueSet<'a, 'tcx> {
266    indices: HashTable<VnIndex>,
267    hashes: IndexVec<VnIndex, u64>,
268    values: IndexVec<VnIndex, Value<'a, 'tcx>>,
269    types: IndexVec<VnIndex, Ty<'tcx>>,
270}
271
272impl<'a, 'tcx> ValueSet<'a, 'tcx> {
273    fn new(num_values: usize) -> ValueSet<'a, 'tcx> {
274        ValueSet {
275            indices: HashTable::with_capacity(num_values),
276            hashes: IndexVec::with_capacity(num_values),
277            values: IndexVec::with_capacity(num_values),
278            types: IndexVec::with_capacity(num_values),
279        }
280    }
281
282    /// Insert a `(Value, Ty)` pair without hashing or deduplication.
283    /// This always creates a new `VnIndex`.
284    #[inline]
285    fn insert_unique(
286        &mut self,
287        ty: Ty<'tcx>,
288        value: impl FnOnce(VnOpaque) -> Value<'a, 'tcx>,
289    ) -> VnIndex {
290        let value = value(VnOpaque);
291
292        debug_assert!(match value {
293            Value::Opaque(_) | Value::Address { .. } => true,
294            Value::Constant { disambiguator, .. } => disambiguator.is_some(),
295            _ => false,
296        });
297
298        let index = self.hashes.push(0);
299        let _index = self.types.push(ty);
300        debug_assert_eq!(index, _index);
301        let _index = self.values.push(value);
302        debug_assert_eq!(index, _index);
303        index
304    }
305
306    /// Insert a `(Value, Ty)` pair to be deduplicated.
307    /// Returns `true` as second tuple field if this value did not exist previously.
308    #[allow(rustc::pass_by_value)] // closures take `&VnIndex`
309    fn insert(&mut self, ty: Ty<'tcx>, value: Value<'a, 'tcx>) -> (VnIndex, bool) {
310        debug_assert!(match value {
311            Value::Opaque(_) | Value::Address { .. } => false,
312            Value::Constant { disambiguator, .. } => disambiguator.is_none(),
313            _ => true,
314        });
315
316        let hash: u64 = {
317            let mut h = FxHasher::default();
318            value.hash(&mut h);
319            ty.hash(&mut h);
320            h.finish()
321        };
322
323        let eq = |index: &VnIndex| self.values[*index] == value && self.types[*index] == ty;
324        let hasher = |index: &VnIndex| self.hashes[*index];
325        match self.indices.entry(hash, eq, hasher) {
326            Entry::Occupied(entry) => {
327                let index = *entry.get();
328                (index, false)
329            }
330            Entry::Vacant(entry) => {
331                let index = self.hashes.push(hash);
332                entry.insert(index);
333                let _index = self.values.push(value);
334                debug_assert_eq!(index, _index);
335                let _index = self.types.push(ty);
336                debug_assert_eq!(index, _index);
337                (index, true)
338            }
339        }
340    }
341
342    /// Return the `Value` associated with the given `VnIndex`.
343    #[inline]
344    fn value(&self, index: VnIndex) -> Value<'a, 'tcx> {
345        self.values[index]
346    }
347
348    /// Return the type associated with the given `VnIndex`.
349    #[inline]
350    fn ty(&self, index: VnIndex) -> Ty<'tcx> {
351        self.types[index]
352    }
353
354    /// Replace the value associated with `index` with an opaque value.
355    #[inline]
356    fn forget(&mut self, index: VnIndex) {
357        self.values[index] = Value::Opaque(VnOpaque);
358    }
359}
360
361struct VnState<'body, 'a, 'tcx> {
362    tcx: TyCtxt<'tcx>,
363    ecx: InterpCx<'tcx, DummyMachine>,
364    local_decls: &'body LocalDecls<'tcx>,
365    is_coroutine: bool,
366    /// Value stored in each local.
367    locals: IndexVec<Local, Option<VnIndex>>,
368    /// Locals that are assigned that value.
369    // This vector does not hold all the values of `VnIndex` that we create.
370    rev_locals: IndexVec<VnIndex, SmallVec<[Local; 1]>>,
371    values: ValueSet<'a, 'tcx>,
372    /// Values evaluated as constants if possible.
373    /// - `None` are values not computed yet;
374    /// - `Some(None)` are values for which computation has failed;
375    /// - `Some(Some(op))` are successful computations.
376    evaluated: IndexVec<VnIndex, Option<Option<&'a OpTy<'tcx>>>>,
377    /// Cache the deref values.
378    derefs: Vec<VnIndex>,
379    ssa: &'body SsaLocals,
380    dominators: Dominators<BasicBlock>,
381    reused_locals: DenseBitSet<Local>,
382    arena: &'a DroplessArena,
383}
384
385impl<'body, 'a, 'tcx> VnState<'body, 'a, 'tcx> {
386    fn new(
387        tcx: TyCtxt<'tcx>,
388        body: &Body<'tcx>,
389        typing_env: ty::TypingEnv<'tcx>,
390        ssa: &'body SsaLocals,
391        dominators: Dominators<BasicBlock>,
392        local_decls: &'body LocalDecls<'tcx>,
393        arena: &'a DroplessArena,
394    ) -> Self {
395        // Compute a rough estimate of the number of values in the body from the number of
396        // statements. This is meant to reduce the number of allocations, but it's all right if
397        // we miss the exact amount. We estimate based on 2 values per statement (one in LHS and
398        // one in RHS) and 4 values per terminator (for call operands).
399        let num_values =
400            2 * body.basic_blocks.iter().map(|bbdata| bbdata.statements.len()).sum::<usize>()
401                + 4 * body.basic_blocks.len();
402        VnState {
403            tcx,
404            ecx: InterpCx::new(tcx, DUMMY_SP, typing_env, DummyMachine),
405            local_decls,
406            is_coroutine: body.coroutine.is_some(),
407            locals: IndexVec::from_elem(None, local_decls),
408            rev_locals: IndexVec::with_capacity(num_values),
409            values: ValueSet::new(num_values),
410            evaluated: IndexVec::with_capacity(num_values),
411            derefs: Vec::new(),
412            ssa,
413            dominators,
414            reused_locals: DenseBitSet::new_empty(local_decls.len()),
415            arena,
416        }
417    }
418
419    fn typing_env(&self) -> ty::TypingEnv<'tcx> {
420        self.ecx.typing_env()
421    }
422
423    #[instrument(level = "trace", skip(self), ret)]
424    fn insert(&mut self, ty: Ty<'tcx>, value: Value<'a, 'tcx>) -> VnIndex {
425        let (index, new) = self.values.insert(ty, value);
426        if new {
427            // Grow `evaluated` and `rev_locals` here to amortize the allocations.
428            let _index = self.evaluated.push(None);
429            debug_assert_eq!(index, _index);
430            let _index = self.rev_locals.push(SmallVec::new());
431            debug_assert_eq!(index, _index);
432        }
433        index
434    }
435
436    /// Create a new `Value` for which we have no information at all, except that it is distinct
437    /// from all the others.
438    #[instrument(level = "trace", skip(self), ret)]
439    fn new_opaque(&mut self, ty: Ty<'tcx>) -> VnIndex {
440        let index = self.values.insert_unique(ty, Value::Opaque);
441        let _index = self.evaluated.push(Some(None));
442        debug_assert_eq!(index, _index);
443        let _index = self.rev_locals.push(SmallVec::new());
444        debug_assert_eq!(index, _index);
445        index
446    }
447
448    /// Create a new `Value::Address` distinct from all the others.
449    #[instrument(level = "trace", skip(self), ret)]
450    fn new_pointer(&mut self, place: Place<'tcx>, kind: AddressKind) -> Option<VnIndex> {
451        let pty = place.ty(self.local_decls, self.tcx).ty;
452        let ty = match kind {
453            AddressKind::Ref(bk) => {
454                Ty::new_ref(self.tcx, self.tcx.lifetimes.re_erased, pty, bk.to_mutbl_lossy())
455            }
456            AddressKind::Address(mutbl) => Ty::new_ptr(self.tcx, pty, mutbl.to_mutbl_lossy()),
457        };
458
459        let mut projection = place.projection.iter();
460        let base = if place.is_indirect_first_projection() {
461            let base = self.locals[place.local]?;
462            // Skip the initial `Deref`.
463            projection.next();
464            AddressBase::Deref(base)
465        } else {
466            AddressBase::Local(place.local)
467        };
468        // Do not try evaluating inside `Index`, this has been done by `simplify_place_projection`.
469        let projection =
470            projection.map(|proj| proj.try_map(|index| self.locals[index], |ty| ty).ok_or(()));
471        let projection = self.arena.try_alloc_from_iter(projection).ok()?;
472
473        let index = self.values.insert_unique(ty, |provenance| Value::Address {
474            base,
475            projection,
476            kind,
477            provenance,
478        });
479        let _index = self.evaluated.push(None);
480        debug_assert_eq!(index, _index);
481        let _index = self.rev_locals.push(SmallVec::new());
482        debug_assert_eq!(index, _index);
483
484        Some(index)
485    }
486
487    #[instrument(level = "trace", skip(self), ret)]
488    fn insert_constant(&mut self, value: Const<'tcx>) -> VnIndex {
489        let (index, new) = if value.is_deterministic() {
490            // The constant is deterministic, no need to disambiguate.
491            let constant = Value::Constant { value, disambiguator: None };
492            self.values.insert(value.ty(), constant)
493        } else {
494            // Multiple mentions of this constant will yield different values,
495            // so assign a different `disambiguator` to ensure they do not get the same `VnIndex`.
496            let index = self.values.insert_unique(value.ty(), |disambiguator| Value::Constant {
497                value,
498                disambiguator: Some(disambiguator),
499            });
500            (index, true)
501        };
502        if new {
503            let _index = self.evaluated.push(None);
504            debug_assert_eq!(index, _index);
505            let _index = self.rev_locals.push(SmallVec::new());
506            debug_assert_eq!(index, _index);
507        }
508        index
509    }
510
511    #[inline]
512    fn get(&self, index: VnIndex) -> Value<'a, 'tcx> {
513        self.values.value(index)
514    }
515
516    #[inline]
517    fn ty(&self, index: VnIndex) -> Ty<'tcx> {
518        self.values.ty(index)
519    }
520
521    /// Record that `local` is assigned `value`. `local` must be SSA.
522    #[instrument(level = "trace", skip(self))]
523    fn assign(&mut self, local: Local, value: VnIndex) {
524        debug_assert!(self.ssa.is_ssa(local));
525        self.locals[local] = Some(value);
526        self.rev_locals[value].push(local);
527    }
528
529    fn insert_bool(&mut self, flag: bool) -> VnIndex {
530        // Booleans are deterministic.
531        let value = Const::from_bool(self.tcx, flag);
532        debug_assert!(value.is_deterministic());
533        self.insert(self.tcx.types.bool, Value::Constant { value, disambiguator: None })
534    }
535
536    fn insert_scalar(&mut self, ty: Ty<'tcx>, scalar: Scalar) -> VnIndex {
537        // Scalars are deterministic.
538        let value = Const::from_scalar(self.tcx, scalar, ty);
539        debug_assert!(value.is_deterministic());
540        self.insert(ty, Value::Constant { value, disambiguator: None })
541    }
542
543    fn insert_tuple(&mut self, ty: Ty<'tcx>, values: &[VnIndex]) -> VnIndex {
544        self.insert(ty, Value::Aggregate(VariantIdx::ZERO, self.arena.alloc_slice(values)))
545    }
546
547    fn insert_deref(&mut self, ty: Ty<'tcx>, value: VnIndex) -> VnIndex {
548        let value = self.insert(ty, Value::Projection(value, ProjectionElem::Deref));
549        self.derefs.push(value);
550        value
551    }
552
553    fn invalidate_derefs(&mut self) {
554        for deref in std::mem::take(&mut self.derefs) {
555            self.values.forget(deref);
556        }
557    }
558
559    #[instrument(level = "trace", skip(self), ret)]
560    fn eval_to_const_inner(&mut self, value: VnIndex) -> Option<OpTy<'tcx>> {
561        use Value::*;
562        let ty = self.ty(value);
563        // Avoid computing layouts inside a coroutine, as that can cause cycles.
564        let ty = if !self.is_coroutine || ty.is_scalar() {
565            self.ecx.layout_of(ty).ok()?
566        } else {
567            return None;
568        };
569        let op = match self.get(value) {
570            _ if ty.is_zst() => ImmTy::uninit(ty).into(),
571
572            Opaque(_) => return None,
573            // Do not bother evaluating repeat expressions. This would uselessly consume memory.
574            Repeat(..) => return None,
575
576            Constant { ref value, disambiguator: _ } => {
577                self.ecx.eval_mir_constant(value, DUMMY_SP, None).discard_err()?
578            }
579            Aggregate(variant, ref fields) => {
580                let fields =
581                    fields.iter().map(|&f| self.eval_to_const(f)).collect::<Option<Vec<_>>>()?;
582                let variant = if ty.ty.is_enum() { Some(variant) } else { None };
583                if matches!(ty.backend_repr, BackendRepr::Scalar(..) | BackendRepr::ScalarPair(..))
584                {
585                    let dest = self.ecx.allocate(ty, MemoryKind::Stack).discard_err()?;
586                    let variant_dest = if let Some(variant) = variant {
587                        self.ecx.project_downcast(&dest, variant).discard_err()?
588                    } else {
589                        dest.clone()
590                    };
591                    for (field_index, op) in fields.into_iter().enumerate() {
592                        let field_dest = self
593                            .ecx
594                            .project_field(&variant_dest, FieldIdx::from_usize(field_index))
595                            .discard_err()?;
596                        self.ecx.copy_op(op, &field_dest).discard_err()?;
597                    }
598                    self.ecx
599                        .write_discriminant(variant.unwrap_or(FIRST_VARIANT), &dest)
600                        .discard_err()?;
601                    self.ecx
602                        .alloc_mark_immutable(dest.ptr().provenance.unwrap().alloc_id())
603                        .discard_err()?;
604                    dest.into()
605                } else {
606                    return None;
607                }
608            }
609            Union(active_field, field) => {
610                let field = self.eval_to_const(field)?;
611                if matches!(ty.backend_repr, BackendRepr::Scalar(..) | BackendRepr::ScalarPair(..))
612                {
613                    let dest = self.ecx.allocate(ty, MemoryKind::Stack).discard_err()?;
614                    let field_dest = self.ecx.project_field(&dest, active_field).discard_err()?;
615                    self.ecx.copy_op(field, &field_dest).discard_err()?;
616                    self.ecx
617                        .alloc_mark_immutable(dest.ptr().provenance.unwrap().alloc_id())
618                        .discard_err()?;
619                    dest.into()
620                } else {
621                    return None;
622                }
623            }
624            RawPtr { pointer, metadata } => {
625                let pointer = self.eval_to_const(pointer)?;
626                let metadata = self.eval_to_const(metadata)?;
627
628                // Pointers don't have fields, so don't `project_field` them.
629                let data = self.ecx.read_pointer(pointer).discard_err()?;
630                let meta = if metadata.layout.is_zst() {
631                    MemPlaceMeta::None
632                } else {
633                    MemPlaceMeta::Meta(self.ecx.read_scalar(metadata).discard_err()?)
634                };
635                let ptr_imm = Immediate::new_pointer_with_meta(data, meta, &self.ecx);
636                ImmTy::from_immediate(ptr_imm, ty).into()
637            }
638
639            Projection(base, elem) => {
640                let base = self.eval_to_const(base)?;
641                // `Index` by constants should have been replaced by `ConstantIndex` by
642                // `simplify_place_projection`.
643                let elem = elem.try_map(|_| None, |()| ty.ty)?;
644                self.ecx.project(base, elem).discard_err()?
645            }
646            Address { base, projection, .. } => {
647                debug_assert!(!projection.contains(&ProjectionElem::Deref));
648                let pointer = match base {
649                    AddressBase::Deref(pointer) => self.eval_to_const(pointer)?,
650                    // We have no stack to point to.
651                    AddressBase::Local(_) => return None,
652                };
653                let mut mplace = self.ecx.deref_pointer(pointer).discard_err()?;
654                for elem in projection {
655                    // `Index` by constants should have been replaced by `ConstantIndex` by
656                    // `simplify_place_projection`.
657                    let elem = elem.try_map(|_| None, |ty| ty)?;
658                    mplace = self.ecx.project(&mplace, elem).discard_err()?;
659                }
660                let pointer = mplace.to_ref(&self.ecx);
661                ImmTy::from_immediate(pointer, ty).into()
662            }
663
664            Discriminant(base) => {
665                let base = self.eval_to_const(base)?;
666                let variant = self.ecx.read_discriminant(base).discard_err()?;
667                let discr_value =
668                    self.ecx.discriminant_for_variant(base.layout.ty, variant).discard_err()?;
669                discr_value.into()
670            }
671            NullaryOp(NullOp::RuntimeChecks(_)) => return None,
672            UnaryOp(un_op, operand) => {
673                let operand = self.eval_to_const(operand)?;
674                let operand = self.ecx.read_immediate(operand).discard_err()?;
675                let val = self.ecx.unary_op(un_op, &operand).discard_err()?;
676                val.into()
677            }
678            BinaryOp(bin_op, lhs, rhs) => {
679                let lhs = self.eval_to_const(lhs)?;
680                let rhs = self.eval_to_const(rhs)?;
681                let lhs = self.ecx.read_immediate(lhs).discard_err()?;
682                let rhs = self.ecx.read_immediate(rhs).discard_err()?;
683                let val = self.ecx.binary_op(bin_op, &lhs, &rhs).discard_err()?;
684                val.into()
685            }
686            Cast { kind, value } => match kind {
687                CastKind::IntToInt | CastKind::IntToFloat => {
688                    let value = self.eval_to_const(value)?;
689                    let value = self.ecx.read_immediate(value).discard_err()?;
690                    let res = self.ecx.int_to_int_or_float(&value, ty).discard_err()?;
691                    res.into()
692                }
693                CastKind::FloatToFloat | CastKind::FloatToInt => {
694                    let value = self.eval_to_const(value)?;
695                    let value = self.ecx.read_immediate(value).discard_err()?;
696                    let res = self.ecx.float_to_float_or_int(&value, ty).discard_err()?;
697                    res.into()
698                }
699                CastKind::Transmute | CastKind::Subtype => {
700                    let value = self.eval_to_const(value)?;
701                    // `offset` for immediates generally only supports projections that match the
702                    // type of the immediate. However, as a HACK, we exploit that it can also do
703                    // limited transmutes: it only works between types with the same layout, and
704                    // cannot transmute pointers to integers.
705                    if value.as_mplace_or_imm().is_right() {
706                        let can_transmute = match (value.layout.backend_repr, ty.backend_repr) {
707                            (BackendRepr::Scalar(s1), BackendRepr::Scalar(s2)) => {
708                                s1.size(&self.ecx) == s2.size(&self.ecx)
709                                    && !matches!(s1.primitive(), Primitive::Pointer(..))
710                            }
711                            (BackendRepr::ScalarPair(a1, b1), BackendRepr::ScalarPair(a2, b2)) => {
712                                a1.size(&self.ecx) == a2.size(&self.ecx)
713                                    && b1.size(&self.ecx) == b2.size(&self.ecx)
714                                    // The alignment of the second component determines its offset, so that also needs to match.
715                                    && b1.align(&self.ecx) == b2.align(&self.ecx)
716                                    // None of the inputs may be a pointer.
717                                    && !matches!(a1.primitive(), Primitive::Pointer(..))
718                                    && !matches!(b1.primitive(), Primitive::Pointer(..))
719                            }
720                            _ => false,
721                        };
722                        if !can_transmute {
723                            return None;
724                        }
725                    }
726                    value.offset(Size::ZERO, ty, &self.ecx).discard_err()?
727                }
728                CastKind::PointerCoercion(ty::adjustment::PointerCoercion::Unsize, _) => {
729                    let src = self.eval_to_const(value)?;
730                    let dest = self.ecx.allocate(ty, MemoryKind::Stack).discard_err()?;
731                    self.ecx.unsize_into(src, ty, &dest).discard_err()?;
732                    self.ecx
733                        .alloc_mark_immutable(dest.ptr().provenance.unwrap().alloc_id())
734                        .discard_err()?;
735                    dest.into()
736                }
737                CastKind::FnPtrToPtr | CastKind::PtrToPtr => {
738                    let src = self.eval_to_const(value)?;
739                    let src = self.ecx.read_immediate(src).discard_err()?;
740                    let ret = self.ecx.ptr_to_ptr(&src, ty).discard_err()?;
741                    ret.into()
742                }
743                CastKind::PointerCoercion(ty::adjustment::PointerCoercion::UnsafeFnPointer, _) => {
744                    let src = self.eval_to_const(value)?;
745                    let src = self.ecx.read_immediate(src).discard_err()?;
746                    ImmTy::from_immediate(*src, ty).into()
747                }
748                _ => return None,
749            },
750        };
751        Some(op)
752    }
753
754    fn eval_to_const(&mut self, index: VnIndex) -> Option<&'a OpTy<'tcx>> {
755        if let Some(op) = self.evaluated[index] {
756            return op;
757        }
758        let op = self.eval_to_const_inner(index);
759        self.evaluated[index] = Some(self.arena.alloc(op).as_ref());
760        self.evaluated[index].unwrap()
761    }
762
763    /// Represent the *value* we obtain by dereferencing an `Address` value.
764    #[instrument(level = "trace", skip(self), ret)]
765    fn dereference_address(
766        &mut self,
767        base: AddressBase,
768        projection: &[ProjectionElem<VnIndex, Ty<'tcx>>],
769    ) -> Option<VnIndex> {
770        let (mut place_ty, mut value) = match base {
771            // The base is a local, so we take the local's value and project from it.
772            AddressBase::Local(local) => {
773                let local = self.locals[local]?;
774                let place_ty = PlaceTy::from_ty(self.ty(local));
775                (place_ty, local)
776            }
777            // The base is a pointer's deref, so we introduce the implicit deref.
778            AddressBase::Deref(reborrow) => {
779                let place_ty = PlaceTy::from_ty(self.ty(reborrow));
780                self.project(place_ty, reborrow, ProjectionElem::Deref)?
781            }
782        };
783        for &proj in projection {
784            (place_ty, value) = self.project(place_ty, value, proj)?;
785        }
786        Some(value)
787    }
788
789    #[instrument(level = "trace", skip(self), ret)]
790    fn project(
791        &mut self,
792        place_ty: PlaceTy<'tcx>,
793        value: VnIndex,
794        proj: ProjectionElem<VnIndex, Ty<'tcx>>,
795    ) -> Option<(PlaceTy<'tcx>, VnIndex)> {
796        let projection_ty = place_ty.projection_ty(self.tcx, proj);
797        let proj = match proj {
798            ProjectionElem::Deref => {
799                if let Some(Mutability::Not) = place_ty.ty.ref_mutability()
800                    && projection_ty.ty.is_freeze(self.tcx, self.typing_env())
801                {
802                    if let Value::Address { base, projection, .. } = self.get(value)
803                        && let Some(value) = self.dereference_address(base, projection)
804                    {
805                        return Some((projection_ty, value));
806                    }
807
808                    // An immutable borrow `_x` always points to the same value for the
809                    // lifetime of the borrow, so we can merge all instances of `*_x`.
810                    return Some((projection_ty, self.insert_deref(projection_ty.ty, value)));
811                } else {
812                    return None;
813                }
814            }
815            ProjectionElem::Downcast(name, index) => ProjectionElem::Downcast(name, index),
816            ProjectionElem::Field(f, _) => match self.get(value) {
817                Value::Aggregate(_, fields) => return Some((projection_ty, fields[f.as_usize()])),
818                Value::Union(active, field) if active == f => return Some((projection_ty, field)),
819                Value::Projection(outer_value, ProjectionElem::Downcast(_, read_variant))
820                    if let Value::Aggregate(written_variant, fields) = self.get(outer_value)
821                    // This pass is not aware of control-flow, so we do not know whether the
822                    // replacement we are doing is actually reachable. We could be in any arm of
823                    // ```
824                    // match Some(x) {
825                    //     Some(y) => /* stuff */,
826                    //     None => /* other */,
827                    // }
828                    // ```
829                    //
830                    // In surface rust, the current statement would be unreachable.
831                    //
832                    // However, from the reference chapter on enums and RFC 2195,
833                    // accessing the wrong variant is not UB if the enum has repr.
834                    // So it's not impossible for a series of MIR opts to generate
835                    // a downcast to an inactive variant.
836                    && written_variant == read_variant =>
837                {
838                    return Some((projection_ty, fields[f.as_usize()]));
839                }
840                _ => ProjectionElem::Field(f, ()),
841            },
842            ProjectionElem::Index(idx) => {
843                if let Value::Repeat(inner, _) = self.get(value) {
844                    return Some((projection_ty, inner));
845                }
846                ProjectionElem::Index(idx)
847            }
848            ProjectionElem::ConstantIndex { offset, min_length, from_end } => {
849                match self.get(value) {
850                    Value::Repeat(inner, _) => {
851                        return Some((projection_ty, inner));
852                    }
853                    Value::Aggregate(_, operands) => {
854                        let offset = if from_end {
855                            operands.len() - offset as usize
856                        } else {
857                            offset as usize
858                        };
859                        let value = operands.get(offset).copied()?;
860                        return Some((projection_ty, value));
861                    }
862                    _ => {}
863                };
864                ProjectionElem::ConstantIndex { offset, min_length, from_end }
865            }
866            ProjectionElem::Subslice { from, to, from_end } => {
867                ProjectionElem::Subslice { from, to, from_end }
868            }
869            ProjectionElem::OpaqueCast(_) => ProjectionElem::OpaqueCast(()),
870            ProjectionElem::UnwrapUnsafeBinder(_) => ProjectionElem::UnwrapUnsafeBinder(()),
871        };
872
873        let value = self.insert(projection_ty.ty, Value::Projection(value, proj));
874        Some((projection_ty, value))
875    }
876
877    /// Simplify the projection chain if we know better.
878    #[instrument(level = "trace", skip(self))]
879    fn simplify_place_projection(&mut self, place: &mut Place<'tcx>, location: Location) {
880        // If the projection is indirect, we treat the local as a value, so can replace it with
881        // another local.
882        if place.is_indirect_first_projection()
883            && let Some(base) = self.locals[place.local]
884            && let Some(new_local) = self.try_as_local(base, location)
885            && place.local != new_local
886        {
887            place.local = new_local;
888            self.reused_locals.insert(new_local);
889        }
890
891        let mut projection = Cow::Borrowed(&place.projection[..]);
892
893        for i in 0..projection.len() {
894            let elem = projection[i];
895            if let ProjectionElem::Index(idx_local) = elem
896                && let Some(idx) = self.locals[idx_local]
897            {
898                if let Some(offset) = self.eval_to_const(idx)
899                    && let Some(offset) = self.ecx.read_target_usize(offset).discard_err()
900                    && let Some(min_length) = offset.checked_add(1)
901                {
902                    projection.to_mut()[i] =
903                        ProjectionElem::ConstantIndex { offset, min_length, from_end: false };
904                } else if let Some(new_idx_local) = self.try_as_local(idx, location)
905                    && idx_local != new_idx_local
906                {
907                    projection.to_mut()[i] = ProjectionElem::Index(new_idx_local);
908                    self.reused_locals.insert(new_idx_local);
909                }
910            }
911        }
912
913        if Cow::is_owned(&projection) {
914            place.projection = self.tcx.mk_place_elems(&projection);
915        }
916
917        trace!(?place);
918    }
919
920    /// Represent the *value* which would be read from `place`. If we succeed, return it.
921    /// If we fail, return a `PlaceRef` that contains the same value.
922    #[instrument(level = "trace", skip(self), ret)]
923    fn compute_place_value(
924        &mut self,
925        place: Place<'tcx>,
926        location: Location,
927    ) -> Result<VnIndex, PlaceRef<'tcx>> {
928        // Invariant: `place` and `place_ref` point to the same value, even if they point to
929        // different memory locations.
930        let mut place_ref = place.as_ref();
931
932        // Invariant: `value` holds the value up-to the `index`th projection excluded.
933        let Some(mut value) = self.locals[place.local] else { return Err(place_ref) };
934        // Invariant: `value` has type `place_ty`, with optional downcast variant if needed.
935        let mut place_ty = PlaceTy::from_ty(self.local_decls[place.local].ty);
936        for (index, proj) in place.projection.iter().enumerate() {
937            if let Some(local) = self.try_as_local(value, location) {
938                // Both `local` and `Place { local: place.local, projection: projection[..index] }`
939                // hold the same value. Therefore, following place holds the value in the original
940                // `place`.
941                place_ref = PlaceRef { local, projection: &place.projection[index..] };
942            }
943
944            let Some(proj) = proj.try_map(|value| self.locals[value], |ty| ty) else {
945                return Err(place_ref);
946            };
947            let Some(ty_and_value) = self.project(place_ty, value, proj) else {
948                return Err(place_ref);
949            };
950            (place_ty, value) = ty_and_value;
951        }
952
953        Ok(value)
954    }
955
956    /// Represent the *value* which would be read from `place`, and point `place` to a preexisting
957    /// place with the same value (if that already exists).
958    #[instrument(level = "trace", skip(self), ret)]
959    fn simplify_place_value(
960        &mut self,
961        place: &mut Place<'tcx>,
962        location: Location,
963    ) -> Option<VnIndex> {
964        self.simplify_place_projection(place, location);
965
966        match self.compute_place_value(*place, location) {
967            Ok(value) => {
968                if let Some(new_place) = self.try_as_place(value, location, true)
969                    && (new_place.local != place.local
970                        || new_place.projection.len() < place.projection.len())
971                {
972                    *place = new_place;
973                    self.reused_locals.insert(new_place.local);
974                }
975                Some(value)
976            }
977            Err(place_ref) => {
978                if place_ref.local != place.local
979                    || place_ref.projection.len() < place.projection.len()
980                {
981                    // By the invariant on `place_ref`.
982                    *place = place_ref.project_deeper(&[], self.tcx);
983                    self.reused_locals.insert(place_ref.local);
984                }
985                None
986            }
987        }
988    }
989
990    #[instrument(level = "trace", skip(self), ret)]
991    fn simplify_operand(
992        &mut self,
993        operand: &mut Operand<'tcx>,
994        location: Location,
995    ) -> Option<VnIndex> {
996        match *operand {
997            Operand::Constant(ref constant) => Some(self.insert_constant(constant.const_)),
998            Operand::Copy(ref mut place) | Operand::Move(ref mut place) => {
999                let value = self.simplify_place_value(place, location)?;
1000                if let Some(const_) = self.try_as_constant(value) {
1001                    *operand = Operand::Constant(Box::new(const_));
1002                }
1003                Some(value)
1004            }
1005        }
1006    }
1007
1008    #[instrument(level = "trace", skip(self), ret)]
1009    fn simplify_rvalue(
1010        &mut self,
1011        lhs: &Place<'tcx>,
1012        rvalue: &mut Rvalue<'tcx>,
1013        location: Location,
1014    ) -> Option<VnIndex> {
1015        let value = match *rvalue {
1016            // Forward values.
1017            Rvalue::Use(ref mut operand) => return self.simplify_operand(operand, location),
1018
1019            // Roots.
1020            Rvalue::Repeat(ref mut op, amount) => {
1021                let op = self.simplify_operand(op, location)?;
1022                Value::Repeat(op, amount)
1023            }
1024            Rvalue::NullaryOp(op) => Value::NullaryOp(op),
1025            Rvalue::Aggregate(..) => return self.simplify_aggregate(lhs, rvalue, location),
1026            Rvalue::Ref(_, borrow_kind, ref mut place) => {
1027                self.simplify_place_projection(place, location);
1028                return self.new_pointer(*place, AddressKind::Ref(borrow_kind));
1029            }
1030            Rvalue::RawPtr(mutbl, ref mut place) => {
1031                self.simplify_place_projection(place, location);
1032                return self.new_pointer(*place, AddressKind::Address(mutbl));
1033            }
1034            Rvalue::WrapUnsafeBinder(ref mut op, _) => {
1035                let value = self.simplify_operand(op, location)?;
1036                Value::Cast { kind: CastKind::Transmute, value }
1037            }
1038
1039            // Operations.
1040            Rvalue::Cast(ref mut kind, ref mut value, to) => {
1041                return self.simplify_cast(kind, value, to, location);
1042            }
1043            Rvalue::BinaryOp(op, box (ref mut lhs, ref mut rhs)) => {
1044                return self.simplify_binary(op, lhs, rhs, location);
1045            }
1046            Rvalue::UnaryOp(op, ref mut arg_op) => {
1047                return self.simplify_unary(op, arg_op, location);
1048            }
1049            Rvalue::Discriminant(ref mut place) => {
1050                let place = self.simplify_place_value(place, location)?;
1051                if let Some(discr) = self.simplify_discriminant(place) {
1052                    return Some(discr);
1053                }
1054                Value::Discriminant(place)
1055            }
1056
1057            // Unsupported values.
1058            Rvalue::ThreadLocalRef(..) => return None,
1059            Rvalue::CopyForDeref(_) | Rvalue::ShallowInitBox(..) => {
1060                bug!("forbidden in runtime MIR: {rvalue:?}")
1061            }
1062        };
1063        let ty = rvalue.ty(self.local_decls, self.tcx);
1064        Some(self.insert(ty, value))
1065    }
1066
1067    fn simplify_discriminant(&mut self, place: VnIndex) -> Option<VnIndex> {
1068        let enum_ty = self.ty(place);
1069        if enum_ty.is_enum()
1070            && let Value::Aggregate(variant, _) = self.get(place)
1071        {
1072            let discr = self.ecx.discriminant_for_variant(enum_ty, variant).discard_err()?;
1073            return Some(self.insert_scalar(discr.layout.ty, discr.to_scalar()));
1074        }
1075
1076        None
1077    }
1078
1079    fn try_as_place_elem(
1080        &mut self,
1081        ty: Ty<'tcx>,
1082        proj: ProjectionElem<VnIndex, ()>,
1083        loc: Location,
1084    ) -> Option<PlaceElem<'tcx>> {
1085        proj.try_map(
1086            |value| {
1087                let local = self.try_as_local(value, loc)?;
1088                self.reused_locals.insert(local);
1089                Some(local)
1090            },
1091            |()| ty,
1092        )
1093    }
1094
1095    fn simplify_aggregate_to_copy(
1096        &mut self,
1097        ty: Ty<'tcx>,
1098        variant_index: VariantIdx,
1099        fields: &[VnIndex],
1100    ) -> Option<VnIndex> {
1101        let Some(&first_field) = fields.first() else { return None };
1102        let Value::Projection(copy_from_value, _) = self.get(first_field) else { return None };
1103
1104        // All fields must correspond one-to-one and come from the same aggregate value.
1105        if fields.iter().enumerate().any(|(index, &v)| {
1106            if let Value::Projection(pointer, ProjectionElem::Field(from_index, _)) = self.get(v)
1107                && copy_from_value == pointer
1108                && from_index.index() == index
1109            {
1110                return false;
1111            }
1112            true
1113        }) {
1114            return None;
1115        }
1116
1117        let mut copy_from_local_value = copy_from_value;
1118        if let Value::Projection(pointer, proj) = self.get(copy_from_value)
1119            && let ProjectionElem::Downcast(_, read_variant) = proj
1120        {
1121            if variant_index == read_variant {
1122                // When copying a variant, there is no need to downcast.
1123                copy_from_local_value = pointer;
1124            } else {
1125                // The copied variant must be identical.
1126                return None;
1127            }
1128        }
1129
1130        // Both must be variants of the same type.
1131        if self.ty(copy_from_local_value) == ty { Some(copy_from_local_value) } else { None }
1132    }
1133
1134    fn simplify_aggregate(
1135        &mut self,
1136        lhs: &Place<'tcx>,
1137        rvalue: &mut Rvalue<'tcx>,
1138        location: Location,
1139    ) -> Option<VnIndex> {
1140        let tcx = self.tcx;
1141        let ty = rvalue.ty(self.local_decls, tcx);
1142
1143        let Rvalue::Aggregate(box ref kind, ref mut field_ops) = *rvalue else { bug!() };
1144
1145        if field_ops.is_empty() {
1146            let is_zst = match *kind {
1147                AggregateKind::Array(..)
1148                | AggregateKind::Tuple
1149                | AggregateKind::Closure(..)
1150                | AggregateKind::CoroutineClosure(..) => true,
1151                // Only enums can be non-ZST.
1152                AggregateKind::Adt(did, ..) => tcx.def_kind(did) != DefKind::Enum,
1153                // Coroutines are never ZST, as they at least contain the implicit states.
1154                AggregateKind::Coroutine(..) => false,
1155                AggregateKind::RawPtr(..) => bug!("MIR for RawPtr aggregate must have 2 fields"),
1156            };
1157
1158            if is_zst {
1159                return Some(self.insert_constant(Const::zero_sized(ty)));
1160            }
1161        }
1162
1163        let fields = self.arena.alloc_from_iter(field_ops.iter_mut().map(|op| {
1164            self.simplify_operand(op, location)
1165                .unwrap_or_else(|| self.new_opaque(op.ty(self.local_decls, self.tcx)))
1166        }));
1167
1168        let variant_index = match *kind {
1169            AggregateKind::Array(..) | AggregateKind::Tuple => {
1170                assert!(!field_ops.is_empty());
1171                FIRST_VARIANT
1172            }
1173            AggregateKind::Closure(..)
1174            | AggregateKind::CoroutineClosure(..)
1175            | AggregateKind::Coroutine(..) => FIRST_VARIANT,
1176            AggregateKind::Adt(_, variant_index, _, _, None) => variant_index,
1177            // Do not track unions.
1178            AggregateKind::Adt(_, _, _, _, Some(active_field)) => {
1179                let field = *fields.first()?;
1180                return Some(self.insert(ty, Value::Union(active_field, field)));
1181            }
1182            AggregateKind::RawPtr(..) => {
1183                assert_eq!(field_ops.len(), 2);
1184                let [mut pointer, metadata] = fields.try_into().unwrap();
1185
1186                // Any thin pointer of matching mutability is fine as the data pointer.
1187                let mut was_updated = false;
1188                while let Value::Cast { kind: CastKind::PtrToPtr, value: cast_value } =
1189                    self.get(pointer)
1190                    && let ty::RawPtr(from_pointee_ty, from_mtbl) = self.ty(cast_value).kind()
1191                    && let ty::RawPtr(_, output_mtbl) = ty.kind()
1192                    && from_mtbl == output_mtbl
1193                    && from_pointee_ty.is_sized(self.tcx, self.typing_env())
1194                {
1195                    pointer = cast_value;
1196                    was_updated = true;
1197                }
1198
1199                if was_updated && let Some(op) = self.try_as_operand(pointer, location) {
1200                    field_ops[FieldIdx::ZERO] = op;
1201                }
1202
1203                return Some(self.insert(ty, Value::RawPtr { pointer, metadata }));
1204            }
1205        };
1206
1207        if ty.is_array()
1208            && fields.len() > 4
1209            && let Ok(&first) = fields.iter().all_equal_value()
1210        {
1211            let len = ty::Const::from_target_usize(self.tcx, fields.len().try_into().unwrap());
1212            if let Some(op) = self.try_as_operand(first, location) {
1213                *rvalue = Rvalue::Repeat(op, len);
1214            }
1215            return Some(self.insert(ty, Value::Repeat(first, len)));
1216        }
1217
1218        if let Some(value) = self.simplify_aggregate_to_copy(ty, variant_index, &fields) {
1219            // Allow introducing places with non-constant offsets, as those are still better than
1220            // reconstructing an aggregate. But avoid creating `*a = copy (*b)`, as they might be
1221            // aliases resulting in overlapping assignments.
1222            let allow_complex_projection =
1223                lhs.projection[..].iter().all(PlaceElem::is_stable_offset);
1224            if let Some(place) = self.try_as_place(value, location, allow_complex_projection) {
1225                self.reused_locals.insert(place.local);
1226                *rvalue = Rvalue::Use(Operand::Copy(place));
1227            }
1228            return Some(value);
1229        }
1230
1231        Some(self.insert(ty, Value::Aggregate(variant_index, fields)))
1232    }
1233
1234    #[instrument(level = "trace", skip(self), ret)]
1235    fn simplify_unary(
1236        &mut self,
1237        op: UnOp,
1238        arg_op: &mut Operand<'tcx>,
1239        location: Location,
1240    ) -> Option<VnIndex> {
1241        let mut arg_index = self.simplify_operand(arg_op, location)?;
1242        let arg_ty = self.ty(arg_index);
1243        let ret_ty = op.ty(self.tcx, arg_ty);
1244
1245        // PtrMetadata doesn't care about *const vs *mut vs & vs &mut,
1246        // so start by removing those distinctions so we can update the `Operand`
1247        if op == UnOp::PtrMetadata {
1248            let mut was_updated = false;
1249            loop {
1250                arg_index = match self.get(arg_index) {
1251                    // Pointer casts that preserve metadata, such as
1252                    // `*const [i32]` <-> `*mut [i32]` <-> `*mut [f32]`.
1253                    // It's critical that this not eliminate cases like
1254                    // `*const [T]` -> `*const T` which remove metadata.
1255                    // We run on potentially-generic MIR, though, so unlike codegen
1256                    // we can't always know exactly what the metadata are.
1257                    // To allow things like `*mut (?A, ?T)` <-> `*mut (?B, ?T)`,
1258                    // it's fine to get a projection as the type.
1259                    Value::Cast { kind: CastKind::PtrToPtr, value: inner }
1260                        if self.pointers_have_same_metadata(self.ty(inner), arg_ty) =>
1261                    {
1262                        inner
1263                    }
1264
1265                    // We have an unsizing cast, which assigns the length to wide pointer metadata.
1266                    Value::Cast {
1267                        kind: CastKind::PointerCoercion(ty::adjustment::PointerCoercion::Unsize, _),
1268                        value: from,
1269                    } if let Some(from) = self.ty(from).builtin_deref(true)
1270                        && let ty::Array(_, len) = from.kind()
1271                        && let Some(to) = self.ty(arg_index).builtin_deref(true)
1272                        && let ty::Slice(..) = to.kind() =>
1273                    {
1274                        return Some(self.insert_constant(Const::Ty(self.tcx.types.usize, *len)));
1275                    }
1276
1277                    // `&mut *p`, `&raw *p`, etc don't change metadata.
1278                    Value::Address { base: AddressBase::Deref(reborrowed), projection, .. }
1279                        if projection.is_empty() =>
1280                    {
1281                        reborrowed
1282                    }
1283
1284                    _ => break,
1285                };
1286                was_updated = true;
1287            }
1288
1289            if was_updated && let Some(op) = self.try_as_operand(arg_index, location) {
1290                *arg_op = op;
1291            }
1292        }
1293
1294        let value = match (op, self.get(arg_index)) {
1295            (UnOp::Not, Value::UnaryOp(UnOp::Not, inner)) => return Some(inner),
1296            (UnOp::Neg, Value::UnaryOp(UnOp::Neg, inner)) => return Some(inner),
1297            (UnOp::Not, Value::BinaryOp(BinOp::Eq, lhs, rhs)) => {
1298                Value::BinaryOp(BinOp::Ne, lhs, rhs)
1299            }
1300            (UnOp::Not, Value::BinaryOp(BinOp::Ne, lhs, rhs)) => {
1301                Value::BinaryOp(BinOp::Eq, lhs, rhs)
1302            }
1303            (UnOp::PtrMetadata, Value::RawPtr { metadata, .. }) => return Some(metadata),
1304            // We have an unsizing cast, which assigns the length to wide pointer metadata.
1305            (
1306                UnOp::PtrMetadata,
1307                Value::Cast {
1308                    kind: CastKind::PointerCoercion(ty::adjustment::PointerCoercion::Unsize, _),
1309                    value: inner,
1310                },
1311            ) if let ty::Slice(..) = arg_ty.builtin_deref(true).unwrap().kind()
1312                && let ty::Array(_, len) = self.ty(inner).builtin_deref(true).unwrap().kind() =>
1313            {
1314                return Some(self.insert_constant(Const::Ty(self.tcx.types.usize, *len)));
1315            }
1316            _ => Value::UnaryOp(op, arg_index),
1317        };
1318        Some(self.insert(ret_ty, value))
1319    }
1320
1321    #[instrument(level = "trace", skip(self), ret)]
1322    fn simplify_binary(
1323        &mut self,
1324        op: BinOp,
1325        lhs_operand: &mut Operand<'tcx>,
1326        rhs_operand: &mut Operand<'tcx>,
1327        location: Location,
1328    ) -> Option<VnIndex> {
1329        let lhs = self.simplify_operand(lhs_operand, location);
1330        let rhs = self.simplify_operand(rhs_operand, location);
1331
1332        // Only short-circuit options after we called `simplify_operand`
1333        // on both operands for side effect.
1334        let mut lhs = lhs?;
1335        let mut rhs = rhs?;
1336
1337        let lhs_ty = self.ty(lhs);
1338
1339        // If we're comparing pointers, remove `PtrToPtr` casts if the from
1340        // types of both casts and the metadata all match.
1341        if let BinOp::Eq | BinOp::Ne | BinOp::Lt | BinOp::Le | BinOp::Gt | BinOp::Ge = op
1342            && lhs_ty.is_any_ptr()
1343            && let Value::Cast { kind: CastKind::PtrToPtr, value: lhs_value } = self.get(lhs)
1344            && let Value::Cast { kind: CastKind::PtrToPtr, value: rhs_value } = self.get(rhs)
1345            && let lhs_from = self.ty(lhs_value)
1346            && lhs_from == self.ty(rhs_value)
1347            && self.pointers_have_same_metadata(lhs_from, lhs_ty)
1348        {
1349            lhs = lhs_value;
1350            rhs = rhs_value;
1351            if let Some(lhs_op) = self.try_as_operand(lhs, location)
1352                && let Some(rhs_op) = self.try_as_operand(rhs, location)
1353            {
1354                *lhs_operand = lhs_op;
1355                *rhs_operand = rhs_op;
1356            }
1357        }
1358
1359        if let Some(value) = self.simplify_binary_inner(op, lhs_ty, lhs, rhs) {
1360            return Some(value);
1361        }
1362        let ty = op.ty(self.tcx, lhs_ty, self.ty(rhs));
1363        let value = Value::BinaryOp(op, lhs, rhs);
1364        Some(self.insert(ty, value))
1365    }
1366
1367    fn simplify_binary_inner(
1368        &mut self,
1369        op: BinOp,
1370        lhs_ty: Ty<'tcx>,
1371        lhs: VnIndex,
1372        rhs: VnIndex,
1373    ) -> Option<VnIndex> {
1374        // Floats are weird enough that none of the logic below applies.
1375        let reasonable_ty =
1376            lhs_ty.is_integral() || lhs_ty.is_bool() || lhs_ty.is_char() || lhs_ty.is_any_ptr();
1377        if !reasonable_ty {
1378            return None;
1379        }
1380
1381        let layout = self.ecx.layout_of(lhs_ty).ok()?;
1382
1383        let mut as_bits = |value: VnIndex| {
1384            let constant = self.eval_to_const(value)?;
1385            if layout.backend_repr.is_scalar() {
1386                let scalar = self.ecx.read_scalar(constant).discard_err()?;
1387                scalar.to_bits(constant.layout.size).discard_err()
1388            } else {
1389                // `constant` is a wide pointer. Do not evaluate to bits.
1390                None
1391            }
1392        };
1393
1394        // Represent the values as `Left(bits)` or `Right(VnIndex)`.
1395        use Either::{Left, Right};
1396        let a = as_bits(lhs).map_or(Right(lhs), Left);
1397        let b = as_bits(rhs).map_or(Right(rhs), Left);
1398
1399        let result = match (op, a, b) {
1400            // Neutral elements.
1401            (
1402                BinOp::Add
1403                | BinOp::AddWithOverflow
1404                | BinOp::AddUnchecked
1405                | BinOp::BitOr
1406                | BinOp::BitXor,
1407                Left(0),
1408                Right(p),
1409            )
1410            | (
1411                BinOp::Add
1412                | BinOp::AddWithOverflow
1413                | BinOp::AddUnchecked
1414                | BinOp::BitOr
1415                | BinOp::BitXor
1416                | BinOp::Sub
1417                | BinOp::SubWithOverflow
1418                | BinOp::SubUnchecked
1419                | BinOp::Offset
1420                | BinOp::Shl
1421                | BinOp::Shr,
1422                Right(p),
1423                Left(0),
1424            )
1425            | (BinOp::Mul | BinOp::MulWithOverflow | BinOp::MulUnchecked, Left(1), Right(p))
1426            | (
1427                BinOp::Mul | BinOp::MulWithOverflow | BinOp::MulUnchecked | BinOp::Div,
1428                Right(p),
1429                Left(1),
1430            ) => p,
1431            // Attempt to simplify `x & ALL_ONES` to `x`, with `ALL_ONES` depending on type size.
1432            (BinOp::BitAnd, Right(p), Left(ones)) | (BinOp::BitAnd, Left(ones), Right(p))
1433                if ones == layout.size.truncate(u128::MAX)
1434                    || (layout.ty.is_bool() && ones == 1) =>
1435            {
1436                p
1437            }
1438            // Absorbing elements.
1439            (
1440                BinOp::Mul | BinOp::MulWithOverflow | BinOp::MulUnchecked | BinOp::BitAnd,
1441                _,
1442                Left(0),
1443            )
1444            | (BinOp::Rem, _, Left(1))
1445            | (
1446                BinOp::Mul
1447                | BinOp::MulWithOverflow
1448                | BinOp::MulUnchecked
1449                | BinOp::Div
1450                | BinOp::Rem
1451                | BinOp::BitAnd
1452                | BinOp::Shl
1453                | BinOp::Shr,
1454                Left(0),
1455                _,
1456            ) => self.insert_scalar(lhs_ty, Scalar::from_uint(0u128, layout.size)),
1457            // Attempt to simplify `x | ALL_ONES` to `ALL_ONES`.
1458            (BinOp::BitOr, _, Left(ones)) | (BinOp::BitOr, Left(ones), _)
1459                if ones == layout.size.truncate(u128::MAX)
1460                    || (layout.ty.is_bool() && ones == 1) =>
1461            {
1462                self.insert_scalar(lhs_ty, Scalar::from_uint(ones, layout.size))
1463            }
1464            // Sub/Xor with itself.
1465            (BinOp::Sub | BinOp::SubWithOverflow | BinOp::SubUnchecked | BinOp::BitXor, a, b)
1466                if a == b =>
1467            {
1468                self.insert_scalar(lhs_ty, Scalar::from_uint(0u128, layout.size))
1469            }
1470            // Comparison:
1471            // - if both operands can be computed as bits, just compare the bits;
1472            // - if we proved that both operands have the same value, we can insert true/false;
1473            // - otherwise, do nothing, as we do not try to prove inequality.
1474            (BinOp::Eq, Left(a), Left(b)) => self.insert_bool(a == b),
1475            (BinOp::Eq, a, b) if a == b => self.insert_bool(true),
1476            (BinOp::Ne, Left(a), Left(b)) => self.insert_bool(a != b),
1477            (BinOp::Ne, a, b) if a == b => self.insert_bool(false),
1478            _ => return None,
1479        };
1480
1481        if op.is_overflowing() {
1482            let ty = Ty::new_tup(self.tcx, &[self.ty(result), self.tcx.types.bool]);
1483            let false_val = self.insert_bool(false);
1484            Some(self.insert_tuple(ty, &[result, false_val]))
1485        } else {
1486            Some(result)
1487        }
1488    }
1489
1490    fn simplify_cast(
1491        &mut self,
1492        initial_kind: &mut CastKind,
1493        initial_operand: &mut Operand<'tcx>,
1494        to: Ty<'tcx>,
1495        location: Location,
1496    ) -> Option<VnIndex> {
1497        use CastKind::*;
1498        use rustc_middle::ty::adjustment::PointerCoercion::*;
1499
1500        let mut kind = *initial_kind;
1501        let mut value = self.simplify_operand(initial_operand, location)?;
1502        let mut from = self.ty(value);
1503        if from == to {
1504            return Some(value);
1505        }
1506
1507        if let CastKind::PointerCoercion(ReifyFnPointer | ClosureFnPointer(_), _) = kind {
1508            // Each reification of a generic fn may get a different pointer.
1509            // Do not try to merge them.
1510            return Some(self.new_opaque(to));
1511        }
1512
1513        let mut was_ever_updated = false;
1514        loop {
1515            let mut was_updated_this_iteration = false;
1516
1517            // Transmuting between raw pointers is just a pointer cast so long as
1518            // they have the same metadata type (like `*const i32` <=> `*mut u64`
1519            // or `*mut [i32]` <=> `*const [u64]`), including the common special
1520            // case of `*const T` <=> `*mut T`.
1521            if let Transmute = kind
1522                && from.is_raw_ptr()
1523                && to.is_raw_ptr()
1524                && self.pointers_have_same_metadata(from, to)
1525            {
1526                kind = PtrToPtr;
1527                was_updated_this_iteration = true;
1528            }
1529
1530            // If a cast just casts away the metadata again, then we can get it by
1531            // casting the original thin pointer passed to `from_raw_parts`
1532            if let PtrToPtr = kind
1533                && let Value::RawPtr { pointer, .. } = self.get(value)
1534                && let ty::RawPtr(to_pointee, _) = to.kind()
1535                && to_pointee.is_sized(self.tcx, self.typing_env())
1536            {
1537                from = self.ty(pointer);
1538                value = pointer;
1539                was_updated_this_iteration = true;
1540                if from == to {
1541                    return Some(pointer);
1542                }
1543            }
1544
1545            // Aggregate-then-Transmute can just transmute the original field value,
1546            // so long as the bytes of a value from only from a single field.
1547            if let Transmute = kind
1548                && let Value::Aggregate(variant_idx, field_values) = self.get(value)
1549                && let Some((field_idx, field_ty)) =
1550                    self.value_is_all_in_one_field(from, variant_idx)
1551            {
1552                from = field_ty;
1553                value = field_values[field_idx.as_usize()];
1554                was_updated_this_iteration = true;
1555                if field_ty == to {
1556                    return Some(value);
1557                }
1558            }
1559
1560            // Various cast-then-cast cases can be simplified.
1561            if let Value::Cast { kind: inner_kind, value: inner_value } = self.get(value) {
1562                let inner_from = self.ty(inner_value);
1563                let new_kind = match (inner_kind, kind) {
1564                    // Even if there's a narrowing cast in here that's fine, because
1565                    // things like `*mut [i32] -> *mut i32 -> *const i32` and
1566                    // `*mut [i32] -> *const [i32] -> *const i32` can skip the middle in MIR.
1567                    (PtrToPtr, PtrToPtr) => Some(PtrToPtr),
1568                    // PtrToPtr-then-Transmute is fine so long as the pointer cast is identity:
1569                    // `*const T -> *mut T -> NonNull<T>` is fine, but we need to check for narrowing
1570                    // to skip things like `*const [i32] -> *const i32 -> NonNull<T>`.
1571                    (PtrToPtr, Transmute) if self.pointers_have_same_metadata(inner_from, from) => {
1572                        Some(Transmute)
1573                    }
1574                    // Similarly, for Transmute-then-PtrToPtr. Note that we need to check different
1575                    // variables for their metadata, and thus this can't merge with the previous arm.
1576                    (Transmute, PtrToPtr) if self.pointers_have_same_metadata(from, to) => {
1577                        Some(Transmute)
1578                    }
1579                    // If would be legal to always do this, but we don't want to hide information
1580                    // from the backend that it'd otherwise be able to use for optimizations.
1581                    (Transmute, Transmute)
1582                        if !self.type_may_have_niche_of_interest_to_backend(from) =>
1583                    {
1584                        Some(Transmute)
1585                    }
1586                    _ => None,
1587                };
1588                if let Some(new_kind) = new_kind {
1589                    kind = new_kind;
1590                    from = inner_from;
1591                    value = inner_value;
1592                    was_updated_this_iteration = true;
1593                    if inner_from == to {
1594                        return Some(inner_value);
1595                    }
1596                }
1597            }
1598
1599            if was_updated_this_iteration {
1600                was_ever_updated = true;
1601            } else {
1602                break;
1603            }
1604        }
1605
1606        if was_ever_updated && let Some(op) = self.try_as_operand(value, location) {
1607            *initial_operand = op;
1608            *initial_kind = kind;
1609        }
1610
1611        Some(self.insert(to, Value::Cast { kind, value }))
1612    }
1613
1614    fn pointers_have_same_metadata(&self, left_ptr_ty: Ty<'tcx>, right_ptr_ty: Ty<'tcx>) -> bool {
1615        let left_meta_ty = left_ptr_ty.pointee_metadata_ty_or_projection(self.tcx);
1616        let right_meta_ty = right_ptr_ty.pointee_metadata_ty_or_projection(self.tcx);
1617        if left_meta_ty == right_meta_ty {
1618            true
1619        } else if let Ok(left) =
1620            self.tcx.try_normalize_erasing_regions(self.typing_env(), left_meta_ty)
1621            && let Ok(right) =
1622                self.tcx.try_normalize_erasing_regions(self.typing_env(), right_meta_ty)
1623        {
1624            left == right
1625        } else {
1626            false
1627        }
1628    }
1629
1630    /// Returns `false` if we know for sure that this type has no interesting niche,
1631    /// and thus we can skip transmuting through it without worrying.
1632    ///
1633    /// The backend will emit `assume`s when transmuting between types with niches,
1634    /// so we want to preserve `i32 -> char -> u32` so that that data is around,
1635    /// but it's fine to skip whole-range-is-value steps like `A -> u32 -> B`.
1636    fn type_may_have_niche_of_interest_to_backend(&self, ty: Ty<'tcx>) -> bool {
1637        let Ok(layout) = self.ecx.layout_of(ty) else {
1638            // If it's too generic or something, then assume it might be interesting later.
1639            return true;
1640        };
1641
1642        if layout.uninhabited {
1643            return true;
1644        }
1645
1646        match layout.backend_repr {
1647            BackendRepr::Scalar(a) => !a.is_always_valid(&self.ecx),
1648            BackendRepr::ScalarPair(a, b) => {
1649                !a.is_always_valid(&self.ecx) || !b.is_always_valid(&self.ecx)
1650            }
1651            BackendRepr::SimdVector { .. } | BackendRepr::Memory { .. } => false,
1652        }
1653    }
1654
1655    fn value_is_all_in_one_field(
1656        &self,
1657        ty: Ty<'tcx>,
1658        variant: VariantIdx,
1659    ) -> Option<(FieldIdx, Ty<'tcx>)> {
1660        if let Ok(layout) = self.ecx.layout_of(ty)
1661            && let abi::Variants::Single { index } = layout.variants
1662            && index == variant
1663            && let Some((field_idx, field_layout)) = layout.non_1zst_field(&self.ecx)
1664            && layout.size == field_layout.size
1665        {
1666            // We needed to check the variant to avoid trying to read the tag
1667            // field from an enum where no fields have variants, since that tag
1668            // field isn't in the `Aggregate` from which we're getting values.
1669            Some((field_idx, field_layout.ty))
1670        } else if let ty::Adt(adt, args) = ty.kind()
1671            && adt.is_struct()
1672            && adt.repr().transparent()
1673            && let [single_field] = adt.non_enum_variant().fields.raw.as_slice()
1674        {
1675            Some((FieldIdx::ZERO, single_field.ty(self.tcx, args)))
1676        } else {
1677            None
1678        }
1679    }
1680}
1681
1682fn op_to_prop_const<'tcx>(
1683    ecx: &mut InterpCx<'tcx, DummyMachine>,
1684    op: &OpTy<'tcx>,
1685) -> Option<ConstValue> {
1686    // Do not attempt to propagate unsized locals.
1687    if op.layout.is_unsized() {
1688        return None;
1689    }
1690
1691    // This constant is a ZST, just return an empty value.
1692    if op.layout.is_zst() {
1693        return Some(ConstValue::ZeroSized);
1694    }
1695
1696    // Do not synthetize too large constants. Codegen will just memcpy them, which we'd like to
1697    // avoid.
1698    if !matches!(op.layout.backend_repr, BackendRepr::Scalar(..) | BackendRepr::ScalarPair(..)) {
1699        return None;
1700    }
1701
1702    // If this constant has scalar ABI, return it as a `ConstValue::Scalar`.
1703    if let BackendRepr::Scalar(abi::Scalar::Initialized { .. }) = op.layout.backend_repr
1704        && let Some(scalar) = ecx.read_scalar(op).discard_err()
1705    {
1706        if !scalar.try_to_scalar_int().is_ok() {
1707            // Check that we do not leak a pointer.
1708            // Those pointers may lose part of their identity in codegen.
1709            // FIXME: remove this hack once https://github.com/rust-lang/rust/issues/79738 is fixed.
1710            return None;
1711        }
1712        return Some(ConstValue::Scalar(scalar));
1713    }
1714
1715    // If this constant is already represented as an `Allocation`,
1716    // try putting it into global memory to return it.
1717    if let Either::Left(mplace) = op.as_mplace_or_imm() {
1718        let (size, _align) = ecx.size_and_align_of_val(&mplace).discard_err()??;
1719
1720        // Do not try interning a value that contains provenance.
1721        // Due to https://github.com/rust-lang/rust/issues/79738, doing so could lead to bugs.
1722        // FIXME: remove this hack once that issue is fixed.
1723        let alloc_ref = ecx.get_ptr_alloc(mplace.ptr(), size).discard_err()??;
1724        if alloc_ref.has_provenance() {
1725            return None;
1726        }
1727
1728        let pointer = mplace.ptr().into_pointer_or_addr().ok()?;
1729        let (prov, offset) = pointer.prov_and_relative_offset();
1730        let alloc_id = prov.alloc_id();
1731        intern_const_alloc_for_constprop(ecx, alloc_id).discard_err()?;
1732
1733        // `alloc_id` may point to a static. Codegen will choke on an `Indirect` with anything
1734        // by `GlobalAlloc::Memory`, so do fall through to copying if needed.
1735        // FIXME: find a way to treat this more uniformly (probably by fixing codegen)
1736        if let GlobalAlloc::Memory(alloc) = ecx.tcx.global_alloc(alloc_id)
1737            // Transmuting a constant is just an offset in the allocation. If the alignment of the
1738            // allocation is not enough, fallback to copying into a properly aligned value.
1739            && alloc.inner().align >= op.layout.align.abi
1740        {
1741            return Some(ConstValue::Indirect { alloc_id, offset });
1742        }
1743    }
1744
1745    // Everything failed: create a new allocation to hold the data.
1746    let alloc_id =
1747        ecx.intern_with_temp_alloc(op.layout, |ecx, dest| ecx.copy_op(op, dest)).discard_err()?;
1748    let value = ConstValue::Indirect { alloc_id, offset: Size::ZERO };
1749
1750    // Check that we do not leak a pointer.
1751    // Those pointers may lose part of their identity in codegen.
1752    // FIXME: remove this hack once https://github.com/rust-lang/rust/issues/79738 is fixed.
1753    if ecx.tcx.global_alloc(alloc_id).unwrap_memory().inner().provenance().ptrs().is_empty() {
1754        return Some(value);
1755    }
1756
1757    None
1758}
1759
1760impl<'tcx> VnState<'_, '_, 'tcx> {
1761    /// If either [`Self::try_as_constant`] as [`Self::try_as_place`] succeeds,
1762    /// returns that result as an [`Operand`].
1763    fn try_as_operand(&mut self, index: VnIndex, location: Location) -> Option<Operand<'tcx>> {
1764        if let Some(const_) = self.try_as_constant(index) {
1765            Some(Operand::Constant(Box::new(const_)))
1766        } else if let Some(place) = self.try_as_place(index, location, false) {
1767            self.reused_locals.insert(place.local);
1768            Some(Operand::Copy(place))
1769        } else {
1770            None
1771        }
1772    }
1773
1774    /// If `index` is a `Value::Constant`, return the `Constant` to be put in the MIR.
1775    fn try_as_constant(&mut self, index: VnIndex) -> Option<ConstOperand<'tcx>> {
1776        // This was already constant in MIR, do not change it. If the constant is not
1777        // deterministic, adding an additional mention of it in MIR will not give the same value as
1778        // the former mention.
1779        if let Value::Constant { value, disambiguator: None } = self.get(index) {
1780            debug_assert!(value.is_deterministic());
1781            return Some(ConstOperand { span: DUMMY_SP, user_ty: None, const_: value });
1782        }
1783
1784        let op = self.eval_to_const(index)?;
1785        if op.layout.is_unsized() {
1786            // Do not attempt to propagate unsized locals.
1787            return None;
1788        }
1789
1790        let value = op_to_prop_const(&mut self.ecx, op)?;
1791
1792        // Check that we do not leak a pointer.
1793        // Those pointers may lose part of their identity in codegen.
1794        // FIXME: remove this hack once https://github.com/rust-lang/rust/issues/79738 is fixed.
1795        assert!(!value.may_have_provenance(self.tcx, op.layout.size));
1796
1797        let const_ = Const::Val(value, op.layout.ty);
1798        Some(ConstOperand { span: DUMMY_SP, user_ty: None, const_ })
1799    }
1800
1801    /// Construct a place which holds the same value as `index` and for which all locals strictly
1802    /// dominate `loc`. If you used this place, add its base local to `reused_locals` to remove
1803    /// storage statements.
1804    #[instrument(level = "trace", skip(self), ret)]
1805    fn try_as_place(
1806        &mut self,
1807        mut index: VnIndex,
1808        loc: Location,
1809        allow_complex_projection: bool,
1810    ) -> Option<Place<'tcx>> {
1811        let mut projection = SmallVec::<[PlaceElem<'tcx>; 1]>::new();
1812        loop {
1813            if let Some(local) = self.try_as_local(index, loc) {
1814                projection.reverse();
1815                let place =
1816                    Place { local, projection: self.tcx.mk_place_elems(projection.as_slice()) };
1817                return Some(place);
1818            } else if projection.last() == Some(&PlaceElem::Deref) {
1819                // `Deref` can only be the first projection in a place.
1820                // If we are here, we failed to find a local, and we already have a `Deref`.
1821                // Trying to add projections will only result in an ill-formed place.
1822                return None;
1823            } else if let Value::Projection(pointer, proj) = self.get(index)
1824                && (allow_complex_projection || proj.is_stable_offset())
1825                && let Some(proj) = self.try_as_place_elem(self.ty(index), proj, loc)
1826            {
1827                projection.push(proj);
1828                index = pointer;
1829            } else {
1830                return None;
1831            }
1832        }
1833    }
1834
1835    /// If there is a local which is assigned `index`, and its assignment strictly dominates `loc`,
1836    /// return it. If you used this local, add it to `reused_locals` to remove storage statements.
1837    fn try_as_local(&mut self, index: VnIndex, loc: Location) -> Option<Local> {
1838        let other = self.rev_locals.get(index)?;
1839        other
1840            .iter()
1841            .find(|&&other| self.ssa.assignment_dominates(&self.dominators, other, loc))
1842            .copied()
1843    }
1844}
1845
1846impl<'tcx> MutVisitor<'tcx> for VnState<'_, '_, 'tcx> {
1847    fn tcx(&self) -> TyCtxt<'tcx> {
1848        self.tcx
1849    }
1850
1851    fn visit_place(&mut self, place: &mut Place<'tcx>, context: PlaceContext, location: Location) {
1852        self.simplify_place_projection(place, location);
1853        if context.is_mutating_use() && place.is_indirect() {
1854            // Non-local mutation maybe invalidate deref.
1855            self.invalidate_derefs();
1856        }
1857        self.super_place(place, context, location);
1858    }
1859
1860    fn visit_operand(&mut self, operand: &mut Operand<'tcx>, location: Location) {
1861        self.simplify_operand(operand, location);
1862        self.super_operand(operand, location);
1863    }
1864
1865    fn visit_assign(
1866        &mut self,
1867        lhs: &mut Place<'tcx>,
1868        rvalue: &mut Rvalue<'tcx>,
1869        location: Location,
1870    ) {
1871        self.simplify_place_projection(lhs, location);
1872
1873        let value = self.simplify_rvalue(lhs, rvalue, location);
1874        if let Some(value) = value {
1875            if let Some(const_) = self.try_as_constant(value) {
1876                *rvalue = Rvalue::Use(Operand::Constant(Box::new(const_)));
1877            } else if let Some(place) = self.try_as_place(value, location, false)
1878                && *rvalue != Rvalue::Use(Operand::Move(place))
1879                && *rvalue != Rvalue::Use(Operand::Copy(place))
1880            {
1881                *rvalue = Rvalue::Use(Operand::Copy(place));
1882                self.reused_locals.insert(place.local);
1883            }
1884        }
1885
1886        if lhs.is_indirect() {
1887            // Non-local mutation maybe invalidate deref.
1888            self.invalidate_derefs();
1889        }
1890
1891        if let Some(local) = lhs.as_local()
1892            && self.ssa.is_ssa(local)
1893            && let rvalue_ty = rvalue.ty(self.local_decls, self.tcx)
1894            // FIXME(#112651) `rvalue` may have a subtype to `local`. We can only mark
1895            // `local` as reusable if we have an exact type match.
1896            && self.local_decls[local].ty == rvalue_ty
1897        {
1898            let value = value.unwrap_or_else(|| self.new_opaque(rvalue_ty));
1899            self.assign(local, value);
1900        }
1901    }
1902
1903    fn visit_terminator(&mut self, terminator: &mut Terminator<'tcx>, location: Location) {
1904        if let Terminator { kind: TerminatorKind::Call { destination, .. }, .. } = terminator {
1905            if let Some(local) = destination.as_local()
1906                && self.ssa.is_ssa(local)
1907            {
1908                let ty = self.local_decls[local].ty;
1909                let opaque = self.new_opaque(ty);
1910                self.assign(local, opaque);
1911            }
1912        }
1913        // Terminators that can write to memory may invalidate (nested) derefs.
1914        if terminator.kind.can_write_to_memory() {
1915            self.invalidate_derefs();
1916        }
1917        self.super_terminator(terminator, location);
1918    }
1919}
1920
1921struct StorageRemover<'tcx> {
1922    tcx: TyCtxt<'tcx>,
1923    reused_locals: DenseBitSet<Local>,
1924}
1925
1926impl<'tcx> MutVisitor<'tcx> for StorageRemover<'tcx> {
1927    fn tcx(&self) -> TyCtxt<'tcx> {
1928        self.tcx
1929    }
1930
1931    fn visit_operand(&mut self, operand: &mut Operand<'tcx>, _: Location) {
1932        if let Operand::Move(place) = *operand
1933            && !place.is_indirect_first_projection()
1934            && self.reused_locals.contains(place.local)
1935        {
1936            *operand = Operand::Copy(place);
1937        }
1938    }
1939
1940    fn visit_statement(&mut self, stmt: &mut Statement<'tcx>, loc: Location) {
1941        match stmt.kind {
1942            // When removing storage statements, we need to remove both (#107511).
1943            StatementKind::StorageLive(l) | StatementKind::StorageDead(l)
1944                if self.reused_locals.contains(l) =>
1945            {
1946                stmt.make_nop(true)
1947            }
1948            _ => self.super_statement(stmt, loc),
1949        }
1950    }
1951}