compiler/rustc_codegen_llvm/src/base.rs

   1 //! Codegen the MIR to the LLVM IR.
   2 //!
   3 //! Hopefully useful general knowledge about codegen:
   4 //!
   5 //! * There's no way to find out the [`Ty`] type of a [`Value`]. Doing so
   6 //!   would be "trying to get the eggs out of an omelette" (credit:
   7 //!   pcwalton). You can, instead, find out its [`llvm::Type`] by calling [`val_ty`],
   8 //!   but one [`llvm::Type`] corresponds to many [`Ty`]s; for instance, `tup(int, int,
   9 //!   int)` and `rec(x=int, y=int, z=int)` will have the same [`llvm::Type`].
  10 //!
  11 //! [`Ty`]: rustc_middle::ty::Ty
  12 //! [`val_ty`]: common::val_ty
  13
  14 use super::ModuleLlvm;
  15
  16 use crate::attributes;
  17 use crate::builder::Builder;
  18 use crate::common;
  19 use crate::context::CodegenCx;
  20 use crate::llvm;
  21 use crate::value::Value;
  22
  23 use rustc_codegen_ssa::base::maybe_create_entry_wrapper;
  24 use rustc_codegen_ssa::mono_item::MonoItemExt;
  25 use rustc_codegen_ssa::traits::*;
  26 use rustc_codegen_ssa::{ModuleCodegen, ModuleKind};
  27 use rustc_data_structures::small_c_str::SmallCStr;
  28 use rustc_middle::dep_graph;
  29 use rustc_middle::middle::codegen_fn_attrs::CodegenFnAttrs;
  30 use rustc_middle::middle::cstore::EncodedMetadata;
  31 use rustc_middle::middle::exported_symbols;
  32 use rustc_middle::mir::mono::{Linkage, Visibility};
  33 use rustc_middle::ty::TyCtxt;
  34 use rustc_session::config::DebugInfo;
  35 use rustc_span::symbol::Symbol;
  36 use rustc_target::spec::SanitizerSet;
  37
  38 use std::ffi::CString;
  39 use std::time::Instant;
  40
  41 pub fn write_compressed_metadata<'tcx>(
  42     tcx: TyCtxt<'tcx>,
  43     metadata: &EncodedMetadata,
  44     llvm_module: &mut ModuleLlvm,
  45 ) {
  46     use snap::write::FrameEncoder;
  47     use std::io::Write;
  48
  49     // Historical note:
  50     //
  51     // When using link.exe it was seen that the section name `.note.rustc`
  52     // was getting shortened to `.note.ru`, and according to the PE and COFF
  53     // specification:
  54     //
  55     // > Executable images do not use a string table and do not support
  56     // > section names longer than 8 characters
  57     //
  58     // https://docs.microsoft.com/en-us/windows/win32/debug/pe-format
  59     //
  60     // As a result, we choose a slightly shorter name! As to why
  61     // `.note.rustc` works on MinGW, see
  62     // https://github.com/llvm/llvm-project/blob/llvmorg-12.0.0/lld/COFF/Writer.cpp#L1190-L1197
  63     let section_name = if tcx.sess.target.is_like_osx { "__DATA,.rustc" } else { ".rustc" };
  64
  65     let (metadata_llcx, metadata_llmod) = (&*llvm_module.llcx, llvm_module.llmod());
  66     let mut compressed = rustc_metadata::METADATA_HEADER.to_vec();
  67     FrameEncoder::new(&mut compressed).write_all(&metadata.raw_data).unwrap();
  68
  69     let llmeta = common::bytes_in_context(metadata_llcx, &compressed);
  70     let llconst = common::struct_in_context(metadata_llcx, &[llmeta], false);
  71     let name = exported_symbols::metadata_symbol_name(tcx);
  72     let buf = CString::new(name).unwrap();
  73     let llglobal =
  74         unsafe { llvm::LLVMAddGlobal(metadata_llmod, common::val_ty(llconst), buf.as_ptr()) };
  75     unsafe {
  76         llvm::LLVMSetInitializer(llglobal, llconst);
  77         let name = SmallCStr::new(section_name);
  78         llvm::LLVMSetSection(llglobal, name.as_ptr());
  79
  80         // Also generate a .section directive to force no
  81         // flags, at least for ELF outputs, so that the
  82         // metadata doesn't get loaded into memory.
  83         let directive = format!(".section {}", section_name);
  84         llvm::LLVMSetModuleInlineAsm2(metadata_llmod, directive.as_ptr().cast(), directive.len())
  85     }
  86 }
  87
  88 pub struct ValueIter<'ll> {
  89     cur: Option<&'ll Value>,
  90     step: unsafe extern "C" fn(&'ll Value) -> Option<&'ll Value>,
  91 }
  92
  93 impl Iterator for ValueIter<'ll> {
  94     type Item = &'ll Value;
  95
  96     fn next(&mut self) -> Option<&'ll Value> {
  97         let old = self.cur;
  98         if let Some(old) = old {
  99             self.cur = unsafe { (self.step)(old) };
 100         }
 101         old
 102     }
 103 }
 104
 105 pub fn iter_globals(llmod: &'ll llvm::Module) -> ValueIter<'ll> {
 106     unsafe { ValueIter { cur: llvm::LLVMGetFirstGlobal(llmod), step: llvm::LLVMGetNextGlobal } }
 107 }
 108
 109 pub fn compile_codegen_unit(
 110     tcx: TyCtxt<'tcx>,
 111     cgu_name: Symbol,
 112 ) -> (ModuleCodegen<ModuleLlvm>, u64) {
 113     let start_time = Instant::now();
 114
 115     let dep_node = tcx.codegen_unit(cgu_name).codegen_dep_node(tcx);
 116     let (module, _) =
 117         tcx.dep_graph.with_task(dep_node, tcx, cgu_name, module_codegen, dep_graph::hash_result);
 118     let time_to_codegen = start_time.elapsed();
 119
 120     // We assume that the cost to run LLVM on a CGU is proportional to
 121     // the time we needed for codegenning it.
 122     let cost = time_to_codegen.as_nanos() as u64;
 123
 124     fn module_codegen(tcx: TyCtxt<'_>, cgu_name: Symbol) -> ModuleCodegen<ModuleLlvm> {
 125         let cgu = tcx.codegen_unit(cgu_name);
 126         let _prof_timer = tcx.prof.generic_activity_with_args(
 127             "codegen_module",
 128             &[cgu_name.to_string(), cgu.size_estimate().to_string()],
 129         );
 130         // Instantiate monomorphizations without filling out definitions yet...
 131         let llvm_module = ModuleLlvm::new(tcx, &cgu_name.as_str());
 132         {
 133             let cx = CodegenCx::new(tcx, cgu, &llvm_module);
 134             let mono_items = cx.codegen_unit.items_in_deterministic_order(cx.tcx);
 135             for &(mono_item, (linkage, visibility)) in &mono_items {
 136                 mono_item.predefine::<Builder<'_, '_, '_>>(&cx, linkage, visibility);
 137             }
 138
 139             // ... and now that we have everything pre-defined, fill out those definitions.
 140             for &(mono_item, _) in &mono_items {
 141                 mono_item.define::<Builder<'_, '_, '_>>(&cx);
 142             }
 143
 144             // If this codegen unit contains the main function, also create the
 145             // wrapper here
 146             if let Some(entry) = maybe_create_entry_wrapper::<Builder<'_, '_, '_>>(&cx) {
 147                 attributes::sanitize(&cx, SanitizerSet::empty(), entry);
 148             }
 149
 150             // Run replace-all-uses-with for statics that need it
 151             for &(old_g, new_g) in cx.statics_to_rauw().borrow().iter() {
 152                 unsafe {
 153                     let bitcast = llvm::LLVMConstPointerCast(new_g, cx.val_ty(old_g));
 154                     llvm::LLVMReplaceAllUsesWith(old_g, bitcast);
 155                     llvm::LLVMDeleteGlobal(old_g);
 156                 }
 157             }
 158
 159             // Finalize code coverage by injecting the coverage map. Note, the coverage map will
 160             // also be added to the `llvm.used` variable, created next.
 161             if cx.sess().instrument_coverage() {
 162                 cx.coverageinfo_finalize();
 163             }
 164
 165             // Create the llvm.used variable
 166             // This variable has type [N x i8*] and is stored in the llvm.metadata section
 167             if !cx.used_statics().borrow().is_empty() {
 168                 cx.create_used_variable()
 169             }
 170
 171             // Finalize debuginfo
 172             if cx.sess().opts.debuginfo != DebugInfo::None {
 173                 cx.debuginfo_finalize();
 174             }
 175         }
 176
 177         ModuleCodegen {
 178             name: cgu_name.to_string(),
 179             module_llvm: llvm_module,
 180             kind: ModuleKind::Regular,
 181         }
 182     }
 183
 184     (module, cost)
 185 }
 186
 187 pub fn set_link_section(llval: &Value, attrs: &CodegenFnAttrs) {
 188     let sect = match attrs.link_section {
 189         Some(name) => name,
 190         None => return,
 191     };
 192     unsafe {
 193         let buf = SmallCStr::new(&sect.as_str());
 194         llvm::LLVMSetSection(llval, buf.as_ptr());
 195     }
 196 }
 197
 198 pub fn linkage_to_llvm(linkage: Linkage) -> llvm::Linkage {
 199     match linkage {
 200         Linkage::External => llvm::Linkage::ExternalLinkage,
 201         Linkage::AvailableExternally => llvm::Linkage::AvailableExternallyLinkage,
 202         Linkage::LinkOnceAny => llvm::Linkage::LinkOnceAnyLinkage,
 203         Linkage::LinkOnceODR => llvm::Linkage::LinkOnceODRLinkage,
 204         Linkage::WeakAny => llvm::Linkage::WeakAnyLinkage,
 205         Linkage::WeakODR => llvm::Linkage::WeakODRLinkage,
 206         Linkage::Appending => llvm::Linkage::AppendingLinkage,
 207         Linkage::Internal => llvm::Linkage::InternalLinkage,
 208         Linkage::Private => llvm::Linkage::PrivateLinkage,
 209         Linkage::ExternalWeak => llvm::Linkage::ExternalWeakLinkage,
 210         Linkage::Common => llvm::Linkage::CommonLinkage,
 211     }
 212 }
 213
 214 pub fn visibility_to_llvm(linkage: Visibility) -> llvm::Visibility {
 215     match linkage {
 216         Visibility::Default => llvm::Visibility::Default,
 217         Visibility::Hidden => llvm::Visibility::Hidden,
 218         Visibility::Protected => llvm::Visibility::Protected,
 219     }
 220 }