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