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(rustc_diagnostic_macros)]
   8 #![feature(stmt_expr_attributes)]
   9 #![feature(try_blocks)]
  10 #![feature(in_band_lifetimes)]
  11 #![feature(nll)]
  12 #![feature(trusted_len)]
  13 #![feature(mem_take)]
  14 #![feature(associated_type_bounds)]
  15
  16 #![recursion_limit="256"]
  17
  18 //! This crate contains codegen code that is used by all codegen backends (LLVM and others).
  19 //! The backend-agnostic functions of this crate use functions defined in various traits that
  20 //! have to be implemented by each backends.
  21
  22 #[macro_use] extern crate log;
  23 #[macro_use] extern crate rustc;
  24 #[macro_use] extern crate rustc_data_structures;
  25 #[macro_use] extern crate syntax;
  26
  27 use std::path::PathBuf;
  28 use rustc::dep_graph::WorkProduct;
  29 use rustc::session::config::{OutputFilenames, OutputType};
  30 use rustc::middle::lang_items::LangItem;
  31 use rustc::hir::def_id::CrateNum;
  32 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  33 use rustc_data_structures::sync::Lrc;
  34 use rustc_data_structures::svh::Svh;
  35 use rustc::middle::cstore::{LibSource, CrateSource, NativeLibrary};
  36 use syntax_pos::symbol::Symbol;
  37
  38 // N.B., this module needs to be declared first so diagnostics are
  39 // registered before they are used.
  40 mod error_codes;
  41
  42 pub mod common;
  43 pub mod traits;
  44 pub mod mir;
  45 pub mod debuginfo;
  46 pub mod base;
  47 pub mod callee;
  48 pub mod glue;
  49 pub mod meth;
  50 pub mod mono_item;
  51 pub mod back;
  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 pub const METADATA_FILENAME: &str = "rust.metadata.bin";
  66 pub const RLIB_BYTECODE_EXTENSION: &str = "bc.z";
  67
  68 impl<M> ModuleCodegen<M> {
  69     pub fn into_compiled_module(self,
  70                             emit_obj: bool,
  71                             emit_bc: bool,
  72                             emit_bc_compressed: bool,
  73                             outputs: &OutputFilenames) -> CompiledModule {
  74         let object = if emit_obj {
  75             Some(outputs.temp_path(OutputType::Object, Some(&self.name)))
  76         } else {
  77             None
  78         };
  79         let bytecode = if emit_bc {
  80             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name)))
  81         } else {
  82             None
  83         };
  84         let bytecode_compressed = if emit_bc_compressed {
  85             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name))
  86                     .with_extension(RLIB_BYTECODE_EXTENSION))
  87         } else {
  88             None
  89         };
  90
  91         CompiledModule {
  92             name: self.name.clone(),
  93             kind: self.kind,
  94             object,
  95             bytecode,
  96             bytecode_compressed,
  97         }
  98     }
  99 }
 100
 101 #[derive(Debug)]
 102 pub struct CompiledModule {
 103     pub name: String,
 104     pub kind: ModuleKind,
 105     pub object: Option<PathBuf>,
 106     pub bytecode: Option<PathBuf>,
 107     pub bytecode_compressed: Option<PathBuf>,
 108 }
 109
 110 pub struct CachedModuleCodegen {
 111     pub name: String,
 112     pub source: WorkProduct,
 113 }
 114
 115 #[derive(Copy, Clone, Debug, PartialEq)]
 116 pub enum ModuleKind {
 117     Regular,
 118     Metadata,
 119     Allocator,
 120 }
 121
 122 bitflags::bitflags! {
 123     pub struct MemFlags: u8 {
 124         const VOLATILE = 1 << 0;
 125         const NONTEMPORAL = 1 << 1;
 126         const UNALIGNED = 1 << 2;
 127     }
 128 }
 129
 130 /// Misc info we load from metadata to persist beyond the tcx.
 131 #[derive(Debug)]
 132 pub struct CrateInfo {
 133     pub panic_runtime: Option<CrateNum>,
 134     pub compiler_builtins: Option<CrateNum>,
 135     pub profiler_runtime: Option<CrateNum>,
 136     pub sanitizer_runtime: Option<CrateNum>,
 137     pub is_no_builtins: FxHashSet<CrateNum>,
 138     pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLibrary>>>,
 139     pub crate_name: FxHashMap<CrateNum, String>,
 140     pub used_libraries: Lrc<Vec<NativeLibrary>>,
 141     pub link_args: Lrc<Vec<String>>,
 142     pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
 143     pub used_crates_static: Vec<(CrateNum, LibSource)>,
 144     pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
 145     pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
 146     pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
 147 }
 148
 149
 150 pub struct CodegenResults {
 151     pub crate_name: Symbol,
 152     pub modules: Vec<CompiledModule>,
 153     pub allocator_module: Option<CompiledModule>,
 154     pub metadata_module: Option<CompiledModule>,
 155     pub crate_hash: Svh,
 156     pub metadata: rustc::middle::cstore::EncodedMetadata,
 157     pub windows_subsystem: Option<String>,
 158     pub linker_info: back::linker::LinkerInfo,
 159     pub crate_info: CrateInfo,
 160 }
 161
 162 __build_diagnostic_array! { librustc_codegen_ssa, DIAGNOSTICS }