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