src/librustc_codegen_ssa/base.rs

   1 //! Codegen the completed AST to the LLVM IR.
   2 //!
   3 //! Some functions here, such as `codegen_block` and `codegen_expr`, return a value --
   4 //! the result of the codegen to LLVM -- while others, such as `codegen_fn`
   5 //! and `mono_item`, are called only for the side effect of adding a
   6 //! particular definition to the LLVM IR output we're producing.
   7 //!
   8 //! Hopefully useful general knowledge about codegen:
   9 //!
  10 //! * There's no way to find out the `Ty` type of a `Value`. Doing so
  11 //!   would be "trying to get the eggs out of an omelette" (credit:
  12 //!   pcwalton). You can, instead, find out its `llvm::Type` by calling `val_ty`,
  13 //!   but one `llvm::Type` corresponds to many `Ty`s; for instance, `tup(int, int,
  14 //!   int)` and `rec(x=int, y=int, z=int)` will have the same `llvm::Type`.
  15
  16 use crate::back::write::{
  17     start_async_codegen, submit_codegened_module_to_llvm, submit_post_lto_module_to_llvm,
  18     submit_pre_lto_module_to_llvm, OngoingCodegen,
  19 };
  20 use crate::common::{IntPredicate, RealPredicate, TypeKind};
  21 use crate::meth;
  22 use crate::mir;
  23 use crate::mir::operand::OperandValue;
  24 use crate::mir::place::PlaceRef;
  25 use crate::traits::*;
  26 use crate::{CachedModuleCodegen, CrateInfo, MemFlags, ModuleCodegen, ModuleKind};
  27
  28 use rustc_attr as attr;
  29 use rustc_data_structures::fx::FxHashMap;
  30 use rustc_data_structures::profiling::print_time_passes_entry;
  31 use rustc_data_structures::sync::{par_iter, Lock, ParallelIterator};
  32 use rustc_hir as hir;
  33 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
  34 use rustc_hir::lang_items::StartFnLangItem;
  35 use rustc_index::vec::Idx;
  36 use rustc_middle::middle::codegen_fn_attrs::CodegenFnAttrs;
  37 use rustc_middle::middle::cstore::EncodedMetadata;
  38 use rustc_middle::middle::cstore::{self, LinkagePreference};
  39 use rustc_middle::middle::lang_items;
  40 use rustc_middle::mir::mono::{CodegenUnit, CodegenUnitNameBuilder, MonoItem};
  41 use rustc_middle::ty::layout::{self, HasTyCtxt, TyAndLayout};
  42 use rustc_middle::ty::layout::{FAT_PTR_ADDR, FAT_PTR_EXTRA};
  43 use rustc_middle::ty::query::Providers;
  44 use rustc_middle::ty::{self, Instance, Ty, TyCtxt};
  45 use rustc_session::cgu_reuse_tracker::CguReuse;
  46 use rustc_session::config::{self, EntryFnType, Lto};
  47 use rustc_session::Session;
  48 use rustc_span::Span;
  49 use rustc_symbol_mangling::test as symbol_names_test;
  50 use rustc_target::abi::{Abi, Align, LayoutOf, Scalar, VariantIdx};
  51
  52 use std::cmp;
  53 use std::ops::{Deref, DerefMut};
  54 use std::time::{Duration, Instant};
  55
  56 pub fn bin_op_to_icmp_predicate(op: hir::BinOpKind, signed: bool) -> IntPredicate {
  57     match op {
  58         hir::BinOpKind::Eq => IntPredicate::IntEQ,
  59         hir::BinOpKind::Ne => IntPredicate::IntNE,
  60         hir::BinOpKind::Lt => {
  61             if signed {
  62                 IntPredicate::IntSLT
  63             } else {
  64                 IntPredicate::IntULT
  65             }
  66         }
  67         hir::BinOpKind::Le => {
  68             if signed {
  69                 IntPredicate::IntSLE
  70             } else {
  71                 IntPredicate::IntULE
  72             }
  73         }
  74         hir::BinOpKind::Gt => {
  75             if signed {
  76                 IntPredicate::IntSGT
  77             } else {
  78                 IntPredicate::IntUGT
  79             }
  80         }
  81         hir::BinOpKind::Ge => {
  82             if signed {
  83                 IntPredicate::IntSGE
  84             } else {
  85                 IntPredicate::IntUGE
  86             }
  87         }
  88         op => bug!(
  89             "comparison_op_to_icmp_predicate: expected comparison operator, \
  90              found {:?}",
  91             op
  92         ),
  93     }
  94 }
  95
  96 pub fn bin_op_to_fcmp_predicate(op: hir::BinOpKind) -> RealPredicate {
  97     match op {
  98         hir::BinOpKind::Eq => RealPredicate::RealOEQ,
  99         hir::BinOpKind::Ne => RealPredicate::RealUNE,
 100         hir::BinOpKind::Lt => RealPredicate::RealOLT,
 101         hir::BinOpKind::Le => RealPredicate::RealOLE,
 102         hir::BinOpKind::Gt => RealPredicate::RealOGT,
 103         hir::BinOpKind::Ge => RealPredicate::RealOGE,
 104         op => {
 105             bug!(
 106                 "comparison_op_to_fcmp_predicate: expected comparison operator, \
 107                  found {:?}",
 108                 op
 109             );
 110         }
 111     }
 112 }
 113
 114 pub fn compare_simd_types<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 115     bx: &mut Bx,
 116     lhs: Bx::Value,
 117     rhs: Bx::Value,
 118     t: Ty<'tcx>,
 119     ret_ty: Bx::Type,
 120     op: hir::BinOpKind,
 121 ) -> Bx::Value {
 122     let signed = match t.kind {
 123         ty::Float(_) => {
 124             let cmp = bin_op_to_fcmp_predicate(op);
 125             let cmp = bx.fcmp(cmp, lhs, rhs);
 126             return bx.sext(cmp, ret_ty);
 127         }
 128         ty::Uint(_) => false,
 129         ty::Int(_) => true,
 130         _ => bug!("compare_simd_types: invalid SIMD type"),
 131     };
 132
 133     let cmp = bin_op_to_icmp_predicate(op, signed);
 134     let cmp = bx.icmp(cmp, lhs, rhs);
 135     // LLVM outputs an `< size x i1 >`, so we need to perform a sign extension
 136     // to get the correctly sized type. This will compile to a single instruction
 137     // once the IR is converted to assembly if the SIMD instruction is supported
 138     // by the target architecture.
 139     bx.sext(cmp, ret_ty)
 140 }
 141
 142 /// Retrieves the information we are losing (making dynamic) in an unsizing
 143 /// adjustment.
 144 ///
 145 /// The `old_info` argument is a bit odd. It is intended for use in an upcast,
 146 /// where the new vtable for an object will be derived from the old one.
 147 pub fn unsized_info<'tcx, Cx: CodegenMethods<'tcx>>(
 148     cx: &Cx,
 149     source: Ty<'tcx>,
 150     target: Ty<'tcx>,
 151     old_info: Option<Cx::Value>,
 152 ) -> Cx::Value {
 153     let (source, target) =
 154         cx.tcx().struct_lockstep_tails_erasing_lifetimes(source, target, cx.param_env());
 155     match (&source.kind, &target.kind) {
 156         (&ty::Array(_, len), &ty::Slice(_)) => {
 157             cx.const_usize(len.eval_usize(cx.tcx(), ty::ParamEnv::reveal_all()))
 158         }
 159         (&ty::Dynamic(..), &ty::Dynamic(..)) => {
 160             // For now, upcasts are limited to changes in marker
 161             // traits, and hence never actually require an actual
 162             // change to the vtable.
 163             old_info.expect("unsized_info: missing old info for trait upcast")
 164         }
 165         (_, &ty::Dynamic(ref data, ..)) => {
 166             let vtable_ptr = cx.layout_of(cx.tcx().mk_mut_ptr(target)).field(cx, FAT_PTR_EXTRA);
 167             cx.const_ptrcast(
 168                 meth::get_vtable(cx, source, data.principal()),
 169                 cx.backend_type(vtable_ptr),
 170             )
 171         }
 172         _ => bug!("unsized_info: invalid unsizing {:?} -> {:?}", source, target),
 173     }
 174 }
 175
 176 /// Coerces `src` to `dst_ty`. `src_ty` must be a thin pointer.
 177 pub fn unsize_thin_ptr<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 178     bx: &mut Bx,
 179     src: Bx::Value,
 180     src_ty: Ty<'tcx>,
 181     dst_ty: Ty<'tcx>,
 182 ) -> (Bx::Value, Bx::Value) {
 183     debug!("unsize_thin_ptr: {:?} => {:?}", src_ty, dst_ty);
 184     match (&src_ty.kind, &dst_ty.kind) {
 185         (&ty::Ref(_, a, _), &ty::Ref(_, b, _) | &ty::RawPtr(ty::TypeAndMut { ty: b, .. }))
 186         | (&ty::RawPtr(ty::TypeAndMut { ty: a, .. }), &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) => {
 187             assert!(bx.cx().type_is_sized(a));
 188             let ptr_ty = bx.cx().type_ptr_to(bx.cx().backend_type(bx.cx().layout_of(b)));
 189             (bx.pointercast(src, ptr_ty), unsized_info(bx.cx(), a, b, None))
 190         }
 191         (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) => {
 192             assert_eq!(def_a, def_b);
 193
 194             let src_layout = bx.cx().layout_of(src_ty);
 195             let dst_layout = bx.cx().layout_of(dst_ty);
 196             let mut result = None;
 197             for i in 0..src_layout.fields.count() {
 198                 let src_f = src_layout.field(bx.cx(), i);
 199                 assert_eq!(src_layout.fields.offset(i).bytes(), 0);
 200                 assert_eq!(dst_layout.fields.offset(i).bytes(), 0);
 201                 if src_f.is_zst() {
 202                     continue;
 203                 }
 204                 assert_eq!(src_layout.size, src_f.size);
 205
 206                 let dst_f = dst_layout.field(bx.cx(), i);
 207                 assert_ne!(src_f.ty, dst_f.ty);
 208                 assert_eq!(result, None);
 209                 result = Some(unsize_thin_ptr(bx, src, src_f.ty, dst_f.ty));
 210             }
 211             let (lldata, llextra) = result.unwrap();
 212             // HACK(eddyb) have to bitcast pointers until LLVM removes pointee types.
 213             // FIXME(eddyb) move these out of this `match` arm, so they're always
 214             // applied, uniformly, no matter the source/destination types.
 215             (
 216                 bx.bitcast(lldata, bx.cx().scalar_pair_element_backend_type(dst_layout, 0, true)),
 217                 bx.bitcast(llextra, bx.cx().scalar_pair_element_backend_type(dst_layout, 1, true)),
 218             )
 219         }
 220         _ => bug!("unsize_thin_ptr: called on bad types"),
 221     }
 222 }
 223
 224 /// Coerces `src`, which is a reference to a value of type `src_ty`,
 225 /// to a value of type `dst_ty`, and stores the result in `dst`.
 226 pub fn coerce_unsized_into<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 227     bx: &mut Bx,
 228     src: PlaceRef<'tcx, Bx::Value>,
 229     dst: PlaceRef<'tcx, Bx::Value>,
 230 ) {
 231     let src_ty = src.layout.ty;
 232     let dst_ty = dst.layout.ty;
 233     match (&src_ty.kind, &dst_ty.kind) {
 234         (&ty::Ref(..), &ty::Ref(..) | &ty::RawPtr(..)) | (&ty::RawPtr(..), &ty::RawPtr(..)) => {
 235             let (base, info) = match bx.load_operand(src).val {
 236                 OperandValue::Pair(base, info) => {
 237                     // fat-ptr to fat-ptr unsize preserves the vtable
 238                     // i.e., &'a fmt::Debug+Send => &'a fmt::Debug
 239                     // So we need to pointercast the base to ensure
 240                     // the types match up.
 241                     // FIXME(eddyb) use `scalar_pair_element_backend_type` here,
 242                     // like `unsize_thin_ptr` does.
 243                     let thin_ptr = dst.layout.field(bx.cx(), FAT_PTR_ADDR);
 244                     (bx.pointercast(base, bx.cx().backend_type(thin_ptr)), info)
 245                 }
 246                 OperandValue::Immediate(base) => unsize_thin_ptr(bx, base, src_ty, dst_ty),
 247                 OperandValue::Ref(..) => bug!(),
 248             };
 249             OperandValue::Pair(base, info).store(bx, dst);
 250         }
 251
 252         (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) => {
 253             assert_eq!(def_a, def_b);
 254
 255             for i in 0..def_a.variants[VariantIdx::new(0)].fields.len() {
 256                 let src_f = src.project_field(bx, i);
 257                 let dst_f = dst.project_field(bx, i);
 258
 259                 if dst_f.layout.is_zst() {
 260                     continue;
 261                 }
 262
 263                 if src_f.layout.ty == dst_f.layout.ty {
 264                     memcpy_ty(
 265                         bx,
 266                         dst_f.llval,
 267                         dst_f.align,
 268                         src_f.llval,
 269                         src_f.align,
 270                         src_f.layout,
 271                         MemFlags::empty(),
 272                     );
 273                 } else {
 274                     coerce_unsized_into(bx, src_f, dst_f);
 275                 }
 276             }
 277         }
 278         _ => bug!("coerce_unsized_into: invalid coercion {:?} -> {:?}", src_ty, dst_ty,),
 279     }
 280 }
 281
 282 pub fn cast_shift_expr_rhs<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 283     bx: &mut Bx,
 284     op: hir::BinOpKind,
 285     lhs: Bx::Value,
 286     rhs: Bx::Value,
 287 ) -> Bx::Value {
 288     cast_shift_rhs(bx, op, lhs, rhs)
 289 }
 290
 291 fn cast_shift_rhs<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 292     bx: &mut Bx,
 293     op: hir::BinOpKind,
 294     lhs: Bx::Value,
 295     rhs: Bx::Value,
 296 ) -> Bx::Value {
 297     // Shifts may have any size int on the rhs
 298     if op.is_shift() {
 299         let mut rhs_llty = bx.cx().val_ty(rhs);
 300         let mut lhs_llty = bx.cx().val_ty(lhs);
 301         if bx.cx().type_kind(rhs_llty) == TypeKind::Vector {
 302             rhs_llty = bx.cx().element_type(rhs_llty)
 303         }
 304         if bx.cx().type_kind(lhs_llty) == TypeKind::Vector {
 305             lhs_llty = bx.cx().element_type(lhs_llty)
 306         }
 307         let rhs_sz = bx.cx().int_width(rhs_llty);
 308         let lhs_sz = bx.cx().int_width(lhs_llty);
 309         if lhs_sz < rhs_sz {
 310             bx.trunc(rhs, lhs_llty)
 311         } else if lhs_sz > rhs_sz {
 312             // FIXME (#1877: If in the future shifting by negative
 313             // values is no longer undefined then this is wrong.
 314             bx.zext(rhs, lhs_llty)
 315         } else {
 316             rhs
 317         }
 318     } else {
 319         rhs
 320     }
 321 }
 322
 323 /// Returns `true` if this session's target will use SEH-based unwinding.
 324 ///
 325 /// This is only true for MSVC targets, and even then the 64-bit MSVC target
 326 /// currently uses SEH-ish unwinding with DWARF info tables to the side (same as
 327 /// 64-bit MinGW) instead of "full SEH".
 328 pub fn wants_msvc_seh(sess: &Session) -> bool {
 329     sess.target.target.options.is_like_msvc
 330 }
 331
 332 pub fn from_immediate<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 333     bx: &mut Bx,
 334     val: Bx::Value,
 335 ) -> Bx::Value {
 336     if bx.cx().val_ty(val) == bx.cx().type_i1() { bx.zext(val, bx.cx().type_i8()) } else { val }
 337 }
 338
 339 pub fn to_immediate<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 340     bx: &mut Bx,
 341     val: Bx::Value,
 342     layout: layout::TyAndLayout<'_>,
 343 ) -> Bx::Value {
 344     if let Abi::Scalar(ref scalar) = layout.abi {
 345         return to_immediate_scalar(bx, val, scalar);
 346     }
 347     val
 348 }
 349
 350 pub fn to_immediate_scalar<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 351     bx: &mut Bx,
 352     val: Bx::Value,
 353     scalar: &Scalar,
 354 ) -> Bx::Value {
 355     if scalar.is_bool() {
 356         return bx.trunc(val, bx.cx().type_i1());
 357     }
 358     val
 359 }
 360
 361 pub fn memcpy_ty<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 362     bx: &mut Bx,
 363     dst: Bx::Value,
 364     dst_align: Align,
 365     src: Bx::Value,
 366     src_align: Align,
 367     layout: TyAndLayout<'tcx>,
 368     flags: MemFlags,
 369 ) {
 370     let size = layout.size.bytes();
 371     if size == 0 {
 372         return;
 373     }
 374
 375     bx.memcpy(dst, dst_align, src, src_align, bx.cx().const_usize(size), flags);
 376 }
 377
 378 pub fn codegen_instance<'a, 'tcx: 'a, Bx: BuilderMethods<'a, 'tcx>>(
 379     cx: &'a Bx::CodegenCx,
 380     instance: Instance<'tcx>,
 381 ) {
 382     // this is an info! to allow collecting monomorphization statistics
 383     // and to allow finding the last function before LLVM aborts from
 384     // release builds.
 385     info!("codegen_instance({})", instance);
 386
 387     mir::codegen_mir::<Bx>(cx, instance);
 388 }
 389
 390 /// Creates the `main` function which will initialize the rust runtime and call
 391 /// users main function.
 392 pub fn maybe_create_entry_wrapper<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 393     cx: &'a Bx::CodegenCx,
 394 ) -> Option<Bx::Function> {
 395     let (main_def_id, span) = match cx.tcx().entry_fn(LOCAL_CRATE) {
 396         Some((def_id, _)) => (def_id, cx.tcx().def_span(def_id)),
 397         None => return None,
 398     };
 399
 400     let instance = Instance::mono(cx.tcx(), main_def_id);
 401
 402     if !cx.codegen_unit().contains_item(&MonoItem::Fn(instance)) {
 403         // We want to create the wrapper in the same codegen unit as Rust's main
 404         // function.
 405         return None;
 406     }
 407
 408     let main_llfn = cx.get_fn_addr(instance);
 409
 410     return cx.tcx().entry_fn(LOCAL_CRATE).map(|(_, et)| {
 411         let use_start_lang_item = EntryFnType::Start != et;
 412         create_entry_fn::<Bx>(cx, span, main_llfn, main_def_id, use_start_lang_item)
 413     });
 414
 415     fn create_entry_fn<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 416         cx: &'a Bx::CodegenCx,
 417         sp: Span,
 418         rust_main: Bx::Value,
 419         rust_main_def_id: DefId,
 420         use_start_lang_item: bool,
 421     ) -> Bx::Function {
 422         // The entry function is either `int main(void)` or `int main(int argc, char **argv)`,
 423         // depending on whether the target needs `argc` and `argv` to be passed in.
 424         let llfty = if cx.sess().target.target.options.main_needs_argc_argv {
 425             cx.type_func(&[cx.type_int(), cx.type_ptr_to(cx.type_i8p())], cx.type_int())
 426         } else {
 427             cx.type_func(&[], cx.type_int())
 428         };
 429
 430         let main_ret_ty = cx.tcx().fn_sig(rust_main_def_id).output();
 431         // Given that `main()` has no arguments,
 432         // then its return type cannot have
 433         // late-bound regions, since late-bound
 434         // regions must appear in the argument
 435         // listing.
 436         let main_ret_ty = cx.tcx().erase_regions(&main_ret_ty.no_bound_vars().unwrap());
 437
 438         if cx.get_declared_value("main").is_some() {
 439             // FIXME: We should be smart and show a better diagnostic here.
 440             cx.sess()
 441                 .struct_span_err(sp, "entry symbol `main` declared multiple times")
 442                 .help("did you use `#[no_mangle]` on `fn main`? Use `#[start]` instead")
 443                 .emit();
 444             cx.sess().abort_if_errors();
 445             bug!();
 446         }
 447         let llfn = cx.declare_cfn("main", llfty);
 448
 449         // `main` should respect same config for frame pointer elimination as rest of code
 450         cx.set_frame_pointer_elimination(llfn);
 451         cx.apply_target_cpu_attr(llfn);
 452
 453         let mut bx = Bx::new_block(&cx, llfn, "top");
 454
 455         bx.insert_reference_to_gdb_debug_scripts_section_global();
 456
 457         let (arg_argc, arg_argv) = get_argc_argv(cx, &mut bx);
 458
 459         let (start_fn, args) = if use_start_lang_item {
 460             let start_def_id = cx.tcx().require_lang_item(StartFnLangItem, None);
 461             let start_fn = cx.get_fn_addr(
 462                 ty::Instance::resolve(
 463                     cx.tcx(),
 464                     ty::ParamEnv::reveal_all(),
 465                     start_def_id,
 466                     cx.tcx().intern_substs(&[main_ret_ty.into()]),
 467                 )
 468                 .unwrap()
 469                 .unwrap(),
 470             );
 471             (
 472                 start_fn,
 473                 vec![bx.pointercast(rust_main, cx.type_ptr_to(cx.type_i8p())), arg_argc, arg_argv],
 474             )
 475         } else {
 476             debug!("using user-defined start fn");
 477             (rust_main, vec![arg_argc, arg_argv])
 478         };
 479
 480         let result = bx.call(start_fn, &args, None);
 481         let cast = bx.intcast(result, cx.type_int(), true);
 482         bx.ret(cast);
 483
 484         llfn
 485     }
 486 }
 487
 488 /// Obtain the `argc` and `argv` values to pass to the rust start function.
 489 fn get_argc_argv<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 490     cx: &'a Bx::CodegenCx,
 491     bx: &mut Bx,
 492 ) -> (Bx::Value, Bx::Value) {
 493     if cx.sess().target.target.options.main_needs_argc_argv {
 494         // Params from native `main()` used as args for rust start function
 495         let param_argc = bx.get_param(0);
 496         let param_argv = bx.get_param(1);
 497         let arg_argc = bx.intcast(param_argc, cx.type_isize(), true);
 498         let arg_argv = param_argv;
 499         (arg_argc, arg_argv)
 500     } else {
 501         // The Rust start function doesn't need `argc` and `argv`, so just pass zeros.
 502         let arg_argc = bx.const_int(cx.type_int(), 0);
 503         let arg_argv = bx.const_null(cx.type_ptr_to(cx.type_i8p()));
 504         (arg_argc, arg_argv)
 505     }
 506 }
 507
 508 pub const CODEGEN_WORKER_ID: usize = usize::MAX;
 509
 510 pub fn codegen_crate<B: ExtraBackendMethods>(
 511     backend: B,
 512     tcx: TyCtxt<'tcx>,
 513     metadata: EncodedMetadata,
 514     need_metadata_module: bool,
 515 ) -> OngoingCodegen<B> {
 516     // Skip crate items and just output metadata in -Z no-codegen mode.
 517     if tcx.sess.opts.debugging_opts.no_codegen || !tcx.sess.opts.output_types.should_codegen() {
 518         let ongoing_codegen = start_async_codegen(backend, tcx, metadata, 1);
 519
 520         ongoing_codegen.codegen_finished(tcx);
 521
 522         finalize_tcx(tcx);
 523
 524         ongoing_codegen.check_for_errors(tcx.sess);
 525
 526         return ongoing_codegen;
 527     }
 528
 529     let cgu_name_builder = &mut CodegenUnitNameBuilder::new(tcx);
 530
 531     // Run the monomorphization collector and partition the collected items into
 532     // codegen units.
 533     let codegen_units = tcx.collect_and_partition_mono_items(LOCAL_CRATE).1;
 534
 535     // Force all codegen_unit queries so they are already either red or green
 536     // when compile_codegen_unit accesses them. We are not able to re-execute
 537     // the codegen_unit query from just the DepNode, so an unknown color would
 538     // lead to having to re-execute compile_codegen_unit, possibly
 539     // unnecessarily.
 540     if tcx.dep_graph.is_fully_enabled() {
 541         for cgu in codegen_units {
 542             tcx.codegen_unit(cgu.name());
 543         }
 544     }
 545
 546     let ongoing_codegen = start_async_codegen(backend.clone(), tcx, metadata, codegen_units.len());
 547     let ongoing_codegen = AbortCodegenOnDrop::<B>(Some(ongoing_codegen));
 548
 549     // Codegen an allocator shim, if necessary.
 550     //
 551     // If the crate doesn't have an `allocator_kind` set then there's definitely
 552     // no shim to generate. Otherwise we also check our dependency graph for all
 553     // our output crate types. If anything there looks like its a `Dynamic`
 554     // linkage, then it's already got an allocator shim and we'll be using that
 555     // one instead. If nothing exists then it's our job to generate the
 556     // allocator!
 557     let any_dynamic_crate = tcx.dependency_formats(LOCAL_CRATE).iter().any(|(_, list)| {
 558         use rustc_middle::middle::dependency_format::Linkage;
 559         list.iter().any(|&linkage| linkage == Linkage::Dynamic)
 560     });
 561     let allocator_module = if any_dynamic_crate {
 562         None
 563     } else if let Some(kind) = tcx.allocator_kind() {
 564         let llmod_id =
 565             cgu_name_builder.build_cgu_name(LOCAL_CRATE, &["crate"], Some("allocator")).to_string();
 566         let mut modules = backend.new_metadata(tcx, &llmod_id);
 567         tcx.sess
 568             .time("write_allocator_module", || backend.codegen_allocator(tcx, &mut modules, kind));
 569
 570         Some(ModuleCodegen { name: llmod_id, module_llvm: modules, kind: ModuleKind::Allocator })
 571     } else {
 572         None
 573     };
 574
 575     if let Some(allocator_module) = allocator_module {
 576         ongoing_codegen.submit_pre_codegened_module_to_llvm(tcx, allocator_module);
 577     }
 578
 579     if need_metadata_module {
 580         // Codegen the encoded metadata.
 581         let metadata_cgu_name =
 582             cgu_name_builder.build_cgu_name(LOCAL_CRATE, &["crate"], Some("metadata")).to_string();
 583         let mut metadata_llvm_module = backend.new_metadata(tcx, &metadata_cgu_name);
 584         tcx.sess.time("write_compressed_metadata", || {
 585             backend.write_compressed_metadata(
 586                 tcx,
 587                 &ongoing_codegen.metadata,
 588                 &mut metadata_llvm_module,
 589             );
 590         });
 591
 592         let metadata_module = ModuleCodegen {
 593             name: metadata_cgu_name,
 594             module_llvm: metadata_llvm_module,
 595             kind: ModuleKind::Metadata,
 596         };
 597         ongoing_codegen.submit_pre_codegened_module_to_llvm(tcx, metadata_module);
 598     }
 599
 600     // We sort the codegen units by size. This way we can schedule work for LLVM
 601     // a bit more efficiently.
 602     let codegen_units = {
 603         let mut codegen_units = codegen_units.iter().collect::<Vec<_>>();
 604         codegen_units.sort_by_cached_key(|cgu| cmp::Reverse(cgu.size_estimate()));
 605         codegen_units
 606     };
 607
 608     let total_codegen_time = Lock::new(Duration::new(0, 0));
 609
 610     // The non-parallel compiler can only translate codegen units to LLVM IR
 611     // on a single thread, leading to a staircase effect where the N LLVM
 612     // threads have to wait on the single codegen threads to generate work
 613     // for them. The parallel compiler does not have this restriction, so
 614     // we can pre-load the LLVM queue in parallel before handing off
 615     // coordination to the OnGoingCodegen scheduler.
 616     //
 617     // This likely is a temporary measure. Once we don't have to support the
 618     // non-parallel compiler anymore, we can compile CGUs end-to-end in
 619     // parallel and get rid of the complicated scheduling logic.
 620     let pre_compile_cgus = |cgu_reuse: &[CguReuse]| {
 621         if cfg!(parallel_compiler) {
 622             tcx.sess.time("compile_first_CGU_batch", || {
 623                 // Try to find one CGU to compile per thread.
 624                 let cgus: Vec<_> = cgu_reuse
 625                     .iter()
 626                     .enumerate()
 627                     .filter(|&(_, reuse)| reuse == &CguReuse::No)
 628                     .take(tcx.sess.threads())
 629                     .collect();
 630
 631                 // Compile the found CGUs in parallel.
 632                 par_iter(cgus)
 633                     .map(|(i, _)| {
 634                         let start_time = Instant::now();
 635                         let module = backend.compile_codegen_unit(tcx, codegen_units[i].name());
 636                         let mut time = total_codegen_time.lock();
 637                         *time += start_time.elapsed();
 638                         (i, module)
 639                     })
 640                     .collect()
 641             })
 642         } else {
 643             FxHashMap::default()
 644         }
 645     };
 646
 647     let mut cgu_reuse = Vec::new();
 648     let mut pre_compiled_cgus: Option<FxHashMap<usize, _>> = None;
 649
 650     for (i, cgu) in codegen_units.iter().enumerate() {
 651         ongoing_codegen.wait_for_signal_to_codegen_item();
 652         ongoing_codegen.check_for_errors(tcx.sess);
 653
 654         // Do some setup work in the first iteration
 655         if pre_compiled_cgus.is_none() {
 656             // Calculate the CGU reuse
 657             cgu_reuse = tcx.sess.time("find_cgu_reuse", || {
 658                 codegen_units.iter().map(|cgu| determine_cgu_reuse(tcx, &cgu)).collect()
 659             });
 660             // Pre compile some CGUs
 661             pre_compiled_cgus = Some(pre_compile_cgus(&cgu_reuse));
 662         }
 663
 664         let cgu_reuse = cgu_reuse[i];
 665         tcx.sess.cgu_reuse_tracker.set_actual_reuse(&cgu.name().as_str(), cgu_reuse);
 666
 667         match cgu_reuse {
 668             CguReuse::No => {
 669                 let (module, cost) =
 670                     if let Some(cgu) = pre_compiled_cgus.as_mut().unwrap().remove(&i) {
 671                         cgu
 672                     } else {
 673                         let start_time = Instant::now();
 674                         let module = backend.compile_codegen_unit(tcx, cgu.name());
 675                         let mut time = total_codegen_time.lock();
 676                         *time += start_time.elapsed();
 677                         module
 678                     };
 679                 submit_codegened_module_to_llvm(
 680                     &backend,
 681                     &ongoing_codegen.coordinator_send,
 682                     module,
 683                     cost,
 684                 );
 685                 false
 686             }
 687             CguReuse::PreLto => {
 688                 submit_pre_lto_module_to_llvm(
 689                     &backend,
 690                     tcx,
 691                     &ongoing_codegen.coordinator_send,
 692                     CachedModuleCodegen {
 693                         name: cgu.name().to_string(),
 694                         source: cgu.work_product(tcx),
 695                     },
 696                 );
 697                 true
 698             }
 699             CguReuse::PostLto => {
 700                 submit_post_lto_module_to_llvm(
 701                     &backend,
 702                     &ongoing_codegen.coordinator_send,
 703                     CachedModuleCodegen {
 704                         name: cgu.name().to_string(),
 705                         source: cgu.work_product(tcx),
 706                     },
 707                 );
 708                 true
 709             }
 710         };
 711     }
 712
 713     ongoing_codegen.codegen_finished(tcx);
 714
 715     // Since the main thread is sometimes blocked during codegen, we keep track
 716     // -Ztime-passes output manually.
 717     print_time_passes_entry(
 718         tcx.sess.time_passes(),
 719         "codegen_to_LLVM_IR",
 720         total_codegen_time.into_inner(),
 721     );
 722
 723     ::rustc_incremental::assert_module_sources::assert_module_sources(tcx);
 724
 725     symbol_names_test::report_symbol_names(tcx);
 726
 727     ongoing_codegen.check_for_errors(tcx.sess);
 728
 729     finalize_tcx(tcx);
 730
 731     ongoing_codegen.into_inner()
 732 }
 733
 734 /// A curious wrapper structure whose only purpose is to call `codegen_aborted`
 735 /// when it's dropped abnormally.
 736 ///
 737 /// In the process of working on rust-lang/rust#55238 a mysterious segfault was
 738 /// stumbled upon. The segfault was never reproduced locally, but it was
 739 /// suspected to be related to the fact that codegen worker threads were
 740 /// sticking around by the time the main thread was exiting, causing issues.
 741 ///
 742 /// This structure is an attempt to fix that issue where the `codegen_aborted`
 743 /// message will block until all workers have finished. This should ensure that
 744 /// even if the main codegen thread panics we'll wait for pending work to
 745 /// complete before returning from the main thread, hopefully avoiding
 746 /// segfaults.
 747 ///
 748 /// If you see this comment in the code, then it means that this workaround
 749 /// worked! We may yet one day track down the mysterious cause of that
 750 /// segfault...
 751 struct AbortCodegenOnDrop<B: ExtraBackendMethods>(Option<OngoingCodegen<B>>);
 752
 753 impl<B: ExtraBackendMethods> AbortCodegenOnDrop<B> {
 754     fn into_inner(mut self) -> OngoingCodegen<B> {
 755         self.0.take().unwrap()
 756     }
 757 }
 758
 759 impl<B: ExtraBackendMethods> Deref for AbortCodegenOnDrop<B> {
 760     type Target = OngoingCodegen<B>;
 761
 762     fn deref(&self) -> &OngoingCodegen<B> {
 763         self.0.as_ref().unwrap()
 764     }
 765 }
 766
 767 impl<B: ExtraBackendMethods> DerefMut for AbortCodegenOnDrop<B> {
 768     fn deref_mut(&mut self) -> &mut OngoingCodegen<B> {
 769         self.0.as_mut().unwrap()
 770     }
 771 }
 772
 773 impl<B: ExtraBackendMethods> Drop for AbortCodegenOnDrop<B> {
 774     fn drop(&mut self) {
 775         if let Some(codegen) = self.0.take() {
 776             codegen.codegen_aborted();
 777         }
 778     }
 779 }
 780
 781 fn finalize_tcx(tcx: TyCtxt<'_>) {
 782     tcx.sess.time("assert_dep_graph", || ::rustc_incremental::assert_dep_graph(tcx));
 783     tcx.sess.time("serialize_dep_graph", || ::rustc_incremental::save_dep_graph(tcx));
 784
 785     // We assume that no queries are run past here. If there are new queries
 786     // after this point, they'll show up as "<unknown>" in self-profiling data.
 787     {
 788         let _prof_timer = tcx.prof.generic_activity("self_profile_alloc_query_strings");
 789         tcx.alloc_self_profile_query_strings();
 790     }
 791 }
 792
 793 impl CrateInfo {
 794     pub fn new(tcx: TyCtxt<'_>) -> CrateInfo {
 795         let mut info = CrateInfo {
 796             panic_runtime: None,
 797             compiler_builtins: None,
 798             profiler_runtime: None,
 799             is_no_builtins: Default::default(),
 800             native_libraries: Default::default(),
 801             used_libraries: tcx.native_libraries(LOCAL_CRATE),
 802             link_args: tcx.link_args(LOCAL_CRATE),
 803             crate_name: Default::default(),
 804             used_crates_dynamic: cstore::used_crates(tcx, LinkagePreference::RequireDynamic),
 805             used_crates_static: cstore::used_crates(tcx, LinkagePreference::RequireStatic),
 806             used_crate_source: Default::default(),
 807             lang_item_to_crate: Default::default(),
 808             missing_lang_items: Default::default(),
 809             dependency_formats: tcx.dependency_formats(LOCAL_CRATE),
 810         };
 811         let lang_items = tcx.lang_items();
 812
 813         let crates = tcx.crates();
 814
 815         let n_crates = crates.len();
 816         info.native_libraries.reserve(n_crates);
 817         info.crate_name.reserve(n_crates);
 818         info.used_crate_source.reserve(n_crates);
 819         info.missing_lang_items.reserve(n_crates);
 820
 821         for &cnum in crates.iter() {
 822             info.native_libraries.insert(cnum, tcx.native_libraries(cnum));
 823             info.crate_name.insert(cnum, tcx.crate_name(cnum).to_string());
 824             info.used_crate_source.insert(cnum, tcx.used_crate_source(cnum));
 825             if tcx.is_panic_runtime(cnum) {
 826                 info.panic_runtime = Some(cnum);
 827             }
 828             if tcx.is_compiler_builtins(cnum) {
 829                 info.compiler_builtins = Some(cnum);
 830             }
 831             if tcx.is_profiler_runtime(cnum) {
 832                 info.profiler_runtime = Some(cnum);
 833             }
 834             if tcx.is_no_builtins(cnum) {
 835                 info.is_no_builtins.insert(cnum);
 836             }
 837             let missing = tcx.missing_lang_items(cnum);
 838             for &item in missing.iter() {
 839                 if let Ok(id) = lang_items.require(item) {
 840                     info.lang_item_to_crate.insert(item, id.krate);
 841                 }
 842             }
 843
 844             // No need to look for lang items that are whitelisted and don't
 845             // actually need to exist.
 846             let missing =
 847                 missing.iter().cloned().filter(|&l| !lang_items::whitelisted(tcx, l)).collect();
 848             info.missing_lang_items.insert(cnum, missing);
 849         }
 850
 851         info
 852     }
 853 }
 854
 855 pub fn provide_both(providers: &mut Providers<'_>) {
 856     providers.backend_optimization_level = |tcx, cratenum| {
 857         let for_speed = match tcx.sess.opts.optimize {
 858             // If globally no optimisation is done, #[optimize] has no effect.
 859             //
 860             // This is done because if we ended up "upgrading" to `-O2` here, we’d populate the
 861             // pass manager and it is likely that some module-wide passes (such as inliner or
 862             // cross-function constant propagation) would ignore the `optnone` annotation we put
 863             // on the functions, thus necessarily involving these functions into optimisations.
 864             config::OptLevel::No => return config::OptLevel::No,
 865             // If globally optimise-speed is already specified, just use that level.
 866             config::OptLevel::Less => return config::OptLevel::Less,
 867             config::OptLevel::Default => return config::OptLevel::Default,
 868             config::OptLevel::Aggressive => return config::OptLevel::Aggressive,
 869             // If globally optimize-for-size has been requested, use -O2 instead (if optimize(size)
 870             // are present).
 871             config::OptLevel::Size => config::OptLevel::Default,
 872             config::OptLevel::SizeMin => config::OptLevel::Default,
 873         };
 874
 875         let (defids, _) = tcx.collect_and_partition_mono_items(cratenum);
 876         for id in &*defids {
 877             let CodegenFnAttrs { optimize, .. } = tcx.codegen_fn_attrs(*id);
 878             match optimize {
 879                 attr::OptimizeAttr::None => continue,
 880                 attr::OptimizeAttr::Size => continue,
 881                 attr::OptimizeAttr::Speed => {
 882                     return for_speed;
 883                 }
 884             }
 885         }
 886         tcx.sess.opts.optimize
 887     };
 888
 889     providers.dllimport_foreign_items = |tcx, krate| {
 890         let module_map = tcx.foreign_modules(krate);
 891         let module_map =
 892             module_map.iter().map(|lib| (lib.def_id, lib)).collect::<FxHashMap<_, _>>();
 893
 894         let dllimports = tcx
 895             .native_libraries(krate)
 896             .iter()
 897             .filter(|lib| {
 898                 if lib.kind != cstore::NativeLibraryKind::NativeUnknown {
 899                     return false;
 900                 }
 901                 let cfg = match lib.cfg {
 902                     Some(ref cfg) => cfg,
 903                     None => return true,
 904                 };
 905                 attr::cfg_matches(cfg, &tcx.sess.parse_sess, None)
 906             })
 907             .filter_map(|lib| lib.foreign_module)
 908             .map(|id| &module_map[&id])
 909             .flat_map(|module| module.foreign_items.iter().cloned())
 910             .collect();
 911         tcx.arena.alloc(dllimports)
 912     };
 913
 914     providers.is_dllimport_foreign_item =
 915         |tcx, def_id| tcx.dllimport_foreign_items(def_id.krate).contains(&def_id);
 916 }
 917
 918 fn determine_cgu_reuse<'tcx>(tcx: TyCtxt<'tcx>, cgu: &CodegenUnit<'tcx>) -> CguReuse {
 919     if !tcx.dep_graph.is_fully_enabled() {
 920         return CguReuse::No;
 921     }
 922
 923     let work_product_id = &cgu.work_product_id();
 924     if tcx.dep_graph.previous_work_product(work_product_id).is_none() {
 925         // We don't have anything cached for this CGU. This can happen
 926         // if the CGU did not exist in the previous session.
 927         return CguReuse::No;
 928     }
 929
 930     // Try to mark the CGU as green. If it we can do so, it means that nothing
 931     // affecting the LLVM module has changed and we can re-use a cached version.
 932     // If we compile with any kind of LTO, this means we can re-use the bitcode
 933     // of the Pre-LTO stage (possibly also the Post-LTO version but we'll only
 934     // know that later). If we are not doing LTO, there is only one optimized
 935     // version of each module, so we re-use that.
 936     let dep_node = cgu.codegen_dep_node(tcx);
 937     assert!(
 938         !tcx.dep_graph.dep_node_exists(&dep_node),
 939         "CompileCodegenUnit dep-node for CGU `{}` already exists before marking.",
 940         cgu.name()
 941     );
 942
 943     if tcx.dep_graph.try_mark_green(tcx, &dep_node).is_some() {
 944         // We can re-use either the pre- or the post-thinlto state
 945         if tcx.sess.lto() != Lto::No { CguReuse::PreLto } else { CguReuse::PostLto }
 946     } else {
 947         CguReuse::No
 948     }
 949 }