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::BinOp;
26use rustc_middle::mir::interpret::ErrorHandled;
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, 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 => ::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 string = common::asm_const_to_str(
423                                cx.tcx(),
424                                *op_sp,
425                                const_value,
426                                cx.layout_of(ty),
427                            );
428                            GlobalAsmOperandRef::Const { string }
429                        }
430                        Err(ErrorHandled::Reported { .. }) => {
431                            // An error has already been reported and
432                            // compilation is guaranteed to fail if execution
433                            // hits this path. So an empty string instead of
434                            // a stringified constant value will suffice.
435                            GlobalAsmOperandRef::Const { string: String::new() }
436                        }
437                        Err(ErrorHandled::TooGeneric(_)) => {
438                            ::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")
439                        }
440                    }
441                }
442                rustc_hir::InlineAsmOperand::SymFn { expr } => {
443                    let ty = cx.tcx().typeck(item_id.owner_id).expr_ty(expr);
444                    let instance = match ty.kind() {
445                        &ty::FnDef(def_id, args) => Instance::expect_resolve(
446                            cx.tcx(),
447                            ty::TypingEnv::fully_monomorphized(),
448                            def_id,
449                            args.no_bound_vars().unwrap(),
450                            expr.span,
451                        ),
452                        _ => ::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"),
453                    };
454
455                    GlobalAsmOperandRef::SymFn { instance }
456                }
457                rustc_hir::InlineAsmOperand::SymStatic { path: _, def_id } => {
458                    GlobalAsmOperandRef::SymStatic { def_id }
459                }
460                rustc_hir::InlineAsmOperand::In { .. }
461                | rustc_hir::InlineAsmOperand::Out { .. }
462                | rustc_hir::InlineAsmOperand::InOut { .. }
463                | rustc_hir::InlineAsmOperand::SplitInOut { .. }
464                | rustc_hir::InlineAsmOperand::Label { .. } => {
465                    ::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!")
466                }
467            })
468            .collect();
469
470        cx.codegen_global_asm(asm.template, &operands, asm.options, asm.line_spans);
471    } else {
472        ::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")
473    }
474}
475
476/// Creates the `main` function which will initialize the rust runtime and call
477/// users main function.
478pub fn maybe_create_entry_wrapper<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
479    cx: &'a Bx::CodegenCx,
480    cgu: &CodegenUnit<'tcx>,
481) -> Option<Bx::Function> {
482    let (main_def_id, entry_type) = cx.tcx().entry_fn(())?;
483    let main_is_local = main_def_id.is_local();
484    let instance = Instance::mono(cx.tcx(), main_def_id);
485
486    if main_is_local {
487        // We want to create the wrapper in the same codegen unit as Rust's main
488        // function.
489        if !cgu.contains_item(&MonoItem::Fn(instance)) {
490            return None;
491        }
492    } else if !cgu.is_primary() {
493        // We want to create the wrapper only when the codegen unit is the primary one
494        return None;
495    }
496
497    let main_llfn = cx.get_fn_addr(instance, cx.sess().pointer_authentication_functions());
498
499    let entry_fn = create_entry_fn::<Bx>(cx, main_llfn, main_def_id, entry_type);
500    return Some(entry_fn);
501
502    fn create_entry_fn<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
503        cx: &'a Bx::CodegenCx,
504        rust_main: Bx::Value,
505        rust_main_def_id: DefId,
506        entry_type: EntryFnType,
507    ) -> Bx::Function {
508        // The entry function is either `int main(void)` or `int main(int argc, char **argv)`, or
509        // `usize efi_main(void *handle, void *system_table)` depending on the target.
510        let llfty = if cx.sess().target.os == Os::Uefi {
511            cx.type_func(&[cx.type_ptr(), cx.type_ptr()], cx.type_isize())
512        } else if cx.sess().target.main_needs_argc_argv {
513            cx.type_func(&[cx.type_int(), cx.type_ptr()], cx.type_int())
514        } else {
515            cx.type_func(&[], cx.type_int())
516        };
517
518        let main_ret_ty = cx.tcx().fn_sig(rust_main_def_id).no_bound_vars().unwrap().output();
519        // Given that `main()` has no arguments,
520        // then its return type cannot have
521        // late-bound regions, since late-bound
522        // regions must appear in the argument
523        // listing.
524        let main_ret_ty = cx.tcx().normalize_erasing_regions(
525            cx.typing_env(),
526            Unnormalized::new_wip(main_ret_ty.no_bound_vars().unwrap()),
527        );
528
529        let Some(llfn) = cx.declare_c_main(llfty) else {
530            // FIXME: We should be smart and show a better diagnostic here.
531            let span = cx.tcx().def_span(rust_main_def_id);
532            cx.tcx().dcx().emit_fatal(diagnostics::MultipleMainFunctions { span });
533        };
534
535        // `main` should respect same config for frame pointer elimination as rest of code
536        cx.set_frame_pointer_type(llfn);
537        cx.apply_target_cpu_attr(llfn);
538
539        let llbb = Bx::append_block(cx, llfn, "top");
540        let mut bx = Bx::build(cx, llbb);
541
542        bx.insert_reference_to_gdb_debug_scripts_section_global();
543
544        let isize_ty = cx.type_isize();
545        let ptr_ty = cx.type_ptr();
546        let (arg_argc, arg_argv) = get_argc_argv(&mut bx);
547
548        let EntryFnType::Main { sigpipe } = entry_type;
549        let (start_fn, start_ty, args, instance) = {
550            let start_def_id = cx.tcx().require_lang_item(LangItem::Start, DUMMY_SP);
551            let start_instance = ty::Instance::expect_resolve(
552                cx.tcx(),
553                cx.typing_env(),
554                start_def_id,
555                cx.tcx().mk_args(&[main_ret_ty.into()]),
556                DUMMY_SP,
557            );
558            let start_fn =
559                cx.get_fn_addr(start_instance, cx.sess().pointer_authentication_functions());
560
561            let i8_ty = cx.type_i8();
562            let arg_sigpipe = bx.const_u8(sigpipe);
563
564            let start_ty = cx.type_func(&[cx.val_ty(rust_main), isize_ty, ptr_ty, i8_ty], isize_ty);
565            (
566                start_fn,
567                start_ty,
568                ::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],
569                Some(start_instance),
570            )
571        };
572
573        let result = bx.call(start_ty, None, None, start_fn, &args, None, instance);
574        if cx.sess().target.os == Os::Uefi {
575            bx.ret(result);
576        } else {
577            let cast = bx.intcast(result, cx.type_int(), true);
578            bx.ret(cast);
579        }
580
581        llfn
582    }
583}
584
585/// Obtain the `argc` and `argv` values to pass to the rust start function
586/// (i.e., the "start" lang item).
587fn get_argc_argv<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(bx: &mut Bx) -> (Bx::Value, Bx::Value) {
588    if bx.cx().sess().target.os == Os::Uefi {
589        // Params for UEFI
590        let param_handle = bx.get_param(0);
591        let param_system_table = bx.get_param(1);
592        let ptr_size = bx.tcx().data_layout.pointer_size();
593        let ptr_align = bx.tcx().data_layout.pointer_align().abi;
594        let arg_argc = bx.const_int(bx.cx().type_isize(), 2);
595        let arg_argv = bx.alloca(2 * ptr_size, ptr_align);
596        bx.store(param_handle, arg_argv, ptr_align);
597        let arg_argv_el1 = bx.inbounds_ptradd(arg_argv, bx.const_usize(ptr_size.bytes()));
598        bx.store(param_system_table, arg_argv_el1, ptr_align);
599        (arg_argc, arg_argv)
600    } else if bx.cx().sess().target.main_needs_argc_argv {
601        // Params from native `main()` used as args for rust start function
602        let param_argc = bx.get_param(0);
603        let param_argv = bx.get_param(1);
604        let arg_argc = bx.intcast(param_argc, bx.cx().type_isize(), true);
605        let arg_argv = param_argv;
606        (arg_argc, arg_argv)
607    } else {
608        // The Rust start function doesn't need `argc` and `argv`, so just pass zeros.
609        let arg_argc = bx.const_int(bx.cx().type_int(), 0);
610        let arg_argv = bx.const_null(bx.cx().type_ptr());
611        (arg_argc, arg_argv)
612    }
613}
614
615/// This function returns all of the debugger visualizers specified for the
616/// current crate as well as all upstream crates transitively that match the
617/// `visualizer_type` specified.
618pub fn collect_debugger_visualizers_transitive(
619    tcx: TyCtxt<'_>,
620    visualizer_type: DebuggerVisualizerType,
621) -> BTreeSet<DebuggerVisualizerFile> {
622    tcx.debugger_visualizers(LOCAL_CRATE)
623        .iter()
624        .chain(
625            tcx.crates(())
626                .iter()
627                .filter(|&cnum| {
628                    let used_crate_source = tcx.used_crate_source(*cnum);
629                    used_crate_source.rlib.is_some() || used_crate_source.rmeta.is_some()
630                })
631                .flat_map(|&cnum| tcx.debugger_visualizers(cnum)),
632        )
633        .filter(|visualizer| visualizer.visualizer_type == visualizer_type)
634        .cloned()
635        .collect::<BTreeSet<_>>()
636}
637
638/// Decide allocator kind to codegen. If `Some(_)` this will be the same as
639/// `tcx.allocator_kind`, but it may be `None` in more cases (e.g. if using
640/// allocator definitions from a dylib dependency).
641pub fn allocator_kind_for_codegen(tcx: TyCtxt<'_>) -> Option<AllocatorKind> {
642    // If the crate doesn't have an `allocator_kind` set then there's definitely
643    // no shim to generate. Otherwise we also check our dependency graph for all
644    // our output crate types. If anything there looks like its a `Dynamic`
645    // linkage for all crate types we may link as, then it's already got an
646    // allocator shim and we'll be using that one instead. If nothing exists
647    // then it's our job to generate the allocator! If crate types disagree
648    // about whether an allocator shim is necessary or not, we generate one
649    // and let needs_allocator_shim_for_linking decide at link time whether or
650    // not to use it for any particular linker invocation.
651    let all_crate_types_any_dynamic_crate = tcx.dependency_formats(()).iter().all(|(_, list)| {
652        use rustc_middle::middle::dependency_format::Linkage;
653        list.iter().any(|&linkage| linkage == Linkage::Dynamic)
654    });
655    if all_crate_types_any_dynamic_crate { None } else { tcx.allocator_kind(()) }
656}
657
658/// Decide if this particular crate type needs an allocator shim linked in.
659/// This may return true even when allocator_kind_for_codegen returns false. In
660/// this case no allocator shim shall be linked.
661pub(crate) fn needs_allocator_shim_for_linking(
662    dependency_formats: &Dependencies,
663    crate_type: CrateType,
664) -> bool {
665    use rustc_middle::middle::dependency_format::Linkage;
666    let any_dynamic_crate =
667        dependency_formats[&crate_type].iter().any(|&linkage| linkage == Linkage::Dynamic);
668    !any_dynamic_crate
669}
670
671pub fn allocator_shim_contents(tcx: TyCtxt<'_>, kind: AllocatorKind) -> Vec<AllocatorMethod> {
672    let mut methods = Vec::new();
673
674    if kind == AllocatorKind::Default {
675        methods.extend(ALLOCATOR_METHODS.into_iter().copied());
676    }
677
678    // If the return value of allocator_kind_for_codegen is Some then
679    // alloc_error_handler_kind must also be Some.
680    if tcx.alloc_error_handler_kind(()).unwrap() == AllocatorKind::Default {
681        methods.push(AllocatorMethod {
682            name: ALLOC_ERROR_HANDLER,
683            special: None,
684            inputs: &[AllocatorMethodInput { name: "layout", ty: AllocatorTy::Layout }],
685            output: AllocatorTy::Never,
686        });
687    }
688
689    methods
690}
691
692pub fn codegen_crate<
693    B: ExtraBackendMethods<Module = M> + WriteBackendMethods<Module = M>,
694    M: Send,
695>(
696    backend: B,
697    tcx: TyCtxt<'_>,
698) -> OngoingCodegen<B> {
699    if tcx.sess.target.need_explicit_cpu && tcx.sess.opts.cg.target_cpu.is_none() {
700        // The target has no default cpu, but none is set explicitly
701        tcx.dcx().emit_fatal(diagnostics::CpuRequired);
702    }
703
704    if let Some(target_cpu) = &tcx.sess.opts.cg.target_cpu
705        && tcx.sess.target.unsupported_cpus.contains(&target_cpu.into())
706    {
707        // The target cpu is explicitly listed as an unsupported cpu
708        tcx.dcx().emit_fatal(diagnostics::CpuUnsupported { target_cpu: target_cpu.clone() });
709    }
710
711    let cgu_name_builder = &mut CodegenUnitNameBuilder::new(tcx);
712
713    // Run the monomorphization collector and partition the collected items into
714    // codegen units.
715    let MonoItemPartitions { codegen_units, .. } = tcx.collect_and_partition_mono_items(());
716
717    // Force all codegen_unit queries so they are already either red or green
718    // when compile_codegen_unit accesses them. We are not able to re-execute
719    // the codegen_unit query from just the DepNode, so an unknown color would
720    // lead to having to re-execute compile_codegen_unit, possibly
721    // unnecessarily.
722    if tcx.dep_graph.is_fully_enabled() {
723        for cgu in codegen_units {
724            tcx.ensure_ok().codegen_unit(cgu.name());
725        }
726    }
727
728    // Codegen an allocator shim, if necessary.
729    let allocator_module = if let Some(kind) = allocator_kind_for_codegen(tcx) {
730        let llmod_id =
731            cgu_name_builder.build_cgu_name(LOCAL_CRATE, &["crate"], Some("allocator")).to_string();
732
733        tcx.sess.time("write_allocator_module", || {
734            let module =
735                backend.codegen_allocator(tcx, &llmod_id, &allocator_shim_contents(tcx, kind));
736            Some(ModuleCodegen::new_allocator(llmod_id, module))
737        })
738    } else {
739        None
740    };
741
742    let ongoing_codegen = start_async_codegen(backend.clone(), tcx, allocator_module);
743
744    // For better throughput during parallel processing by LLVM, we used to sort
745    // CGUs largest to smallest. This would lead to better thread utilization
746    // by, for example, preventing a large CGU from being processed last and
747    // having only one LLVM thread working while the rest remained idle.
748    //
749    // However, this strategy would lead to high memory usage, as it meant the
750    // LLVM-IR for all of the largest CGUs would be resident in memory at once.
751    //
752    // Instead, we can compromise by ordering CGUs such that the largest and
753    // smallest are first, second largest and smallest are next, etc. If there
754    // are large size variations, this can reduce memory usage significantly.
755    let codegen_units: Vec<_> = {
756        let mut sorted_cgus = codegen_units.iter().collect::<Vec<_>>();
757        sorted_cgus.sort_by_key(|cgu| cmp::Reverse(cgu.size_estimate()));
758
759        let (first_half, second_half) = sorted_cgus.split_at(sorted_cgus.len() / 2);
760        first_half.iter().interleave(second_half.iter().rev()).copied().collect()
761    };
762
763    // Calculate the CGU reuse
764    let cgu_reuse = tcx.sess.time("find_cgu_reuse", || {
765        codegen_units.iter().map(|cgu| determine_cgu_reuse(tcx, cgu)).collect::<Vec<_>>()
766    });
767
768    crate::assert_module_sources::assert_module_sources(tcx, &|cgu_reuse_tracker| {
769        for (i, cgu) in codegen_units.iter().enumerate() {
770            let cgu_reuse = cgu_reuse[i];
771            cgu_reuse_tracker.set_actual_reuse(cgu.name().as_str(), cgu_reuse);
772        }
773    });
774
775    let mut total_codegen_time = Duration::new(0, 0);
776    let start_rss = tcx.sess.opts.unstable_opts.time_passes.then(|| get_resident_set_size());
777
778    // The non-parallel compiler can only translate codegen units to LLVM IR
779    // on a single thread, leading to a staircase effect where the N LLVM
780    // threads have to wait on the single codegen threads to generate work
781    // for them. The parallel compiler does not have this restriction, so
782    // we can pre-load the LLVM queue in parallel before handing off
783    // coordination to the OnGoingCodegen scheduler.
784    //
785    // This likely is a temporary measure. Once we don't have to support the
786    // non-parallel compiler anymore, we can compile CGUs end-to-end in
787    // parallel and get rid of the complicated scheduling logic.
788    let mut pre_compiled_cgus = if let Some(threads) = tcx.sess.threads() {
789        tcx.sess.time("compile_first_CGU_batch", || {
790            // Try to find one CGU to compile per thread.
791            let cgus: Vec<_> = cgu_reuse
792                .iter()
793                .enumerate()
794                .filter(|&(_, reuse)| reuse == &CguReuse::No)
795                .take(threads)
796                .collect();
797
798            // Compile the found CGUs in parallel.
799            let start_time = Instant::now();
800
801            let pre_compiled_cgus = par_map(cgus, |(i, _)| {
802                let module = backend.compile_codegen_unit(tcx, codegen_units[i].name());
803                (i, IntoDynSyncSend(module))
804            });
805
806            total_codegen_time += start_time.elapsed();
807
808            pre_compiled_cgus
809        })
810    } else {
811        FxHashMap::default()
812    };
813
814    for (i, cgu) in codegen_units.iter().enumerate() {
815        ongoing_codegen.wait_for_signal_to_codegen_item();
816        ongoing_codegen.check_for_errors(tcx.sess);
817
818        let cgu_reuse = cgu_reuse[i];
819
820        match cgu_reuse {
821            CguReuse::No => {
822                let (module, cost) = if let Some(cgu) = pre_compiled_cgus.remove(&i) {
823                    cgu.0
824                } else {
825                    let start_time = Instant::now();
826                    let module = backend.compile_codegen_unit(tcx, cgu.name());
827                    total_codegen_time += start_time.elapsed();
828                    module
829                };
830                // This will unwind if there are errors, which triggers our `AbortCodegenOnDrop`
831                // guard. Unfortunately, just skipping the `submit_codegened_module_to_llvm` makes
832                // compilation hang on post-monomorphization errors.
833                tcx.dcx().abort_if_errors();
834
835                submit_codegened_module_to_llvm(&ongoing_codegen.coordinator, module, cost);
836            }
837            CguReuse::PreLto => {
838                submit_pre_lto_module_to_llvm(
839                    tcx,
840                    &ongoing_codegen.coordinator,
841                    CachedModuleCodegen {
842                        name: cgu.name().to_string(),
843                        source: cgu.previous_work_product(tcx),
844                    },
845                );
846            }
847            CguReuse::PostLto => {
848                submit_post_lto_module_to_llvm(
849                    &ongoing_codegen.coordinator,
850                    CachedModuleCodegen {
851                        name: cgu.name().to_string(),
852                        source: cgu.previous_work_product(tcx),
853                    },
854                );
855            }
856        }
857    }
858
859    ongoing_codegen.codegen_finished(tcx);
860
861    // Since the main thread is sometimes blocked during codegen, we keep track
862    // -Ztime-passes output manually.
863    if tcx.sess.opts.unstable_opts.time_passes {
864        let end_rss = get_resident_set_size();
865
866        print_time_passes_entry(
867            "codegen_to_LLVM_IR",
868            total_codegen_time,
869            start_rss.unwrap(),
870            end_rss,
871            tcx.sess.opts.unstable_opts.time_passes_format,
872        );
873    }
874
875    ongoing_codegen.check_for_errors(tcx.sess);
876    ongoing_codegen
877}
878
879/// Returns whether a call from the current crate to the [`Instance`] would produce a call
880/// from `compiler_builtins` to a symbol the linker must resolve.
881///
882/// Such calls from `compiler_builtins` are effectively impossible for the linker to handle. Some
883/// linkers will optimize such that dead calls to unresolved symbols are not an error, but this is
884/// not guaranteed. So we use this function in codegen backends to ensure we do not generate any
885/// unlinkable calls.
886///
887/// Note that calls to LLVM intrinsics are uniquely okay because they won't make it to the linker.
888/// Note also that calls to foreign items that are actually exported by the local crate are also
889/// okay. This situation arises because compiler-builtins calls functions in core that are
890/// `#[inline]` wrappers for `extern "C"` declarations in core, which resolve to a symbol exported
891/// by compiler-builtins.
892pub fn is_call_from_compiler_builtins_to_upstream_monomorphization<'tcx>(
893    tcx: TyCtxt<'tcx>,
894    instance: Instance<'tcx>,
895) -> bool {
896    if let ty::InstanceKind::LlvmIntrinsic(_) = instance.def {
897        return false;
898    }
899
900    fn is_extern_call_to_local_crate<'tcx>(tcx: TyCtxt<'tcx>, instance: Instance<'tcx>) -> bool {
901        tcx.is_foreign_item(instance.def_id())
902            && tcx.exported_non_generic_symbols(LOCAL_CRATE).iter().any(|(sym, _info)| {
903                sym.symbol_name_for_local_instance(tcx) == tcx.symbol_name(instance)
904            })
905    }
906
907    let def_id = instance.def_id();
908    !def_id.is_local()
909        && tcx.is_compiler_builtins(LOCAL_CRATE)
910        && !tcx.should_codegen_locally(instance)
911        && !is_extern_call_to_local_crate(tcx, instance)
912}
913
914fn collect_eii_linkage(tcx: TyCtxt<'_>) -> Vec<EiiLinkageInfo> {
915    #[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)]
916    struct FoundImpl {
917        imp: EiiImpl,
918        impl_crate: CrateNum,
919    }
920
921    #[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)]
922    struct FoundEii {
923        decl: EiiDecl,
924        impls: FxIndexMap<DefId, FoundImpl>,
925    }
926
927    let mut eiis = FxIndexMap::<DefId, FoundEii>::default();
928
929    for &cnum in tcx.crates(()).iter().chain(iter::once(&LOCAL_CRATE)) {
930        for (&did, &(decl, ref impls)) in tcx.externally_implementable_items(cnum) {
931            eiis.entry(did)
932                .or_insert_with(|| FoundEii { decl, impls: Default::default() })
933                .impls
934                .extend(
935                    impls
936                        .into_iter()
937                        .map(|(&did, &imp)| (did, FoundImpl { imp, impl_crate: cnum })),
938                );
939        }
940    }
941
942    eiis.into_iter()
943        .filter_map(|(_, FoundEii { decl, impls })| {
944            let mut explicit_impls = Vec::new();
945            let mut default_impl = None;
946
947            for (impl_did, FoundImpl { imp, impl_crate }) in impls {
948                let impl_info = EiiLinkageImplInfo { span: tcx.def_span(impl_did), impl_crate };
949                if imp.is_default {
950                    default_impl = Some(impl_info);
951                } else {
952                    explicit_impls.push(impl_info);
953                }
954            }
955
956            // Link time check is only needed when there may be a default impl in a dylib.
957            // Other cases emit an error in `rustc_passes` already.
958            if let Some(default_impl) = default_impl {
959                Some(EiiLinkageInfo {
960                    name: decl.name.name,
961                    impls: explicit_impls,
962                    default_impl: Some(default_impl),
963                })
964            } else {
965                None
966            }
967        })
968        .collect()
969}
970
971fn eii_linkage_needed(dependency_formats: &Dependencies) -> bool {
972    dependency_formats.values().any(|formats| {
973        formats
974            .iter()
975            .any(|&linkage| #[allow(non_exhaustive_omitted_patterns)] match linkage {
    Linkage::Dynamic | Linkage::IncludedFromDylib => true,
    _ => false,
}matches!(linkage, Linkage::Dynamic | Linkage::IncludedFromDylib))
976    })
977}
978
979impl CrateInfo {
980    pub fn new(tcx: TyCtxt<'_>, target_cpu: String) -> CrateInfo {
981        let crate_types = tcx.crate_types().to_vec();
982        let exported_symbols = crate_types
983            .iter()
984            .map(|&c| (c, crate::back::linker::exported_symbols(tcx, c)))
985            .collect();
986        let linked_symbols =
987            crate_types.iter().map(|&c| (c, crate::back::linker::linked_symbols(tcx, c))).collect();
988        let local_crate_name = tcx.crate_name(LOCAL_CRATE);
989        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);
990        let dependency_formats = Arc::clone(tcx.dependency_formats(()));
991        let eii_linkage = if eii_linkage_needed(&dependency_formats) {
992            collect_eii_linkage(tcx)
993        } else {
994            Vec::new()
995        };
996
997        // This list is used when generating the command line to pass through to
998        // system linker. The linker expects undefined symbols on the left of the
999        // command line to be defined in libraries on the right, not the other way
1000        // around. For more info, see some comments in the add_used_library function
1001        // below.
1002        //
1003        // In order to get this left-to-right dependency ordering, we use the reverse
1004        // postorder of all crates putting the leaves at the rightmost positions.
1005        let mut compiler_builtins = None;
1006        let mut used_crates: Vec<_> = tcx
1007            .postorder_cnums(())
1008            .iter()
1009            .rev()
1010            .copied()
1011            .filter(|&cnum| {
1012                let link = !tcx.crate_dep_kind(cnum).macros_only();
1013                if link && tcx.is_compiler_builtins(cnum) {
1014                    compiler_builtins = Some(cnum);
1015                    return false;
1016                }
1017                link
1018            })
1019            .collect();
1020        // `compiler_builtins` are always placed last to ensure that they're linked correctly.
1021        used_crates.extend(compiler_builtins);
1022
1023        let crates = tcx.crates(());
1024        let n_crates = crates.len();
1025        let mut info = CrateInfo {
1026            target_cpu,
1027            target_features: tcx.global_backend_features(()).clone(),
1028            crate_types,
1029            exported_symbols,
1030            linked_symbols,
1031            local_crate_name,
1032            compiler_builtins,
1033            profiler_runtime: None,
1034            is_no_builtins: Default::default(),
1035            native_libraries: Default::default(),
1036            used_libraries: tcx.native_libraries(LOCAL_CRATE).iter().map(Into::into).collect(),
1037            crate_name: UnordMap::with_capacity(n_crates),
1038            used_crates,
1039            used_crate_source: UnordMap::with_capacity(n_crates),
1040            dependency_formats,
1041            eii_linkage,
1042            windows_subsystem,
1043            natvis_debugger_visualizers: Default::default(),
1044            lint_level_specs: CodegenLintLevelSpecs::from_tcx(tcx),
1045            metadata_symbol: exported_symbols::metadata_symbol_name(tcx),
1046            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)),
1047            each_linked_rlib_file_for_lto: Default::default(),
1048            exported_symbols_for_lto: Default::default(),
1049        };
1050
1051        info.native_libraries.reserve(n_crates);
1052
1053        for &cnum in crates.iter() {
1054            info.native_libraries
1055                .insert(cnum, tcx.native_libraries(cnum).iter().map(Into::into).collect());
1056            info.crate_name.insert(cnum, tcx.crate_name(cnum));
1057
1058            let used_crate_source = tcx.used_crate_source(cnum);
1059            info.used_crate_source.insert(cnum, Arc::clone(used_crate_source));
1060            if tcx.is_profiler_runtime(cnum) {
1061                info.profiler_runtime = Some(cnum);
1062            }
1063            if tcx.is_no_builtins(cnum) {
1064                info.is_no_builtins.insert(cnum);
1065            }
1066        }
1067
1068        // Handle circular dependencies in the standard library.
1069        // See comment before `add_linked_symbol_object` function for the details.
1070        // If global LTO is enabled then almost everything (*) is glued into a single object file,
1071        // so this logic is not necessary and can cause issues on some targets (due to weak lang
1072        // item symbols being "privatized" to that object file), so we disable it.
1073        // (*) Native libs, and `#[compiler_builtins]` and `#[no_builtins]` crates are not glued,
1074        // and we assume that they cannot define weak lang items. This is not currently enforced
1075        // by the compiler, but that's ok because all this stuff is unstable anyway.
1076        let target = &tcx.sess.target;
1077        if !are_upstream_rust_objects_already_included(tcx.sess) {
1078            let add_prefix = match (target.is_like_windows, &target.arch) {
1079                (true, Arch::X86) => |name: String, _: SymbolExportKind| ::alloc::__export::must_use({
        ::alloc::fmt::format(format_args!("_{0}", name))
    })format!("_{name}"),
1080                (true, Arch::Arm64EC) => {
1081                    // Only functions are decorated for arm64ec.
1082                    |name: String, export_kind: SymbolExportKind| match export_kind {
1083                        SymbolExportKind::Text => ::alloc::__export::must_use({
        ::alloc::fmt::format(format_args!("#{0}", name))
    })format!("#{name}"),
1084                        _ => name,
1085                    }
1086                }
1087                _ => |name: String, _: SymbolExportKind| name,
1088            };
1089            let missing_weak_lang_items: FxIndexSet<(Symbol, SymbolExportKind)> = info
1090                .used_crates
1091                .iter()
1092                .flat_map(|&cnum| tcx.missing_lang_items(cnum))
1093                .filter(|l| l.is_weak())
1094                .filter_map(|&l| {
1095                    let name = l.link_name()?;
1096                    let export_kind = match l.target() {
1097                        Target::ForeignFn | Target::Fn => SymbolExportKind::Text,
1098                        Target::Static => SymbolExportKind::Data,
1099                        _ => ::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!(
1100                            "Don't know what the export kind is for lang item of kind {:?}",
1101                            l.target()
1102                        ),
1103                    };
1104                    lang_items::required(tcx, l).then_some((name, export_kind))
1105                })
1106                .collect();
1107
1108            // This loop only adds new items to values of the hash map, so the order in which we
1109            // iterate over the values is not important.
1110            #[allow(rustc::potential_query_instability)]
1111            info.linked_symbols
1112                .iter_mut()
1113                .filter(|(crate_type, _)| {
1114                    !#[allow(non_exhaustive_omitted_patterns)] match crate_type {
    CrateType::Rlib | CrateType::StaticLib => true,
    _ => false,
}matches!(crate_type, CrateType::Rlib | CrateType::StaticLib)
1115                })
1116                .for_each(|(_, linked_symbols)| {
1117                    let mut symbols = missing_weak_lang_items
1118                        .iter()
1119                        .map(|(item, export_kind)| {
1120                            (
1121                                add_prefix(
1122                                    mangle_internal_symbol(tcx, item.as_str()),
1123                                    *export_kind,
1124                                ),
1125                                *export_kind,
1126                            )
1127                        })
1128                        .collect::<Vec<_>>();
1129                    symbols.sort_unstable_by(|a, b| a.0.cmp(&b.0));
1130                    linked_symbols.extend(symbols);
1131                });
1132        }
1133
1134        let mut each_linked_rlib_for_lto = Vec::new();
1135        let mut each_linked_rlib_file_for_lto = Vec::new();
1136        if tcx.sess.lto() != config::Lto::No && tcx.sess.lto() != config::Lto::ThinLocal {
1137            drop(crate::back::link::each_linked_rlib(&info, None, &mut |cnum, path| {
1138                if crate::back::link::ignored_for_lto(tcx.sess, &info, cnum) {
1139                    return;
1140                }
1141
1142                each_linked_rlib_for_lto.push(cnum);
1143                each_linked_rlib_file_for_lto.push(path.to_path_buf());
1144            }));
1145        }
1146        info.each_linked_rlib_file_for_lto = each_linked_rlib_file_for_lto;
1147
1148        // FIXME move to -Zlink-only half such that each_linked_rlib_file_for_lto can be moved there too
1149        // Compute the set of symbols we need to retain when doing LTO (if we need to)
1150        info.exported_symbols_for_lto =
1151            crate::back::lto::exported_symbols_for_lto(tcx, &each_linked_rlib_for_lto);
1152
1153        let embed_visualizers = tcx.crate_types().iter().any(|&crate_type| match crate_type {
1154            CrateType::Executable | CrateType::Dylib | CrateType::Cdylib | CrateType::Sdylib => {
1155                // These are crate types for which we invoke the linker and can embed
1156                // NatVis visualizers.
1157                true
1158            }
1159            CrateType::ProcMacro => {
1160                // We could embed NatVis for proc macro crates too (to improve the debugging
1161                // experience for them) but it does not seem like a good default, since
1162                // this is a rare use case and we don't want to slow down the common case.
1163                false
1164            }
1165            CrateType::StaticLib | CrateType::Rlib => {
1166                // We don't invoke the linker for these, so we don't need to collect the NatVis for
1167                // them.
1168                false
1169            }
1170        });
1171
1172        if target.is_like_msvc && embed_visualizers {
1173            info.natvis_debugger_visualizers =
1174                collect_debugger_visualizers_transitive(tcx, DebuggerVisualizerType::Natvis);
1175        }
1176
1177        info
1178    }
1179}
1180
1181pub(crate) fn provide(providers: &mut Providers) {
1182    providers.backend_optimization_level = |tcx, cratenum| {
1183        let for_speed = match tcx.sess.opts.optimize {
1184            // If globally no optimisation is done, #[optimize] has no effect.
1185            //
1186            // This is done because if we ended up "upgrading" to `-O2` here, we’d populate the
1187            // pass manager and it is likely that some module-wide passes (such as inliner or
1188            // cross-function constant propagation) would ignore the `optnone` annotation we put
1189            // on the functions, thus necessarily involving these functions into optimisations.
1190            config::OptLevel::No => return config::OptLevel::No,
1191            // If globally optimise-speed is already specified, just use that level.
1192            config::OptLevel::Less => return config::OptLevel::Less,
1193            config::OptLevel::More => return config::OptLevel::More,
1194            config::OptLevel::Aggressive => return config::OptLevel::Aggressive,
1195            // If globally optimize-for-size has been requested, use -O2 instead (if optimize(size)
1196            // are present).
1197            config::OptLevel::Size => config::OptLevel::More,
1198            config::OptLevel::SizeMin => config::OptLevel::More,
1199        };
1200
1201        let defids = tcx.collect_and_partition_mono_items(cratenum).all_mono_items;
1202
1203        let any_for_speed = defids.items().any(|id| {
1204            let CodegenFnAttrs { optimize, .. } = tcx.codegen_fn_attrs(*id);
1205            #[allow(non_exhaustive_omitted_patterns)] match optimize {
    OptimizeAttr::Speed => true,
    _ => false,
}matches!(optimize, OptimizeAttr::Speed)
1206        });
1207
1208        if any_for_speed {
1209            return for_speed;
1210        }
1211
1212        tcx.sess.opts.optimize
1213    };
1214}
1215
1216pub fn determine_cgu_reuse<'tcx>(tcx: TyCtxt<'tcx>, cgu: &CodegenUnit<'tcx>) -> CguReuse {
1217    if !tcx.dep_graph.is_fully_enabled()
1218        || tcx.sess.opts.unstable_opts.disable_incr_comp_backend_caching
1219    {
1220        return CguReuse::No;
1221    }
1222
1223    let work_product_id = &cgu.work_product_id();
1224    if tcx.dep_graph.previous_work_product(work_product_id).is_none() {
1225        // We don't have anything cached for this CGU. This can happen
1226        // if the CGU did not exist in the previous session.
1227        return CguReuse::No;
1228    }
1229
1230    // Try to mark the CGU as green. If it we can do so, it means that nothing
1231    // affecting the LLVM module has changed and we can re-use a cached version.
1232    // If we compile with any kind of LTO, this means we can re-use the bitcode
1233    // of the Pre-LTO stage (possibly also the Post-LTO version but we'll only
1234    // know that later). If we are not doing LTO, there is only one optimized
1235    // version of each module, so we re-use that.
1236    let dep_node = cgu.codegen_dep_node(tcx);
1237    tcx.dep_graph.assert_dep_node_not_yet_allocated_in_current_session(tcx.sess, &dep_node, || {
1238        ::alloc::__export::must_use({
        ::alloc::fmt::format(format_args!("CompileCodegenUnit dep-node for CGU `{0}` already exists before marking.",
                cgu.name()))
    })format!(
1239            "CompileCodegenUnit dep-node for CGU `{}` already exists before marking.",
1240            cgu.name()
1241        )
1242    });
1243
1244    if tcx.dep_graph.try_mark_green(tcx, &dep_node).is_some() {
1245        // We can re-use either the pre- or the post-thinlto state. If no LTO is
1246        // being performed then we can use post-LTO artifacts, otherwise we must
1247        // reuse pre-LTO artifacts
1248        match compute_per_cgu_lto_type(
1249            &tcx.sess.lto(),
1250            tcx.sess.opts.cg.linker_plugin_lto.enabled(),
1251            tcx.crate_types(),
1252        ) {
1253            ComputedLtoType::No => CguReuse::PostLto,
1254            _ => CguReuse::PreLto,
1255        }
1256    } else {
1257        CguReuse::No
1258    }
1259}