src/librustc_codegen_ssa/lib.rs

   1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
   2
   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
  15 #![recursion_limit="256"]
  16
  17 //! This crate contains codegen code that is used by all codegen backends (LLVM and others).
  18 //! The backend-agnostic functions of this crate use functions defined in various traits that
  19 //! have to be implemented by each backends.
  20
  21 #[macro_use] extern crate log;
  22 #[macro_use] extern crate rustc;
  23 #[macro_use] extern crate syntax;
  24
  25 use std::path::{Path, PathBuf};
  26 use rustc::dep_graph::WorkProduct;
  27 use rustc::session::config::{OutputFilenames, OutputType, RUST_CGU_EXT};
  28 use rustc::middle::lang_items::LangItem;
  29 use rustc::hir::def_id::CrateNum;
  30 use rustc::ty::query::Providers;
  31 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  32 use rustc_data_structures::sync::Lrc;
  33 use rustc_data_structures::svh::Svh;
  34 use rustc::middle::cstore::{LibSource, CrateSource, NativeLibrary};
  35 use rustc::middle::dependency_format::Dependencies;
  36 use syntax_pos::symbol::Symbol;
  37
  38 mod error_codes;
  39
  40 pub mod common;
  41 pub mod traits;
  42 pub mod mir;
  43 pub mod debuginfo;
  44 pub mod base;
  45 pub mod glue;
  46 pub mod meth;
  47 pub mod mono_item;
  48 pub mod back;
  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 pub const METADATA_FILENAME: &str = "rust.metadata.bin";
  63 pub const RLIB_BYTECODE_EXTENSION: &str = "bc.z";
  64
  65
  66 impl<M> ModuleCodegen<M> {
  67     pub fn into_compiled_module(self,
  68                             emit_obj: bool,
  69                             emit_bc: bool,
  70                             emit_bc_compressed: bool,
  71                             outputs: &OutputFilenames) -> CompiledModule {
  72         let object = if emit_obj {
  73             Some(outputs.temp_path(OutputType::Object, Some(&self.name)))
  74         } else {
  75             None
  76         };
  77         let bytecode = if emit_bc {
  78             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name)))
  79         } else {
  80             None
  81         };
  82         let bytecode_compressed = if emit_bc_compressed {
  83             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name))
  84                     .with_extension(RLIB_BYTECODE_EXTENSION))
  85         } else {
  86             None
  87         };
  88
  89         CompiledModule {
  90             name: self.name.clone(),
  91             kind: self.kind,
  92             object,
  93             bytecode,
  94             bytecode_compressed,
  95         }
  96     }
  97 }
  98
  99 #[derive(Debug)]
 100 pub struct CompiledModule {
 101     pub name: String,
 102     pub kind: ModuleKind,
 103     pub object: Option<PathBuf>,
 104     pub bytecode: Option<PathBuf>,
 105     pub bytecode_compressed: Option<PathBuf>,
 106 }
 107
 108 pub struct CachedModuleCodegen {
 109     pub name: String,
 110     pub source: WorkProduct,
 111 }
 112
 113 #[derive(Copy, Clone, Debug, PartialEq)]
 114 pub enum ModuleKind {
 115     Regular,
 116     Metadata,
 117     Allocator,
 118 }
 119
 120 bitflags::bitflags! {
 121     pub struct MemFlags: u8 {
 122         const VOLATILE = 1 << 0;
 123         const NONTEMPORAL = 1 << 1;
 124         const UNALIGNED = 1 << 2;
 125     }
 126 }
 127
 128 /// Misc info we load from metadata to persist beyond the tcx.
 129 #[derive(Debug)]
 130 pub struct CrateInfo {
 131     pub panic_runtime: Option<CrateNum>,
 132     pub compiler_builtins: Option<CrateNum>,
 133     pub profiler_runtime: Option<CrateNum>,
 134     pub sanitizer_runtime: Option<CrateNum>,
 135     pub is_no_builtins: FxHashSet<CrateNum>,
 136     pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLibrary>>>,
 137     pub crate_name: FxHashMap<CrateNum, String>,
 138     pub used_libraries: Lrc<Vec<NativeLibrary>>,
 139     pub link_args: Lrc<Vec<String>>,
 140     pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
 141     pub used_crates_static: Vec<(CrateNum, LibSource)>,
 142     pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
 143     pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
 144     pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
 145     pub dependency_formats: Lrc<Dependencies>,
 146 }
 147
 148
 149 pub struct CodegenResults {
 150     pub crate_name: Symbol,
 151     pub modules: Vec<CompiledModule>,
 152     pub allocator_module: Option<CompiledModule>,
 153     pub metadata_module: Option<CompiledModule>,
 154     pub crate_hash: Svh,
 155     pub metadata: rustc::middle::cstore::EncodedMetadata,
 156     pub windows_subsystem: Option<String>,
 157     pub linker_info: back::linker::LinkerInfo,
 158     pub crate_info: CrateInfo,
 159 }
 160
 161 pub fn provide(providers: &mut Providers<'_>) {
 162     crate::back::symbol_export::provide(providers);
 163     crate::base::provide_both(providers);
 164 }
 165
 166 pub fn provide_extern(providers: &mut Providers<'_>) {
 167     crate::back::symbol_export::provide_extern(providers);
 168     crate::base::provide_both(providers);
 169 }
 170
 171 /// Checks if the given filename ends with the `.rcgu.o` extension that `rustc`
 172 /// uses for the object files it generates.
 173 pub fn looks_like_rust_object_file(filename: &str) -> bool {
 174     let path = Path::new(filename);
 175     let ext = path.extension().and_then(|s| s.to_str());
 176     if ext != Some(OutputType::Object.extension()) {
 177         // The file name does not end with ".o", so it can't be an object file.
 178         return false
 179     }
 180
 181     // Strip the ".o" at the end
 182     let ext2 = path.file_stem()
 183         .and_then(|s| Path::new(s).extension())
 184         .and_then(|s| s.to_str());
 185
 186     // Check if the "inner" extension
 187     ext2 == Some(RUST_CGU_EXT)
 188 }