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(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 rustc::middle::dependency_format::Dependencies;
  37 use syntax_pos::symbol::Symbol;
  38
  39 mod error_codes;
  40
  41 pub mod common;
  42 pub mod traits;
  43 pub mod mir;
  44 pub mod debuginfo;
  45 pub mod base;
  46 pub mod callee;
  47 pub mod glue;
  48 pub mod meth;
  49 pub mod mono_item;
  50 pub mod back;
  51
  52 pub struct ModuleCodegen<M> {
  53     /// The name of the module. When the crate may be saved between
  54     /// compilations, incremental compilation requires that name be
  55     /// unique amongst **all** crates. Therefore, it should contain
  56     /// something unique to this crate (e.g., a module path) as well
  57     /// as the crate name and disambiguator.
  58     /// We currently generate these names via CodegenUnit::build_cgu_name().
  59     pub name: String,
  60     pub module_llvm: M,
  61     pub kind: ModuleKind,
  62 }
  63
  64 pub const METADATA_FILENAME: &str = "rust.metadata.bin";
  65 pub const RLIB_BYTECODE_EXTENSION: &str = "bc.z";
  66
  67 impl<M> ModuleCodegen<M> {
  68     pub fn into_compiled_module(self,
  69                             emit_obj: bool,
  70                             emit_bc: bool,
  71                             emit_bc_compressed: bool,
  72                             outputs: &OutputFilenames) -> CompiledModule {
  73         let object = if emit_obj {
  74             Some(outputs.temp_path(OutputType::Object, Some(&self.name)))
  75         } else {
  76             None
  77         };
  78         let bytecode = if emit_bc {
  79             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name)))
  80         } else {
  81             None
  82         };
  83         let bytecode_compressed = if emit_bc_compressed {
  84             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name))
  85                     .with_extension(RLIB_BYTECODE_EXTENSION))
  86         } else {
  87             None
  88         };
  89
  90         CompiledModule {
  91             name: self.name.clone(),
  92             kind: self.kind,
  93             object,
  94             bytecode,
  95             bytecode_compressed,
  96         }
  97     }
  98 }
  99
 100 #[derive(Debug)]
 101 pub struct CompiledModule {
 102     pub name: String,
 103     pub kind: ModuleKind,
 104     pub object: Option<PathBuf>,
 105     pub bytecode: Option<PathBuf>,
 106     pub bytecode_compressed: Option<PathBuf>,
 107 }
 108
 109 pub struct CachedModuleCodegen {
 110     pub name: String,
 111     pub source: WorkProduct,
 112 }
 113
 114 #[derive(Copy, Clone, Debug, PartialEq)]
 115 pub enum ModuleKind {
 116     Regular,
 117     Metadata,
 118     Allocator,
 119 }
 120
 121 bitflags::bitflags! {
 122     pub struct MemFlags: u8 {
 123         const VOLATILE = 1 << 0;
 124         const NONTEMPORAL = 1 << 1;
 125         const UNALIGNED = 1 << 2;
 126     }
 127 }
 128
 129 /// Misc info we load from metadata to persist beyond the tcx.
 130 #[derive(Debug)]
 131 pub struct CrateInfo {
 132     pub panic_runtime: Option<CrateNum>,
 133     pub compiler_builtins: Option<CrateNum>,
 134     pub profiler_runtime: Option<CrateNum>,
 135     pub sanitizer_runtime: Option<CrateNum>,
 136     pub is_no_builtins: FxHashSet<CrateNum>,
 137     pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLibrary>>>,
 138     pub crate_name: FxHashMap<CrateNum, String>,
 139     pub used_libraries: Lrc<Vec<NativeLibrary>>,
 140     pub link_args: Lrc<Vec<String>>,
 141     pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
 142     pub used_crates_static: Vec<(CrateNum, LibSource)>,
 143     pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
 144     pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
 145     pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
 146     pub dependency_formats: Lrc<Dependencies>,
 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 }