src/librustc_codegen_ssa/lib.rs

   1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
   2 #![feature(bool_to_option)]
   3 #![feature(option_expect_none)]
   4 #![feature(box_patterns)]
   5 #![feature(try_blocks)]
   6 #![feature(in_band_lifetimes)]
   7 #![feature(nll)]
   8 #![feature(or_patterns)]
   9 #![feature(trusted_len)]
  10 #![feature(associated_type_bounds)]
  11 #![feature(const_fn)] // for rustc_index::newtype_index
  12 #![feature(const_panic)] // for rustc_index::newtype_index
  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 rustc_macros;
  21 #[macro_use]
  22 extern crate log;
  23 #[macro_use]
  24 extern crate rustc_middle;
  25
  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_hir::LangItem;
  31 use rustc_middle::dep_graph::WorkProduct;
  32 use rustc_middle::middle::cstore::{CrateSource, LibSource, NativeLib};
  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_span::symbol::Symbol;
  37 use std::path::{Path, PathBuf};
  38
  39 pub mod back;
  40 pub mod base;
  41 pub mod common;
  42 pub mod coverageinfo;
  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
  65 impl<M> ModuleCodegen<M> {
  66     pub fn into_compiled_module(
  67         self,
  68         emit_obj: bool,
  69         emit_bc: 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
  75         CompiledModule { name: self.name.clone(), kind: self.kind, object, bytecode }
  76     }
  77 }
  78
  79 #[derive(Debug, Encodable, Decodable)]
  80 pub struct CompiledModule {
  81     pub name: String,
  82     pub kind: ModuleKind,
  83     pub object: Option<PathBuf>,
  84     pub bytecode: Option<PathBuf>,
  85 }
  86
  87 pub struct CachedModuleCodegen {
  88     pub name: String,
  89     pub source: WorkProduct,
  90 }
  91
  92 #[derive(Copy, Clone, Debug, PartialEq, Encodable, Decodable)]
  93 pub enum ModuleKind {
  94     Regular,
  95     Metadata,
  96     Allocator,
  97 }
  98
  99 bitflags::bitflags! {
 100     pub struct MemFlags: u8 {
 101         const VOLATILE = 1 << 0;
 102         const NONTEMPORAL = 1 << 1;
 103         const UNALIGNED = 1 << 2;
 104     }
 105 }
 106
 107 /// Misc info we load from metadata to persist beyond the tcx.
 108 ///
 109 /// Note: though `CrateNum` is only meaningful within the same tcx, information within `CrateInfo`
 110 /// is self-contained. `CrateNum` can be viewed as a unique identifier within a `CrateInfo`, where
 111 /// `used_crate_source` contains all `CrateSource` of the dependents, and maintains a mapping from
 112 /// identifiers (`CrateNum`) to `CrateSource`. The other fields map `CrateNum` to the crate's own
 113 /// additional properties, so that effectively we can retrieve each dependent crate's `CrateSource`
 114 /// and the corresponding properties without referencing information outside of a `CrateInfo`.
 115 #[derive(Debug, Encodable, Decodable)]
 116 pub struct CrateInfo {
 117     pub panic_runtime: Option<CrateNum>,
 118     pub compiler_builtins: Option<CrateNum>,
 119     pub profiler_runtime: Option<CrateNum>,
 120     pub is_no_builtins: FxHashSet<CrateNum>,
 121     pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLib>>>,
 122     pub crate_name: FxHashMap<CrateNum, String>,
 123     pub used_libraries: Lrc<Vec<NativeLib>>,
 124     pub link_args: Lrc<Vec<String>>,
 125     pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
 126     pub used_crates_static: Vec<(CrateNum, LibSource)>,
 127     pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
 128     pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
 129     pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
 130     pub dependency_formats: Lrc<Dependencies>,
 131 }
 132
 133 #[derive(Encodable, Decodable)]
 134 pub struct CodegenResults {
 135     pub crate_name: Symbol,
 136     pub modules: Vec<CompiledModule>,
 137     pub allocator_module: Option<CompiledModule>,
 138     pub metadata_module: Option<CompiledModule>,
 139     pub crate_hash: Svh,
 140     pub metadata: rustc_middle::middle::cstore::EncodedMetadata,
 141     pub windows_subsystem: Option<String>,
 142     pub linker_info: back::linker::LinkerInfo,
 143     pub crate_info: CrateInfo,
 144 }
 145
 146 pub fn provide(providers: &mut Providers) {
 147     crate::back::symbol_export::provide(providers);
 148     crate::base::provide_both(providers);
 149 }
 150
 151 pub fn provide_extern(providers: &mut Providers) {
 152     crate::back::symbol_export::provide_extern(providers);
 153     crate::base::provide_both(providers);
 154 }
 155
 156 /// Checks if the given filename ends with the `.rcgu.o` extension that `rustc`
 157 /// uses for the object files it generates.
 158 pub fn looks_like_rust_object_file(filename: &str) -> bool {
 159     let path = Path::new(filename);
 160     let ext = path.extension().and_then(|s| s.to_str());
 161     if ext != Some(OutputType::Object.extension()) {
 162         // The file name does not end with ".o", so it can't be an object file.
 163         return false;
 164     }
 165
 166     // Strip the ".o" at the end
 167     let ext2 = path.file_stem().and_then(|s| Path::new(s).extension()).and_then(|s| s.to_str());
 168
 169     // Check if the "inner" extension
 170     ext2 == Some(RUST_CGU_EXT)
 171 }