compiler/rustc_codegen_ssa/src/lib.rs

   1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
   2 #![feature(box_patterns)]
   3 #![feature(try_blocks)]
   4 #![feature(let_else)]
   5 #![feature(once_cell)]
   6 #![feature(associated_type_bounds)]
   7 #![feature(strict_provenance)]
   8 #![feature(int_roundings)]
   9 #![recursion_limit = "256"]
  10 #![allow(rustc::potential_query_instability)]
  11
  12 //! This crate contains codegen code that is used by all codegen backends (LLVM and others).
  13 //! The backend-agnostic functions of this crate use functions defined in various traits that
  14 //! have to be implemented by each backends.
  15
  16 #[macro_use]
  17 extern crate rustc_macros;
  18 #[macro_use]
  19 extern crate tracing;
  20 #[macro_use]
  21 extern crate rustc_middle;
  22
  23 use rustc_ast as ast;
  24 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  25 use rustc_data_structures::sync::Lrc;
  26 use rustc_hir::def_id::CrateNum;
  27 use rustc_hir::LangItem;
  28 use rustc_middle::dep_graph::WorkProduct;
  29 use rustc_middle::middle::dependency_format::Dependencies;
  30 use rustc_middle::middle::exported_symbols::SymbolExportKind;
  31 use rustc_middle::ty::query::{ExternProviders, Providers};
  32 use rustc_serialize::{opaque, Decodable, Decoder, Encodable, Encoder};
  33 use rustc_session::config::{CrateType, OutputFilenames, OutputType, RUST_CGU_EXT};
  34 use rustc_session::cstore::{self, CrateSource};
  35 use rustc_session::utils::NativeLibKind;
  36 use rustc_span::symbol::Symbol;
  37 use rustc_span::DebuggerVisualizerFile;
  38 use std::collections::BTreeSet;
  39 use std::path::{Path, PathBuf};
  40
  41 pub mod back;
  42 pub mod base;
  43 pub mod common;
  44 pub mod coverageinfo;
  45 pub mod debuginfo;
  46 pub mod glue;
  47 pub mod meth;
  48 pub mod mir;
  49 pub mod mono_item;
  50 pub mod target_features;
  51 pub mod traits;
  52
  53 pub struct ModuleCodegen<M> {
  54     /// The name of the module. When the crate may be saved between
  55     /// compilations, incremental compilation requires that name be
  56     /// unique amongst **all** crates. Therefore, it should contain
  57     /// something unique to this crate (e.g., a module path) as well
  58     /// as the crate name and disambiguator.
  59     /// We currently generate these names via CodegenUnit::build_cgu_name().
  60     pub name: String,
  61     pub module_llvm: M,
  62     pub kind: ModuleKind,
  63 }
  64
  65 // FIXME(eddyb) maybe include the crate name in this?
  66 pub const METADATA_FILENAME: &str = "lib.rmeta";
  67
  68 impl<M> ModuleCodegen<M> {
  69     pub fn into_compiled_module(
  70         self,
  71         emit_obj: bool,
  72         emit_dwarf_obj: bool,
  73         emit_bc: bool,
  74         outputs: &OutputFilenames,
  75     ) -> CompiledModule {
  76         let object = emit_obj.then(|| outputs.temp_path(OutputType::Object, Some(&self.name)));
  77         let dwarf_object = emit_dwarf_obj.then(|| outputs.temp_path_dwo(Some(&self.name)));
  78         let bytecode = emit_bc.then(|| outputs.temp_path(OutputType::Bitcode, Some(&self.name)));
  79
  80         CompiledModule { name: self.name.clone(), kind: self.kind, object, dwarf_object, bytecode }
  81     }
  82 }
  83
  84 #[derive(Debug, Encodable, Decodable)]
  85 pub struct CompiledModule {
  86     pub name: String,
  87     pub kind: ModuleKind,
  88     pub object: Option<PathBuf>,
  89     pub dwarf_object: Option<PathBuf>,
  90     pub bytecode: Option<PathBuf>,
  91 }
  92
  93 pub struct CachedModuleCodegen {
  94     pub name: String,
  95     pub source: WorkProduct,
  96 }
  97
  98 #[derive(Copy, Clone, Debug, PartialEq, Encodable, Decodable)]
  99 pub enum ModuleKind {
 100     Regular,
 101     Metadata,
 102     Allocator,
 103 }
 104
 105 bitflags::bitflags! {
 106     pub struct MemFlags: u8 {
 107         const VOLATILE = 1 << 0;
 108         const NONTEMPORAL = 1 << 1;
 109         const UNALIGNED = 1 << 2;
 110     }
 111 }
 112
 113 #[derive(Clone, Debug, Encodable, Decodable, HashStable)]
 114 pub struct NativeLib {
 115     pub kind: NativeLibKind,
 116     pub name: Option<Symbol>,
 117     pub cfg: Option<ast::MetaItem>,
 118     pub verbatim: Option<bool>,
 119     pub dll_imports: Vec<cstore::DllImport>,
 120 }
 121
 122 impl From<&cstore::NativeLib> for NativeLib {
 123     fn from(lib: &cstore::NativeLib) -> Self {
 124         NativeLib {
 125             kind: lib.kind,
 126             name: lib.name,
 127             cfg: lib.cfg.clone(),
 128             verbatim: lib.verbatim,
 129             dll_imports: lib.dll_imports.clone(),
 130         }
 131     }
 132 }
 133
 134 /// Misc info we load from metadata to persist beyond the tcx.
 135 ///
 136 /// Note: though `CrateNum` is only meaningful within the same tcx, information within `CrateInfo`
 137 /// is self-contained. `CrateNum` can be viewed as a unique identifier within a `CrateInfo`, where
 138 /// `used_crate_source` contains all `CrateSource` of the dependents, and maintains a mapping from
 139 /// identifiers (`CrateNum`) to `CrateSource`. The other fields map `CrateNum` to the crate's own
 140 /// additional properties, so that effectively we can retrieve each dependent crate's `CrateSource`
 141 /// and the corresponding properties without referencing information outside of a `CrateInfo`.
 142 #[derive(Debug, Encodable, Decodable)]
 143 pub struct CrateInfo {
 144     pub target_cpu: String,
 145     pub exported_symbols: FxHashMap<CrateType, Vec<String>>,
 146     pub linked_symbols: FxHashMap<CrateType, Vec<(String, SymbolExportKind)>>,
 147     pub local_crate_name: Symbol,
 148     pub compiler_builtins: Option<CrateNum>,
 149     pub profiler_runtime: Option<CrateNum>,
 150     pub is_no_builtins: FxHashSet<CrateNum>,
 151     pub native_libraries: FxHashMap<CrateNum, Vec<NativeLib>>,
 152     pub crate_name: FxHashMap<CrateNum, Symbol>,
 153     pub used_libraries: Vec<NativeLib>,
 154     pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
 155     pub used_crates: Vec<CrateNum>,
 156     pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
 157     pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
 158     pub dependency_formats: Lrc<Dependencies>,
 159     pub windows_subsystem: Option<String>,
 160     pub natvis_debugger_visualizers: BTreeSet<DebuggerVisualizerFile>,
 161 }
 162
 163 #[derive(Encodable, Decodable)]
 164 pub struct CodegenResults {
 165     pub modules: Vec<CompiledModule>,
 166     pub allocator_module: Option<CompiledModule>,
 167     pub metadata_module: Option<CompiledModule>,
 168     pub metadata: rustc_metadata::EncodedMetadata,
 169     pub crate_info: CrateInfo,
 170 }
 171
 172 pub fn provide(providers: &mut Providers) {
 173     crate::back::symbol_export::provide(providers);
 174     crate::base::provide(providers);
 175     crate::target_features::provide(providers);
 176 }
 177
 178 pub fn provide_extern(providers: &mut ExternProviders) {
 179     crate::back::symbol_export::provide_extern(providers);
 180 }
 181
 182 /// Checks if the given filename ends with the `.rcgu.o` extension that `rustc`
 183 /// uses for the object files it generates.
 184 pub fn looks_like_rust_object_file(filename: &str) -> bool {
 185     let path = Path::new(filename);
 186     let ext = path.extension().and_then(|s| s.to_str());
 187     if ext != Some(OutputType::Object.extension()) {
 188         // The file name does not end with ".o", so it can't be an object file.
 189         return false;
 190     }
 191
 192     // Strip the ".o" at the end
 193     let ext2 = path.file_stem().and_then(|s| Path::new(s).extension()).and_then(|s| s.to_str());
 194
 195     // Check if the "inner" extension
 196     ext2 == Some(RUST_CGU_EXT)
 197 }
 198
 199 const RLINK_VERSION: u32 = 1;
 200 const RLINK_MAGIC: &[u8] = b"rustlink";
 201
 202 const RUSTC_VERSION: Option<&str> = option_env!("CFG_VERSION");
 203
 204 impl CodegenResults {
 205     pub fn serialize_rlink(codegen_results: &CodegenResults) -> Vec<u8> {
 206         let mut encoder = opaque::Encoder::new();
 207         encoder.emit_raw_bytes(RLINK_MAGIC);
 208         // `emit_raw_bytes` is used to make sure that the version representation does not depend on
 209         // Encoder's inner representation of `u32`.
 210         encoder.emit_raw_bytes(&RLINK_VERSION.to_be_bytes());
 211         encoder.emit_str(RUSTC_VERSION.unwrap());
 212         Encodable::encode(codegen_results, &mut encoder);
 213         encoder.finish()
 214     }
 215
 216     pub fn deserialize_rlink(data: Vec<u8>) -> Result<Self, String> {
 217         // The Decodable machinery is not used here because it panics if the input data is invalid
 218         // and because its internal representation may change.
 219         if !data.starts_with(RLINK_MAGIC) {
 220             return Err("The input does not look like a .rlink file".to_string());
 221         }
 222         let data = &data[RLINK_MAGIC.len()..];
 223         if data.len() < 4 {
 224             return Err("The input does not contain version number".to_string());
 225         }
 226
 227         let mut version_array: [u8; 4] = Default::default();
 228         version_array.copy_from_slice(&data[..4]);
 229         if u32::from_be_bytes(version_array) != RLINK_VERSION {
 230             return Err(".rlink file was produced with encoding version {version_array}, but the current version is {RLINK_VERSION}".to_string());
 231         }
 232
 233         let mut decoder = opaque::Decoder::new(&data[4..], 0);
 234         let rustc_version = decoder.read_str();
 235         let current_version = RUSTC_VERSION.unwrap();
 236         if rustc_version != current_version {
 237             return Err(format!(
 238                 ".rlink file was produced by rustc version {rustc_version}, but the current version is {current_version}."
 239             ));
 240         }
 241
 242         let codegen_results = CodegenResults::decode(&mut decoder);
 243         Ok(codegen_results)
 244     }
 245 }