1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
2 #![feature(bool_to_option)]
3 #![feature(box_patterns)]
4 #![feature(try_blocks)]
5 #![feature(in_band_lifetimes)]
6 #![feature(let_else)]
7 #![feature(once_cell)]
8 #![feature(nll)]
9 #![feature(associated_type_bounds)]
10 #![recursion_limit = "256"]
11
12 //! This crate contains codegen code that is used by all codegen backends (LLVM and others).
13 //! The backend-agnostic functions of this crate use functions defined in various traits that
14 //! have to be implemented by each backends.
15
16 #[macro_use]
17 extern crate rustc_macros;
18 #[macro_use]
19 extern crate tracing;
20 #[macro_use]
21 extern crate rustc_middle;
22
23 use rustc_ast as ast;
24 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
25 use rustc_data_structures::sync::Lrc;
26 use rustc_hir::def_id::CrateNum;
27 use rustc_hir::LangItem;
28 use rustc_middle::dep_graph::WorkProduct;
29 use rustc_middle::middle::dependency_format::Dependencies;
30 use rustc_middle::ty::query::{ExternProviders, Providers};
31 use rustc_session::config::{CrateType, OutputFilenames, OutputType, RUST_CGU_EXT};
32 use rustc_session::cstore::{self, CrateSource};
33 use rustc_session::utils::NativeLibKind;
34 use rustc_span::symbol::Symbol;
35 use std::path::{Path, PathBuf};
36
37 pub mod back;
38 pub mod base;
39 pub mod common;
40 pub mod coverageinfo;
41 pub mod debuginfo;
42 pub mod glue;
43 pub mod meth;
44 pub mod mir;
45 pub mod mono_item;
46 pub mod target_features;
47 pub mod traits;
48
49 pub struct ModuleCodegen<M> {
50 /// The name of the module. When the crate may be saved between
51 /// compilations, incremental compilation requires that name be
52 /// unique amongst **all** crates. Therefore, it should contain
53 /// something unique to this crate (e.g., a module path) as well
54 /// as the crate name and disambiguator.
55 /// We currently generate these names via CodegenUnit::build_cgu_name().
56 pub name: String,
57 pub module_llvm: M,
58 pub kind: ModuleKind,
59 }
60
61 // FIXME(eddyb) maybe include the crate name in this?
62 pub const METADATA_FILENAME: &str = "lib.rmeta";
63
64 impl<M> ModuleCodegen<M> {
into_compiled_module( self, emit_obj: bool, emit_dwarf_obj: bool, emit_bc: bool, outputs: &OutputFilenames, ) -> CompiledModule65 pub fn into_compiled_module(
66 self,
67 emit_obj: bool,
68 emit_dwarf_obj: bool,
69 emit_bc: bool,
70 outputs: &OutputFilenames,
71 ) -> CompiledModule {
72 let object = emit_obj.then(|| outputs.temp_path(OutputType::Object, Some(&self.name)));
73 let dwarf_object = emit_dwarf_obj.then(|| outputs.temp_path_dwo(Some(&self.name)));
74 let bytecode = emit_bc.then(|| outputs.temp_path(OutputType::Bitcode, Some(&self.name)));
75
76 CompiledModule { name: self.name.clone(), kind: self.kind, object, dwarf_object, bytecode }
77 }
78 }
79
80 #[derive(Debug, Encodable, Decodable)]
81 pub struct CompiledModule {
82 pub name: String,
83 pub kind: ModuleKind,
84 pub object: Option<PathBuf>,
85 pub dwarf_object: Option<PathBuf>,
86 pub bytecode: Option<PathBuf>,
87 }
88
89 pub struct CachedModuleCodegen {
90 pub name: String,
91 pub source: WorkProduct,
92 }
93
94 #[derive(Copy, Clone, Debug, PartialEq, Encodable, Decodable)]
95 pub enum ModuleKind {
96 Regular,
97 Metadata,
98 Allocator,
99 }
100
101 bitflags::bitflags! {
102 pub struct MemFlags: u8 {
103 const VOLATILE = 1 << 0;
104 const NONTEMPORAL = 1 << 1;
105 const UNALIGNED = 1 << 2;
106 }
107 }
108
109 #[derive(Clone, Debug, Encodable, Decodable, HashStable)]
110 pub struct NativeLib {
111 pub kind: NativeLibKind,
112 pub name: Option<Symbol>,
113 pub cfg: Option<ast::MetaItem>,
114 pub verbatim: Option<bool>,
115 pub dll_imports: Vec<cstore::DllImport>,
116 }
117
118 impl From<&cstore::NativeLib> for NativeLib {
from(lib: &cstore::NativeLib) -> Self119 fn from(lib: &cstore::NativeLib) -> Self {
120 NativeLib {
121 kind: lib.kind,
122 name: lib.name,
123 cfg: lib.cfg.clone(),
124 verbatim: lib.verbatim,
125 dll_imports: lib.dll_imports.clone(),
126 }
127 }
128 }
129
130 /// Misc info we load from metadata to persist beyond the tcx.
131 ///
132 /// Note: though `CrateNum` is only meaningful within the same tcx, information within `CrateInfo`
133 /// is self-contained. `CrateNum` can be viewed as a unique identifier within a `CrateInfo`, where
134 /// `used_crate_source` contains all `CrateSource` of the dependents, and maintains a mapping from
135 /// identifiers (`CrateNum`) to `CrateSource`. The other fields map `CrateNum` to the crate's own
136 /// additional properties, so that effectively we can retrieve each dependent crate's `CrateSource`
137 /// and the corresponding properties without referencing information outside of a `CrateInfo`.
138 #[derive(Debug, Encodable, Decodable)]
139 pub struct CrateInfo {
140 pub target_cpu: String,
141 pub exported_symbols: FxHashMap<CrateType, Vec<String>>,
142 pub local_crate_name: Symbol,
143 pub compiler_builtins: Option<CrateNum>,
144 pub profiler_runtime: Option<CrateNum>,
145 pub is_no_builtins: FxHashSet<CrateNum>,
146 pub native_libraries: FxHashMap<CrateNum, Vec<NativeLib>>,
147 pub crate_name: FxHashMap<CrateNum, String>,
148 pub used_libraries: Vec<NativeLib>,
149 pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
150 pub used_crates: Vec<CrateNum>,
151 pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
152 pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
153 pub dependency_formats: Lrc<Dependencies>,
154 pub windows_subsystem: Option<String>,
155 }
156
157 #[derive(Encodable, Decodable)]
158 pub struct CodegenResults {
159 pub modules: Vec<CompiledModule>,
160 pub allocator_module: Option<CompiledModule>,
161 pub metadata_module: Option<CompiledModule>,
162 pub metadata: rustc_metadata::EncodedMetadata,
163 pub crate_info: CrateInfo,
164 }
165
provide(providers: &mut Providers)166 pub fn provide(providers: &mut Providers) {
167 crate::back::symbol_export::provide(providers);
168 crate::base::provide(providers);
169 crate::target_features::provide(providers);
170 }
171
provide_extern(providers: &mut ExternProviders)172 pub fn provide_extern(providers: &mut ExternProviders) {
173 crate::back::symbol_export::provide_extern(providers);
174 }
175
176 /// Checks if the given filename ends with the `.rcgu.o` extension that `rustc`
177 /// uses for the object files it generates.
looks_like_rust_object_file(filename: &str) -> bool178 pub fn looks_like_rust_object_file(filename: &str) -> bool {
179 let path = Path::new(filename);
180 let ext = path.extension().and_then(|s| s.to_str());
181 if ext != Some(OutputType::Object.extension()) {
182 // The file name does not end with ".o", so it can't be an object file.
183 return false;
184 }
185
186 // Strip the ".o" at the end
187 let ext2 = path.file_stem().and_then(|s| Path::new(s).extension()).and_then(|s| s.to_str());
188
189 // Check if the "inner" extension
190 ext2 == Some(RUST_CGU_EXT)
191 }
192