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(stmt_expr_attributes)]
   8 #![feature(try_blocks)]
   9 #![feature(in_band_lifetimes)]
  10 #![feature(nll)]
  11 #![feature(trusted_len)]
  12 #![feature(mem_take)]
  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 rustc_data_structures;
  24 #[macro_use] extern crate syntax;
  25
  26 use std::path::PathBuf;
  27 use rustc::dep_graph::WorkProduct;
  28 use rustc::session::config::{OutputFilenames, OutputType};
  29 use rustc::middle::lang_items::LangItem;
  30 use rustc::hir::def_id::CrateNum;
  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 syntax_pos::symbol::Symbol;
  36
  37 mod error_codes;
  38
  39 pub mod common;
  40 pub mod traits;
  41 pub mod mir;
  42 pub mod debuginfo;
  43 pub mod base;
  44 pub mod callee;
  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 impl<M> ModuleCodegen<M> {
  66     pub fn into_compiled_module(self,
  67                             emit_obj: bool,
  68                             emit_bc: bool,
  69                             emit_bc_compressed: bool,
  70                             outputs: &OutputFilenames) -> CompiledModule {
  71         let object = if emit_obj {
  72             Some(outputs.temp_path(OutputType::Object, Some(&self.name)))
  73         } else {
  74             None
  75         };
  76         let bytecode = if emit_bc {
  77             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name)))
  78         } else {
  79             None
  80         };
  81         let bytecode_compressed = if emit_bc_compressed {
  82             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name))
  83                     .with_extension(RLIB_BYTECODE_EXTENSION))
  84         } else {
  85             None
  86         };
  87
  88         CompiledModule {
  89             name: self.name.clone(),
  90             kind: self.kind,
  91             object,
  92             bytecode,
  93             bytecode_compressed,
  94         }
  95     }
  96 }
  97
  98 #[derive(Debug)]
  99 pub struct CompiledModule {
 100     pub name: String,
 101     pub kind: ModuleKind,
 102     pub object: Option<PathBuf>,
 103     pub bytecode: Option<PathBuf>,
 104     pub bytecode_compressed: Option<PathBuf>,
 105 }
 106
 107 pub struct CachedModuleCodegen {
 108     pub name: String,
 109     pub source: WorkProduct,
 110 }
 111
 112 #[derive(Copy, Clone, Debug, PartialEq)]
 113 pub enum ModuleKind {
 114     Regular,
 115     Metadata,
 116     Allocator,
 117 }
 118
 119 bitflags::bitflags! {
 120     pub struct MemFlags: u8 {
 121         const VOLATILE = 1 << 0;
 122         const NONTEMPORAL = 1 << 1;
 123         const UNALIGNED = 1 << 2;
 124     }
 125 }
 126
 127 /// Misc info we load from metadata to persist beyond the tcx.
 128 #[derive(Debug)]
 129 pub struct CrateInfo {
 130     pub panic_runtime: Option<CrateNum>,
 131     pub compiler_builtins: Option<CrateNum>,
 132     pub profiler_runtime: Option<CrateNum>,
 133     pub sanitizer_runtime: Option<CrateNum>,
 134     pub is_no_builtins: FxHashSet<CrateNum>,
 135     pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLibrary>>>,
 136     pub crate_name: FxHashMap<CrateNum, String>,
 137     pub used_libraries: Lrc<Vec<NativeLibrary>>,
 138     pub link_args: Lrc<Vec<String>>,
 139     pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
 140     pub used_crates_static: Vec<(CrateNum, LibSource)>,
 141     pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
 142     pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
 143     pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
 144 }
 145
 146
 147 pub struct CodegenResults {
 148     pub crate_name: Symbol,
 149     pub modules: Vec<CompiledModule>,
 150     pub allocator_module: Option<CompiledModule>,
 151     pub metadata_module: Option<CompiledModule>,
 152     pub crate_hash: Svh,
 153     pub metadata: rustc::middle::cstore::EncodedMetadata,
 154     pub windows_subsystem: Option<String>,
 155     pub linker_info: back::linker::LinkerInfo,
 156     pub crate_info: CrateInfo,
 157 }