Skip to main content

rustc_codegen_ssa/
base.rs

1use std::collections::BTreeSet;
2use std::sync::Arc;
3use std::time::{Duration, Instant};
4use std::{cmp, iter};
5
6use itertools::Itertools;
7use rustc_abi::FIRST_VARIANT;
8use rustc_ast::expand::allocator::{
9    ALLOC_ERROR_HANDLER, ALLOCATOR_METHODS, AllocatorKind, AllocatorMethod, AllocatorMethodInput,
10    AllocatorTy,
11};
12use rustc_data_structures::fx::{FxHashMap, FxIndexMap, FxIndexSet};
13use rustc_data_structures::profiling::{get_resident_set_size, print_time_passes_entry};
14use rustc_data_structures::sync::{IntoDynSyncSend, par_map};
15use rustc_data_structures::unord::UnordMap;
16use rustc_hir::attrs::{DebuggerVisualizerType, EiiDecl, EiiImpl, OptimizeAttr};
17use rustc_hir::def_id::{CrateNum, DefId, LOCAL_CRATE};
18use rustc_hir::lang_items::LangItem;
19use rustc_hir::{ItemId, Target, find_attr};
20use rustc_middle::middle::codegen_fn_attrs::CodegenFnAttrs;
21use rustc_middle::middle::debugger_visualizer::DebuggerVisualizerFile;
22use rustc_middle::middle::dependency_format::{Dependencies, Linkage};
23use rustc_middle::middle::exported_symbols::{self, SymbolExportKind};
24use rustc_middle::middle::lang_items;
25use rustc_middle::mir::interpret::{CTFE_ALLOC_SALT, ErrorHandled, Scalar};
26use rustc_middle::mir::{BinOp, ConstValue};
27use rustc_middle::mono::{CodegenUnit, CodegenUnitNameBuilder, MonoItem, MonoItemPartitions};
28use rustc_middle::query::Providers;
29use rustc_middle::ty::layout::{HasTyCtxt, HasTypingEnv, LayoutOf, TyAndLayout};
30use rustc_middle::ty::{self, Instance, PatternKind, Ty, TyCtxt, UintTy, Unnormalized};
31use rustc_middle::{bug, span_bug};
32use rustc_session::Session;
33use rustc_session::config::{self, CrateType, EntryFnType};
34use rustc_span::{DUMMY_SP, Symbol};
35use rustc_symbol_mangling::mangle_internal_symbol;
36use rustc_target::spec::{Arch, Os};
37use rustc_trait_selection::infer::{BoundRegionConversionTime, TyCtxtInferExt};
38use rustc_trait_selection::traits::{ObligationCause, ObligationCtxt};
39use tracing::{debug, info};
40
41use crate::assert_module_sources::CguReuse;
42use crate::back::link::are_upstream_rust_objects_already_included;
43use crate::back::write::{
44    ComputedLtoType, OngoingCodegen, compute_per_cgu_lto_type, start_async_codegen,
45    submit_codegened_module_to_llvm, submit_post_lto_module_to_llvm, submit_pre_lto_module_to_llvm,
46};
47use crate::common::{self, IntPredicate, RealPredicate, TypeKind};
48use crate::meth::load_vtable;
49use crate::mir::operand::OperandValue;
50use crate::mir::place::PlaceRef;
51use crate::traits::*;
52use crate::{
53    CachedModuleCodegen, CodegenLintLevelSpecs, CrateInfo, EiiLinkageImplInfo, EiiLinkageInfo,
54    ModuleCodegen, diagnostics, meth, mir,
55};
56
57pub(crate) fn bin_op_to_icmp_predicate(op: BinOp, signed: bool) -> IntPredicate {
58    match (op, signed) {
59        (BinOp::Eq, _) => IntPredicate::IntEQ,
60        (BinOp::Ne, _) => IntPredicate::IntNE,
61        (BinOp::Lt, true) => IntPredicate::IntSLT,
62        (BinOp::Lt, false) => IntPredicate::IntULT,
63        (BinOp::Le, true) => IntPredicate::IntSLE,
64        (BinOp::Le, false) => IntPredicate::IntULE,
65        (BinOp::Gt, true) => IntPredicate::IntSGT,
66        (BinOp::Gt, false) => IntPredicate::IntUGT,
67        (BinOp::Ge, true) => IntPredicate::IntSGE,
68        (BinOp::Ge, false) => IntPredicate::IntUGE,
69        op => ::rustc_middle::util::bug::bug_fmt(format_args!("bin_op_to_icmp_predicate: expected comparison operator, found {0:?}",
        op))bug!("bin_op_to_icmp_predicate: expected comparison operator, found {:?}", op),
70    }
71}
72
73pub(crate) fn bin_op_to_fcmp_predicate(op: BinOp) -> RealPredicate {
74    match op {
75        BinOp::Eq => RealPredicate::RealOEQ,
76        BinOp::Ne => RealPredicate::RealUNE,
77        BinOp::Lt => RealPredicate::RealOLT,
78        BinOp::Le => RealPredicate::RealOLE,
79        BinOp::Gt => RealPredicate::RealOGT,
80        BinOp::Ge => RealPredicate::RealOGE,
81        op => ::rustc_middle::util::bug::bug_fmt(format_args!("bin_op_to_fcmp_predicate: expected comparison operator, found {0:?}",
        op))bug!("bin_op_to_fcmp_predicate: expected comparison operator, found {:?}", op),
82    }
83}
84
85pub fn compare_simd_types<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
86    bx: &mut Bx,
87    lhs: Bx::Value,
88    rhs: Bx::Value,
89    t: Ty<'tcx>,
90    ret_ty: Bx::Type,
91    op: BinOp,
92) -> Bx::Value {
93    let signed = match t.kind() {
94        ty::Float(_) => {
95            let cmp = bin_op_to_fcmp_predicate(op);
96            let cmp = bx.fcmp(cmp, lhs, rhs);
97            return bx.sext(cmp, ret_ty);
98        }
99        ty::Uint(_) => false,
100        ty::Int(_) => true,
101        _ => ::rustc_middle::util::bug::bug_fmt(format_args!("compare_simd_types: invalid SIMD type"))bug!("compare_simd_types: invalid SIMD type"),
102    };
103
104    let cmp = bin_op_to_icmp_predicate(op, signed);
105    let cmp = bx.icmp(cmp, lhs, rhs);
106    // LLVM outputs an `< size x i1 >`, so we need to perform a sign extension
107    // to get the correctly sized type. This will compile to a single instruction
108    // once the IR is converted to assembly if the SIMD instruction is supported
109    // by the target architecture.
110    bx.sext(cmp, ret_ty)
111}
112
113/// Codegen takes advantage of the additional assumption, where if the
114/// principal trait def id of what's being casted doesn't change,
115/// then we don't need to adjust the vtable at all. This
116/// corresponds to the fact that `dyn Tr<A>: Unsize<dyn Tr<B>>`
117/// requires that `A = B`; we don't allow *upcasting* objects
118/// between the same trait with different args. If we, for
119/// some reason, were to relax the `Unsize` trait, it could become
120/// unsound, so let's validate here that the trait refs are subtypes.
121pub fn validate_trivial_unsize<'tcx>(
122    tcx: TyCtxt<'tcx>,
123    source_data: &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
124    target_data: &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
125) -> bool {
126    match (source_data.principal(), target_data.principal()) {
127        (Some(hr_source_principal), Some(hr_target_principal)) => {
128            let (infcx, param_env) =
129                tcx.infer_ctxt().build_with_typing_env(ty::TypingEnv::fully_monomorphized());
130            let universe = infcx.universe();
131            let ocx = ObligationCtxt::new(&infcx);
132            infcx.enter_forall(hr_target_principal, |target_principal| {
133                let source_principal = infcx.instantiate_binder_with_fresh_vars(
134                    DUMMY_SP,
135                    BoundRegionConversionTime::HigherRankedType,
136                    hr_source_principal,
137                );
138                let Ok(()) = ocx.eq(
139                    &ObligationCause::dummy(),
140                    param_env,
141                    target_principal,
142                    source_principal,
143                ) else {
144                    return false;
145                };
146                if !ocx.evaluate_obligations_error_on_ambiguity().is_empty() {
147                    return false;
148                }
149                infcx.leak_check(universe, None).is_ok()
150            })
151        }
152        (_, None) => true,
153        _ => false,
154    }
155}
156
157/// Retrieves the information we are losing (making dynamic) in an unsizing
158/// adjustment.
159///
160/// The `old_info` argument is a bit odd. It is intended for use in an upcast,
161/// where the new vtable for an object will be derived from the old one.
162fn unsized_info<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
163    bx: &mut Bx,
164    source: Ty<'tcx>,
165    target: Ty<'tcx>,
166    old_info: Option<Bx::Value>,
167) -> Bx::Value {
168    let cx = bx.cx();
169    let (source, target) =
170        cx.tcx().struct_lockstep_tails_for_codegen(source, target, bx.typing_env());
171    match (source.kind(), target.kind()) {
172        (&ty::Array(_, len), &ty::Slice(_)) => cx.const_usize(
173            len.try_to_target_usize(cx.tcx()).expect("expected monomorphic const in codegen"),
174        ),
175        (&ty::Dynamic(data_a, _), &ty::Dynamic(data_b, _)) => {
176            let old_info =
177                old_info.expect("unsized_info: missing old info for trait upcasting coercion");
178            let b_principal_def_id = data_b.principal_def_id();
179            if data_a.principal_def_id() == b_principal_def_id || b_principal_def_id.is_none() {
180                // Codegen takes advantage of the additional assumption, where if the
181                // principal trait def id of what's being casted doesn't change,
182                // then we don't need to adjust the vtable at all. This
183                // corresponds to the fact that `dyn Tr<A>: Unsize<dyn Tr<B>>`
184                // requires that `A = B`; we don't allow *upcasting* objects
185                // between the same trait with different args. If we, for
186                // some reason, were to relax the `Unsize` trait, it could become
187                // unsound, so let's assert here that the trait refs are *equal*.
188                if true {
    if !validate_trivial_unsize(cx.tcx(), data_a, data_b) {
        {
            ::core::panicking::panic_fmt(format_args!("NOP unsize vtable changed principal trait ref: {0} -> {1}",
                    data_a, data_b));
        }
    };
};debug_assert!(
189                    validate_trivial_unsize(cx.tcx(), data_a, data_b),
190                    "NOP unsize vtable changed principal trait ref: {data_a} -> {data_b}"
191                );
192
193                // A NOP cast that doesn't actually change anything, let's avoid any
194                // unnecessary work. This relies on the assumption that if the principal
195                // traits are equal, then the associated type bounds (`dyn Trait<Assoc=T>`)
196                // are also equal, which is ensured by the fact that normalization is
197                // a function and we do not allow overlapping impls.
198                return old_info;
199            }
200
201            // trait upcasting coercion
202
203            let vptr_entry_idx = cx.tcx().supertrait_vtable_slot((source, target));
204
205            if let Some(entry_idx) = vptr_entry_idx {
206                let ptr_size = bx.data_layout().pointer_size();
207                let vtable_byte_offset = u64::try_from(entry_idx).unwrap() * ptr_size.bytes();
208                load_vtable(bx, old_info, bx.type_ptr(), vtable_byte_offset, source, true)
209            } else {
210                old_info
211            }
212        }
213        (_, ty::Dynamic(data, _)) => meth::get_vtable(
214            cx,
215            source,
216            data.principal()
217                .map(|principal| bx.tcx().instantiate_bound_regions_with_erased(principal)),
218        ),
219        _ => ::rustc_middle::util::bug::bug_fmt(format_args!("unsized_info: invalid unsizing {0:?} -> {1:?}",
        source, target))bug!("unsized_info: invalid unsizing {:?} -> {:?}", source, target),
220    }
221}
222
223/// Coerces `src` to `dst_ty`. `src_ty` must be a pointer.
224pub(crate) fn unsize_ptr<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
225    bx: &mut Bx,
226    src: Bx::Value,
227    src_ty: Ty<'tcx>,
228    dst_ty: Ty<'tcx>,
229    old_info: Option<Bx::Value>,
230) -> (Bx::Value, Bx::Value) {
231    {
    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/base.rs:231",
                        "rustc_codegen_ssa::base", ::tracing::Level::DEBUG,
                        ::tracing_core::__macro_support::Option::Some("compiler/rustc_codegen_ssa/src/base.rs"),
                        ::tracing_core::__macro_support::Option::Some(231u32),
                        ::tracing_core::__macro_support::Option::Some("rustc_codegen_ssa::base"),
                        ::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};
                __CALLSITE.metadata().fields().value_set_all(&[(::tracing::__macro_support::Option::Some(&format_args!("unsize_ptr: {0:?} => {1:?}",
                                                    src_ty, dst_ty) as &dyn ::tracing::field::Value))])
            });
    } else { ; }
};debug!("unsize_ptr: {:?} => {:?}", src_ty, dst_ty);
232    match (src_ty.kind(), dst_ty.kind()) {
233        (&ty::Pat(a, _), &ty::Pat(b, _)) => unsize_ptr(bx, src, a, b, old_info),
234        (&ty::Ref(_, a, _), &ty::Ref(_, b, _) | &ty::RawPtr(b, _))
235        | (&ty::RawPtr(a, _), &ty::RawPtr(b, _)) => {
236            {
    match (&bx.cx().type_is_sized(a), &old_info.is_none()) {
        (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!(bx.cx().type_is_sized(a), old_info.is_none());
237            (src, unsized_info(bx, a, b, old_info))
238        }
239        (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) => {
240            {
    match (&def_a, &def_b) {
        (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!(def_a, def_b); // implies same number of fields
241            let src_layout = bx.cx().layout_of(src_ty);
242            let dst_layout = bx.cx().layout_of(dst_ty);
243            if src_ty == dst_ty {
244                return (src, old_info.unwrap());
245            }
246            let mut result = None;
247            for i in 0..src_layout.fields.count() {
248                let src_f = src_layout.field(bx.cx(), i);
249                if src_f.is_1zst() {
250                    // We are looking for the one non-1-ZST field; this is not it.
251                    continue;
252                }
253
254                {
    match (&src_layout.fields.offset(i).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!(src_layout.fields.offset(i).bytes(), 0);
255                {
    match (&dst_layout.fields.offset(i).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!(dst_layout.fields.offset(i).bytes(), 0);
256                {
    match (&src_layout.size, &src_f.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::None);
            }
        }
    }
};assert_eq!(src_layout.size, src_f.size);
257
258                let dst_f = dst_layout.field(bx.cx(), i);
259                {
    match (&src_f.ty, &dst_f.ty) {
        (left_val, right_val) => {
            if *left_val == *right_val {
                let kind = ::core::panicking::AssertKind::Ne;
                ::core::panicking::assert_failed(kind, &*left_val,
                    &*right_val, ::core::option::Option::None);
            }
        }
    }
};assert_ne!(src_f.ty, dst_f.ty);
260                {
    match (&result, &None) {
        (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!(result, None);
261                result = Some(unsize_ptr(bx, src, src_f.ty, dst_f.ty, old_info));
262            }
263            result.unwrap()
264        }
265        _ => ::rustc_middle::util::bug::bug_fmt(format_args!("unsize_ptr: called on bad types"))bug!("unsize_ptr: called on bad types"),
266    }
267}
268
269/// Coerces `src`, which is a reference to a value of type `src_ty`,
270/// to a value of type `dst_ty`, and stores the result in `dst`.
271pub(crate) fn coerce_unsized_into<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
272    bx: &mut Bx,
273    src: PlaceRef<'tcx, Bx::Value>,
274    dst: PlaceRef<'tcx, Bx::Value>,
275) {
276    let src_ty = src.layout.ty;
277    let dst_ty = dst.layout.ty;
278    match (src_ty.kind(), dst_ty.kind()) {
279        (&ty::Pat(s, sp), &ty::Pat(d, dp))
280            if let (PatternKind::NotNull, PatternKind::NotNull) = (*sp, *dp) =>
281        {
282            let src = src.project_type(bx, s);
283            let dst = dst.project_type(bx, d);
284            coerce_unsized_into(bx, src, dst)
285        }
286        (&ty::Ref(..), &ty::Ref(..) | &ty::RawPtr(..)) | (&ty::RawPtr(..), &ty::RawPtr(..)) => {
287            let (base, info) = match bx.load_operand(src).val {
288                OperandValue::Pair(base, info) => unsize_ptr(bx, base, src_ty, dst_ty, Some(info)),
289                OperandValue::Immediate(base) => unsize_ptr(bx, base, src_ty, dst_ty, None),
290                OperandValue::Ref(..) | OperandValue::ZeroSized | OperandValue::Uninit => ::rustc_middle::util::bug::bug_fmt(format_args!("impossible case reached"))bug!(),
291            };
292            OperandValue::Pair(base, info).store(bx, dst);
293        }
294
295        (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) => {
296            {
    match (&def_a, &def_b) {
        (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!(def_a, def_b); // implies same number of fields
297
298            for i in def_a.variant(FIRST_VARIANT).fields.indices() {
299                let src_f = src.project_field(bx, i.as_usize());
300                let dst_f = dst.project_field(bx, i.as_usize());
301
302                if dst_f.layout.is_zst() {
303                    // No data here, nothing to copy/coerce.
304                    continue;
305                }
306
307                if src_f.layout.ty == dst_f.layout.ty {
308                    bx.typed_place_copy(dst_f.val, src_f.val, src_f.layout);
309                } else {
310                    coerce_unsized_into(bx, src_f, dst_f);
311                }
312            }
313        }
314        _ => ::rustc_middle::util::bug::bug_fmt(format_args!("coerce_unsized_into: invalid coercion {0:?} -> {1:?}",
        src_ty, dst_ty))bug!("coerce_unsized_into: invalid coercion {:?} -> {:?}", src_ty, dst_ty,),
315    }
316}
317
318/// Returns `rhs` sufficiently masked, truncated, and/or extended so that it can be used to shift
319/// `lhs`: it has the same size as `lhs`, and the value, when interpreted unsigned (no matter its
320/// type), will not exceed the size of `lhs`.
321///
322/// Shifts in MIR are all allowed to have mismatched LHS & RHS types, and signed RHS.
323/// The shift methods in `BuilderMethods`, however, are fully homogeneous
324/// (both parameters and the return type are all the same size) and assume an unsigned RHS.
325///
326/// If `is_unchecked` is false, this masks the RHS to ensure it stays in-bounds,
327/// as the `BuilderMethods` shifts are UB for out-of-bounds shift amounts.
328/// For 32- and 64-bit types, this matches the semantics
329/// of Java. (See related discussion on #1877 and #10183.)
330///
331/// If `is_unchecked` is true, this does no masking, and adds sufficient `assume`
332/// calls or operation flags to preserve as much freedom to optimize as possible.
333pub(crate) fn build_shift_expr_rhs<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
334    bx: &mut Bx,
335    lhs: Bx::Value,
336    mut rhs: Bx::Value,
337    is_unchecked: bool,
338) -> Bx::Value {
339    // Shifts may have any size int on the rhs
340    let mut rhs_llty = bx.cx().val_ty(rhs);
341    let mut lhs_llty = bx.cx().val_ty(lhs);
342
343    let mask = common::shift_mask_val(bx, lhs_llty, rhs_llty, false);
344    if !is_unchecked {
345        rhs = bx.and(rhs, mask);
346    }
347
348    if bx.cx().type_kind(rhs_llty) == TypeKind::Vector {
349        rhs_llty = bx.cx().element_type(rhs_llty)
350    }
351    if bx.cx().type_kind(lhs_llty) == TypeKind::Vector {
352        lhs_llty = bx.cx().element_type(lhs_llty)
353    }
354    let rhs_sz = bx.cx().int_width(rhs_llty);
355    let lhs_sz = bx.cx().int_width(lhs_llty);
356    if lhs_sz < rhs_sz {
357        if is_unchecked { bx.unchecked_utrunc(rhs, lhs_llty) } else { bx.trunc(rhs, lhs_llty) }
358    } else if lhs_sz > rhs_sz {
359        // We zero-extend even if the RHS is signed. So e.g. `(x: i32) << -1i8` will zero-extend the
360        // RHS to `255i32`. But then we mask the shift amount to be within the size of the LHS
361        // anyway so the result is `31` as it should be. All the extra bits introduced by zext
362        // are masked off so their value does not matter.
363        // FIXME: if we ever support 512bit integers, this will be wrong! For such large integers,
364        // the extra bits introduced by zext are *not* all masked away any more.
365        if !(lhs_sz <= 256) {
    ::core::panicking::panic("assertion failed: lhs_sz <= 256")
};assert!(lhs_sz <= 256);
366        bx.zext(rhs, lhs_llty)
367    } else {
368        rhs
369    }
370}
371
372// Returns `true` if this session's target will use native wasm
373// exceptions. This means that the VM does the unwinding for
374// us
375pub fn wants_wasm_eh(sess: &Session) -> bool {
376    sess.target.is_like_wasm
377}
378
379/// Returns `true` if this session's target will use SEH-based unwinding.
380///
381/// This is only true for MSVC targets, and even then the 64-bit MSVC target
382/// currently uses SEH-ish unwinding with DWARF info tables to the side (same as
383/// 64-bit MinGW) instead of "full SEH".
384pub fn wants_msvc_seh(sess: &Session) -> bool {
385    sess.target.is_like_msvc
386}
387
388/// Returns `true` if this session's target requires the new exception
389/// handling LLVM IR instructions (catchpad / cleanuppad / ... instead
390/// of landingpad)
391pub(crate) fn wants_new_eh_instructions(sess: &Session) -> bool {
392    wants_wasm_eh(sess) || wants_msvc_seh(sess)
393}
394
395pub(crate) fn codegen_instance<'a, 'tcx: 'a, Bx: BuilderMethods<'a, 'tcx>>(
396    cx: &'a Bx::CodegenCx,
397    instance: Instance<'tcx>,
398) {
399    // this is an info! to allow collecting monomorphization statistics
400    // and to allow finding the last function before LLVM aborts from
401    // release builds.
402    {
    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/base.rs:402",
                        "rustc_codegen_ssa::base", ::tracing::Level::INFO,
                        ::tracing_core::__macro_support::Option::Some("compiler/rustc_codegen_ssa/src/base.rs"),
                        ::tracing_core::__macro_support::Option::Some(402u32),
                        ::tracing_core::__macro_support::Option::Some("rustc_codegen_ssa::base"),
                        ::tracing_core::field::FieldSet::new(&["message"],
                            ::tracing_core::callsite::Identifier(&__CALLSITE)),
                        ::tracing::metadata::Kind::EVENT)
                };
            ::tracing::callsite::DefaultCallsite::new(&META)
        };
    let enabled =
        ::tracing::Level::INFO <= ::tracing::level_filters::STATIC_MAX_LEVEL
                &&
                ::tracing::Level::INFO <=
                    ::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};
                __CALLSITE.metadata().fields().value_set_all(&[(::tracing::__macro_support::Option::Some(&format_args!("codegen_instance({0})",
                                                    instance) as &dyn ::tracing::field::Value))])
            });
    } else { ; }
};info!("codegen_instance({})", instance);
403
404    mir::codegen_mir::<Bx>(cx, instance);
405}
406
407pub fn codegen_global_asm<'tcx, Cx>(cx: &mut Cx, item_id: ItemId)
408where
409    Cx: LayoutOf<'tcx, LayoutOfResult = TyAndLayout<'tcx>> + AsmCodegenMethods<'tcx>,
410{
411    let item = cx.tcx().hir_item(item_id);
412    if let rustc_hir::ItemKind::GlobalAsm { asm, .. } = item.kind {
413        let operands: Vec<_> = asm
414            .operands
415            .iter()
416            .map(|(op, op_sp)| match *op {
417                rustc_hir::InlineAsmOperand::Const { ref anon_const } => {
418                    match cx.tcx().const_eval_poly(anon_const.def_id.to_def_id()) {
419                        Ok(const_value) => {
420                            let ty =
421                                cx.tcx().typeck_body(anon_const.body).node_type(anon_const.hir_id);
422                            let ConstValue::Scalar(scalar) = const_value else {
423                                ::rustc_middle::util::bug::span_bug_fmt(*op_sp,
    format_args!("expected Scalar for promoted asm const, but got {0:#?}",
        const_value))span_bug!(
424                                    *op_sp,
425                                    "expected Scalar for promoted asm const, but got {:#?}",
426                                    const_value
427                                )
428                            };
429                            GlobalAsmOperandRef::Const {
430                                value: common::asm_const_ptr_clean(cx.tcx(), scalar),
431                                ty,
432                            }
433                        }
434                        Err(ErrorHandled::Reported { .. }) => {
435                            // An error has already been reported and
436                            // compilation is guaranteed to fail if execution
437                            // hits this path. So anything will suffice.
438                            GlobalAsmOperandRef::Const {
439                                value: Scalar::from_u32(0),
440                                ty: Ty::new_uint(cx.tcx(), UintTy::U32),
441                            }
442                        }
443                        Err(ErrorHandled::TooGeneric(_)) => {
444                            ::rustc_middle::util::bug::span_bug_fmt(*op_sp,
    format_args!("asm const cannot be resolved; too generic"))span_bug!(*op_sp, "asm const cannot be resolved; too generic")
445                        }
446                    }
447                }
448                rustc_hir::InlineAsmOperand::SymFn { expr } => {
449                    let ty = cx.tcx().typeck(item_id.owner_id).expr_ty(expr);
450                    let instance = match ty.kind() {
451                        &ty::FnDef(def_id, args) => Instance::expect_resolve(
452                            cx.tcx(),
453                            ty::TypingEnv::fully_monomorphized(),
454                            def_id,
455                            args.no_bound_vars().unwrap(),
456                            expr.span,
457                        ),
458                        _ => ::rustc_middle::util::bug::span_bug_fmt(*op_sp,
    format_args!("asm sym is not a function"))span_bug!(*op_sp, "asm sym is not a function"),
459                    };
460
461                    GlobalAsmOperandRef::Const {
462                        value: Scalar::from_pointer(
463                            cx.tcx().reserve_and_set_fn_alloc(instance, CTFE_ALLOC_SALT).into(),
464                            cx,
465                        ),
466                        ty: Ty::new_fn_ptr(cx.tcx(), ty.fn_sig(cx.tcx())),
467                    }
468                }
469                rustc_hir::InlineAsmOperand::SymStatic { path: _, def_id } => {
470                    if cx.tcx().is_thread_local_static(def_id) {
471                        GlobalAsmOperandRef::SymThreadLocalStatic { def_id }
472                    } else {
473                        GlobalAsmOperandRef::Const {
474                            value: Scalar::from_pointer(
475                                cx.tcx().reserve_and_set_static_alloc(def_id).into(),
476                                cx,
477                            ),
478                            ty: cx.tcx().static_ptr_ty(def_id, cx.typing_env()),
479                        }
480                    }
481                }
482                rustc_hir::InlineAsmOperand::In { .. }
483                | rustc_hir::InlineAsmOperand::Out { .. }
484                | rustc_hir::InlineAsmOperand::InOut { .. }
485                | rustc_hir::InlineAsmOperand::SplitInOut { .. }
486                | rustc_hir::InlineAsmOperand::Label { .. } => {
487                    ::rustc_middle::util::bug::span_bug_fmt(*op_sp,
    format_args!("invalid operand type for global_asm!"))span_bug!(*op_sp, "invalid operand type for global_asm!")
488                }
489            })
490            .collect();
491
492        cx.codegen_global_asm(asm.template, &operands, asm.options, asm.line_spans);
493    } else {
494        ::rustc_middle::util::bug::span_bug_fmt(item.span,
    format_args!("Mismatch between hir::Item type and MonoItem type"))span_bug!(item.span, "Mismatch between hir::Item type and MonoItem type")
495    }
496}
497
498/// Creates the `main` function which will initialize the rust runtime and call
499/// users main function.
500pub fn maybe_create_entry_wrapper<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
501    cx: &'a Bx::CodegenCx,
502    cgu: &CodegenUnit<'tcx>,
503) -> Option<Bx::Function> {
504    let (main_def_id, entry_type) = cx.tcx().entry_fn(())?;
505    let main_is_local = main_def_id.is_local();
506    let instance = Instance::mono(cx.tcx(), main_def_id);
507
508    if main_is_local {
509        // We want to create the wrapper in the same codegen unit as Rust's main
510        // function.
511        if !cgu.contains_item(&MonoItem::Fn(instance)) {
512            return None;
513        }
514    } else if !cgu.is_primary() {
515        // We want to create the wrapper only when the codegen unit is the primary one
516        return None;
517    }
518
519    let main_llfn = cx.get_fn_addr(instance, cx.sess().pointer_authentication_functions());
520
521    let entry_fn = create_entry_fn::<Bx>(cx, main_llfn, main_def_id, entry_type);
522    return Some(entry_fn);
523
524    fn create_entry_fn<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
525        cx: &'a Bx::CodegenCx,
526        rust_main: Bx::Value,
527        rust_main_def_id: DefId,
528        entry_type: EntryFnType,
529    ) -> Bx::Function {
530        // The entry function is either `int main(void)` or `int main(int argc, char **argv)`, or
531        // `usize efi_main(void *handle, void *system_table)` depending on the target.
532        let llfty = if cx.sess().target.os == Os::Uefi {
533            cx.type_func(&[cx.type_ptr(), cx.type_ptr()], cx.type_isize())
534        } else if cx.sess().target.main_needs_argc_argv {
535            cx.type_func(&[cx.type_int(), cx.type_ptr()], cx.type_int())
536        } else {
537            cx.type_func(&[], cx.type_int())
538        };
539
540        let main_ret_ty = cx.tcx().fn_sig(rust_main_def_id).no_bound_vars().unwrap().output();
541        // Given that `main()` has no arguments,
542        // then its return type cannot have
543        // late-bound regions, since late-bound
544        // regions must appear in the argument
545        // listing.
546        let main_ret_ty = cx.tcx().normalize_erasing_regions(
547            cx.typing_env(),
548            Unnormalized::new_wip(main_ret_ty.no_bound_vars().unwrap()),
549        );
550
551        let Some(llfn) = cx.declare_c_main(llfty) else {
552            // FIXME: We should be smart and show a better diagnostic here.
553            let span = cx.tcx().def_span(rust_main_def_id);
554            cx.tcx().dcx().emit_fatal(diagnostics::MultipleMainFunctions { span });
555        };
556
557        // `main` should respect same config for frame pointer elimination as rest of code
558        cx.set_frame_pointer_type(llfn);
559        cx.apply_target_cpu_attr(llfn);
560
561        let llbb = Bx::append_block(cx, llfn, "top");
562        let mut bx = Bx::build(cx, llbb);
563
564        bx.insert_reference_to_gdb_debug_scripts_section_global();
565
566        let isize_ty = cx.type_isize();
567        let ptr_ty = cx.type_ptr();
568        let (arg_argc, arg_argv) = get_argc_argv(&mut bx);
569
570        let EntryFnType::Main { sigpipe } = entry_type;
571        let (start_fn, start_ty, args, instance) = {
572            let start_def_id = cx.tcx().require_lang_item(LangItem::Start, DUMMY_SP);
573            let start_instance = ty::Instance::expect_resolve(
574                cx.tcx(),
575                cx.typing_env(),
576                start_def_id,
577                cx.tcx().mk_args(&[main_ret_ty.into()]),
578                DUMMY_SP,
579            );
580            let start_fn =
581                cx.get_fn_addr(start_instance, cx.sess().pointer_authentication_functions());
582
583            let i8_ty = cx.type_i8();
584            let arg_sigpipe = bx.const_u8(sigpipe);
585
586            let start_ty = cx.type_func(&[cx.val_ty(rust_main), isize_ty, ptr_ty, i8_ty], isize_ty);
587            (
588                start_fn,
589                start_ty,
590                ::alloc::boxed::box_assume_init_into_vec_unsafe(::alloc::intrinsics::write_box_via_move(::alloc::boxed::Box::new_uninit(),
        [rust_main, arg_argc, arg_argv, arg_sigpipe]))vec![rust_main, arg_argc, arg_argv, arg_sigpipe],
591                Some(start_instance),
592            )
593        };
594
595        let result = bx.call(start_ty, None, None, start_fn, &args, None, instance);
596        if cx.sess().target.os == Os::Uefi {
597            bx.ret(result);
598        } else {
599            let cast = bx.intcast(result, cx.type_int(), true);
600            bx.ret(cast);
601        }
602
603        llfn
604    }
605}
606
607/// Obtain the `argc` and `argv` values to pass to the rust start function
608/// (i.e., the "start" lang item).
609fn get_argc_argv<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(bx: &mut Bx) -> (Bx::Value, Bx::Value) {
610    if bx.cx().sess().target.os == Os::Uefi {
611        // Params for UEFI
612        let param_handle = bx.get_param(0);
613        let param_system_table = bx.get_param(1);
614        let ptr_size = bx.tcx().data_layout.pointer_size();
615        let ptr_align = bx.tcx().data_layout.pointer_align().abi;
616        let arg_argc = bx.const_int(bx.cx().type_isize(), 2);
617        let arg_argv = bx.alloca(2 * ptr_size, ptr_align);
618        bx.store(param_handle, arg_argv, ptr_align);
619        let arg_argv_el1 = bx.inbounds_ptradd(arg_argv, bx.const_usize(ptr_size.bytes()));
620        bx.store(param_system_table, arg_argv_el1, ptr_align);
621        (arg_argc, arg_argv)
622    } else if bx.cx().sess().target.main_needs_argc_argv {
623        // Params from native `main()` used as args for rust start function
624        let param_argc = bx.get_param(0);
625        let param_argv = bx.get_param(1);
626        let arg_argc = bx.intcast(param_argc, bx.cx().type_isize(), true);
627        let arg_argv = param_argv;
628        (arg_argc, arg_argv)
629    } else {
630        // The Rust start function doesn't need `argc` and `argv`, so just pass zeros.
631        let arg_argc = bx.const_int(bx.cx().type_int(), 0);
632        let arg_argv = bx.const_null(bx.cx().type_ptr());
633        (arg_argc, arg_argv)
634    }
635}
636
637/// This function returns all of the debugger visualizers specified for the
638/// current crate as well as all upstream crates transitively that match the
639/// `visualizer_type` specified.
640pub fn collect_debugger_visualizers_transitive(
641    tcx: TyCtxt<'_>,
642    visualizer_type: DebuggerVisualizerType,
643) -> BTreeSet<DebuggerVisualizerFile> {
644    tcx.debugger_visualizers(LOCAL_CRATE)
645        .iter()
646        .chain(
647            tcx.crates(())
648                .iter()
649                .filter(|&cnum| {
650                    let used_crate_source = tcx.used_crate_source(*cnum);
651                    used_crate_source.rlib.is_some() || used_crate_source.rmeta.is_some()
652                })
653                .flat_map(|&cnum| tcx.debugger_visualizers(cnum)),
654        )
655        .filter(|visualizer| visualizer.visualizer_type == visualizer_type)
656        .cloned()
657        .collect::<BTreeSet<_>>()
658}
659
660/// Decide allocator kind to codegen. If `Some(_)` this will be the same as
661/// `tcx.allocator_kind`, but it may be `None` in more cases (e.g. if using
662/// allocator definitions from a dylib dependency).
663pub fn allocator_kind_for_codegen(tcx: TyCtxt<'_>) -> Option<AllocatorKind> {
664    // If the crate doesn't have an `allocator_kind` set then there's definitely
665    // no shim to generate. Otherwise we also check our dependency graph for all
666    // our output crate types. If anything there looks like its a `Dynamic`
667    // linkage for all crate types we may link as, then it's already got an
668    // allocator shim and we'll be using that one instead. If nothing exists
669    // then it's our job to generate the allocator! If crate types disagree
670    // about whether an allocator shim is necessary or not, we generate one
671    // and let needs_allocator_shim_for_linking decide at link time whether or
672    // not to use it for any particular linker invocation.
673    let all_crate_types_any_dynamic_crate = tcx.dependency_formats(()).iter().all(|(_, list)| {
674        use rustc_middle::middle::dependency_format::Linkage;
675        list.iter().any(|&linkage| linkage == Linkage::Dynamic)
676    });
677    if all_crate_types_any_dynamic_crate { None } else { tcx.allocator_kind(()) }
678}
679
680/// Decide if this particular crate type needs an allocator shim linked in.
681/// This may return true even when allocator_kind_for_codegen returns false. In
682/// this case no allocator shim shall be linked.
683pub(crate) fn needs_allocator_shim_for_linking(
684    dependency_formats: &Dependencies,
685    crate_type: CrateType,
686) -> bool {
687    use rustc_middle::middle::dependency_format::Linkage;
688    let any_dynamic_crate =
689        dependency_formats[&crate_type].iter().any(|&linkage| linkage == Linkage::Dynamic);
690    !any_dynamic_crate
691}
692
693pub fn allocator_shim_contents(tcx: TyCtxt<'_>, kind: AllocatorKind) -> Vec<AllocatorMethod> {
694    let mut methods = Vec::new();
695
696    if kind == AllocatorKind::Default {
697        methods.extend(ALLOCATOR_METHODS.into_iter().copied());
698    }
699
700    // If the return value of allocator_kind_for_codegen is Some then
701    // alloc_error_handler_kind must also be Some.
702    if tcx.alloc_error_handler_kind(()).unwrap() == AllocatorKind::Default {
703        methods.push(AllocatorMethod {
704            name: ALLOC_ERROR_HANDLER,
705            special: None,
706            inputs: &[AllocatorMethodInput { name: "layout", ty: AllocatorTy::Layout }],
707            output: AllocatorTy::Never,
708        });
709    }
710
711    methods
712}
713
714pub fn codegen_crate<
715    B: ExtraBackendMethods<Module = M> + WriteBackendMethods<Module = M>,
716    M: Send,
717>(
718    backend: B,
719    tcx: TyCtxt<'_>,
720) -> OngoingCodegen<B> {
721    if tcx.sess.target.need_explicit_cpu && tcx.sess.opts.cg.target_cpu.is_none() {
722        // The target has no default cpu, but none is set explicitly
723        tcx.dcx().emit_fatal(diagnostics::CpuRequired);
724    }
725
726    if let Some(target_cpu) = &tcx.sess.opts.cg.target_cpu
727        && tcx.sess.target.unsupported_cpus.contains(&target_cpu.into())
728    {
729        // The target cpu is explicitly listed as an unsupported cpu
730        tcx.dcx().emit_fatal(diagnostics::CpuUnsupported { target_cpu: target_cpu.clone() });
731    }
732
733    let cgu_name_builder = &mut CodegenUnitNameBuilder::new(tcx);
734
735    // Run the monomorphization collector and partition the collected items into
736    // codegen units.
737    let MonoItemPartitions { codegen_units, .. } = tcx.collect_and_partition_mono_items(());
738
739    // Force all codegen_unit queries so they are already either red or green
740    // when compile_codegen_unit accesses them. We are not able to re-execute
741    // the codegen_unit query from just the DepNode, so an unknown color would
742    // lead to having to re-execute compile_codegen_unit, possibly
743    // unnecessarily.
744    if tcx.dep_graph.is_fully_enabled() {
745        for cgu in codegen_units {
746            tcx.ensure_ok().codegen_unit(cgu.name());
747        }
748    }
749
750    // Codegen an allocator shim, if necessary.
751    let allocator_module = if let Some(kind) = allocator_kind_for_codegen(tcx) {
752        let llmod_id =
753            cgu_name_builder.build_cgu_name(LOCAL_CRATE, &["crate"], Some("allocator")).to_string();
754
755        tcx.sess.time("write_allocator_module", || {
756            let module =
757                backend.codegen_allocator(tcx, &llmod_id, &allocator_shim_contents(tcx, kind));
758            Some(ModuleCodegen::new_allocator(llmod_id, module))
759        })
760    } else {
761        None
762    };
763
764    let ongoing_codegen = start_async_codegen(backend.clone(), tcx, allocator_module);
765
766    // For better throughput during parallel processing by LLVM, we used to sort
767    // CGUs largest to smallest. This would lead to better thread utilization
768    // by, for example, preventing a large CGU from being processed last and
769    // having only one LLVM thread working while the rest remained idle.
770    //
771    // However, this strategy would lead to high memory usage, as it meant the
772    // LLVM-IR for all of the largest CGUs would be resident in memory at once.
773    //
774    // Instead, we can compromise by ordering CGUs such that the largest and
775    // smallest are first, second largest and smallest are next, etc. If there
776    // are large size variations, this can reduce memory usage significantly.
777    let codegen_units: Vec<_> = {
778        let mut sorted_cgus = codegen_units.iter().collect::<Vec<_>>();
779        sorted_cgus.sort_by_key(|cgu| cmp::Reverse(cgu.size_estimate()));
780
781        let (first_half, second_half) = sorted_cgus.split_at(sorted_cgus.len() / 2);
782        first_half.iter().interleave(second_half.iter().rev()).copied().collect()
783    };
784
785    // Calculate the CGU reuse
786    let cgu_reuse = tcx.sess.time("find_cgu_reuse", || {
787        codegen_units.iter().map(|cgu| determine_cgu_reuse(tcx, cgu)).collect::<Vec<_>>()
788    });
789
790    crate::assert_module_sources::assert_module_sources(tcx, &|cgu_reuse_tracker| {
791        for (i, cgu) in codegen_units.iter().enumerate() {
792            let cgu_reuse = cgu_reuse[i];
793            cgu_reuse_tracker.set_actual_reuse(cgu.name().as_str(), cgu_reuse);
794        }
795    });
796
797    let mut total_codegen_time = Duration::new(0, 0);
798    let start_rss = tcx.sess.opts.unstable_opts.time_passes.then(|| get_resident_set_size());
799
800    // The non-parallel compiler can only translate codegen units to LLVM IR
801    // on a single thread, leading to a staircase effect where the N LLVM
802    // threads have to wait on the single codegen threads to generate work
803    // for them. The parallel compiler does not have this restriction, so
804    // we can pre-load the LLVM queue in parallel before handing off
805    // coordination to the OnGoingCodegen scheduler.
806    //
807    // This likely is a temporary measure. Once we don't have to support the
808    // non-parallel compiler anymore, we can compile CGUs end-to-end in
809    // parallel and get rid of the complicated scheduling logic.
810    let mut pre_compiled_cgus = if let Some(threads) = tcx.sess.threads() {
811        tcx.sess.time("compile_first_CGU_batch", || {
812            // Try to find one CGU to compile per thread.
813            let cgus: Vec<_> = cgu_reuse
814                .iter()
815                .enumerate()
816                .filter(|&(_, reuse)| reuse == &CguReuse::No)
817                .take(threads)
818                .collect();
819
820            // Compile the found CGUs in parallel.
821            let start_time = Instant::now();
822
823            let pre_compiled_cgus = par_map(cgus, |(i, _)| {
824                let module = backend.compile_codegen_unit(tcx, codegen_units[i].name());
825                (i, IntoDynSyncSend(module))
826            });
827
828            total_codegen_time += start_time.elapsed();
829
830            pre_compiled_cgus
831        })
832    } else {
833        FxHashMap::default()
834    };
835
836    for (i, cgu) in codegen_units.iter().enumerate() {
837        ongoing_codegen.wait_for_signal_to_codegen_item();
838        ongoing_codegen.check_for_errors(tcx.sess);
839
840        let cgu_reuse = cgu_reuse[i];
841
842        match cgu_reuse {
843            CguReuse::No => {
844                let (module, cost) = if let Some(cgu) = pre_compiled_cgus.remove(&i) {
845                    cgu.0
846                } else {
847                    let start_time = Instant::now();
848                    let module = backend.compile_codegen_unit(tcx, cgu.name());
849                    total_codegen_time += start_time.elapsed();
850                    module
851                };
852                // This will unwind if there are errors, which triggers our `AbortCodegenOnDrop`
853                // guard. Unfortunately, just skipping the `submit_codegened_module_to_llvm` makes
854                // compilation hang on post-monomorphization errors.
855                tcx.dcx().abort_if_errors();
856
857                submit_codegened_module_to_llvm(&ongoing_codegen.coordinator, module, cost);
858            }
859            CguReuse::PreLto => {
860                submit_pre_lto_module_to_llvm(
861                    tcx,
862                    &ongoing_codegen.coordinator,
863                    CachedModuleCodegen {
864                        name: cgu.name().to_string(),
865                        source: cgu.previous_work_product(tcx),
866                    },
867                );
868            }
869            CguReuse::PostLto => {
870                submit_post_lto_module_to_llvm(
871                    &ongoing_codegen.coordinator,
872                    CachedModuleCodegen {
873                        name: cgu.name().to_string(),
874                        source: cgu.previous_work_product(tcx),
875                    },
876                );
877            }
878        }
879    }
880
881    ongoing_codegen.codegen_finished(tcx);
882
883    // Since the main thread is sometimes blocked during codegen, we keep track
884    // -Ztime-passes output manually.
885    if tcx.sess.opts.unstable_opts.time_passes {
886        let end_rss = get_resident_set_size();
887
888        print_time_passes_entry(
889            "codegen_to_LLVM_IR",
890            total_codegen_time,
891            start_rss.unwrap(),
892            end_rss,
893            tcx.sess.opts.unstable_opts.time_passes_format,
894        );
895    }
896
897    ongoing_codegen.check_for_errors(tcx.sess);
898    ongoing_codegen
899}
900
901/// Returns whether a call from the current crate to the [`Instance`] would produce a call
902/// from `compiler_builtins` to a symbol the linker must resolve.
903///
904/// Such calls from `compiler_builtins` are effectively impossible for the linker to handle. Some
905/// linkers will optimize such that dead calls to unresolved symbols are not an error, but this is
906/// not guaranteed. So we use this function in codegen backends to ensure we do not generate any
907/// unlinkable calls.
908///
909/// Note that calls to LLVM intrinsics are uniquely okay because they won't make it to the linker.
910/// Note also that calls to foreign items that are actually exported by the local crate are also
911/// okay. This situation arises because compiler-builtins calls functions in core that are
912/// `#[inline]` wrappers for `extern "C"` declarations in core, which resolve to a symbol exported
913/// by compiler-builtins.
914pub fn is_call_from_compiler_builtins_to_upstream_monomorphization<'tcx>(
915    tcx: TyCtxt<'tcx>,
916    instance: Instance<'tcx>,
917) -> bool {
918    if let ty::InstanceKind::LlvmIntrinsic(_) = instance.def {
919        return false;
920    }
921
922    fn is_extern_call_to_local_crate<'tcx>(tcx: TyCtxt<'tcx>, instance: Instance<'tcx>) -> bool {
923        tcx.is_foreign_item(instance.def_id())
924            && tcx.exported_non_generic_symbols(LOCAL_CRATE).iter().any(|(sym, _info)| {
925                sym.symbol_name_for_local_instance(tcx) == tcx.symbol_name(instance)
926            })
927    }
928
929    let def_id = instance.def_id();
930    !def_id.is_local()
931        && tcx.is_compiler_builtins(LOCAL_CRATE)
932        && !tcx.should_codegen_locally(instance)
933        && !is_extern_call_to_local_crate(tcx, instance)
934}
935
936fn collect_eii_linkage(tcx: TyCtxt<'_>) -> Vec<EiiLinkageInfo> {
937    #[derive(#[automatically_derived]
impl ::core::fmt::Debug for FoundImpl {
    #[inline]
    fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
        ::core::fmt::Formatter::debug_struct_field2_finish(f, "FoundImpl",
            "imp", &self.imp, "impl_crate", &&self.impl_crate)
    }
}Debug)]
938    struct FoundImpl {
939        imp: EiiImpl,
940        impl_crate: CrateNum,
941    }
942
943    #[derive(#[automatically_derived]
impl ::core::fmt::Debug for FoundEii {
    #[inline]
    fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
        ::core::fmt::Formatter::debug_struct_field2_finish(f, "FoundEii",
            "decl", &self.decl, "impls", &&self.impls)
    }
}Debug)]
944    struct FoundEii {
945        decl: EiiDecl,
946        impls: FxIndexMap<DefId, FoundImpl>,
947    }
948
949    let mut eiis = FxIndexMap::<DefId, FoundEii>::default();
950
951    for &cnum in tcx.crates(()).iter().chain(iter::once(&LOCAL_CRATE)) {
952        for (&did, &(decl, ref impls)) in tcx.externally_implementable_items(cnum) {
953            eiis.entry(did)
954                .or_insert_with(|| FoundEii { decl, impls: Default::default() })
955                .impls
956                .extend(
957                    impls
958                        .into_iter()
959                        .map(|(&did, &imp)| (did, FoundImpl { imp, impl_crate: cnum })),
960                );
961        }
962    }
963
964    eiis.into_iter()
965        .filter_map(|(_, FoundEii { decl, impls })| {
966            let mut explicit_impls = Vec::new();
967            let mut default_impl = None;
968
969            for (impl_did, FoundImpl { imp, impl_crate }) in impls {
970                let impl_info = EiiLinkageImplInfo { span: tcx.def_span(impl_did), impl_crate };
971                if imp.is_default {
972                    default_impl = Some(impl_info);
973                } else {
974                    explicit_impls.push(impl_info);
975                }
976            }
977
978            // Link time check is only needed when there may be a default impl in a dylib.
979            // Other cases emit an error in `rustc_passes` already.
980            if let Some(default_impl) = default_impl {
981                Some(EiiLinkageInfo {
982                    name: decl.name.name,
983                    impls: explicit_impls,
984                    default_impl: Some(default_impl),
985                })
986            } else {
987                None
988            }
989        })
990        .collect()
991}
992
993fn eii_linkage_needed(dependency_formats: &Dependencies) -> bool {
994    dependency_formats.values().any(|formats| {
995        formats
996            .iter()
997            .any(|&linkage| #[allow(non_exhaustive_omitted_patterns)] match linkage {
    Linkage::Dynamic | Linkage::IncludedFromDylib => true,
    _ => false,
}matches!(linkage, Linkage::Dynamic | Linkage::IncludedFromDylib))
998    })
999}
1000
1001impl CrateInfo {
1002    pub fn new(tcx: TyCtxt<'_>, target_cpu: String) -> CrateInfo {
1003        let crate_types = tcx.crate_types().to_vec();
1004        let exported_symbols = crate_types
1005            .iter()
1006            .map(|&c| (c, crate::back::linker::exported_symbols(tcx, c)))
1007            .collect();
1008        let linked_symbols =
1009            crate_types.iter().map(|&c| (c, crate::back::linker::linked_symbols(tcx, c))).collect();
1010        let local_crate_name = tcx.crate_name(LOCAL_CRATE);
1011        let windows_subsystem = {
    'done:
        {
        for i in tcx.hir_krate_attrs() {
            #[allow(unused_imports)]
            use rustc_hir::attrs::AttributeKind::*;
            let i: &rustc_hir::Attribute = i;
            match i {
                rustc_hir::Attribute::Parsed(WindowsSubsystem(kind)) => {
                    break 'done Some(*kind);
                }
                rustc_hir::Attribute::Unparsed(..) =>
                    {}
                    #[deny(unreachable_patterns)]
                    _ => {}
            }
        }
        None
    }
}find_attr!(tcx, crate, WindowsSubsystem(kind) => *kind);
1012        let dependency_formats = Arc::clone(tcx.dependency_formats(()));
1013        let eii_linkage = if eii_linkage_needed(&dependency_formats) {
1014            collect_eii_linkage(tcx)
1015        } else {
1016            Vec::new()
1017        };
1018
1019        // This list is used when generating the command line to pass through to
1020        // system linker. The linker expects undefined symbols on the left of the
1021        // command line to be defined in libraries on the right, not the other way
1022        // around. For more info, see some comments in the add_used_library function
1023        // below.
1024        //
1025        // In order to get this left-to-right dependency ordering, we use the reverse
1026        // postorder of all crates putting the leaves at the rightmost positions.
1027        let mut compiler_builtins = None;
1028        let mut used_crates: Vec<_> = tcx
1029            .postorder_cnums(())
1030            .iter()
1031            .rev()
1032            .copied()
1033            .filter(|&cnum| {
1034                let link = !tcx.crate_dep_kind(cnum).macros_only();
1035                if link && tcx.is_compiler_builtins(cnum) {
1036                    compiler_builtins = Some(cnum);
1037                    return false;
1038                }
1039                link
1040            })
1041            .collect();
1042        // `compiler_builtins` are always placed last to ensure that they're linked correctly.
1043        used_crates.extend(compiler_builtins);
1044
1045        let crates = tcx.crates(());
1046        let n_crates = crates.len();
1047        let mut info = CrateInfo {
1048            target_cpu,
1049            target_features: tcx.global_backend_features(()).clone(),
1050            crate_types,
1051            exported_symbols,
1052            linked_symbols,
1053            local_crate_name,
1054            compiler_builtins,
1055            profiler_runtime: None,
1056            is_no_builtins: Default::default(),
1057            native_libraries: Default::default(),
1058            used_libraries: tcx.native_libraries(LOCAL_CRATE).iter().map(Into::into).collect(),
1059            crate_name: UnordMap::with_capacity(n_crates),
1060            used_crates,
1061            used_crate_source: UnordMap::with_capacity(n_crates),
1062            dependency_formats,
1063            eii_linkage,
1064            windows_subsystem,
1065            natvis_debugger_visualizers: Default::default(),
1066            lint_level_specs: CodegenLintLevelSpecs::from_tcx(tcx),
1067            metadata_symbol: exported_symbols::metadata_symbol_name(tcx),
1068            symbol_rename_suffix: ::alloc::__export::must_use({
        ::alloc::fmt::format(format_args!(".rs{0:x}",
                tcx.stable_crate_id(LOCAL_CRATE)))
    })format!(".rs{:x}", tcx.stable_crate_id(LOCAL_CRATE)),
1069            each_linked_rlib_file_for_lto: Default::default(),
1070            exported_symbols_for_lto: Default::default(),
1071        };
1072
1073        info.native_libraries.reserve(n_crates);
1074
1075        for &cnum in crates.iter() {
1076            info.native_libraries
1077                .insert(cnum, tcx.native_libraries(cnum).iter().map(Into::into).collect());
1078            info.crate_name.insert(cnum, tcx.crate_name(cnum));
1079
1080            let used_crate_source = tcx.used_crate_source(cnum);
1081            info.used_crate_source.insert(cnum, Arc::clone(used_crate_source));
1082            if tcx.is_profiler_runtime(cnum) {
1083                info.profiler_runtime = Some(cnum);
1084            }
1085            if tcx.is_no_builtins(cnum) {
1086                info.is_no_builtins.insert(cnum);
1087            }
1088        }
1089
1090        // Handle circular dependencies in the standard library.
1091        // See comment before `add_linked_symbol_object` function for the details.
1092        // If global LTO is enabled then almost everything (*) is glued into a single object file,
1093        // so this logic is not necessary and can cause issues on some targets (due to weak lang
1094        // item symbols being "privatized" to that object file), so we disable it.
1095        // (*) Native libs, and `#[compiler_builtins]` and `#[no_builtins]` crates are not glued,
1096        // and we assume that they cannot define weak lang items. This is not currently enforced
1097        // by the compiler, but that's ok because all this stuff is unstable anyway.
1098        let target = &tcx.sess.target;
1099        if !are_upstream_rust_objects_already_included(tcx.sess) {
1100            let add_prefix = match (target.is_like_windows, &target.arch) {
1101                (true, Arch::X86) => |name: String, _: SymbolExportKind| ::alloc::__export::must_use({
        ::alloc::fmt::format(format_args!("_{0}", name))
    })format!("_{name}"),
1102                (true, Arch::Arm64EC) => {
1103                    // Only functions are decorated for arm64ec.
1104                    |name: String, export_kind: SymbolExportKind| match export_kind {
1105                        SymbolExportKind::Text => ::alloc::__export::must_use({
        ::alloc::fmt::format(format_args!("#{0}", name))
    })format!("#{name}"),
1106                        _ => name,
1107                    }
1108                }
1109                _ => |name: String, _: SymbolExportKind| name,
1110            };
1111            let missing_weak_lang_items: FxIndexSet<(Symbol, SymbolExportKind)> = info
1112                .used_crates
1113                .iter()
1114                .flat_map(|&cnum| tcx.missing_lang_items(cnum))
1115                .filter(|l| l.is_weak())
1116                .filter_map(|&l| {
1117                    let name = l.link_name()?;
1118                    let export_kind = match l.target() {
1119                        Target::ForeignFn | Target::Fn => SymbolExportKind::Text,
1120                        Target::Static => SymbolExportKind::Data,
1121                        _ => ::rustc_middle::util::bug::bug_fmt(format_args!("Don\'t know what the export kind is for lang item of kind {0:?}",
        l.target()))bug!(
1122                            "Don't know what the export kind is for lang item of kind {:?}",
1123                            l.target()
1124                        ),
1125                    };
1126                    lang_items::required(tcx, l).then_some((name, export_kind))
1127                })
1128                .collect();
1129
1130            // This loop only adds new items to values of the hash map, so the order in which we
1131            // iterate over the values is not important.
1132            #[allow(rustc::potential_query_instability)]
1133            info.linked_symbols
1134                .iter_mut()
1135                .filter(|(crate_type, _)| {
1136                    !#[allow(non_exhaustive_omitted_patterns)] match crate_type {
    CrateType::Rlib | CrateType::StaticLib => true,
    _ => false,
}matches!(crate_type, CrateType::Rlib | CrateType::StaticLib)
1137                })
1138                .for_each(|(_, linked_symbols)| {
1139                    let mut symbols = missing_weak_lang_items
1140                        .iter()
1141                        .map(|(item, export_kind)| {
1142                            (
1143                                add_prefix(
1144                                    mangle_internal_symbol(tcx, item.as_str()),
1145                                    *export_kind,
1146                                ),
1147                                *export_kind,
1148                            )
1149                        })
1150                        .collect::<Vec<_>>();
1151                    symbols.sort_unstable_by(|a, b| a.0.cmp(&b.0));
1152                    linked_symbols.extend(symbols);
1153                });
1154        }
1155
1156        let mut each_linked_rlib_for_lto = Vec::new();
1157        let mut each_linked_rlib_file_for_lto = Vec::new();
1158        if tcx.sess.lto() != config::Lto::No && tcx.sess.lto() != config::Lto::ThinLocal {
1159            drop(crate::back::link::each_linked_rlib(&info, None, &mut |cnum, path| {
1160                if crate::back::link::ignored_for_lto(tcx.sess, &info, cnum) {
1161                    return;
1162                }
1163
1164                each_linked_rlib_for_lto.push(cnum);
1165                each_linked_rlib_file_for_lto.push(path.to_path_buf());
1166            }));
1167        }
1168        info.each_linked_rlib_file_for_lto = each_linked_rlib_file_for_lto;
1169
1170        // FIXME move to -Zlink-only half such that each_linked_rlib_file_for_lto can be moved there too
1171        // Compute the set of symbols we need to retain when doing LTO (if we need to)
1172        info.exported_symbols_for_lto =
1173            crate::back::lto::exported_symbols_for_lto(tcx, &each_linked_rlib_for_lto);
1174
1175        let embed_visualizers = tcx.crate_types().iter().any(|&crate_type| match crate_type {
1176            CrateType::Executable | CrateType::Dylib | CrateType::Cdylib | CrateType::Sdylib => {
1177                // These are crate types for which we invoke the linker and can embed
1178                // NatVis visualizers.
1179                true
1180            }
1181            CrateType::ProcMacro => {
1182                // We could embed NatVis for proc macro crates too (to improve the debugging
1183                // experience for them) but it does not seem like a good default, since
1184                // this is a rare use case and we don't want to slow down the common case.
1185                false
1186            }
1187            CrateType::StaticLib | CrateType::Rlib => {
1188                // We don't invoke the linker for these, so we don't need to collect the NatVis for
1189                // them.
1190                false
1191            }
1192        });
1193
1194        if target.is_like_msvc && embed_visualizers {
1195            info.natvis_debugger_visualizers =
1196                collect_debugger_visualizers_transitive(tcx, DebuggerVisualizerType::Natvis);
1197        }
1198
1199        info
1200    }
1201}
1202
1203pub(crate) fn provide(providers: &mut Providers) {
1204    providers.backend_optimization_level = |tcx, cratenum| {
1205        let for_speed = match tcx.sess.opts.optimize {
1206            // If globally no optimisation is done, #[optimize] has no effect.
1207            //
1208            // This is done because if we ended up "upgrading" to `-O2` here, we’d populate the
1209            // pass manager and it is likely that some module-wide passes (such as inliner or
1210            // cross-function constant propagation) would ignore the `optnone` annotation we put
1211            // on the functions, thus necessarily involving these functions into optimisations.
1212            config::OptLevel::No => return config::OptLevel::No,
1213            // If globally optimise-speed is already specified, just use that level.
1214            config::OptLevel::Less => return config::OptLevel::Less,
1215            config::OptLevel::More => return config::OptLevel::More,
1216            config::OptLevel::Aggressive => return config::OptLevel::Aggressive,
1217            // If globally optimize-for-size has been requested, use -O2 instead (if optimize(size)
1218            // are present).
1219            config::OptLevel::Size => config::OptLevel::More,
1220            config::OptLevel::SizeMin => config::OptLevel::More,
1221        };
1222
1223        let defids = tcx.collect_and_partition_mono_items(cratenum).all_mono_items;
1224
1225        let any_for_speed = defids.items().any(|id| {
1226            let CodegenFnAttrs { optimize, .. } = tcx.codegen_fn_attrs(*id);
1227            #[allow(non_exhaustive_omitted_patterns)] match optimize {
    OptimizeAttr::Speed => true,
    _ => false,
}matches!(optimize, OptimizeAttr::Speed)
1228        });
1229
1230        if any_for_speed {
1231            return for_speed;
1232        }
1233
1234        tcx.sess.opts.optimize
1235    };
1236}
1237
1238pub fn determine_cgu_reuse<'tcx>(tcx: TyCtxt<'tcx>, cgu: &CodegenUnit<'tcx>) -> CguReuse {
1239    if !tcx.dep_graph.is_fully_enabled()
1240        || tcx.sess.opts.unstable_opts.disable_incr_comp_backend_caching
1241    {
1242        return CguReuse::No;
1243    }
1244
1245    let work_product_id = &cgu.work_product_id();
1246    if tcx.dep_graph.previous_work_product(work_product_id).is_none() {
1247        // We don't have anything cached for this CGU. This can happen
1248        // if the CGU did not exist in the previous session.
1249        return CguReuse::No;
1250    }
1251
1252    // Try to mark the CGU as green. If it we can do so, it means that nothing
1253    // affecting the LLVM module has changed and we can re-use a cached version.
1254    // If we compile with any kind of LTO, this means we can re-use the bitcode
1255    // of the Pre-LTO stage (possibly also the Post-LTO version but we'll only
1256    // know that later). If we are not doing LTO, there is only one optimized
1257    // version of each module, so we re-use that.
1258    let dep_node = cgu.codegen_dep_node(tcx);
1259    tcx.dep_graph.assert_dep_node_not_yet_allocated_in_current_session(tcx.sess, &dep_node, || {
1260        ::alloc::__export::must_use({
        ::alloc::fmt::format(format_args!("CompileCodegenUnit dep-node for CGU `{0}` already exists before marking.",
                cgu.name()))
    })format!(
1261            "CompileCodegenUnit dep-node for CGU `{}` already exists before marking.",
1262            cgu.name()
1263        )
1264    });
1265
1266    if tcx.dep_graph.try_mark_green(tcx, &dep_node).is_some() {
1267        // We can re-use either the pre- or the post-thinlto state. If no LTO is
1268        // being performed then we can use post-LTO artifacts, otherwise we must
1269        // reuse pre-LTO artifacts
1270        match compute_per_cgu_lto_type(
1271            &tcx.sess.lto(),
1272            tcx.sess.opts.cg.linker_plugin_lto.enabled(),
1273            tcx.crate_types(),
1274        ) {
1275            ComputedLtoType::No => CguReuse::PostLto,
1276            _ => CguReuse::PreLto,
1277        }
1278    } else {
1279        CguReuse::No
1280    }
1281}