compiler/rustc_codegen_ssa/src/lib.rs

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