src/librustc_codegen_llvm/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 super::{LlvmCodegenBackend, ModuleLlvm};
  17 use rustc_codegen_ssa::{ModuleCodegen, ModuleKind};
  18 use rustc_codegen_ssa::base::maybe_create_entry_wrapper;
  19
  20 use crate::llvm;
  21 use crate::metadata;
  22 use crate::builder::Builder;
  23 use crate::common;
  24 use crate::context::CodegenCx;
  25 use crate::monomorphize::partitioning::CodegenUnitExt;
  26 use rustc::dep_graph;
  27 use rustc::mir::mono::{Linkage, Visibility, Stats};
  28 use rustc::middle::cstore::{EncodedMetadata};
  29 use rustc::ty::TyCtxt;
  30 use rustc::middle::exported_symbols;
  31 use rustc::session::config::DebugInfo;
  32 use rustc_codegen_ssa::mono_item::MonoItemExt;
  33 use rustc_data_structures::small_c_str::SmallCStr;
  34
  35 use rustc_codegen_ssa::traits::*;
  36 use rustc_codegen_ssa::back::write::submit_codegened_module_to_llvm;
  37
  38 use std::ffi::CString;
  39 use std::time::Instant;
  40 use syntax_pos::symbol::InternedString;
  41 use rustc::hir::CodegenFnAttrs;
  42
  43 use crate::value::Value;
  44
  45 pub fn write_compressed_metadata<'a, 'gcx>(
  46     tcx: TyCtxt<'a, 'gcx, 'gcx>,
  47     metadata: &EncodedMetadata,
  48     llvm_module: &mut ModuleLlvm
  49 ) {
  50     use std::io::Write;
  51     use flate2::Compression;
  52     use flate2::write::DeflateEncoder;
  53
  54     let (metadata_llcx, metadata_llmod) = (&*llvm_module.llcx, llvm_module.llmod());
  55     let mut compressed = tcx.metadata_encoding_version();
  56     DeflateEncoder::new(&mut compressed, Compression::fast())
  57         .write_all(&metadata.raw_data).unwrap();
  58
  59     let llmeta = common::bytes_in_context(metadata_llcx, &compressed);
  60     let llconst = common::struct_in_context(metadata_llcx, &[llmeta], false);
  61     let name = exported_symbols::metadata_symbol_name(tcx);
  62     let buf = CString::new(name).unwrap();
  63     let llglobal = unsafe {
  64         llvm::LLVMAddGlobal(metadata_llmod, common::val_ty(llconst), buf.as_ptr())
  65     };
  66     unsafe {
  67         llvm::LLVMSetInitializer(llglobal, llconst);
  68         let section_name = metadata::metadata_section_name(&tcx.sess.target.target);
  69         let name = SmallCStr::new(section_name);
  70         llvm::LLVMSetSection(llglobal, name.as_ptr());
  71
  72         // Also generate a .section directive to force no
  73         // flags, at least for ELF outputs, so that the
  74         // metadata doesn't get loaded into memory.
  75         let directive = format!(".section {}", section_name);
  76         let directive = CString::new(directive).unwrap();
  77         llvm::LLVMSetModuleInlineAsm(metadata_llmod, directive.as_ptr())
  78     }
  79 }
  80
  81 pub struct ValueIter<'ll> {
  82     cur: Option<&'ll Value>,
  83     step: unsafe extern "C" fn(&'ll Value) -> Option<&'ll Value>,
  84 }
  85
  86 impl Iterator for ValueIter<'ll> {
  87     type Item = &'ll Value;
  88
  89     fn next(&mut self) -> Option<&'ll Value> {
  90         let old = self.cur;
  91         if let Some(old) = old {
  92             self.cur = unsafe { (self.step)(old) };
  93         }
  94         old
  95     }
  96 }
  97
  98 pub fn iter_globals(llmod: &'ll llvm::Module) -> ValueIter<'ll> {
  99     unsafe {
 100         ValueIter {
 101             cur: llvm::LLVMGetFirstGlobal(llmod),
 102             step: llvm::LLVMGetNextGlobal,
 103         }
 104     }
 105 }
 106
 107 pub fn compile_codegen_unit<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 108                                   cgu_name: InternedString)
 109                                   -> Stats {
 110     let start_time = Instant::now();
 111
 112     let dep_node = tcx.codegen_unit(cgu_name).codegen_dep_node(tcx);
 113     let ((stats, module), _) = tcx.dep_graph.with_task(dep_node,
 114                                                        tcx,
 115                                                        cgu_name,
 116                                                        module_codegen,
 117                                                        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_secs() * 1_000_000_000 +
 123                time_to_codegen.subsec_nanos() as u64;
 124
 125     submit_codegened_module_to_llvm(&LlvmCodegenBackend(()), tcx, module, cost);
 126     return stats;
 127
 128     fn module_codegen<'ll, 'tcx>(
 129         tcx: TyCtxt<'ll, 'tcx, 'tcx>,
 130         cgu_name: InternedString)
 131         -> (Stats, ModuleCodegen<ModuleLlvm>)
 132     {
 133         let cgu = tcx.codegen_unit(cgu_name);
 134         // Instantiate monomorphizations without filling out definitions yet...
 135         let llvm_module = ModuleLlvm::new(tcx, &cgu_name.as_str());
 136         let stats = {
 137             let cx = CodegenCx::new(tcx, cgu, &llvm_module);
 138             let mono_items = cx.codegen_unit
 139                                .items_in_deterministic_order(cx.tcx);
 140             for &(mono_item, (linkage, visibility)) in &mono_items {
 141                 mono_item.predefine::<Builder<'_, '_, '_>>(&cx, linkage, visibility);
 142             }
 143
 144             // ... and now that we have everything pre-defined, fill out those definitions.
 145             for &(mono_item, _) in &mono_items {
 146                 mono_item.define::<Builder<'_, '_, '_>>(&cx);
 147             }
 148
 149             // If this codegen unit contains the main function, also create the
 150             // wrapper here
 151             maybe_create_entry_wrapper::<Builder<'_, '_, '_>>(&cx);
 152
 153             // Run replace-all-uses-with for statics that need it
 154             for &(old_g, new_g) in cx.statics_to_rauw().borrow().iter() {
 155                 unsafe {
 156                     let bitcast = llvm::LLVMConstPointerCast(new_g, cx.val_ty(old_g));
 157                     llvm::LLVMReplaceAllUsesWith(old_g, bitcast);
 158                     llvm::LLVMDeleteGlobal(old_g);
 159                 }
 160             }
 161
 162             // Create the llvm.used variable
 163             // This variable has type [N x i8*] and is stored in the llvm.metadata section
 164             if !cx.used_statics().borrow().is_empty() {
 165                 cx.create_used_variable()
 166             }
 167
 168             // Finalize debuginfo
 169             if cx.sess().opts.debuginfo != DebugInfo::None {
 170                 cx.debuginfo_finalize();
 171             }
 172
 173             cx.consume_stats().into_inner()
 174         };
 175
 176         (stats, ModuleCodegen {
 177             name: cgu_name.to_string(),
 178             module_llvm: llvm_module,
 179             kind: ModuleKind::Regular,
 180         })
 181     }
 182 }
 183
 184 pub fn set_link_section(llval: &Value, attrs: &CodegenFnAttrs) {
 185     let sect = match attrs.link_section {
 186         Some(name) => name,
 187         None => return,
 188     };
 189     unsafe {
 190         let buf = SmallCStr::new(&sect.as_str());
 191         llvm::LLVMSetSection(llval, buf.as_ptr());
 192     }
 193 }
 194
 195 pub fn linkage_to_llvm(linkage: Linkage) -> llvm::Linkage {
 196     match linkage {
 197         Linkage::External => llvm::Linkage::ExternalLinkage,
 198         Linkage::AvailableExternally => llvm::Linkage::AvailableExternallyLinkage,
 199         Linkage::LinkOnceAny => llvm::Linkage::LinkOnceAnyLinkage,
 200         Linkage::LinkOnceODR => llvm::Linkage::LinkOnceODRLinkage,
 201         Linkage::WeakAny => llvm::Linkage::WeakAnyLinkage,
 202         Linkage::WeakODR => llvm::Linkage::WeakODRLinkage,
 203         Linkage::Appending => llvm::Linkage::AppendingLinkage,
 204         Linkage::Internal => llvm::Linkage::InternalLinkage,
 205         Linkage::Private => llvm::Linkage::PrivateLinkage,
 206         Linkage::ExternalWeak => llvm::Linkage::ExternalWeakLinkage,
 207         Linkage::Common => llvm::Linkage::CommonLinkage,
 208     }
 209 }
 210
 211 pub fn visibility_to_llvm(linkage: Visibility) -> llvm::Visibility {
 212     match linkage {
 213         Visibility::Default => llvm::Visibility::Default,
 214         Visibility::Hidden => llvm::Visibility::Hidden,
 215         Visibility::Protected => llvm::Visibility::Protected,
 216     }
 217 }