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)]
8 #![feature(associated_type_bounds)]
9 #![recursion_limit = "256"]
11 //! This crate contains codegen code that is used by all codegen backends (LLVM and others).
12 //! The backend-agnostic functions of this crate use functions defined in various traits that
13 //! have to be implemented by each backends.
16 extern crate rustc_macros;
20 extern crate rustc_middle;
23 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
24 use rustc_data_structures::sync::Lrc;
25 use rustc_hir::def_id::CrateNum;
26 use rustc_hir::LangItem;
27 use rustc_middle::dep_graph::WorkProduct;
28 use rustc_middle::middle::dependency_format::Dependencies;
29 use rustc_middle::ty::query::Providers;
30 use rustc_session::config::{CrateType, OutputFilenames, OutputType, RUST_CGU_EXT};
31 use rustc_session::cstore::{self, CrateSource};
32 use rustc_session::utils::NativeLibKind;
33 use rustc_span::symbol::Symbol;
34 use std::path::{Path, PathBuf};
45 pub mod target_features;
48 pub struct ModuleCodegen<M> {
49 /// The name of the module. When the crate may be saved between
50 /// compilations, incremental compilation requires that name be
51 /// unique amongst **all** crates. Therefore, it should contain
52 /// something unique to this crate (e.g., a module path) as well
53 /// as the crate name and disambiguator.
54 /// We currently generate these names via CodegenUnit::build_cgu_name().
60 // FIXME(eddyb) maybe include the crate name in this?
61 pub const METADATA_FILENAME: &str = "lib.rmeta";
63 impl<M> ModuleCodegen<M> {
64 pub fn into_compiled_module(
69 outputs: &OutputFilenames,
71 let object = emit_obj.then(|| outputs.temp_path(OutputType::Object, Some(&self.name)));
72 let dwarf_object = emit_dwarf_obj.then(|| outputs.temp_path_dwo(Some(&self.name)));
73 let bytecode = emit_bc.then(|| outputs.temp_path(OutputType::Bitcode, Some(&self.name)));
75 CompiledModule { name: self.name.clone(), kind: self.kind, object, dwarf_object, bytecode }
79 #[derive(Debug, Encodable, Decodable)]
80 pub struct CompiledModule {
83 pub object: Option<PathBuf>,
84 pub dwarf_object: Option<PathBuf>,
85 pub bytecode: Option<PathBuf>,
88 pub struct CachedModuleCodegen {
90 pub source: WorkProduct,
93 #[derive(Copy, Clone, Debug, PartialEq, Encodable, Decodable)]
100 bitflags::bitflags! {
101 pub struct MemFlags: u8 {
102 const VOLATILE = 1 << 0;
103 const NONTEMPORAL = 1 << 1;
104 const UNALIGNED = 1 << 2;
108 #[derive(Clone, Debug, Encodable, Decodable, HashStable)]
109 pub struct NativeLib {
110 pub kind: NativeLibKind,
111 pub name: Option<Symbol>,
112 pub cfg: Option<ast::MetaItem>,
113 pub verbatim: Option<bool>,
114 pub dll_imports: Vec<cstore::DllImport>,
117 impl From<&cstore::NativeLib> for NativeLib {
118 fn from(lib: &cstore::NativeLib) -> Self {
122 cfg: lib.cfg.clone(),
123 verbatim: lib.verbatim,
124 dll_imports: lib.dll_imports.clone(),
129 /// Misc info we load from metadata to persist beyond the tcx.
131 /// Note: though `CrateNum` is only meaningful within the same tcx, information within `CrateInfo`
132 /// is self-contained. `CrateNum` can be viewed as a unique identifier within a `CrateInfo`, where
133 /// `used_crate_source` contains all `CrateSource` of the dependents, and maintains a mapping from
134 /// identifiers (`CrateNum`) to `CrateSource`. The other fields map `CrateNum` to the crate's own
135 /// additional properties, so that effectively we can retrieve each dependent crate's `CrateSource`
136 /// and the corresponding properties without referencing information outside of a `CrateInfo`.
137 #[derive(Debug, Encodable, Decodable)]
138 pub struct CrateInfo {
139 pub target_cpu: String,
140 pub exported_symbols: FxHashMap<CrateType, Vec<String>>,
141 pub local_crate_name: Symbol,
142 pub compiler_builtins: Option<CrateNum>,
143 pub profiler_runtime: Option<CrateNum>,
144 pub is_no_builtins: FxHashSet<CrateNum>,
145 pub native_libraries: FxHashMap<CrateNum, Vec<NativeLib>>,
146 pub crate_name: FxHashMap<CrateNum, String>,
147 pub used_libraries: Vec<NativeLib>,
148 pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
149 pub used_crates: Vec<CrateNum>,
150 pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
151 pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
152 pub dependency_formats: Lrc<Dependencies>,
153 pub windows_subsystem: Option<String>,
156 #[derive(Encodable, Decodable)]
157 pub struct CodegenResults {
158 pub modules: Vec<CompiledModule>,
159 pub allocator_module: Option<CompiledModule>,
160 pub metadata_module: Option<CompiledModule>,
161 pub metadata: rustc_metadata::EncodedMetadata,
162 pub crate_info: CrateInfo,
165 pub fn provide(providers: &mut Providers) {
166 crate::back::symbol_export::provide(providers);
167 crate::base::provide(providers);
168 crate::target_features::provide(providers);
171 pub fn provide_extern(providers: &mut Providers) {
172 crate::back::symbol_export::provide_extern(providers);
175 /// Checks if the given filename ends with the `.rcgu.o` extension that `rustc`
176 /// uses for the object files it generates.
177 pub fn looks_like_rust_object_file(filename: &str) -> bool {
178 let path = Path::new(filename);
179 let ext = path.extension().and_then(|s| s.to_str());
180 if ext != Some(OutputType::Object.extension()) {
181 // The file name does not end with ".o", so it can't be an object file.
185 // Strip the ".o" at the end
186 let ext2 = path.file_stem().and_then(|s| Path::new(s).extension()).and_then(|s| s.to_str());
188 // Check if the "inner" extension
189 ext2 == Some(RUST_CGU_EXT)