]> git.lizzy.rs Git - rust.git/blob - src/librustc_codegen_ssa/lib.rs
Rollup merge of #58309 - wesleywiser:add_more_profiler_events, r=michaelwoerister
[rust.git] / 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(custom_attribute)]
6 #![feature(libc)]
7 #![feature(rustc_diagnostic_macros)]
8 #![feature(in_band_lifetimes)]
9 #![feature(slice_sort_by_cached_key)]
10 #![feature(nll)]
11 #![allow(unused_attributes)]
12 #![allow(dead_code)]
13 #![deny(rust_2018_idioms)]
14 #![allow(explicit_outlives_requirements)]
15 #![allow(elided_lifetimes_in_paths)]
16
17 #![recursion_limit="256"]
18
19 //! This crate contains codegen code that is used by all codegen backends (LLVM and others).
20 //! The backend-agnostic functions of this crate use functions defined in various traits that
21 //! have to be implemented by each backends.
22
23 #[macro_use] extern crate log;
24 #[macro_use] extern crate rustc;
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 syntax_pos::symbol::Symbol;
37
38 // N.B., this module needs to be declared first so diagnostics are
39 // registered before they are used.
40 mod diagnostics;
41
42 pub mod common;
43 pub mod traits;
44 pub mod mir;
45 pub mod debuginfo;
46 pub mod base;
47 pub mod callee;
48 pub mod glue;
49 pub mod meth;
50 pub mod mono_item;
51 pub mod back;
52
53 pub struct ModuleCodegen<M> {
54     /// The name of the module. When the crate may be saved between
55     /// compilations, incremental compilation requires that name be
56     /// unique amongst **all** crates. Therefore, it should contain
57     /// something unique to this crate (e.g., a module path) as well
58     /// as the crate name and disambiguator.
59     /// We currently generate these names via CodegenUnit::build_cgu_name().
60     pub name: String,
61     pub module_llvm: M,
62     pub kind: ModuleKind,
63 }
64
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 pub struct CrateInfo {
131     pub panic_runtime: Option<CrateNum>,
132     pub compiler_builtins: Option<CrateNum>,
133     pub profiler_runtime: Option<CrateNum>,
134     pub sanitizer_runtime: Option<CrateNum>,
135     pub is_no_builtins: FxHashSet<CrateNum>,
136     pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLibrary>>>,
137     pub crate_name: FxHashMap<CrateNum, String>,
138     pub used_libraries: Lrc<Vec<NativeLibrary>>,
139     pub link_args: Lrc<Vec<String>>,
140     pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
141     pub used_crates_static: Vec<(CrateNum, LibSource)>,
142     pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
143     pub wasm_imports: FxHashMap<String, String>,
144     pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
145     pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
146 }
147
148
149 pub struct CodegenResults {
150     pub crate_name: Symbol,
151     pub modules: Vec<CompiledModule>,
152     pub allocator_module: Option<CompiledModule>,
153     pub metadata_module: CompiledModule,
154     pub crate_hash: Svh,
155     pub metadata: rustc::middle::cstore::EncodedMetadata,
156     pub windows_subsystem: Option<String>,
157     pub linker_info: back::linker::LinkerInfo,
158     pub crate_info: CrateInfo,
159 }
160
161 __build_diagnostic_array! { librustc_codegen_ssa, DIAGNOSTICS }