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::metadata;
  22 use crate::value::Value;
  23
  24 use rustc_codegen_ssa::base::maybe_create_entry_wrapper;
  25 use rustc_codegen_ssa::mono_item::MonoItemExt;
  26 use rustc_codegen_ssa::traits::*;
  27 use rustc_codegen_ssa::{ModuleCodegen, ModuleKind};
  28 use rustc_data_structures::small_c_str::SmallCStr;
  29 use rustc_middle::dep_graph;
  30 use rustc_middle::middle::codegen_fn_attrs::CodegenFnAttrs;
  31 use rustc_middle::middle::cstore::EncodedMetadata;
  32 use rustc_middle::middle::exported_symbols;
  33 use rustc_middle::mir::mono::{Linkage, Visibility};
  34 use rustc_middle::ty::TyCtxt;
  35 use rustc_session::config::{DebugInfo, SanitizerSet};
  36 use rustc_span::symbol::Symbol;
  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     let (metadata_llcx, metadata_llmod) = (&*llvm_module.llcx, llvm_module.llmod());
  50     let mut compressed = tcx.metadata_encoding_version();
  51     FrameEncoder::new(&mut compressed).write_all(&metadata.raw_data).unwrap();
  52
  53     let llmeta = common::bytes_in_context(metadata_llcx, &compressed);
  54     let llconst = common::struct_in_context(metadata_llcx, &[llmeta], false);
  55     let name = exported_symbols::metadata_symbol_name(tcx);
  56     let buf = CString::new(name).unwrap();
  57     let llglobal =
  58         unsafe { llvm::LLVMAddGlobal(metadata_llmod, common::val_ty(llconst), buf.as_ptr()) };
  59     unsafe {
  60         llvm::LLVMSetInitializer(llglobal, llconst);
  61         let section_name = metadata::metadata_section_name(&tcx.sess.target);
  62         let name = SmallCStr::new(section_name);
  63         llvm::LLVMSetSection(llglobal, name.as_ptr());
  64
  65         // Also generate a .section directive to force no
  66         // flags, at least for ELF outputs, so that the
  67         // metadata doesn't get loaded into memory.
  68         let directive = format!(".section {}", section_name);
  69         llvm::LLVMSetModuleInlineAsm2(metadata_llmod, directive.as_ptr().cast(), directive.len())
  70     }
  71 }
  72
  73 pub struct ValueIter<'ll> {
  74     cur: Option<&'ll Value>,
  75     step: unsafe extern "C" fn(&'ll Value) -> Option<&'ll Value>,
  76 }
  77
  78 impl Iterator for ValueIter<'ll> {
  79     type Item = &'ll Value;
  80
  81     fn next(&mut self) -> Option<&'ll Value> {
  82         let old = self.cur;
  83         if let Some(old) = old {
  84             self.cur = unsafe { (self.step)(old) };
  85         }
  86         old
  87     }
  88 }
  89
  90 pub fn iter_globals(llmod: &'ll llvm::Module) -> ValueIter<'ll> {
  91     unsafe { ValueIter { cur: llvm::LLVMGetFirstGlobal(llmod), step: llvm::LLVMGetNextGlobal } }
  92 }
  93
  94 pub fn compile_codegen_unit(
  95     tcx: TyCtxt<'tcx>,
  96     cgu_name: Symbol,
  97 ) -> (ModuleCodegen<ModuleLlvm>, u64) {
  98     let start_time = Instant::now();
  99
 100     let dep_node = tcx.codegen_unit(cgu_name).codegen_dep_node(tcx);
 101     let (module, _) =
 102         tcx.dep_graph.with_task(dep_node, tcx, cgu_name, module_codegen, dep_graph::hash_result);
 103     let time_to_codegen = start_time.elapsed();
 104
 105     // We assume that the cost to run LLVM on a CGU is proportional to
 106     // the time we needed for codegenning it.
 107     let cost = time_to_codegen.as_nanos() as u64;
 108
 109     fn module_codegen(tcx: TyCtxt<'_>, cgu_name: Symbol) -> ModuleCodegen<ModuleLlvm> {
 110         let cgu = tcx.codegen_unit(cgu_name);
 111         let _prof_timer = tcx.prof.generic_activity_with_args(
 112             "codegen_module",
 113             &[cgu_name.to_string(), cgu.size_estimate().to_string()],
 114         );
 115         // Instantiate monomorphizations without filling out definitions yet...
 116         let llvm_module = ModuleLlvm::new(tcx, &cgu_name.as_str());
 117         {
 118             let cx = CodegenCx::new(tcx, cgu, &llvm_module);
 119             let mono_items = cx.codegen_unit.items_in_deterministic_order(cx.tcx);
 120             for &(mono_item, (linkage, visibility)) in &mono_items {
 121                 mono_item.predefine::<Builder<'_, '_, '_>>(&cx, linkage, visibility);
 122             }
 123
 124             // ... and now that we have everything pre-defined, fill out those definitions.
 125             for &(mono_item, _) in &mono_items {
 126                 mono_item.define::<Builder<'_, '_, '_>>(&cx);
 127             }
 128
 129             // If this codegen unit contains the main function, also create the
 130             // wrapper here
 131             if let Some(entry) = maybe_create_entry_wrapper::<Builder<'_, '_, '_>>(&cx) {
 132                 attributes::sanitize(&cx, SanitizerSet::empty(), entry);
 133             }
 134
 135             // Run replace-all-uses-with for statics that need it
 136             for &(old_g, new_g) in cx.statics_to_rauw().borrow().iter() {
 137                 unsafe {
 138                     let bitcast = llvm::LLVMConstPointerCast(new_g, cx.val_ty(old_g));
 139                     llvm::LLVMReplaceAllUsesWith(old_g, bitcast);
 140                     llvm::LLVMDeleteGlobal(old_g);
 141                 }
 142             }
 143
 144             // Finalize code coverage by injecting the coverage map. Note, the coverage map will
 145             // also be added to the `llvm.used` variable, created next.
 146             if cx.sess().instrument_coverage() {
 147                 cx.coverageinfo_finalize();
 148             }
 149
 150             // Create the llvm.used variable
 151             // This variable has type [N x i8*] and is stored in the llvm.metadata section
 152             if !cx.used_statics().borrow().is_empty() {
 153                 cx.create_used_variable()
 154             }
 155
 156             // Finalize debuginfo
 157             if cx.sess().opts.debuginfo != DebugInfo::None {
 158                 cx.debuginfo_finalize();
 159             }
 160         }
 161
 162         ModuleCodegen {
 163             name: cgu_name.to_string(),
 164             module_llvm: llvm_module,
 165             kind: ModuleKind::Regular,
 166         }
 167     }
 168
 169     (module, cost)
 170 }
 171
 172 pub fn set_link_section(llval: &Value, attrs: &CodegenFnAttrs) {
 173     let sect = match attrs.link_section {
 174         Some(name) => name,
 175         None => return,
 176     };
 177     unsafe {
 178         let buf = SmallCStr::new(&sect.as_str());
 179         llvm::LLVMSetSection(llval, buf.as_ptr());
 180     }
 181 }
 182
 183 pub fn linkage_to_llvm(linkage: Linkage) -> llvm::Linkage {
 184     match linkage {
 185         Linkage::External => llvm::Linkage::ExternalLinkage,
 186         Linkage::AvailableExternally => llvm::Linkage::AvailableExternallyLinkage,
 187         Linkage::LinkOnceAny => llvm::Linkage::LinkOnceAnyLinkage,
 188         Linkage::LinkOnceODR => llvm::Linkage::LinkOnceODRLinkage,
 189         Linkage::WeakAny => llvm::Linkage::WeakAnyLinkage,
 190         Linkage::WeakODR => llvm::Linkage::WeakODRLinkage,
 191         Linkage::Appending => llvm::Linkage::AppendingLinkage,
 192         Linkage::Internal => llvm::Linkage::InternalLinkage,
 193         Linkage::Private => llvm::Linkage::PrivateLinkage,
 194         Linkage::ExternalWeak => llvm::Linkage::ExternalWeakLinkage,
 195         Linkage::Common => llvm::Linkage::CommonLinkage,
 196     }
 197 }
 198
 199 pub fn visibility_to_llvm(linkage: Visibility) -> llvm::Visibility {
 200     match linkage {
 201         Visibility::Default => llvm::Visibility::Default,
 202         Visibility::Hidden => llvm::Visibility::Hidden,
 203         Visibility::Protected => llvm::Visibility::Protected,
 204     }
 205 }