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(try_blocks)]
   5 #![feature(in_band_lifetimes)]
   6 #![feature(nll)]
   7 #![feature(trusted_len)]
   8 #![feature(associated_type_bounds)]
   9 #![recursion_limit = "256"]
  10
  11 //! This crate contains codegen code that is used by all codegen backends (LLVM and others).
  12 //! The backend-agnostic functions of this crate use functions defined in various traits that
  13 //! have to be implemented by each backends.
  14
  15 #[macro_use]
  16 extern crate log;
  17 #[macro_use]
  18 extern crate rustc;
  19
  20 use rustc::dep_graph::WorkProduct;
  21 use rustc::middle::cstore::{CrateSource, LibSource, NativeLibrary};
  22 use rustc::middle::dependency_format::Dependencies;
  23 use rustc::middle::lang_items::LangItem;
  24 use rustc::session::config::{OutputFilenames, OutputType, RUST_CGU_EXT};
  25 use rustc::ty::query::Providers;
  26 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  27 use rustc_data_structures::svh::Svh;
  28 use rustc_data_structures::sync::Lrc;
  29 use rustc_hir::def_id::CrateNum;
  30 use rustc_span::symbol::Symbol;
  31 use std::path::{Path, PathBuf};
  32
  33 pub mod back;
  34 pub mod base;
  35 pub mod common;
  36 pub mod debuginfo;
  37 pub mod glue;
  38 pub mod meth;
  39 pub mod mir;
  40 pub mod mono_item;
  41 pub mod traits;
  42
  43 pub struct ModuleCodegen<M> {
  44     /// The name of the module. When the crate may be saved between
  45     /// compilations, incremental compilation requires that name be
  46     /// unique amongst **all** crates. Therefore, it should contain
  47     /// something unique to this crate (e.g., a module path) as well
  48     /// as the crate name and disambiguator.
  49     /// We currently generate these names via CodegenUnit::build_cgu_name().
  50     pub name: String,
  51     pub module_llvm: M,
  52     pub kind: ModuleKind,
  53 }
  54
  55 // FIXME(eddyb) maybe include the crate name in this?
  56 pub const METADATA_FILENAME: &str = "lib.rmeta";
  57 pub const RLIB_BYTECODE_EXTENSION: &str = "bc.z";
  58
  59 impl<M> ModuleCodegen<M> {
  60     pub fn into_compiled_module(
  61         self,
  62         emit_obj: bool,
  63         emit_bc: bool,
  64         emit_bc_compressed: bool,
  65         outputs: &OutputFilenames,
  66     ) -> CompiledModule {
  67         let object = emit_obj.then(|| outputs.temp_path(OutputType::Object, Some(&self.name)));
  68         let bytecode = emit_bc.then(|| outputs.temp_path(OutputType::Bitcode, Some(&self.name)));
  69         let bytecode_compressed = emit_bc_compressed.then(|| {
  70             outputs
  71                 .temp_path(OutputType::Bitcode, Some(&self.name))
  72                 .with_extension(RLIB_BYTECODE_EXTENSION)
  73         });
  74
  75         CompiledModule {
  76             name: self.name.clone(),
  77             kind: self.kind,
  78             object,
  79             bytecode,
  80             bytecode_compressed,
  81         }
  82     }
  83 }
  84
  85 #[derive(Debug, RustcEncodable, RustcDecodable)]
  86 pub struct CompiledModule {
  87     pub name: String,
  88     pub kind: ModuleKind,
  89     pub object: Option<PathBuf>,
  90     pub bytecode: Option<PathBuf>,
  91     pub bytecode_compressed: Option<PathBuf>,
  92 }
  93
  94 pub struct CachedModuleCodegen {
  95     pub name: String,
  96     pub source: WorkProduct,
  97 }
  98
  99 #[derive(Copy, Clone, Debug, PartialEq, RustcEncodable, RustcDecodable)]
 100 pub enum ModuleKind {
 101     Regular,
 102     Metadata,
 103     Allocator,
 104 }
 105
 106 bitflags::bitflags! {
 107     pub struct MemFlags: u8 {
 108         const VOLATILE = 1 << 0;
 109         const NONTEMPORAL = 1 << 1;
 110         const UNALIGNED = 1 << 2;
 111     }
 112 }
 113
 114 /// Misc info we load from metadata to persist beyond the tcx.
 115 ///
 116 /// Note: though `CrateNum` is only meaningful within the same tcx, information within `CrateInfo`
 117 /// is self-contained. `CrateNum` can be viewed as a unique identifier within a `CrateInfo`, where
 118 /// `used_crate_source` contains all `CrateSource` of the dependents, and maintains a mapping from
 119 /// identifiers (`CrateNum`) to `CrateSource`. The other fields map `CrateNum` to the crate's own
 120 /// additional properties, so that effectively we can retrieve each dependent crate's `CrateSource`
 121 /// and the corresponding properties without referencing information outside of a `CrateInfo`.
 122 #[derive(Debug, RustcEncodable, RustcDecodable)]
 123 pub struct CrateInfo {
 124     pub panic_runtime: Option<CrateNum>,
 125     pub compiler_builtins: Option<CrateNum>,
 126     pub profiler_runtime: Option<CrateNum>,
 127     pub is_no_builtins: FxHashSet<CrateNum>,
 128     pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLibrary>>>,
 129     pub crate_name: FxHashMap<CrateNum, String>,
 130     pub used_libraries: Lrc<Vec<NativeLibrary>>,
 131     pub link_args: Lrc<Vec<String>>,
 132     pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
 133     pub used_crates_static: Vec<(CrateNum, LibSource)>,
 134     pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
 135     pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
 136     pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
 137     pub dependency_formats: Lrc<Dependencies>,
 138 }
 139
 140 #[derive(RustcEncodable, RustcDecodable)]
 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 }