1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
3 #![feature(box_patterns)]
4 #![feature(box_syntax)]
5 #![feature(core_intrinsics)]
7 #![feature(rustc_diagnostic_macros)]
8 #![feature(stmt_expr_attributes)]
9 #![feature(try_blocks)]
10 #![feature(in_band_lifetimes)]
12 #![feature(trusted_len)]
14 #![allow(unused_attributes)]
16 #![deny(rust_2018_idioms)]
17 #![deny(unused_lifetimes)]
19 #![recursion_limit="256"]
21 //! This crate contains codegen code that is used by all codegen backends (LLVM and others).
22 //! The backend-agnostic functions of this crate use functions defined in various traits that
23 //! have to be implemented by each backends.
25 #[macro_use] extern crate log;
26 #[macro_use] extern crate rustc;
27 #[macro_use] extern crate rustc_data_structures;
28 #[macro_use] extern crate syntax;
30 use std::path::PathBuf;
31 use rustc::dep_graph::WorkProduct;
32 use rustc::session::config::{OutputFilenames, OutputType};
33 use rustc::middle::lang_items::LangItem;
34 use rustc::hir::def_id::CrateNum;
35 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
36 use rustc_data_structures::sync::Lrc;
37 use rustc_data_structures::svh::Svh;
38 use rustc::middle::cstore::{LibSource, CrateSource, NativeLibrary};
39 use syntax_pos::symbol::Symbol;
41 // N.B., this module needs to be declared first so diagnostics are
42 // registered before they are used.
56 pub struct ModuleCodegen<M> {
57 /// The name of the module. When the crate may be saved between
58 /// compilations, incremental compilation requires that name be
59 /// unique amongst **all** crates. Therefore, it should contain
60 /// something unique to this crate (e.g., a module path) as well
61 /// as the crate name and disambiguator.
62 /// We currently generate these names via CodegenUnit::build_cgu_name().
68 pub const METADATA_FILENAME: &str = "rust.metadata.bin";
69 pub const RLIB_BYTECODE_EXTENSION: &str = "bc.z";
71 impl<M> ModuleCodegen<M> {
72 pub fn into_compiled_module(self,
75 emit_bc_compressed: bool,
76 outputs: &OutputFilenames) -> CompiledModule {
77 let object = if emit_obj {
78 Some(outputs.temp_path(OutputType::Object, Some(&self.name)))
82 let bytecode = if emit_bc {
83 Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name)))
87 let bytecode_compressed = if emit_bc_compressed {
88 Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name))
89 .with_extension(RLIB_BYTECODE_EXTENSION))
95 name: self.name.clone(),
105 pub struct CompiledModule {
107 pub kind: ModuleKind,
108 pub object: Option<PathBuf>,
109 pub bytecode: Option<PathBuf>,
110 pub bytecode_compressed: Option<PathBuf>,
113 pub struct CachedModuleCodegen {
115 pub source: WorkProduct,
118 #[derive(Copy, Clone, Debug, PartialEq)]
119 pub enum ModuleKind {
125 bitflags::bitflags! {
126 pub struct MemFlags: u8 {
127 const VOLATILE = 1 << 0;
128 const NONTEMPORAL = 1 << 1;
129 const UNALIGNED = 1 << 2;
133 /// Misc info we load from metadata to persist beyond the tcx.
134 pub struct CrateInfo {
135 pub panic_runtime: Option<CrateNum>,
136 pub compiler_builtins: Option<CrateNum>,
137 pub profiler_runtime: Option<CrateNum>,
138 pub sanitizer_runtime: Option<CrateNum>,
139 pub is_no_builtins: FxHashSet<CrateNum>,
140 pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLibrary>>>,
141 pub crate_name: FxHashMap<CrateNum, String>,
142 pub used_libraries: Lrc<Vec<NativeLibrary>>,
143 pub link_args: Lrc<Vec<String>>,
144 pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
145 pub used_crates_static: Vec<(CrateNum, LibSource)>,
146 pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
147 pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
148 pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
152 pub struct CodegenResults {
153 pub crate_name: Symbol,
154 pub modules: Vec<CompiledModule>,
155 pub allocator_module: Option<CompiledModule>,
156 pub metadata_module: Option<CompiledModule>,
158 pub metadata: rustc::middle::cstore::EncodedMetadata,
159 pub windows_subsystem: Option<String>,
160 pub linker_info: back::linker::LinkerInfo,
161 pub crate_info: CrateInfo,
164 __build_diagnostic_array! { librustc_codegen_ssa, DIAGNOSTICS }