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