compiler/rustc_codegen_llvm/src/context.rs

   1 use crate::attributes;
   2 use crate::back::write::to_llvm_code_model;
   3 use crate::callee::get_fn;
   4 use crate::coverageinfo;
   5 use crate::debuginfo;
   6 use crate::llvm;
   7 use crate::llvm_util;
   8 use crate::type_::Type;
   9 use crate::value::Value;
  10
  11 use cstr::cstr;
  12 use rustc_codegen_ssa::base::wants_msvc_seh;
  13 use rustc_codegen_ssa::traits::*;
  14 use rustc_data_structures::base_n;
  15 use rustc_data_structures::fx::FxHashMap;
  16 use rustc_data_structures::small_c_str::SmallCStr;
  17 use rustc_middle::mir::mono::CodegenUnit;
  18 use rustc_middle::ty::layout::{
  19     FnAbiError, FnAbiOfHelpers, FnAbiRequest, HasParamEnv, LayoutError, LayoutOfHelpers,
  20     TyAndLayout,
  21 };
  22 use rustc_middle::ty::{self, Instance, Ty, TyCtxt};
  23 use rustc_middle::{bug, span_bug};
  24 use rustc_session::config::{CFGuard, CrateType, DebugInfo};
  25 use rustc_session::Session;
  26 use rustc_span::source_map::Span;
  27 use rustc_span::symbol::Symbol;
  28 use rustc_target::abi::{
  29     call::FnAbi, HasDataLayout, PointeeInfo, Size, TargetDataLayout, VariantIdx,
  30 };
  31 use rustc_target::spec::{HasTargetSpec, RelocModel, Target, TlsModel};
  32 use smallvec::SmallVec;
  33
  34 use std::cell::{Cell, RefCell};
  35 use std::ffi::CStr;
  36 use std::str;
  37
  38 /// There is one `CodegenCx` per compilation unit. Each one has its own LLVM
  39 /// `llvm::Context` so that several compilation units may be optimized in parallel.
  40 /// All other LLVM data structures in the `CodegenCx` are tied to that `llvm::Context`.
  41 pub struct CodegenCx<'ll, 'tcx> {
  42     pub tcx: TyCtxt<'tcx>,
  43     pub check_overflow: bool,
  44     pub use_dll_storage_attrs: bool,
  45     pub tls_model: llvm::ThreadLocalMode,
  46
  47     pub llmod: &'ll llvm::Module,
  48     pub llcx: &'ll llvm::Context,
  49     pub codegen_unit: &'tcx CodegenUnit<'tcx>,
  50
  51     /// Cache instances of monomorphic and polymorphic items
  52     pub instances: RefCell<FxHashMap<Instance<'tcx>, &'ll Value>>,
  53     /// Cache generated vtables
  54     pub vtables:
  55         RefCell<FxHashMap<(Ty<'tcx>, Option<ty::PolyExistentialTraitRef<'tcx>>), &'ll Value>>,
  56     /// Cache of constant strings,
  57     pub const_cstr_cache: RefCell<FxHashMap<Symbol, &'ll Value>>,
  58
  59     /// Reverse-direction for const ptrs cast from globals.
  60     ///
  61     /// Key is a Value holding a `*T`,
  62     /// Val is a Value holding a `*[T]`.
  63     ///
  64     /// Needed because LLVM loses pointer->pointee association
  65     /// when we ptrcast, and we have to ptrcast during codegen
  66     /// of a `[T]` const because we form a slice, a `(*T,usize)` pair, not
  67     /// a pointer to an LLVM array type. Similar for trait objects.
  68     pub const_unsized: RefCell<FxHashMap<&'ll Value, &'ll Value>>,
  69
  70     /// Cache of emitted const globals (value -> global)
  71     pub const_globals: RefCell<FxHashMap<&'ll Value, &'ll Value>>,
  72
  73     /// List of globals for static variables which need to be passed to the
  74     /// LLVM function ReplaceAllUsesWith (RAUW) when codegen is complete.
  75     /// (We have to make sure we don't invalidate any Values referring
  76     /// to constants.)
  77     pub statics_to_rauw: RefCell<Vec<(&'ll Value, &'ll Value)>>,
  78
  79     /// Statics that will be placed in the llvm.used variable
  80     /// See <https://llvm.org/docs/LangRef.html#the-llvm-used-global-variable> for details
  81     pub used_statics: RefCell<Vec<&'ll Value>>,
  82
  83     /// Statics that will be placed in the llvm.compiler.used variable
  84     /// See <https://llvm.org/docs/LangRef.html#the-llvm-compiler-used-global-variable> for details
  85     pub compiler_used_statics: RefCell<Vec<&'ll Value>>,
  86
  87     /// Mapping of non-scalar types to llvm types and field remapping if needed.
  88     pub type_lowering: RefCell<FxHashMap<(Ty<'tcx>, Option<VariantIdx>), TypeLowering<'ll>>>,
  89
  90     /// Mapping of scalar types to llvm types.
  91     pub scalar_lltypes: RefCell<FxHashMap<Ty<'tcx>, &'ll Type>>,
  92
  93     pub pointee_infos: RefCell<FxHashMap<(Ty<'tcx>, Size), Option<PointeeInfo>>>,
  94     pub isize_ty: &'ll Type,
  95
  96     pub coverage_cx: Option<coverageinfo::CrateCoverageContext<'ll, 'tcx>>,
  97     pub dbg_cx: Option<debuginfo::CrateDebugContext<'ll, 'tcx>>,
  98
  99     eh_personality: Cell<Option<&'ll Value>>,
 100     eh_catch_typeinfo: Cell<Option<&'ll Value>>,
 101     pub rust_try_fn: Cell<Option<(&'ll Type, &'ll Value)>>,
 102
 103     intrinsics: RefCell<FxHashMap<&'static str, (&'ll Type, &'ll Value)>>,
 104
 105     /// A counter that is used for generating local symbol names
 106     local_gen_sym_counter: Cell<usize>,
 107 }
 108
 109 pub struct TypeLowering<'ll> {
 110     /// Associated LLVM type
 111     pub lltype: &'ll Type,
 112
 113     /// If padding is used the slice maps fields from source order
 114     /// to llvm order.
 115     pub field_remapping: Option<SmallVec<[u32; 4]>>,
 116 }
 117
 118 fn to_llvm_tls_model(tls_model: TlsModel) -> llvm::ThreadLocalMode {
 119     match tls_model {
 120         TlsModel::GeneralDynamic => llvm::ThreadLocalMode::GeneralDynamic,
 121         TlsModel::LocalDynamic => llvm::ThreadLocalMode::LocalDynamic,
 122         TlsModel::InitialExec => llvm::ThreadLocalMode::InitialExec,
 123         TlsModel::LocalExec => llvm::ThreadLocalMode::LocalExec,
 124     }
 125 }
 126
 127 pub unsafe fn create_module(
 128     tcx: TyCtxt<'_>,
 129     llcx: &'ll llvm::Context,
 130     mod_name: &str,
 131 ) -> &'ll llvm::Module {
 132     let sess = tcx.sess;
 133     let mod_name = SmallCStr::new(mod_name);
 134     let llmod = llvm::LLVMModuleCreateWithNameInContext(mod_name.as_ptr(), llcx);
 135
 136     let mut target_data_layout = sess.target.data_layout.clone();
 137     if llvm_util::get_version() < (13, 0, 0) {
 138         if sess.target.arch == "powerpc64" {
 139             target_data_layout = target_data_layout.replace("-S128", "");
 140         }
 141         if sess.target.arch == "wasm32" {
 142             target_data_layout = "e-m:e-p:32:32-i64:64-n32:64-S128".to_string();
 143         }
 144         if sess.target.arch == "wasm64" {
 145             target_data_layout = "e-m:e-p:64:64-i64:64-n32:64-S128".to_string();
 146         }
 147     }
 148
 149     // Ensure the data-layout values hardcoded remain the defaults.
 150     if sess.target.is_builtin {
 151         let tm = crate::back::write::create_informational_target_machine(tcx.sess);
 152         llvm::LLVMRustSetDataLayoutFromTargetMachine(llmod, tm);
 153         llvm::LLVMRustDisposeTargetMachine(tm);
 154
 155         let llvm_data_layout = llvm::LLVMGetDataLayoutStr(llmod);
 156         let llvm_data_layout = str::from_utf8(CStr::from_ptr(llvm_data_layout).to_bytes())
 157             .expect("got a non-UTF8 data-layout from LLVM");
 158
 159         // Unfortunately LLVM target specs change over time, and right now we
 160         // don't have proper support to work with any more than one
 161         // `data_layout` than the one that is in the rust-lang/rust repo. If
 162         // this compiler is configured against a custom LLVM, we may have a
 163         // differing data layout, even though we should update our own to use
 164         // that one.
 165         //
 166         // As an interim hack, if CFG_LLVM_ROOT is not an empty string then we
 167         // disable this check entirely as we may be configured with something
 168         // that has a different target layout.
 169         //
 170         // Unsure if this will actually cause breakage when rustc is configured
 171         // as such.
 172         //
 173         // FIXME(#34960)
 174         let cfg_llvm_root = option_env!("CFG_LLVM_ROOT").unwrap_or("");
 175         let custom_llvm_used = cfg_llvm_root.trim() != "";
 176
 177         if !custom_llvm_used && target_data_layout != llvm_data_layout {
 178             bug!(
 179                 "data-layout for target `{rustc_target}`, `{rustc_layout}`, \
 180                   differs from LLVM target's `{llvm_target}` default layout, `{llvm_layout}`",
 181                 rustc_target = sess.opts.target_triple,
 182                 rustc_layout = target_data_layout,
 183                 llvm_target = sess.target.llvm_target,
 184                 llvm_layout = llvm_data_layout
 185             );
 186         }
 187     }
 188
 189     let data_layout = SmallCStr::new(&target_data_layout);
 190     llvm::LLVMSetDataLayout(llmod, data_layout.as_ptr());
 191
 192     let llvm_target = SmallCStr::new(&sess.target.llvm_target);
 193     llvm::LLVMRustSetNormalizedTarget(llmod, llvm_target.as_ptr());
 194
 195     let reloc_model = sess.relocation_model();
 196     if matches!(reloc_model, RelocModel::Pic | RelocModel::Pie) {
 197         llvm::LLVMRustSetModulePICLevel(llmod);
 198         // PIE is potentially more effective than PIC, but can only be used in executables.
 199         // If all our outputs are executables, then we can relax PIC to PIE.
 200         if reloc_model == RelocModel::Pie
 201             || sess.crate_types().iter().all(|ty| *ty == CrateType::Executable)
 202         {
 203             llvm::LLVMRustSetModulePIELevel(llmod);
 204         }
 205     }
 206
 207     // Linking object files with different code models is undefined behavior
 208     // because the compiler would have to generate additional code (to span
 209     // longer jumps) if a larger code model is used with a smaller one.
 210     //
 211     // See https://reviews.llvm.org/D52322 and https://reviews.llvm.org/D52323.
 212     llvm::LLVMRustSetModuleCodeModel(llmod, to_llvm_code_model(sess.code_model()));
 213
 214     // If skipping the PLT is enabled, we need to add some module metadata
 215     // to ensure intrinsic calls don't use it.
 216     if !sess.needs_plt() {
 217         let avoid_plt = "RtLibUseGOT\0".as_ptr().cast();
 218         llvm::LLVMRustAddModuleFlag(llmod, avoid_plt, 1);
 219     }
 220
 221     if sess.is_sanitizer_cfi_enabled() {
 222         // FIXME(rcvalle): Add support for non canonical jump tables.
 223         let canonical_jump_tables = "CFI Canonical Jump Tables\0".as_ptr().cast();
 224         // FIXME(rcvalle): Add it with Override behavior flag--LLVMRustAddModuleFlag adds it with
 225         // Warning behavior flag. Add support for specifying the behavior flag to
 226         // LLVMRustAddModuleFlag.
 227         llvm::LLVMRustAddModuleFlag(llmod, canonical_jump_tables, 1);
 228     }
 229
 230     // Control Flow Guard is currently only supported by the MSVC linker on Windows.
 231     if sess.target.is_like_msvc {
 232         match sess.opts.cg.control_flow_guard {
 233             CFGuard::Disabled => {}
 234             CFGuard::NoChecks => {
 235                 // Set `cfguard=1` module flag to emit metadata only.
 236                 llvm::LLVMRustAddModuleFlag(llmod, "cfguard\0".as_ptr() as *const _, 1)
 237             }
 238             CFGuard::Checks => {
 239                 // Set `cfguard=2` module flag to emit metadata and checks.
 240                 llvm::LLVMRustAddModuleFlag(llmod, "cfguard\0".as_ptr() as *const _, 2)
 241             }
 242         }
 243     }
 244
 245     llmod
 246 }
 247
 248 impl<'ll, 'tcx> CodegenCx<'ll, 'tcx> {
 249     crate fn new(
 250         tcx: TyCtxt<'tcx>,
 251         codegen_unit: &'tcx CodegenUnit<'tcx>,
 252         llvm_module: &'ll crate::ModuleLlvm,
 253     ) -> Self {
 254         // An interesting part of Windows which MSVC forces our hand on (and
 255         // apparently MinGW didn't) is the usage of `dllimport` and `dllexport`
 256         // attributes in LLVM IR as well as native dependencies (in C these
 257         // correspond to `__declspec(dllimport)`).
 258         //
 259         // LD (BFD) in MinGW mode can often correctly guess `dllexport` but
 260         // relying on that can result in issues like #50176.
 261         // LLD won't support that and expects symbols with proper attributes.
 262         // Because of that we make MinGW target emit dllexport just like MSVC.
 263         // When it comes to dllimport we use it for constants but for functions
 264         // rely on the linker to do the right thing. Opposed to dllexport this
 265         // task is easy for them (both LD and LLD) and allows us to easily use
 266         // symbols from static libraries in shared libraries.
 267         //
 268         // Whenever a dynamic library is built on Windows it must have its public
 269         // interface specified by functions tagged with `dllexport` or otherwise
 270         // they're not available to be linked against. This poses a few problems
 271         // for the compiler, some of which are somewhat fundamental, but we use
 272         // the `use_dll_storage_attrs` variable below to attach the `dllexport`
 273         // attribute to all LLVM functions that are exported e.g., they're
 274         // already tagged with external linkage). This is suboptimal for a few
 275         // reasons:
 276         //
 277         // * If an object file will never be included in a dynamic library,
 278         //   there's no need to attach the dllexport attribute. Most object
 279         //   files in Rust are not destined to become part of a dll as binaries
 280         //   are statically linked by default.
 281         // * If the compiler is emitting both an rlib and a dylib, the same
 282         //   source object file is currently used but with MSVC this may be less
 283         //   feasible. The compiler may be able to get around this, but it may
 284         //   involve some invasive changes to deal with this.
 285         //
 286         // The flipside of this situation is that whenever you link to a dll and
 287         // you import a function from it, the import should be tagged with
 288         // `dllimport`. At this time, however, the compiler does not emit
 289         // `dllimport` for any declarations other than constants (where it is
 290         // required), which is again suboptimal for even more reasons!
 291         //
 292         // * Calling a function imported from another dll without using
 293         //   `dllimport` causes the linker/compiler to have extra overhead (one
 294         //   `jmp` instruction on x86) when calling the function.
 295         // * The same object file may be used in different circumstances, so a
 296         //   function may be imported from a dll if the object is linked into a
 297         //   dll, but it may be just linked against if linked into an rlib.
 298         // * The compiler has no knowledge about whether native functions should
 299         //   be tagged dllimport or not.
 300         //
 301         // For now the compiler takes the perf hit (I do not have any numbers to
 302         // this effect) by marking very little as `dllimport` and praying the
 303         // linker will take care of everything. Fixing this problem will likely
 304         // require adding a few attributes to Rust itself (feature gated at the
 305         // start) and then strongly recommending static linkage on Windows!
 306         let use_dll_storage_attrs = tcx.sess.target.is_like_windows;
 307
 308         let check_overflow = tcx.sess.overflow_checks();
 309
 310         let tls_model = to_llvm_tls_model(tcx.sess.tls_model());
 311
 312         let (llcx, llmod) = (&*llvm_module.llcx, llvm_module.llmod());
 313
 314         let coverage_cx = if tcx.sess.instrument_coverage() {
 315             let covctx = coverageinfo::CrateCoverageContext::new();
 316             Some(covctx)
 317         } else {
 318             None
 319         };
 320
 321         let dbg_cx = if tcx.sess.opts.debuginfo != DebugInfo::None {
 322             let dctx = debuginfo::CrateDebugContext::new(llmod);
 323             debuginfo::metadata::compile_unit_metadata(tcx, &codegen_unit.name().as_str(), &dctx);
 324             Some(dctx)
 325         } else {
 326             None
 327         };
 328
 329         let isize_ty = Type::ix_llcx(llcx, tcx.data_layout.pointer_size.bits());
 330
 331         CodegenCx {
 332             tcx,
 333             check_overflow,
 334             use_dll_storage_attrs,
 335             tls_model,
 336             llmod,
 337             llcx,
 338             codegen_unit,
 339             instances: Default::default(),
 340             vtables: Default::default(),
 341             const_cstr_cache: Default::default(),
 342             const_unsized: Default::default(),
 343             const_globals: Default::default(),
 344             statics_to_rauw: RefCell::new(Vec::new()),
 345             used_statics: RefCell::new(Vec::new()),
 346             compiler_used_statics: RefCell::new(Vec::new()),
 347             type_lowering: Default::default(),
 348             scalar_lltypes: Default::default(),
 349             pointee_infos: Default::default(),
 350             isize_ty,
 351             coverage_cx,
 352             dbg_cx,
 353             eh_personality: Cell::new(None),
 354             eh_catch_typeinfo: Cell::new(None),
 355             rust_try_fn: Cell::new(None),
 356             intrinsics: Default::default(),
 357             local_gen_sym_counter: Cell::new(0),
 358         }
 359     }
 360
 361     crate fn statics_to_rauw(&self) -> &RefCell<Vec<(&'ll Value, &'ll Value)>> {
 362         &self.statics_to_rauw
 363     }
 364
 365     #[inline]
 366     pub fn coverage_context(&'a self) -> Option<&'a coverageinfo::CrateCoverageContext<'ll, 'tcx>> {
 367         self.coverage_cx.as_ref()
 368     }
 369
 370     fn create_used_variable_impl(&self, name: &'static CStr, values: &[&'ll Value]) {
 371         let section = cstr!("llvm.metadata");
 372         let array = self.const_array(self.type_ptr_to(self.type_i8()), values);
 373
 374         unsafe {
 375             let g = llvm::LLVMAddGlobal(self.llmod, self.val_ty(array), name.as_ptr());
 376             llvm::LLVMSetInitializer(g, array);
 377             llvm::LLVMRustSetLinkage(g, llvm::Linkage::AppendingLinkage);
 378             llvm::LLVMSetSection(g, section.as_ptr());
 379         }
 380     }
 381 }
 382
 383 impl MiscMethods<'tcx> for CodegenCx<'ll, 'tcx> {
 384     fn vtables(
 385         &self,
 386     ) -> &RefCell<FxHashMap<(Ty<'tcx>, Option<ty::PolyExistentialTraitRef<'tcx>>), &'ll Value>>
 387     {
 388         &self.vtables
 389     }
 390
 391     fn get_fn(&self, instance: Instance<'tcx>) -> &'ll Value {
 392         get_fn(self, instance)
 393     }
 394
 395     fn get_fn_addr(&self, instance: Instance<'tcx>) -> &'ll Value {
 396         get_fn(self, instance)
 397     }
 398
 399     fn eh_personality(&self) -> &'ll Value {
 400         // The exception handling personality function.
 401         //
 402         // If our compilation unit has the `eh_personality` lang item somewhere
 403         // within it, then we just need to codegen that. Otherwise, we're
 404         // building an rlib which will depend on some upstream implementation of
 405         // this function, so we just codegen a generic reference to it. We don't
 406         // specify any of the types for the function, we just make it a symbol
 407         // that LLVM can later use.
 408         //
 409         // Note that MSVC is a little special here in that we don't use the
 410         // `eh_personality` lang item at all. Currently LLVM has support for
 411         // both Dwarf and SEH unwind mechanisms for MSVC targets and uses the
 412         // *name of the personality function* to decide what kind of unwind side
 413         // tables/landing pads to emit. It looks like Dwarf is used by default,
 414         // injecting a dependency on the `_Unwind_Resume` symbol for resuming
 415         // an "exception", but for MSVC we want to force SEH. This means that we
 416         // can't actually have the personality function be our standard
 417         // `rust_eh_personality` function, but rather we wired it up to the
 418         // CRT's custom personality function, which forces LLVM to consider
 419         // landing pads as "landing pads for SEH".
 420         if let Some(llpersonality) = self.eh_personality.get() {
 421             return llpersonality;
 422         }
 423         let tcx = self.tcx;
 424         let llfn = match tcx.lang_items().eh_personality() {
 425             Some(def_id) if !wants_msvc_seh(self.sess()) => self.get_fn_addr(
 426                 ty::Instance::resolve(
 427                     tcx,
 428                     ty::ParamEnv::reveal_all(),
 429                     def_id,
 430                     tcx.intern_substs(&[]),
 431                 )
 432                 .unwrap()
 433                 .unwrap(),
 434             ),
 435             _ => {
 436                 let name = if wants_msvc_seh(self.sess()) {
 437                     "__CxxFrameHandler3"
 438                 } else {
 439                     "rust_eh_personality"
 440                 };
 441                 if let Some(llfn) = self.get_declared_value(name) {
 442                     llfn
 443                 } else {
 444                     let fty = self.type_variadic_func(&[], self.type_i32());
 445                     let llfn = self.declare_cfn(name, llvm::UnnamedAddr::Global, fty);
 446                     attributes::apply_target_cpu_attr(self, llfn);
 447                     llfn
 448                 }
 449             }
 450         };
 451         self.eh_personality.set(Some(llfn));
 452         llfn
 453     }
 454
 455     fn sess(&self) -> &Session {
 456         self.tcx.sess
 457     }
 458
 459     fn check_overflow(&self) -> bool {
 460         self.check_overflow
 461     }
 462
 463     fn codegen_unit(&self) -> &'tcx CodegenUnit<'tcx> {
 464         self.codegen_unit
 465     }
 466
 467     fn used_statics(&self) -> &RefCell<Vec<&'ll Value>> {
 468         &self.used_statics
 469     }
 470
 471     fn compiler_used_statics(&self) -> &RefCell<Vec<&'ll Value>> {
 472         &self.compiler_used_statics
 473     }
 474
 475     fn set_frame_pointer_type(&self, llfn: &'ll Value) {
 476         attributes::set_frame_pointer_type(self, llfn)
 477     }
 478
 479     fn apply_target_cpu_attr(&self, llfn: &'ll Value) {
 480         attributes::apply_target_cpu_attr(self, llfn);
 481         attributes::apply_tune_cpu_attr(self, llfn);
 482     }
 483
 484     fn create_used_variable(&self) {
 485         self.create_used_variable_impl(cstr!("llvm.used"), &*self.used_statics.borrow());
 486     }
 487
 488     fn create_compiler_used_variable(&self) {
 489         self.create_used_variable_impl(
 490             cstr!("llvm.compiler.used"),
 491             &*self.compiler_used_statics.borrow(),
 492         );
 493     }
 494
 495     fn declare_c_main(&self, fn_type: Self::Type) -> Option<Self::Function> {
 496         if self.get_declared_value("main").is_none() {
 497             Some(self.declare_cfn("main", llvm::UnnamedAddr::Global, fn_type))
 498         } else {
 499             // If the symbol already exists, it is an error: for example, the user wrote
 500             // #[no_mangle] extern "C" fn main(..) {..}
 501             // instead of #[start]
 502             None
 503         }
 504     }
 505 }
 506
 507 impl CodegenCx<'b, 'tcx> {
 508     crate fn get_intrinsic(&self, key: &str) -> (&'b Type, &'b Value) {
 509         if let Some(v) = self.intrinsics.borrow().get(key).cloned() {
 510             return v;
 511         }
 512
 513         self.declare_intrinsic(key).unwrap_or_else(|| bug!("unknown intrinsic '{}'", key))
 514     }
 515
 516     fn insert_intrinsic(
 517         &self,
 518         name: &'static str,
 519         args: Option<&[&'b llvm::Type]>,
 520         ret: &'b llvm::Type,
 521     ) -> (&'b llvm::Type, &'b llvm::Value) {
 522         let fn_ty = if let Some(args) = args {
 523             self.type_func(args, ret)
 524         } else {
 525             self.type_variadic_func(&[], ret)
 526         };
 527         let f = self.declare_cfn(name, llvm::UnnamedAddr::No, fn_ty);
 528         self.intrinsics.borrow_mut().insert(name, (fn_ty, f));
 529         (fn_ty, f)
 530     }
 531
 532     fn declare_intrinsic(&self, key: &str) -> Option<(&'b Type, &'b Value)> {
 533         macro_rules! ifn {
 534             ($name:expr, fn() -> $ret:expr) => (
 535                 if key == $name {
 536                     return Some(self.insert_intrinsic($name, Some(&[]), $ret));
 537                 }
 538             );
 539             ($name:expr, fn(...) -> $ret:expr) => (
 540                 if key == $name {
 541                     return Some(self.insert_intrinsic($name, None, $ret));
 542                 }
 543             );
 544             ($name:expr, fn($($arg:expr),*) -> $ret:expr) => (
 545                 if key == $name {
 546                     return Some(self.insert_intrinsic($name, Some(&[$($arg),*]), $ret));
 547                 }
 548             );
 549         }
 550         macro_rules! mk_struct {
 551             ($($field_ty:expr),*) => (self.type_struct( &[$($field_ty),*], false))
 552         }
 553
 554         let i8p = self.type_i8p();
 555         let void = self.type_void();
 556         let i1 = self.type_i1();
 557         let t_i8 = self.type_i8();
 558         let t_i16 = self.type_i16();
 559         let t_i32 = self.type_i32();
 560         let t_i64 = self.type_i64();
 561         let t_i128 = self.type_i128();
 562         let t_isize = self.type_isize();
 563         let t_f32 = self.type_f32();
 564         let t_f64 = self.type_f64();
 565
 566         ifn!("llvm.wasm.trunc.unsigned.i32.f32", fn(t_f32) -> t_i32);
 567         ifn!("llvm.wasm.trunc.unsigned.i32.f64", fn(t_f64) -> t_i32);
 568         ifn!("llvm.wasm.trunc.unsigned.i64.f32", fn(t_f32) -> t_i64);
 569         ifn!("llvm.wasm.trunc.unsigned.i64.f64", fn(t_f64) -> t_i64);
 570         ifn!("llvm.wasm.trunc.signed.i32.f32", fn(t_f32) -> t_i32);
 571         ifn!("llvm.wasm.trunc.signed.i32.f64", fn(t_f64) -> t_i32);
 572         ifn!("llvm.wasm.trunc.signed.i64.f32", fn(t_f32) -> t_i64);
 573         ifn!("llvm.wasm.trunc.signed.i64.f64", fn(t_f64) -> t_i64);
 574
 575         ifn!("llvm.fptosi.sat.i8.f32", fn(t_f32) -> t_i8);
 576         ifn!("llvm.fptosi.sat.i16.f32", fn(t_f32) -> t_i16);
 577         ifn!("llvm.fptosi.sat.i32.f32", fn(t_f32) -> t_i32);
 578         ifn!("llvm.fptosi.sat.i64.f32", fn(t_f32) -> t_i64);
 579         ifn!("llvm.fptosi.sat.i128.f32", fn(t_f32) -> t_i128);
 580         ifn!("llvm.fptosi.sat.i8.f64", fn(t_f64) -> t_i8);
 581         ifn!("llvm.fptosi.sat.i16.f64", fn(t_f64) -> t_i16);
 582         ifn!("llvm.fptosi.sat.i32.f64", fn(t_f64) -> t_i32);
 583         ifn!("llvm.fptosi.sat.i64.f64", fn(t_f64) -> t_i64);
 584         ifn!("llvm.fptosi.sat.i128.f64", fn(t_f64) -> t_i128);
 585
 586         ifn!("llvm.fptoui.sat.i8.f32", fn(t_f32) -> t_i8);
 587         ifn!("llvm.fptoui.sat.i16.f32", fn(t_f32) -> t_i16);
 588         ifn!("llvm.fptoui.sat.i32.f32", fn(t_f32) -> t_i32);
 589         ifn!("llvm.fptoui.sat.i64.f32", fn(t_f32) -> t_i64);
 590         ifn!("llvm.fptoui.sat.i128.f32", fn(t_f32) -> t_i128);
 591         ifn!("llvm.fptoui.sat.i8.f64", fn(t_f64) -> t_i8);
 592         ifn!("llvm.fptoui.sat.i16.f64", fn(t_f64) -> t_i16);
 593         ifn!("llvm.fptoui.sat.i32.f64", fn(t_f64) -> t_i32);
 594         ifn!("llvm.fptoui.sat.i64.f64", fn(t_f64) -> t_i64);
 595         ifn!("llvm.fptoui.sat.i128.f64", fn(t_f64) -> t_i128);
 596
 597         ifn!("llvm.trap", fn() -> void);
 598         ifn!("llvm.debugtrap", fn() -> void);
 599         ifn!("llvm.frameaddress", fn(t_i32) -> i8p);
 600
 601         ifn!("llvm.powi.f32", fn(t_f32, t_i32) -> t_f32);
 602         ifn!("llvm.powi.f64", fn(t_f64, t_i32) -> t_f64);
 603
 604         ifn!("llvm.pow.f32", fn(t_f32, t_f32) -> t_f32);
 605         ifn!("llvm.pow.f64", fn(t_f64, t_f64) -> t_f64);
 606
 607         ifn!("llvm.sqrt.f32", fn(t_f32) -> t_f32);
 608         ifn!("llvm.sqrt.f64", fn(t_f64) -> t_f64);
 609
 610         ifn!("llvm.sin.f32", fn(t_f32) -> t_f32);
 611         ifn!("llvm.sin.f64", fn(t_f64) -> t_f64);
 612
 613         ifn!("llvm.cos.f32", fn(t_f32) -> t_f32);
 614         ifn!("llvm.cos.f64", fn(t_f64) -> t_f64);
 615
 616         ifn!("llvm.exp.f32", fn(t_f32) -> t_f32);
 617         ifn!("llvm.exp.f64", fn(t_f64) -> t_f64);
 618
 619         ifn!("llvm.exp2.f32", fn(t_f32) -> t_f32);
 620         ifn!("llvm.exp2.f64", fn(t_f64) -> t_f64);
 621
 622         ifn!("llvm.log.f32", fn(t_f32) -> t_f32);
 623         ifn!("llvm.log.f64", fn(t_f64) -> t_f64);
 624
 625         ifn!("llvm.log10.f32", fn(t_f32) -> t_f32);
 626         ifn!("llvm.log10.f64", fn(t_f64) -> t_f64);
 627
 628         ifn!("llvm.log2.f32", fn(t_f32) -> t_f32);
 629         ifn!("llvm.log2.f64", fn(t_f64) -> t_f64);
 630
 631         ifn!("llvm.fma.f32", fn(t_f32, t_f32, t_f32) -> t_f32);
 632         ifn!("llvm.fma.f64", fn(t_f64, t_f64, t_f64) -> t_f64);
 633
 634         ifn!("llvm.fabs.f32", fn(t_f32) -> t_f32);
 635         ifn!("llvm.fabs.f64", fn(t_f64) -> t_f64);
 636
 637         ifn!("llvm.minnum.f32", fn(t_f32, t_f32) -> t_f32);
 638         ifn!("llvm.minnum.f64", fn(t_f64, t_f64) -> t_f64);
 639         ifn!("llvm.maxnum.f32", fn(t_f32, t_f32) -> t_f32);
 640         ifn!("llvm.maxnum.f64", fn(t_f64, t_f64) -> t_f64);
 641
 642         ifn!("llvm.floor.f32", fn(t_f32) -> t_f32);
 643         ifn!("llvm.floor.f64", fn(t_f64) -> t_f64);
 644
 645         ifn!("llvm.ceil.f32", fn(t_f32) -> t_f32);
 646         ifn!("llvm.ceil.f64", fn(t_f64) -> t_f64);
 647
 648         ifn!("llvm.trunc.f32", fn(t_f32) -> t_f32);
 649         ifn!("llvm.trunc.f64", fn(t_f64) -> t_f64);
 650
 651         ifn!("llvm.copysign.f32", fn(t_f32, t_f32) -> t_f32);
 652         ifn!("llvm.copysign.f64", fn(t_f64, t_f64) -> t_f64);
 653         ifn!("llvm.round.f32", fn(t_f32) -> t_f32);
 654         ifn!("llvm.round.f64", fn(t_f64) -> t_f64);
 655
 656         ifn!("llvm.rint.f32", fn(t_f32) -> t_f32);
 657         ifn!("llvm.rint.f64", fn(t_f64) -> t_f64);
 658         ifn!("llvm.nearbyint.f32", fn(t_f32) -> t_f32);
 659         ifn!("llvm.nearbyint.f64", fn(t_f64) -> t_f64);
 660
 661         ifn!("llvm.ctpop.i8", fn(t_i8) -> t_i8);
 662         ifn!("llvm.ctpop.i16", fn(t_i16) -> t_i16);
 663         ifn!("llvm.ctpop.i32", fn(t_i32) -> t_i32);
 664         ifn!("llvm.ctpop.i64", fn(t_i64) -> t_i64);
 665         ifn!("llvm.ctpop.i128", fn(t_i128) -> t_i128);
 666
 667         ifn!("llvm.ctlz.i8", fn(t_i8, i1) -> t_i8);
 668         ifn!("llvm.ctlz.i16", fn(t_i16, i1) -> t_i16);
 669         ifn!("llvm.ctlz.i32", fn(t_i32, i1) -> t_i32);
 670         ifn!("llvm.ctlz.i64", fn(t_i64, i1) -> t_i64);
 671         ifn!("llvm.ctlz.i128", fn(t_i128, i1) -> t_i128);
 672
 673         ifn!("llvm.cttz.i8", fn(t_i8, i1) -> t_i8);
 674         ifn!("llvm.cttz.i16", fn(t_i16, i1) -> t_i16);
 675         ifn!("llvm.cttz.i32", fn(t_i32, i1) -> t_i32);
 676         ifn!("llvm.cttz.i64", fn(t_i64, i1) -> t_i64);
 677         ifn!("llvm.cttz.i128", fn(t_i128, i1) -> t_i128);
 678
 679         ifn!("llvm.bswap.i16", fn(t_i16) -> t_i16);
 680         ifn!("llvm.bswap.i32", fn(t_i32) -> t_i32);
 681         ifn!("llvm.bswap.i64", fn(t_i64) -> t_i64);
 682         ifn!("llvm.bswap.i128", fn(t_i128) -> t_i128);
 683
 684         ifn!("llvm.bitreverse.i8", fn(t_i8) -> t_i8);
 685         ifn!("llvm.bitreverse.i16", fn(t_i16) -> t_i16);
 686         ifn!("llvm.bitreverse.i32", fn(t_i32) -> t_i32);
 687         ifn!("llvm.bitreverse.i64", fn(t_i64) -> t_i64);
 688         ifn!("llvm.bitreverse.i128", fn(t_i128) -> t_i128);
 689
 690         ifn!("llvm.fshl.i8", fn(t_i8, t_i8, t_i8) -> t_i8);
 691         ifn!("llvm.fshl.i16", fn(t_i16, t_i16, t_i16) -> t_i16);
 692         ifn!("llvm.fshl.i32", fn(t_i32, t_i32, t_i32) -> t_i32);
 693         ifn!("llvm.fshl.i64", fn(t_i64, t_i64, t_i64) -> t_i64);
 694         ifn!("llvm.fshl.i128", fn(t_i128, t_i128, t_i128) -> t_i128);
 695
 696         ifn!("llvm.fshr.i8", fn(t_i8, t_i8, t_i8) -> t_i8);
 697         ifn!("llvm.fshr.i16", fn(t_i16, t_i16, t_i16) -> t_i16);
 698         ifn!("llvm.fshr.i32", fn(t_i32, t_i32, t_i32) -> t_i32);
 699         ifn!("llvm.fshr.i64", fn(t_i64, t_i64, t_i64) -> t_i64);
 700         ifn!("llvm.fshr.i128", fn(t_i128, t_i128, t_i128) -> t_i128);
 701
 702         ifn!("llvm.sadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct! {t_i8, i1});
 703         ifn!("llvm.sadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct! {t_i16, i1});
 704         ifn!("llvm.sadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct! {t_i32, i1});
 705         ifn!("llvm.sadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct! {t_i64, i1});
 706         ifn!("llvm.sadd.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct! {t_i128, i1});
 707
 708         ifn!("llvm.uadd.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct! {t_i8, i1});
 709         ifn!("llvm.uadd.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct! {t_i16, i1});
 710         ifn!("llvm.uadd.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct! {t_i32, i1});
 711         ifn!("llvm.uadd.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct! {t_i64, i1});
 712         ifn!("llvm.uadd.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct! {t_i128, i1});
 713
 714         ifn!("llvm.ssub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct! {t_i8, i1});
 715         ifn!("llvm.ssub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct! {t_i16, i1});
 716         ifn!("llvm.ssub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct! {t_i32, i1});
 717         ifn!("llvm.ssub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct! {t_i64, i1});
 718         ifn!("llvm.ssub.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct! {t_i128, i1});
 719
 720         ifn!("llvm.usub.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct! {t_i8, i1});
 721         ifn!("llvm.usub.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct! {t_i16, i1});
 722         ifn!("llvm.usub.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct! {t_i32, i1});
 723         ifn!("llvm.usub.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct! {t_i64, i1});
 724         ifn!("llvm.usub.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct! {t_i128, i1});
 725
 726         ifn!("llvm.smul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct! {t_i8, i1});
 727         ifn!("llvm.smul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct! {t_i16, i1});
 728         ifn!("llvm.smul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct! {t_i32, i1});
 729         ifn!("llvm.smul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct! {t_i64, i1});
 730         ifn!("llvm.smul.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct! {t_i128, i1});
 731
 732         ifn!("llvm.umul.with.overflow.i8", fn(t_i8, t_i8) -> mk_struct! {t_i8, i1});
 733         ifn!("llvm.umul.with.overflow.i16", fn(t_i16, t_i16) -> mk_struct! {t_i16, i1});
 734         ifn!("llvm.umul.with.overflow.i32", fn(t_i32, t_i32) -> mk_struct! {t_i32, i1});
 735         ifn!("llvm.umul.with.overflow.i64", fn(t_i64, t_i64) -> mk_struct! {t_i64, i1});
 736         ifn!("llvm.umul.with.overflow.i128", fn(t_i128, t_i128) -> mk_struct! {t_i128, i1});
 737
 738         ifn!("llvm.sadd.sat.i8", fn(t_i8, t_i8) -> t_i8);
 739         ifn!("llvm.sadd.sat.i16", fn(t_i16, t_i16) -> t_i16);
 740         ifn!("llvm.sadd.sat.i32", fn(t_i32, t_i32) -> t_i32);
 741         ifn!("llvm.sadd.sat.i64", fn(t_i64, t_i64) -> t_i64);
 742         ifn!("llvm.sadd.sat.i128", fn(t_i128, t_i128) -> t_i128);
 743
 744         ifn!("llvm.uadd.sat.i8", fn(t_i8, t_i8) -> t_i8);
 745         ifn!("llvm.uadd.sat.i16", fn(t_i16, t_i16) -> t_i16);
 746         ifn!("llvm.uadd.sat.i32", fn(t_i32, t_i32) -> t_i32);
 747         ifn!("llvm.uadd.sat.i64", fn(t_i64, t_i64) -> t_i64);
 748         ifn!("llvm.uadd.sat.i128", fn(t_i128, t_i128) -> t_i128);
 749
 750         ifn!("llvm.ssub.sat.i8", fn(t_i8, t_i8) -> t_i8);
 751         ifn!("llvm.ssub.sat.i16", fn(t_i16, t_i16) -> t_i16);
 752         ifn!("llvm.ssub.sat.i32", fn(t_i32, t_i32) -> t_i32);
 753         ifn!("llvm.ssub.sat.i64", fn(t_i64, t_i64) -> t_i64);
 754         ifn!("llvm.ssub.sat.i128", fn(t_i128, t_i128) -> t_i128);
 755
 756         ifn!("llvm.usub.sat.i8", fn(t_i8, t_i8) -> t_i8);
 757         ifn!("llvm.usub.sat.i16", fn(t_i16, t_i16) -> t_i16);
 758         ifn!("llvm.usub.sat.i32", fn(t_i32, t_i32) -> t_i32);
 759         ifn!("llvm.usub.sat.i64", fn(t_i64, t_i64) -> t_i64);
 760         ifn!("llvm.usub.sat.i128", fn(t_i128, t_i128) -> t_i128);
 761
 762         ifn!("llvm.lifetime.start.p0i8", fn(t_i64, i8p) -> void);
 763         ifn!("llvm.lifetime.end.p0i8", fn(t_i64, i8p) -> void);
 764
 765         ifn!("llvm.expect.i1", fn(i1, i1) -> i1);
 766         ifn!("llvm.eh.typeid.for", fn(i8p) -> t_i32);
 767         ifn!("llvm.localescape", fn(...) -> void);
 768         ifn!("llvm.localrecover", fn(i8p, i8p, t_i32) -> i8p);
 769         ifn!("llvm.x86.seh.recoverfp", fn(i8p, i8p) -> i8p);
 770
 771         ifn!("llvm.assume", fn(i1) -> void);
 772         ifn!("llvm.prefetch", fn(i8p, t_i32, t_i32, t_i32) -> void);
 773
 774         // This isn't an "LLVM intrinsic", but LLVM's optimization passes
 775         // recognize it like one and we assume it exists in `core::slice::cmp`
 776         ifn!("memcmp", fn(i8p, i8p, t_isize) -> t_i32);
 777
 778         // variadic intrinsics
 779         ifn!("llvm.va_start", fn(i8p) -> void);
 780         ifn!("llvm.va_end", fn(i8p) -> void);
 781         ifn!("llvm.va_copy", fn(i8p, i8p) -> void);
 782
 783         if self.sess().instrument_coverage() {
 784             ifn!("llvm.instrprof.increment", fn(i8p, t_i64, t_i32, t_i32) -> void);
 785         }
 786
 787         ifn!("llvm.type.test", fn(i8p, self.type_metadata()) -> i1);
 788
 789         if self.sess().opts.debuginfo != DebugInfo::None {
 790             ifn!("llvm.dbg.declare", fn(self.type_metadata(), self.type_metadata()) -> void);
 791             ifn!("llvm.dbg.value", fn(self.type_metadata(), t_i64, self.type_metadata()) -> void);
 792         }
 793         None
 794     }
 795
 796     crate fn eh_catch_typeinfo(&self) -> &'b Value {
 797         if let Some(eh_catch_typeinfo) = self.eh_catch_typeinfo.get() {
 798             return eh_catch_typeinfo;
 799         }
 800         let tcx = self.tcx;
 801         assert!(self.sess().target.is_like_emscripten);
 802         let eh_catch_typeinfo = match tcx.lang_items().eh_catch_typeinfo() {
 803             Some(def_id) => self.get_static(def_id),
 804             _ => {
 805                 let ty = self
 806                     .type_struct(&[self.type_ptr_to(self.type_isize()), self.type_i8p()], false);
 807                 self.declare_global("rust_eh_catch_typeinfo", ty)
 808             }
 809         };
 810         let eh_catch_typeinfo = self.const_bitcast(eh_catch_typeinfo, self.type_i8p());
 811         self.eh_catch_typeinfo.set(Some(eh_catch_typeinfo));
 812         eh_catch_typeinfo
 813     }
 814 }
 815
 816 impl<'b, 'tcx> CodegenCx<'b, 'tcx> {
 817     /// Generates a new symbol name with the given prefix. This symbol name must
 818     /// only be used for definitions with `internal` or `private` linkage.
 819     pub fn generate_local_symbol_name(&self, prefix: &str) -> String {
 820         let idx = self.local_gen_sym_counter.get();
 821         self.local_gen_sym_counter.set(idx + 1);
 822         // Include a '.' character, so there can be no accidental conflicts with
 823         // user defined names
 824         let mut name = String::with_capacity(prefix.len() + 6);
 825         name.push_str(prefix);
 826         name.push('.');
 827         base_n::push_str(idx as u128, base_n::ALPHANUMERIC_ONLY, &mut name);
 828         name
 829     }
 830 }
 831
 832 impl HasDataLayout for CodegenCx<'ll, 'tcx> {
 833     #[inline]
 834     fn data_layout(&self) -> &TargetDataLayout {
 835         &self.tcx.data_layout
 836     }
 837 }
 838
 839 impl HasTargetSpec for CodegenCx<'ll, 'tcx> {
 840     #[inline]
 841     fn target_spec(&self) -> &Target {
 842         &self.tcx.sess.target
 843     }
 844 }
 845
 846 impl ty::layout::HasTyCtxt<'tcx> for CodegenCx<'ll, 'tcx> {
 847     #[inline]
 848     fn tcx(&self) -> TyCtxt<'tcx> {
 849         self.tcx
 850     }
 851 }
 852
 853 impl<'tcx, 'll> HasParamEnv<'tcx> for CodegenCx<'ll, 'tcx> {
 854     fn param_env(&self) -> ty::ParamEnv<'tcx> {
 855         ty::ParamEnv::reveal_all()
 856     }
 857 }
 858
 859 impl LayoutOfHelpers<'tcx> for CodegenCx<'ll, 'tcx> {
 860     type LayoutOfResult = TyAndLayout<'tcx>;
 861
 862     #[inline]
 863     fn handle_layout_err(&self, err: LayoutError<'tcx>, span: Span, ty: Ty<'tcx>) -> ! {
 864         if let LayoutError::SizeOverflow(_) = err {
 865             self.sess().span_fatal(span, &err.to_string())
 866         } else {
 867             span_bug!(span, "failed to get layout for `{}`: {}", ty, err)
 868         }
 869     }
 870 }
 871
 872 impl FnAbiOfHelpers<'tcx> for CodegenCx<'ll, 'tcx> {
 873     type FnAbiOfResult = &'tcx FnAbi<'tcx, Ty<'tcx>>;
 874
 875     #[inline]
 876     fn handle_fn_abi_err(
 877         &self,
 878         err: FnAbiError<'tcx>,
 879         span: Span,
 880         fn_abi_request: FnAbiRequest<'tcx>,
 881     ) -> ! {
 882         if let FnAbiError::Layout(LayoutError::SizeOverflow(_)) = err {
 883             self.sess().span_fatal(span, &err.to_string())
 884         } else {
 885             match fn_abi_request {
 886                 FnAbiRequest::OfFnPtr { sig, extra_args } => {
 887                     span_bug!(
 888                         span,
 889                         "`fn_abi_of_fn_ptr({}, {:?})` failed: {}",
 890                         sig,
 891                         extra_args,
 892                         err
 893                     );
 894                 }
 895                 FnAbiRequest::OfInstance { instance, extra_args } => {
 896                     span_bug!(
 897                         span,
 898                         "`fn_abi_of_instance({}, {:?})` failed: {}",
 899                         instance,
 900                         extra_args,
 901                         err
 902                     );
 903                 }
 904             }
 905         }
 906     }
 907 }