compiler/rustc_codegen_ssa/src/base.rs

   1 use crate::back::link::are_upstream_rust_objects_already_included;
   2 use crate::back::metadata::create_compressed_metadata_file;
   3 use crate::back::write::{
   4     compute_per_cgu_lto_type, start_async_codegen, submit_codegened_module_to_llvm,
   5     submit_post_lto_module_to_llvm, submit_pre_lto_module_to_llvm, ComputedLtoType, OngoingCodegen,
   6 };
   7 use crate::common::{IntPredicate, RealPredicate, TypeKind};
   8 use crate::errors;
   9 use crate::meth;
  10 use crate::mir;
  11 use crate::mir::operand::OperandValue;
  12 use crate::mir::place::PlaceRef;
  13 use crate::traits::*;
  14 use crate::{CachedModuleCodegen, CompiledModule, CrateInfo, MemFlags, ModuleCodegen, ModuleKind};
  15
  16 use rustc_attr as attr;
  17 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  18 use rustc_data_structures::profiling::{get_resident_set_size, print_time_passes_entry};
  19
  20 use rustc_data_structures::sync::par_iter;
  21 #[cfg(parallel_compiler)]
  22 use rustc_data_structures::sync::ParallelIterator;
  23 use rustc_hir as hir;
  24 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
  25 use rustc_hir::lang_items::LangItem;
  26 use rustc_index::vec::Idx;
  27 use rustc_metadata::EncodedMetadata;
  28 use rustc_middle::middle::codegen_fn_attrs::CodegenFnAttrs;
  29 use rustc_middle::middle::exported_symbols;
  30 use rustc_middle::middle::exported_symbols::SymbolExportKind;
  31 use rustc_middle::middle::lang_items;
  32 use rustc_middle::mir::mono::{CodegenUnit, CodegenUnitNameBuilder, MonoItem};
  33 use rustc_middle::ty::layout::{HasTyCtxt, LayoutOf, TyAndLayout};
  34 use rustc_middle::ty::query::Providers;
  35 use rustc_middle::ty::{self, Instance, Ty, TyCtxt};
  36 use rustc_session::cgu_reuse_tracker::CguReuse;
  37 use rustc_session::config::{self, CrateType, EntryFnType, OutputType};
  38 use rustc_session::Session;
  39 use rustc_span::symbol::sym;
  40 use rustc_span::Symbol;
  41 use rustc_span::{DebuggerVisualizerFile, DebuggerVisualizerType};
  42 use rustc_target::abi::{Align, Size, VariantIdx};
  43
  44 use std::collections::BTreeSet;
  45 use std::time::{Duration, Instant};
  46
  47 use itertools::Itertools;
  48
  49 pub fn bin_op_to_icmp_predicate(op: hir::BinOpKind, signed: bool) -> IntPredicate {
  50     match op {
  51         hir::BinOpKind::Eq => IntPredicate::IntEQ,
  52         hir::BinOpKind::Ne => IntPredicate::IntNE,
  53         hir::BinOpKind::Lt => {
  54             if signed {
  55                 IntPredicate::IntSLT
  56             } else {
  57                 IntPredicate::IntULT
  58             }
  59         }
  60         hir::BinOpKind::Le => {
  61             if signed {
  62                 IntPredicate::IntSLE
  63             } else {
  64                 IntPredicate::IntULE
  65             }
  66         }
  67         hir::BinOpKind::Gt => {
  68             if signed {
  69                 IntPredicate::IntSGT
  70             } else {
  71                 IntPredicate::IntUGT
  72             }
  73         }
  74         hir::BinOpKind::Ge => {
  75             if signed {
  76                 IntPredicate::IntSGE
  77             } else {
  78                 IntPredicate::IntUGE
  79             }
  80         }
  81         op => bug!(
  82             "comparison_op_to_icmp_predicate: expected comparison operator, \
  83              found {:?}",
  84             op
  85         ),
  86     }
  87 }
  88
  89 pub fn bin_op_to_fcmp_predicate(op: hir::BinOpKind) -> RealPredicate {
  90     match op {
  91         hir::BinOpKind::Eq => RealPredicate::RealOEQ,
  92         hir::BinOpKind::Ne => RealPredicate::RealUNE,
  93         hir::BinOpKind::Lt => RealPredicate::RealOLT,
  94         hir::BinOpKind::Le => RealPredicate::RealOLE,
  95         hir::BinOpKind::Gt => RealPredicate::RealOGT,
  96         hir::BinOpKind::Ge => RealPredicate::RealOGE,
  97         op => {
  98             bug!(
  99                 "comparison_op_to_fcmp_predicate: expected comparison operator, \
 100                  found {:?}",
 101                 op
 102             );
 103         }
 104     }
 105 }
 106
 107 pub fn compare_simd_types<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 108     bx: &mut Bx,
 109     lhs: Bx::Value,
 110     rhs: Bx::Value,
 111     t: Ty<'tcx>,
 112     ret_ty: Bx::Type,
 113     op: hir::BinOpKind,
 114 ) -> Bx::Value {
 115     let signed = match t.kind() {
 116         ty::Float(_) => {
 117             let cmp = bin_op_to_fcmp_predicate(op);
 118             let cmp = bx.fcmp(cmp, lhs, rhs);
 119             return bx.sext(cmp, ret_ty);
 120         }
 121         ty::Uint(_) => false,
 122         ty::Int(_) => true,
 123         _ => bug!("compare_simd_types: invalid SIMD type"),
 124     };
 125
 126     let cmp = bin_op_to_icmp_predicate(op, signed);
 127     let cmp = bx.icmp(cmp, lhs, rhs);
 128     // LLVM outputs an `< size x i1 >`, so we need to perform a sign extension
 129     // to get the correctly sized type. This will compile to a single instruction
 130     // once the IR is converted to assembly if the SIMD instruction is supported
 131     // by the target architecture.
 132     bx.sext(cmp, ret_ty)
 133 }
 134
 135 /// Retrieves the information we are losing (making dynamic) in an unsizing
 136 /// adjustment.
 137 ///
 138 /// The `old_info` argument is a bit odd. It is intended for use in an upcast,
 139 /// where the new vtable for an object will be derived from the old one.
 140 pub fn unsized_info<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 141     bx: &mut Bx,
 142     source: Ty<'tcx>,
 143     target: Ty<'tcx>,
 144     old_info: Option<Bx::Value>,
 145 ) -> Bx::Value {
 146     let cx = bx.cx();
 147     let (source, target) =
 148         cx.tcx().struct_lockstep_tails_erasing_lifetimes(source, target, bx.param_env());
 149     match (source.kind(), target.kind()) {
 150         (&ty::Array(_, len), &ty::Slice(_)) => {
 151             cx.const_usize(len.eval_usize(cx.tcx(), ty::ParamEnv::reveal_all()))
 152         }
 153         (
 154             &ty::Dynamic(ref data_a, _, src_dyn_kind),
 155             &ty::Dynamic(ref data_b, _, target_dyn_kind),
 156         ) => {
 157             assert_eq!(src_dyn_kind, target_dyn_kind);
 158
 159             let old_info =
 160                 old_info.expect("unsized_info: missing old info for trait upcasting coercion");
 161             if data_a.principal_def_id() == data_b.principal_def_id() {
 162                 // A NOP cast that doesn't actually change anything, should be allowed even with invalid vtables.
 163                 return old_info;
 164             }
 165
 166             // trait upcasting coercion
 167
 168             let vptr_entry_idx =
 169                 cx.tcx().vtable_trait_upcasting_coercion_new_vptr_slot((source, target));
 170
 171             if let Some(entry_idx) = vptr_entry_idx {
 172                 let ptr_ty = cx.type_i8p();
 173                 let ptr_align = cx.tcx().data_layout.pointer_align.abi;
 174                 let vtable_ptr_ty = vtable_ptr_ty(cx, target, target_dyn_kind);
 175                 let llvtable = bx.pointercast(old_info, bx.type_ptr_to(ptr_ty));
 176                 let gep = bx.inbounds_gep(
 177                     ptr_ty,
 178                     llvtable,
 179                     &[bx.const_usize(u64::try_from(entry_idx).unwrap())],
 180                 );
 181                 let new_vptr = bx.load(ptr_ty, gep, ptr_align);
 182                 bx.nonnull_metadata(new_vptr);
 183                 // VTable loads are invariant.
 184                 bx.set_invariant_load(new_vptr);
 185                 bx.pointercast(new_vptr, vtable_ptr_ty)
 186             } else {
 187                 old_info
 188             }
 189         }
 190         (_, &ty::Dynamic(ref data, _, target_dyn_kind)) => {
 191             let vtable_ptr_ty = vtable_ptr_ty(cx, target, target_dyn_kind);
 192             cx.const_ptrcast(meth::get_vtable(cx, source, data.principal()), vtable_ptr_ty)
 193         }
 194         _ => bug!("unsized_info: invalid unsizing {:?} -> {:?}", source, target),
 195     }
 196 }
 197
 198 // Returns the vtable pointer type of a `dyn` or `dyn*` type
 199 fn vtable_ptr_ty<'tcx, Cx: CodegenMethods<'tcx>>(
 200     cx: &Cx,
 201     target: Ty<'tcx>,
 202     kind: ty::DynKind,
 203 ) -> <Cx as BackendTypes>::Type {
 204     cx.scalar_pair_element_backend_type(
 205         cx.layout_of(match kind {
 206             // vtable is the second field of `*mut dyn Trait`
 207             ty::Dyn => cx.tcx().mk_mut_ptr(target),
 208             // vtable is the second field of `dyn* Trait`
 209             ty::DynStar => target,
 210         }),
 211         1,
 212         true,
 213     )
 214 }
 215
 216 /// Coerces `src` to `dst_ty`. `src_ty` must be a pointer.
 217 pub fn unsize_ptr<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 218     bx: &mut Bx,
 219     src: Bx::Value,
 220     src_ty: Ty<'tcx>,
 221     dst_ty: Ty<'tcx>,
 222     old_info: Option<Bx::Value>,
 223 ) -> (Bx::Value, Bx::Value) {
 224     debug!("unsize_ptr: {:?} => {:?}", src_ty, dst_ty);
 225     match (src_ty.kind(), dst_ty.kind()) {
 226         (&ty::Ref(_, a, _), &ty::Ref(_, b, _) | &ty::RawPtr(ty::TypeAndMut { ty: b, .. }))
 227         | (&ty::RawPtr(ty::TypeAndMut { ty: a, .. }), &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) => {
 228             assert_eq!(bx.cx().type_is_sized(a), old_info.is_none());
 229             let ptr_ty = bx.cx().type_ptr_to(bx.cx().backend_type(bx.cx().layout_of(b)));
 230             (bx.pointercast(src, ptr_ty), unsized_info(bx, a, b, old_info))
 231         }
 232         (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) => {
 233             assert_eq!(def_a, def_b);
 234             let src_layout = bx.cx().layout_of(src_ty);
 235             let dst_layout = bx.cx().layout_of(dst_ty);
 236             if src_ty == dst_ty {
 237                 return (src, old_info.unwrap());
 238             }
 239             let mut result = None;
 240             for i in 0..src_layout.fields.count() {
 241                 let src_f = src_layout.field(bx.cx(), i);
 242                 if src_f.is_zst() {
 243                     continue;
 244                 }
 245
 246                 assert_eq!(src_layout.fields.offset(i).bytes(), 0);
 247                 assert_eq!(dst_layout.fields.offset(i).bytes(), 0);
 248                 assert_eq!(src_layout.size, src_f.size);
 249
 250                 let dst_f = dst_layout.field(bx.cx(), i);
 251                 assert_ne!(src_f.ty, dst_f.ty);
 252                 assert_eq!(result, None);
 253                 result = Some(unsize_ptr(bx, src, src_f.ty, dst_f.ty, old_info));
 254             }
 255             let (lldata, llextra) = result.unwrap();
 256             let lldata_ty = bx.cx().scalar_pair_element_backend_type(dst_layout, 0, true);
 257             let llextra_ty = bx.cx().scalar_pair_element_backend_type(dst_layout, 1, true);
 258             // HACK(eddyb) have to bitcast pointers until LLVM removes pointee types.
 259             (bx.bitcast(lldata, lldata_ty), bx.bitcast(llextra, llextra_ty))
 260         }
 261         _ => bug!("unsize_ptr: called on bad types"),
 262     }
 263 }
 264
 265 /// Coerces `src` to `dst_ty` which is guaranteed to be a `dyn*` type.
 266 pub fn cast_to_dyn_star<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 267     bx: &mut Bx,
 268     src: Bx::Value,
 269     src_ty_and_layout: TyAndLayout<'tcx>,
 270     dst_ty: Ty<'tcx>,
 271     old_info: Option<Bx::Value>,
 272 ) -> (Bx::Value, Bx::Value) {
 273     debug!("cast_to_dyn_star: {:?} => {:?}", src_ty_and_layout.ty, dst_ty);
 274     assert!(
 275         matches!(dst_ty.kind(), ty::Dynamic(_, _, ty::DynStar)),
 276         "destination type must be a dyn*"
 277     );
 278     // FIXME(dyn-star): this is probably not the best way to check if this is
 279     // a pointer, and really we should ensure that the value is a suitable
 280     // pointer earlier in the compilation process.
 281     let src = match src_ty_and_layout.pointee_info_at(bx.cx(), Size::ZERO) {
 282         Some(_) => bx.ptrtoint(src, bx.cx().type_isize()),
 283         None => bx.bitcast(src, bx.type_isize()),
 284     };
 285     (src, unsized_info(bx, src_ty_and_layout.ty, dst_ty, old_info))
 286 }
 287
 288 /// Coerces `src`, which is a reference to a value of type `src_ty`,
 289 /// to a value of type `dst_ty`, and stores the result in `dst`.
 290 pub fn coerce_unsized_into<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 291     bx: &mut Bx,
 292     src: PlaceRef<'tcx, Bx::Value>,
 293     dst: PlaceRef<'tcx, Bx::Value>,
 294 ) {
 295     let src_ty = src.layout.ty;
 296     let dst_ty = dst.layout.ty;
 297     match (src_ty.kind(), dst_ty.kind()) {
 298         (&ty::Ref(..), &ty::Ref(..) | &ty::RawPtr(..)) | (&ty::RawPtr(..), &ty::RawPtr(..)) => {
 299             let (base, info) = match bx.load_operand(src).val {
 300                 OperandValue::Pair(base, info) => unsize_ptr(bx, base, src_ty, dst_ty, Some(info)),
 301                 OperandValue::Immediate(base) => unsize_ptr(bx, base, src_ty, dst_ty, None),
 302                 OperandValue::Ref(..) => bug!(),
 303             };
 304             OperandValue::Pair(base, info).store(bx, dst);
 305         }
 306
 307         (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) => {
 308             assert_eq!(def_a, def_b);
 309
 310             for i in 0..def_a.variant(VariantIdx::new(0)).fields.len() {
 311                 let src_f = src.project_field(bx, i);
 312                 let dst_f = dst.project_field(bx, i);
 313
 314                 if dst_f.layout.is_zst() {
 315                     continue;
 316                 }
 317
 318                 if src_f.layout.ty == dst_f.layout.ty {
 319                     memcpy_ty(
 320                         bx,
 321                         dst_f.llval,
 322                         dst_f.align,
 323                         src_f.llval,
 324                         src_f.align,
 325                         src_f.layout,
 326                         MemFlags::empty(),
 327                     );
 328                 } else {
 329                     coerce_unsized_into(bx, src_f, dst_f);
 330                 }
 331             }
 332         }
 333         _ => bug!("coerce_unsized_into: invalid coercion {:?} -> {:?}", src_ty, dst_ty,),
 334     }
 335 }
 336
 337 pub fn cast_shift_expr_rhs<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 338     bx: &mut Bx,
 339     lhs: Bx::Value,
 340     rhs: Bx::Value,
 341 ) -> Bx::Value {
 342     // Shifts may have any size int on the rhs
 343     let mut rhs_llty = bx.cx().val_ty(rhs);
 344     let mut lhs_llty = bx.cx().val_ty(lhs);
 345     if bx.cx().type_kind(rhs_llty) == TypeKind::Vector {
 346         rhs_llty = bx.cx().element_type(rhs_llty)
 347     }
 348     if bx.cx().type_kind(lhs_llty) == TypeKind::Vector {
 349         lhs_llty = bx.cx().element_type(lhs_llty)
 350     }
 351     let rhs_sz = bx.cx().int_width(rhs_llty);
 352     let lhs_sz = bx.cx().int_width(lhs_llty);
 353     if lhs_sz < rhs_sz {
 354         bx.trunc(rhs, lhs_llty)
 355     } else if lhs_sz > rhs_sz {
 356         // FIXME (#1877: If in the future shifting by negative
 357         // values is no longer undefined then this is wrong.
 358         bx.zext(rhs, lhs_llty)
 359     } else {
 360         rhs
 361     }
 362 }
 363
 364 /// Returns `true` if this session's target will use SEH-based unwinding.
 365 ///
 366 /// This is only true for MSVC targets, and even then the 64-bit MSVC target
 367 /// currently uses SEH-ish unwinding with DWARF info tables to the side (same as
 368 /// 64-bit MinGW) instead of "full SEH".
 369 pub fn wants_msvc_seh(sess: &Session) -> bool {
 370     sess.target.is_like_msvc
 371 }
 372
 373 pub fn memcpy_ty<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 374     bx: &mut Bx,
 375     dst: Bx::Value,
 376     dst_align: Align,
 377     src: Bx::Value,
 378     src_align: Align,
 379     layout: TyAndLayout<'tcx>,
 380     flags: MemFlags,
 381 ) {
 382     let size = layout.size.bytes();
 383     if size == 0 {
 384         return;
 385     }
 386
 387     bx.memcpy(dst, dst_align, src, src_align, bx.cx().const_usize(size), flags);
 388 }
 389
 390 pub fn codegen_instance<'a, 'tcx: 'a, Bx: BuilderMethods<'a, 'tcx>>(
 391     cx: &'a Bx::CodegenCx,
 392     instance: Instance<'tcx>,
 393 ) {
 394     // this is an info! to allow collecting monomorphization statistics
 395     // and to allow finding the last function before LLVM aborts from
 396     // release builds.
 397     info!("codegen_instance({})", instance);
 398
 399     mir::codegen_mir::<Bx>(cx, instance);
 400 }
 401
 402 /// Creates the `main` function which will initialize the rust runtime and call
 403 /// users main function.
 404 pub fn maybe_create_entry_wrapper<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 405     cx: &'a Bx::CodegenCx,
 406 ) -> Option<Bx::Function> {
 407     let (main_def_id, entry_type) = cx.tcx().entry_fn(())?;
 408     let main_is_local = main_def_id.is_local();
 409     let instance = Instance::mono(cx.tcx(), main_def_id);
 410
 411     if main_is_local {
 412         // We want to create the wrapper in the same codegen unit as Rust's main
 413         // function.
 414         if !cx.codegen_unit().contains_item(&MonoItem::Fn(instance)) {
 415             return None;
 416         }
 417     } else if !cx.codegen_unit().is_primary() {
 418         // We want to create the wrapper only when the codegen unit is the primary one
 419         return None;
 420     }
 421
 422     let main_llfn = cx.get_fn_addr(instance);
 423
 424     let entry_fn = create_entry_fn::<Bx>(cx, main_llfn, main_def_id, entry_type);
 425     return Some(entry_fn);
 426
 427     fn create_entry_fn<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 428         cx: &'a Bx::CodegenCx,
 429         rust_main: Bx::Value,
 430         rust_main_def_id: DefId,
 431         entry_type: EntryFnType,
 432     ) -> Bx::Function {
 433         // The entry function is either `int main(void)` or `int main(int argc, char **argv)`,
 434         // depending on whether the target needs `argc` and `argv` to be passed in.
 435         let llfty = if cx.sess().target.main_needs_argc_argv {
 436             cx.type_func(&[cx.type_int(), cx.type_ptr_to(cx.type_i8p())], cx.type_int())
 437         } else {
 438             cx.type_func(&[], cx.type_int())
 439         };
 440
 441         let main_ret_ty = cx.tcx().fn_sig(rust_main_def_id).output();
 442         // Given that `main()` has no arguments,
 443         // then its return type cannot have
 444         // late-bound regions, since late-bound
 445         // regions must appear in the argument
 446         // listing.
 447         let main_ret_ty = cx.tcx().normalize_erasing_regions(
 448             ty::ParamEnv::reveal_all(),
 449             main_ret_ty.no_bound_vars().unwrap(),
 450         );
 451
 452         let Some(llfn) = cx.declare_c_main(llfty) else {
 453             // FIXME: We should be smart and show a better diagnostic here.
 454             let span = cx.tcx().def_span(rust_main_def_id);
 455             cx.sess().emit_err(errors::MultipleMainFunctions { span });
 456             cx.sess().abort_if_errors();
 457             bug!();
 458         };
 459
 460         // `main` should respect same config for frame pointer elimination as rest of code
 461         cx.set_frame_pointer_type(llfn);
 462         cx.apply_target_cpu_attr(llfn);
 463
 464         let llbb = Bx::append_block(&cx, llfn, "top");
 465         let mut bx = Bx::build(&cx, llbb);
 466
 467         bx.insert_reference_to_gdb_debug_scripts_section_global();
 468
 469         let isize_ty = cx.type_isize();
 470         let i8pp_ty = cx.type_ptr_to(cx.type_i8p());
 471         let (arg_argc, arg_argv) = get_argc_argv(cx, &mut bx);
 472
 473         let (start_fn, start_ty, args) = if let EntryFnType::Main { sigpipe } = entry_type {
 474             let start_def_id = cx.tcx().require_lang_item(LangItem::Start, None);
 475             let start_fn = cx.get_fn_addr(
 476                 ty::Instance::resolve(
 477                     cx.tcx(),
 478                     ty::ParamEnv::reveal_all(),
 479                     start_def_id,
 480                     cx.tcx().intern_substs(&[main_ret_ty.into()]),
 481                 )
 482                 .unwrap()
 483                 .unwrap(),
 484             );
 485
 486             let i8_ty = cx.type_i8();
 487             let arg_sigpipe = bx.const_u8(sigpipe);
 488
 489             let start_ty =
 490                 cx.type_func(&[cx.val_ty(rust_main), isize_ty, i8pp_ty, i8_ty], isize_ty);
 491             (start_fn, start_ty, vec![rust_main, arg_argc, arg_argv, arg_sigpipe])
 492         } else {
 493             debug!("using user-defined start fn");
 494             let start_ty = cx.type_func(&[isize_ty, i8pp_ty], isize_ty);
 495             (rust_main, start_ty, vec![arg_argc, arg_argv])
 496         };
 497
 498         let result = bx.call(start_ty, None, start_fn, &args, None);
 499         let cast = bx.intcast(result, cx.type_int(), true);
 500         bx.ret(cast);
 501
 502         llfn
 503     }
 504 }
 505
 506 /// Obtain the `argc` and `argv` values to pass to the rust start function.
 507 fn get_argc_argv<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 508     cx: &'a Bx::CodegenCx,
 509     bx: &mut Bx,
 510 ) -> (Bx::Value, Bx::Value) {
 511     if cx.sess().target.main_needs_argc_argv {
 512         // Params from native `main()` used as args for rust start function
 513         let param_argc = bx.get_param(0);
 514         let param_argv = bx.get_param(1);
 515         let arg_argc = bx.intcast(param_argc, cx.type_isize(), true);
 516         let arg_argv = param_argv;
 517         (arg_argc, arg_argv)
 518     } else {
 519         // The Rust start function doesn't need `argc` and `argv`, so just pass zeros.
 520         let arg_argc = bx.const_int(cx.type_int(), 0);
 521         let arg_argv = bx.const_null(cx.type_ptr_to(cx.type_i8p()));
 522         (arg_argc, arg_argv)
 523     }
 524 }
 525
 526 /// This function returns all of the debugger visualizers specified for the
 527 /// current crate as well as all upstream crates transitively that match the
 528 /// `visualizer_type` specified.
 529 pub fn collect_debugger_visualizers_transitive(
 530     tcx: TyCtxt<'_>,
 531     visualizer_type: DebuggerVisualizerType,
 532 ) -> BTreeSet<DebuggerVisualizerFile> {
 533     tcx.debugger_visualizers(LOCAL_CRATE)
 534         .iter()
 535         .chain(
 536             tcx.crates(())
 537                 .iter()
 538                 .filter(|&cnum| {
 539                     let used_crate_source = tcx.used_crate_source(*cnum);
 540                     used_crate_source.rlib.is_some() || used_crate_source.rmeta.is_some()
 541                 })
 542                 .flat_map(|&cnum| tcx.debugger_visualizers(cnum)),
 543         )
 544         .filter(|visualizer| visualizer.visualizer_type == visualizer_type)
 545         .cloned()
 546         .collect::<BTreeSet<_>>()
 547 }
 548
 549 pub fn codegen_crate<B: ExtraBackendMethods>(
 550     backend: B,
 551     tcx: TyCtxt<'_>,
 552     target_cpu: String,
 553     metadata: EncodedMetadata,
 554     need_metadata_module: bool,
 555 ) -> OngoingCodegen<B> {
 556     // Skip crate items and just output metadata in -Z no-codegen mode.
 557     if tcx.sess.opts.unstable_opts.no_codegen || !tcx.sess.opts.output_types.should_codegen() {
 558         let ongoing_codegen = start_async_codegen(backend, tcx, target_cpu, metadata, None, 1);
 559
 560         ongoing_codegen.codegen_finished(tcx);
 561
 562         ongoing_codegen.check_for_errors(tcx.sess);
 563
 564         return ongoing_codegen;
 565     }
 566
 567     let cgu_name_builder = &mut CodegenUnitNameBuilder::new(tcx);
 568
 569     // Run the monomorphization collector and partition the collected items into
 570     // codegen units.
 571     let codegen_units = tcx.collect_and_partition_mono_items(()).1;
 572
 573     // Force all codegen_unit queries so they are already either red or green
 574     // when compile_codegen_unit accesses them. We are not able to re-execute
 575     // the codegen_unit query from just the DepNode, so an unknown color would
 576     // lead to having to re-execute compile_codegen_unit, possibly
 577     // unnecessarily.
 578     if tcx.dep_graph.is_fully_enabled() {
 579         for cgu in codegen_units {
 580             tcx.ensure().codegen_unit(cgu.name());
 581         }
 582     }
 583
 584     let metadata_module = if need_metadata_module {
 585         // Emit compressed metadata object.
 586         let metadata_cgu_name =
 587             cgu_name_builder.build_cgu_name(LOCAL_CRATE, &["crate"], Some("metadata")).to_string();
 588         tcx.sess.time("write_compressed_metadata", || {
 589             let file_name =
 590                 tcx.output_filenames(()).temp_path(OutputType::Metadata, Some(&metadata_cgu_name));
 591             let data = create_compressed_metadata_file(
 592                 tcx.sess,
 593                 &metadata,
 594                 &exported_symbols::metadata_symbol_name(tcx),
 595             );
 596             if let Err(error) = std::fs::write(&file_name, data) {
 597                 tcx.sess.emit_fatal(errors::MetadataObjectFileWrite { error });
 598             }
 599             Some(CompiledModule {
 600                 name: metadata_cgu_name,
 601                 kind: ModuleKind::Metadata,
 602                 object: Some(file_name),
 603                 dwarf_object: None,
 604                 bytecode: None,
 605             })
 606         })
 607     } else {
 608         None
 609     };
 610
 611     let ongoing_codegen = start_async_codegen(
 612         backend.clone(),
 613         tcx,
 614         target_cpu,
 615         metadata,
 616         metadata_module,
 617         codegen_units.len(),
 618     );
 619
 620     // Codegen an allocator shim, if necessary.
 621     //
 622     // If the crate doesn't have an `allocator_kind` set then there's definitely
 623     // no shim to generate. Otherwise we also check our dependency graph for all
 624     // our output crate types. If anything there looks like its a `Dynamic`
 625     // linkage, then it's already got an allocator shim and we'll be using that
 626     // one instead. If nothing exists then it's our job to generate the
 627     // allocator!
 628     let any_dynamic_crate = tcx.dependency_formats(()).iter().any(|(_, list)| {
 629         use rustc_middle::middle::dependency_format::Linkage;
 630         list.iter().any(|&linkage| linkage == Linkage::Dynamic)
 631     });
 632     let allocator_module = if any_dynamic_crate {
 633         None
 634     } else if let Some(kind) = tcx.allocator_kind(()) {
 635         let llmod_id =
 636             cgu_name_builder.build_cgu_name(LOCAL_CRATE, &["crate"], Some("allocator")).to_string();
 637         let module_llvm = tcx.sess.time("write_allocator_module", || {
 638             backend.codegen_allocator(
 639                 tcx,
 640                 &llmod_id,
 641                 kind,
 642                 // If allocator_kind is Some then alloc_error_handler_kind must
 643                 // also be Some.
 644                 tcx.alloc_error_handler_kind(()).unwrap(),
 645             )
 646         });
 647
 648         Some(ModuleCodegen { name: llmod_id, module_llvm, kind: ModuleKind::Allocator })
 649     } else {
 650         None
 651     };
 652
 653     if let Some(allocator_module) = allocator_module {
 654         ongoing_codegen.submit_pre_codegened_module_to_llvm(tcx, allocator_module);
 655     }
 656
 657     // For better throughput during parallel processing by LLVM, we used to sort
 658     // CGUs largest to smallest. This would lead to better thread utilization
 659     // by, for example, preventing a large CGU from being processed last and
 660     // having only one LLVM thread working while the rest remained idle.
 661     //
 662     // However, this strategy would lead to high memory usage, as it meant the
 663     // LLVM-IR for all of the largest CGUs would be resident in memory at once.
 664     //
 665     // Instead, we can compromise by ordering CGUs such that the largest and
 666     // smallest are first, second largest and smallest are next, etc. If there
 667     // are large size variations, this can reduce memory usage significantly.
 668     let codegen_units: Vec<_> = {
 669         let mut sorted_cgus = codegen_units.iter().collect::<Vec<_>>();
 670         sorted_cgus.sort_by_cached_key(|cgu| cgu.size_estimate());
 671
 672         let (first_half, second_half) = sorted_cgus.split_at(sorted_cgus.len() / 2);
 673         second_half.iter().rev().interleave(first_half).copied().collect()
 674     };
 675
 676     // Calculate the CGU reuse
 677     let cgu_reuse = tcx.sess.time("find_cgu_reuse", || {
 678         codegen_units.iter().map(|cgu| determine_cgu_reuse(tcx, &cgu)).collect::<Vec<_>>()
 679     });
 680
 681     let mut total_codegen_time = Duration::new(0, 0);
 682     let start_rss = tcx.sess.opts.unstable_opts.time_passes.then(|| get_resident_set_size());
 683
 684     // The non-parallel compiler can only translate codegen units to LLVM IR
 685     // on a single thread, leading to a staircase effect where the N LLVM
 686     // threads have to wait on the single codegen threads to generate work
 687     // for them. The parallel compiler does not have this restriction, so
 688     // we can pre-load the LLVM queue in parallel before handing off
 689     // coordination to the OnGoingCodegen scheduler.
 690     //
 691     // This likely is a temporary measure. Once we don't have to support the
 692     // non-parallel compiler anymore, we can compile CGUs end-to-end in
 693     // parallel and get rid of the complicated scheduling logic.
 694     let mut pre_compiled_cgus = if cfg!(parallel_compiler) {
 695         tcx.sess.time("compile_first_CGU_batch", || {
 696             // Try to find one CGU to compile per thread.
 697             let cgus: Vec<_> = cgu_reuse
 698                 .iter()
 699                 .enumerate()
 700                 .filter(|&(_, reuse)| reuse == &CguReuse::No)
 701                 .take(tcx.sess.threads())
 702                 .collect();
 703
 704             // Compile the found CGUs in parallel.
 705             let start_time = Instant::now();
 706
 707             let pre_compiled_cgus = par_iter(cgus)
 708                 .map(|(i, _)| {
 709                     let module = backend.compile_codegen_unit(tcx, codegen_units[i].name());
 710                     (i, module)
 711                 })
 712                 .collect();
 713
 714             total_codegen_time += start_time.elapsed();
 715
 716             pre_compiled_cgus
 717         })
 718     } else {
 719         FxHashMap::default()
 720     };
 721
 722     for (i, cgu) in codegen_units.iter().enumerate() {
 723         ongoing_codegen.wait_for_signal_to_codegen_item();
 724         ongoing_codegen.check_for_errors(tcx.sess);
 725
 726         let cgu_reuse = cgu_reuse[i];
 727         tcx.sess.cgu_reuse_tracker.set_actual_reuse(cgu.name().as_str(), cgu_reuse);
 728
 729         match cgu_reuse {
 730             CguReuse::No => {
 731                 let (module, cost) = if let Some(cgu) = pre_compiled_cgus.remove(&i) {
 732                     cgu
 733                 } else {
 734                     let start_time = Instant::now();
 735                     let module = backend.compile_codegen_unit(tcx, cgu.name());
 736                     total_codegen_time += start_time.elapsed();
 737                     module
 738                 };
 739                 // This will unwind if there are errors, which triggers our `AbortCodegenOnDrop`
 740                 // guard. Unfortunately, just skipping the `submit_codegened_module_to_llvm` makes
 741                 // compilation hang on post-monomorphization errors.
 742                 tcx.sess.abort_if_errors();
 743
 744                 submit_codegened_module_to_llvm(
 745                     &backend,
 746                     &ongoing_codegen.coordinator.sender,
 747                     module,
 748                     cost,
 749                 );
 750                 false
 751             }
 752             CguReuse::PreLto => {
 753                 submit_pre_lto_module_to_llvm(
 754                     &backend,
 755                     tcx,
 756                     &ongoing_codegen.coordinator.sender,
 757                     CachedModuleCodegen {
 758                         name: cgu.name().to_string(),
 759                         source: cgu.previous_work_product(tcx),
 760                     },
 761                 );
 762                 true
 763             }
 764             CguReuse::PostLto => {
 765                 submit_post_lto_module_to_llvm(
 766                     &backend,
 767                     &ongoing_codegen.coordinator.sender,
 768                     CachedModuleCodegen {
 769                         name: cgu.name().to_string(),
 770                         source: cgu.previous_work_product(tcx),
 771                     },
 772                 );
 773                 true
 774             }
 775         };
 776     }
 777
 778     ongoing_codegen.codegen_finished(tcx);
 779
 780     // Since the main thread is sometimes blocked during codegen, we keep track
 781     // -Ztime-passes output manually.
 782     if tcx.sess.opts.unstable_opts.time_passes {
 783         let end_rss = get_resident_set_size();
 784
 785         print_time_passes_entry(
 786             "codegen_to_LLVM_IR",
 787             total_codegen_time,
 788             start_rss.unwrap(),
 789             end_rss,
 790         );
 791     }
 792
 793     ongoing_codegen.check_for_errors(tcx.sess);
 794     ongoing_codegen
 795 }
 796
 797 impl CrateInfo {
 798     pub fn new(tcx: TyCtxt<'_>, target_cpu: String) -> CrateInfo {
 799         let exported_symbols = tcx
 800             .sess
 801             .crate_types()
 802             .iter()
 803             .map(|&c| (c, crate::back::linker::exported_symbols(tcx, c)))
 804             .collect();
 805         let linked_symbols = tcx
 806             .sess
 807             .crate_types()
 808             .iter()
 809             .map(|&c| (c, crate::back::linker::linked_symbols(tcx, c)))
 810             .collect();
 811         let local_crate_name = tcx.crate_name(LOCAL_CRATE);
 812         let crate_attrs = tcx.hir().attrs(rustc_hir::CRATE_HIR_ID);
 813         let subsystem = tcx.sess.first_attr_value_str_by_name(crate_attrs, sym::windows_subsystem);
 814         let windows_subsystem = subsystem.map(|subsystem| {
 815             if subsystem != sym::windows && subsystem != sym::console {
 816                 tcx.sess.emit_fatal(errors::InvalidWindowsSubsystem { subsystem });
 817             }
 818             subsystem.to_string()
 819         });
 820
 821         // This list is used when generating the command line to pass through to
 822         // system linker. The linker expects undefined symbols on the left of the
 823         // command line to be defined in libraries on the right, not the other way
 824         // around. For more info, see some comments in the add_used_library function
 825         // below.
 826         //
 827         // In order to get this left-to-right dependency ordering, we use the reverse
 828         // postorder of all crates putting the leaves at the right-most positions.
 829         let mut compiler_builtins = None;
 830         let mut used_crates: Vec<_> = tcx
 831             .postorder_cnums(())
 832             .iter()
 833             .rev()
 834             .copied()
 835             .filter(|&cnum| {
 836                 let link = !tcx.dep_kind(cnum).macros_only();
 837                 if link && tcx.is_compiler_builtins(cnum) {
 838                     compiler_builtins = Some(cnum);
 839                     return false;
 840                 }
 841                 link
 842             })
 843             .collect();
 844         // `compiler_builtins` are always placed last to ensure that they're linked correctly.
 845         used_crates.extend(compiler_builtins);
 846
 847         let mut info = CrateInfo {
 848             target_cpu,
 849             exported_symbols,
 850             linked_symbols,
 851             local_crate_name,
 852             compiler_builtins,
 853             profiler_runtime: None,
 854             is_no_builtins: Default::default(),
 855             native_libraries: Default::default(),
 856             used_libraries: tcx.native_libraries(LOCAL_CRATE).iter().map(Into::into).collect(),
 857             crate_name: Default::default(),
 858             used_crates,
 859             used_crate_source: Default::default(),
 860             dependency_formats: tcx.dependency_formats(()).clone(),
 861             windows_subsystem,
 862             natvis_debugger_visualizers: Default::default(),
 863         };
 864         let crates = tcx.crates(());
 865
 866         let n_crates = crates.len();
 867         info.native_libraries.reserve(n_crates);
 868         info.crate_name.reserve(n_crates);
 869         info.used_crate_source.reserve(n_crates);
 870
 871         for &cnum in crates.iter() {
 872             info.native_libraries
 873                 .insert(cnum, tcx.native_libraries(cnum).iter().map(Into::into).collect());
 874             info.crate_name.insert(cnum, tcx.crate_name(cnum));
 875
 876             let used_crate_source = tcx.used_crate_source(cnum);
 877             info.used_crate_source.insert(cnum, used_crate_source.clone());
 878             if tcx.is_profiler_runtime(cnum) {
 879                 info.profiler_runtime = Some(cnum);
 880             }
 881             if tcx.is_no_builtins(cnum) {
 882                 info.is_no_builtins.insert(cnum);
 883             }
 884         }
 885
 886         // Handle circular dependencies in the standard library.
 887         // See comment before `add_linked_symbol_object` function for the details.
 888         // If global LTO is enabled then almost everything (*) is glued into a single object file,
 889         // so this logic is not necessary and can cause issues on some targets (due to weak lang
 890         // item symbols being "privatized" to that object file), so we disable it.
 891         // (*) Native libs, and `#[compiler_builtins]` and `#[no_builtins]` crates are not glued,
 892         // and we assume that they cannot define weak lang items. This is not currently enforced
 893         // by the compiler, but that's ok because all this stuff is unstable anyway.
 894         let target = &tcx.sess.target;
 895         if !are_upstream_rust_objects_already_included(tcx.sess) {
 896             let missing_weak_lang_items: FxHashSet<Symbol> = info
 897                 .used_crates
 898                 .iter()
 899                 .flat_map(|&cnum| tcx.missing_lang_items(cnum))
 900                 .filter(|l| l.is_weak())
 901                 .filter_map(|&l| {
 902                     let name = l.link_name()?;
 903                     lang_items::required(tcx, l).then_some(name)
 904                 })
 905                 .collect();
 906             let prefix = if target.is_like_windows && target.arch == "x86" { "_" } else { "" };
 907             info.linked_symbols
 908                 .iter_mut()
 909                 .filter(|(crate_type, _)| {
 910                     !matches!(crate_type, CrateType::Rlib | CrateType::Staticlib)
 911                 })
 912                 .for_each(|(_, linked_symbols)| {
 913                     linked_symbols.extend(
 914                         missing_weak_lang_items
 915                             .iter()
 916                             .map(|item| (format!("{prefix}{item}"), SymbolExportKind::Text)),
 917                     )
 918                 });
 919         }
 920
 921         let embed_visualizers = tcx.sess.crate_types().iter().any(|&crate_type| match crate_type {
 922             CrateType::Executable | CrateType::Dylib | CrateType::Cdylib => {
 923                 // These are crate types for which we invoke the linker and can embed
 924                 // NatVis visualizers.
 925                 true
 926             }
 927             CrateType::ProcMacro => {
 928                 // We could embed NatVis for proc macro crates too (to improve the debugging
 929                 // experience for them) but it does not seem like a good default, since
 930                 // this is a rare use case and we don't want to slow down the common case.
 931                 false
 932             }
 933             CrateType::Staticlib | CrateType::Rlib => {
 934                 // We don't invoke the linker for these, so we don't need to collect the NatVis for them.
 935                 false
 936             }
 937         });
 938
 939         if target.is_like_msvc && embed_visualizers {
 940             info.natvis_debugger_visualizers =
 941                 collect_debugger_visualizers_transitive(tcx, DebuggerVisualizerType::Natvis);
 942         }
 943
 944         info
 945     }
 946 }
 947
 948 pub fn provide(providers: &mut Providers) {
 949     providers.backend_optimization_level = |tcx, cratenum| {
 950         let for_speed = match tcx.sess.opts.optimize {
 951             // If globally no optimisation is done, #[optimize] has no effect.
 952             //
 953             // This is done because if we ended up "upgrading" to `-O2` here, we’d populate the
 954             // pass manager and it is likely that some module-wide passes (such as inliner or
 955             // cross-function constant propagation) would ignore the `optnone` annotation we put
 956             // on the functions, thus necessarily involving these functions into optimisations.
 957             config::OptLevel::No => return config::OptLevel::No,
 958             // If globally optimise-speed is already specified, just use that level.
 959             config::OptLevel::Less => return config::OptLevel::Less,
 960             config::OptLevel::Default => return config::OptLevel::Default,
 961             config::OptLevel::Aggressive => return config::OptLevel::Aggressive,
 962             // If globally optimize-for-size has been requested, use -O2 instead (if optimize(size)
 963             // are present).
 964             config::OptLevel::Size => config::OptLevel::Default,
 965             config::OptLevel::SizeMin => config::OptLevel::Default,
 966         };
 967
 968         let (defids, _) = tcx.collect_and_partition_mono_items(cratenum);
 969         for id in &*defids {
 970             let CodegenFnAttrs { optimize, .. } = tcx.codegen_fn_attrs(*id);
 971             match optimize {
 972                 attr::OptimizeAttr::None => continue,
 973                 attr::OptimizeAttr::Size => continue,
 974                 attr::OptimizeAttr::Speed => {
 975                     return for_speed;
 976                 }
 977             }
 978         }
 979         tcx.sess.opts.optimize
 980     };
 981 }
 982
 983 fn determine_cgu_reuse<'tcx>(tcx: TyCtxt<'tcx>, cgu: &CodegenUnit<'tcx>) -> CguReuse {
 984     if !tcx.dep_graph.is_fully_enabled() {
 985         return CguReuse::No;
 986     }
 987
 988     let work_product_id = &cgu.work_product_id();
 989     if tcx.dep_graph.previous_work_product(work_product_id).is_none() {
 990         // We don't have anything cached for this CGU. This can happen
 991         // if the CGU did not exist in the previous session.
 992         return CguReuse::No;
 993     }
 994
 995     // Try to mark the CGU as green. If it we can do so, it means that nothing
 996     // affecting the LLVM module has changed and we can re-use a cached version.
 997     // If we compile with any kind of LTO, this means we can re-use the bitcode
 998     // of the Pre-LTO stage (possibly also the Post-LTO version but we'll only
 999     // know that later). If we are not doing LTO, there is only one optimized
1000     // version of each module, so we re-use that.
1001     let dep_node = cgu.codegen_dep_node(tcx);
1002     assert!(
1003         !tcx.dep_graph.dep_node_exists(&dep_node),
1004         "CompileCodegenUnit dep-node for CGU `{}` already exists before marking.",
1005         cgu.name()
1006     );
1007
1008     if tcx.try_mark_green(&dep_node) {
1009         // We can re-use either the pre- or the post-thinlto state. If no LTO is
1010         // being performed then we can use post-LTO artifacts, otherwise we must
1011         // reuse pre-LTO artifacts
1012         match compute_per_cgu_lto_type(
1013             &tcx.sess.lto(),
1014             &tcx.sess.opts,
1015             &tcx.sess.crate_types(),
1016             ModuleKind::Regular,
1017         ) {
1018             ComputedLtoType::No => CguReuse::PostLto,
1019             _ => CguReuse::PreLto,
1020         }
1021     } else {
1022         CguReuse::No
1023     }
1024 }