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(once_cell)]
   5 #![feature(associated_type_bounds)]
   6 #![feature(strict_provenance)]
   7 #![feature(int_roundings)]
   8 #![feature(if_let_guard)]
   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_middle::dep_graph::WorkProduct;
  28 use rustc_middle::middle::dependency_format::Dependencies;
  29 use rustc_middle::middle::exported_symbols::SymbolExportKind;
  30 use rustc_middle::ty::query::{ExternProviders, Providers};
  31 use rustc_serialize::opaque::{MemDecoder, MemEncoder};
  32 use rustc_serialize::{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 errors;
  47 pub mod glue;
  48 pub mod meth;
  49 pub mod mir;
  50 pub mod mono_item;
  51 pub mod target_features;
  52 pub mod traits;
  53
  54 pub struct ModuleCodegen<M> {
  55     /// The name of the module. When the crate may be saved between
  56     /// compilations, incremental compilation requires that name be
  57     /// unique amongst **all** crates. Therefore, it should contain
  58     /// something unique to this crate (e.g., a module path) as well
  59     /// as the crate name and disambiguator.
  60     /// We currently generate these names via CodegenUnit::build_cgu_name().
  61     pub name: String,
  62     pub module_llvm: M,
  63     pub kind: ModuleKind,
  64 }
  65
  66 impl<M> ModuleCodegen<M> {
  67     pub fn into_compiled_module(
  68         self,
  69         emit_obj: bool,
  70         emit_dwarf_obj: bool,
  71         emit_bc: bool,
  72         outputs: &OutputFilenames,
  73     ) -> CompiledModule {
  74         let object = emit_obj.then(|| outputs.temp_path(OutputType::Object, Some(&self.name)));
  75         let dwarf_object = emit_dwarf_obj.then(|| outputs.temp_path_dwo(Some(&self.name)));
  76         let bytecode = emit_bc.then(|| outputs.temp_path(OutputType::Bitcode, Some(&self.name)));
  77
  78         CompiledModule { name: self.name.clone(), kind: self.kind, object, dwarf_object, bytecode }
  79     }
  80 }
  81
  82 #[derive(Debug, Encodable, Decodable)]
  83 pub struct CompiledModule {
  84     pub name: String,
  85     pub kind: ModuleKind,
  86     pub object: Option<PathBuf>,
  87     pub dwarf_object: Option<PathBuf>,
  88     pub bytecode: Option<PathBuf>,
  89 }
  90
  91 pub struct CachedModuleCodegen {
  92     pub name: String,
  93     pub source: WorkProduct,
  94 }
  95
  96 #[derive(Copy, Clone, Debug, PartialEq, Encodable, Decodable)]
  97 pub enum ModuleKind {
  98     Regular,
  99     Metadata,
 100     Allocator,
 101 }
 102
 103 bitflags::bitflags! {
 104     pub struct MemFlags: u8 {
 105         const VOLATILE = 1 << 0;
 106         const NONTEMPORAL = 1 << 1;
 107         const UNALIGNED = 1 << 2;
 108     }
 109 }
 110
 111 #[derive(Clone, Debug, Encodable, Decodable, HashStable)]
 112 pub struct NativeLib {
 113     pub kind: NativeLibKind,
 114     pub name: Option<Symbol>,
 115     pub filename: Option<Symbol>,
 116     pub cfg: Option<ast::MetaItem>,
 117     pub verbatim: Option<bool>,
 118     pub dll_imports: Vec<cstore::DllImport>,
 119 }
 120
 121 impl From<&cstore::NativeLib> for NativeLib {
 122     fn from(lib: &cstore::NativeLib) -> Self {
 123         NativeLib {
 124             kind: lib.kind,
 125             filename: lib.filename,
 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 dependency_formats: Lrc<Dependencies>,
 157     pub windows_subsystem: Option<String>,
 158     pub natvis_debugger_visualizers: BTreeSet<DebuggerVisualizerFile>,
 159 }
 160
 161 #[derive(Encodable, Decodable)]
 162 pub struct CodegenResults {
 163     pub modules: Vec<CompiledModule>,
 164     pub allocator_module: Option<CompiledModule>,
 165     pub metadata_module: Option<CompiledModule>,
 166     pub metadata: rustc_metadata::EncodedMetadata,
 167     pub crate_info: CrateInfo,
 168 }
 169
 170 pub enum CodegenErrors<'a> {
 171     WrongFileType,
 172     EmptyVersionNumber,
 173     EncodingVersionMismatch { version_array: String, rlink_version: u32 },
 174     RustcVersionMismatch { rustc_version: String, current_version: &'a str },
 175 }
 176
 177 pub fn provide(providers: &mut Providers) {
 178     crate::back::symbol_export::provide(providers);
 179     crate::base::provide(providers);
 180     crate::target_features::provide(providers);
 181 }
 182
 183 pub fn provide_extern(providers: &mut ExternProviders) {
 184     crate::back::symbol_export::provide_extern(providers);
 185 }
 186
 187 /// Checks if the given filename ends with the `.rcgu.o` extension that `rustc`
 188 /// uses for the object files it generates.
 189 pub fn looks_like_rust_object_file(filename: &str) -> bool {
 190     let path = Path::new(filename);
 191     let ext = path.extension().and_then(|s| s.to_str());
 192     if ext != Some(OutputType::Object.extension()) {
 193         // The file name does not end with ".o", so it can't be an object file.
 194         return false;
 195     }
 196
 197     // Strip the ".o" at the end
 198     let ext2 = path.file_stem().and_then(|s| Path::new(s).extension()).and_then(|s| s.to_str());
 199
 200     // Check if the "inner" extension
 201     ext2 == Some(RUST_CGU_EXT)
 202 }
 203
 204 const RLINK_VERSION: u32 = 1;
 205 const RLINK_MAGIC: &[u8] = b"rustlink";
 206
 207 const RUSTC_VERSION: Option<&str> = option_env!("CFG_VERSION");
 208
 209 impl CodegenResults {
 210     pub fn serialize_rlink(codegen_results: &CodegenResults) -> Vec<u8> {
 211         let mut encoder = MemEncoder::new();
 212         encoder.emit_raw_bytes(RLINK_MAGIC);
 213         // `emit_raw_bytes` is used to make sure that the version representation does not depend on
 214         // Encoder's inner representation of `u32`.
 215         encoder.emit_raw_bytes(&RLINK_VERSION.to_be_bytes());
 216         encoder.emit_str(RUSTC_VERSION.unwrap());
 217         Encodable::encode(codegen_results, &mut encoder);
 218         encoder.finish()
 219     }
 220
 221     pub fn deserialize_rlink<'a>(data: Vec<u8>) -> Result<Self, CodegenErrors<'a>> {
 222         // The Decodable machinery is not used here because it panics if the input data is invalid
 223         // and because its internal representation may change.
 224         if !data.starts_with(RLINK_MAGIC) {
 225             return Err(CodegenErrors::WrongFileType);
 226         }
 227         let data = &data[RLINK_MAGIC.len()..];
 228         if data.len() < 4 {
 229             return Err(CodegenErrors::EmptyVersionNumber);
 230         }
 231
 232         let mut version_array: [u8; 4] = Default::default();
 233         version_array.copy_from_slice(&data[..4]);
 234         if u32::from_be_bytes(version_array) != RLINK_VERSION {
 235             return Err(CodegenErrors::EncodingVersionMismatch {
 236                 version_array: String::from_utf8_lossy(&version_array).to_string(),
 237                 rlink_version: RLINK_VERSION,
 238             });
 239         }
 240
 241         let mut decoder = MemDecoder::new(&data[4..], 0);
 242         let rustc_version = decoder.read_str();
 243         let current_version = RUSTC_VERSION.unwrap();
 244         if rustc_version != current_version {
 245             return Err(CodegenErrors::RustcVersionMismatch {
 246                 rustc_version: rustc_version.to_string(),
 247                 current_version,
 248             });
 249         }
 250
 251         let codegen_results = CodegenResults::decode(&mut decoder);
 252         Ok(codegen_results)
 253     }
 254 }