src/librustc_codegen_ssa/lib.rs

   1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
   2 #![feature(bool_to_option)]
   3 #![feature(box_patterns)]
   4 #![feature(box_syntax)]
   5 #![feature(core_intrinsics)]
   6 #![feature(libc)]
   7 #![feature(slice_patterns)]
   8 #![feature(stmt_expr_attributes)]
   9 #![feature(try_blocks)]
  10 #![feature(in_band_lifetimes)]
  11 #![feature(nll)]
  12 #![feature(trusted_len)]
  13 #![feature(associated_type_bounds)]
  14 #![recursion_limit = "256"]
  15
  16 //! This crate contains codegen code that is used by all codegen backends (LLVM and others).
  17 //! The backend-agnostic functions of this crate use functions defined in various traits that
  18 //! have to be implemented by each backends.
  19
  20 #[macro_use]
  21 extern crate log;
  22 #[macro_use]
  23 extern crate rustc;
  24 #[macro_use]
  25 extern crate syntax;
  26
  27 use rustc::dep_graph::WorkProduct;
  28 use rustc::middle::cstore::{CrateSource, LibSource, NativeLibrary};
  29 use rustc::middle::dependency_format::Dependencies;
  30 use rustc::middle::lang_items::LangItem;
  31 use rustc::session::config::{OutputFilenames, OutputType, RUST_CGU_EXT};
  32 use rustc::ty::query::Providers;
  33 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  34 use rustc_data_structures::svh::Svh;
  35 use rustc_data_structures::sync::Lrc;
  36 use rustc_hir::def_id::CrateNum;
  37 use rustc_span::symbol::Symbol;
  38 use std::path::{Path, PathBuf};
  39
  40 pub mod back;
  41 pub mod base;
  42 pub mod common;
  43 pub mod debuginfo;
  44 pub mod glue;
  45 pub mod meth;
  46 pub mod mir;
  47 pub mod mono_item;
  48 pub mod traits;
  49
  50 pub struct ModuleCodegen<M> {
  51     /// The name of the module. When the crate may be saved between
  52     /// compilations, incremental compilation requires that name be
  53     /// unique amongst **all** crates. Therefore, it should contain
  54     /// something unique to this crate (e.g., a module path) as well
  55     /// as the crate name and disambiguator.
  56     /// We currently generate these names via CodegenUnit::build_cgu_name().
  57     pub name: String,
  58     pub module_llvm: M,
  59     pub kind: ModuleKind,
  60 }
  61
  62 // FIXME(eddyb) maybe include the crate name in this?
  63 pub const METADATA_FILENAME: &str = "lib.rmeta";
  64 pub const RLIB_BYTECODE_EXTENSION: &str = "bc.z";
  65
  66 impl<M> ModuleCodegen<M> {
  67     pub fn into_compiled_module(
  68         self,
  69         emit_obj: bool,
  70         emit_bc: bool,
  71         emit_bc_compressed: bool,
  72         outputs: &OutputFilenames,
  73     ) -> CompiledModule {
  74         let object = emit_obj.then(|| outputs.temp_path(OutputType::Object, Some(&self.name)));
  75         let bytecode = emit_bc.then(|| outputs.temp_path(OutputType::Bitcode, Some(&self.name)));
  76         let bytecode_compressed = emit_bc_compressed.then(|| {
  77             outputs
  78                 .temp_path(OutputType::Bitcode, Some(&self.name))
  79                 .with_extension(RLIB_BYTECODE_EXTENSION)
  80         });
  81
  82         CompiledModule {
  83             name: self.name.clone(),
  84             kind: self.kind,
  85             object,
  86             bytecode,
  87             bytecode_compressed,
  88         }
  89     }
  90 }
  91
  92 #[derive(Debug)]
  93 pub struct CompiledModule {
  94     pub name: String,
  95     pub kind: ModuleKind,
  96     pub object: Option<PathBuf>,
  97     pub bytecode: Option<PathBuf>,
  98     pub bytecode_compressed: Option<PathBuf>,
  99 }
 100
 101 pub struct CachedModuleCodegen {
 102     pub name: String,
 103     pub source: WorkProduct,
 104 }
 105
 106 #[derive(Copy, Clone, Debug, PartialEq)]
 107 pub enum ModuleKind {
 108     Regular,
 109     Metadata,
 110     Allocator,
 111 }
 112
 113 bitflags::bitflags! {
 114     pub struct MemFlags: u8 {
 115         const VOLATILE = 1 << 0;
 116         const NONTEMPORAL = 1 << 1;
 117         const UNALIGNED = 1 << 2;
 118     }
 119 }
 120
 121 /// Misc info we load from metadata to persist beyond the tcx.
 122 #[derive(Debug)]
 123 pub struct CrateInfo {
 124     pub panic_runtime: Option<CrateNum>,
 125     pub compiler_builtins: Option<CrateNum>,
 126     pub profiler_runtime: Option<CrateNum>,
 127     pub sanitizer_runtime: Option<CrateNum>,
 128     pub is_no_builtins: FxHashSet<CrateNum>,
 129     pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLibrary>>>,
 130     pub crate_name: FxHashMap<CrateNum, String>,
 131     pub used_libraries: Lrc<Vec<NativeLibrary>>,
 132     pub link_args: Lrc<Vec<String>>,
 133     pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
 134     pub used_crates_static: Vec<(CrateNum, LibSource)>,
 135     pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
 136     pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
 137     pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
 138     pub dependency_formats: Lrc<Dependencies>,
 139 }
 140
 141 pub struct CodegenResults {
 142     pub crate_name: Symbol,
 143     pub modules: Vec<CompiledModule>,
 144     pub allocator_module: Option<CompiledModule>,
 145     pub metadata_module: Option<CompiledModule>,
 146     pub crate_hash: Svh,
 147     pub metadata: rustc::middle::cstore::EncodedMetadata,
 148     pub windows_subsystem: Option<String>,
 149     pub linker_info: back::linker::LinkerInfo,
 150     pub crate_info: CrateInfo,
 151 }
 152
 153 pub fn provide(providers: &mut Providers<'_>) {
 154     crate::back::symbol_export::provide(providers);
 155     crate::base::provide_both(providers);
 156 }
 157
 158 pub fn provide_extern(providers: &mut Providers<'_>) {
 159     crate::back::symbol_export::provide_extern(providers);
 160     crate::base::provide_both(providers);
 161 }
 162
 163 /// Checks if the given filename ends with the `.rcgu.o` extension that `rustc`
 164 /// uses for the object files it generates.
 165 pub fn looks_like_rust_object_file(filename: &str) -> bool {
 166     let path = Path::new(filename);
 167     let ext = path.extension().and_then(|s| s.to_str());
 168     if ext != Some(OutputType::Object.extension()) {
 169         // The file name does not end with ".o", so it can't be an object file.
 170         return false;
 171     }
 172
 173     // Strip the ".o" at the end
 174     let ext2 = path.file_stem().and_then(|s| Path::new(s).extension()).and_then(|s| s.to_str());
 175
 176     // Check if the "inner" extension
 177     ext2 == Some(RUST_CGU_EXT)
 178 }