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