1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
2 #![feature(bool_to_option)]
3 #![feature(box_patterns)]
4 #![feature(try_blocks)]
5 #![feature(in_band_lifetimes)]
7 #![feature(or_patterns)]
8 #![feature(trusted_len)]
9 #![feature(associated_type_bounds)]
10 #![recursion_limit = "256"]
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.
19 extern crate rustc_middle;
21 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
22 use rustc_data_structures::svh::Svh;
23 use rustc_data_structures::sync::Lrc;
24 use rustc_hir::def_id::CrateNum;
25 use rustc_hir::LangItem;
26 use rustc_middle::dep_graph::WorkProduct;
27 use rustc_middle::middle::cstore::{CrateSource, LibSource, NativeLib};
28 use rustc_middle::middle::dependency_format::Dependencies;
29 use rustc_middle::ty::query::Providers;
30 use rustc_session::config::{OutputFilenames, OutputType, RUST_CGU_EXT};
31 use rustc_span::symbol::Symbol;
32 use std::path::{Path, PathBuf};
44 pub struct ModuleCodegen<M> {
45 /// The name of the module. When the crate may be saved between
46 /// compilations, incremental compilation requires that name be
47 /// unique amongst **all** crates. Therefore, it should contain
48 /// something unique to this crate (e.g., a module path) as well
49 /// as the crate name and disambiguator.
50 /// We currently generate these names via CodegenUnit::build_cgu_name().
56 // FIXME(eddyb) maybe include the crate name in this?
57 pub const METADATA_FILENAME: &str = "lib.rmeta";
59 impl<M> ModuleCodegen<M> {
60 pub fn into_compiled_module(
64 outputs: &OutputFilenames,
66 let object = emit_obj.then(|| outputs.temp_path(OutputType::Object, Some(&self.name)));
67 let bytecode = emit_bc.then(|| outputs.temp_path(OutputType::Bitcode, Some(&self.name)));
69 CompiledModule { name: self.name.clone(), kind: self.kind, object, bytecode }
73 #[derive(Debug, RustcEncodable, RustcDecodable)]
74 pub struct CompiledModule {
77 pub object: Option<PathBuf>,
78 pub bytecode: Option<PathBuf>,
81 pub struct CachedModuleCodegen {
83 pub source: WorkProduct,
86 #[derive(Copy, Clone, Debug, PartialEq, RustcEncodable, RustcDecodable)]
94 pub struct MemFlags: u8 {
95 const VOLATILE = 1 << 0;
96 const NONTEMPORAL = 1 << 1;
97 const UNALIGNED = 1 << 2;
101 /// Misc info we load from metadata to persist beyond the tcx.
103 /// Note: though `CrateNum` is only meaningful within the same tcx, information within `CrateInfo`
104 /// is self-contained. `CrateNum` can be viewed as a unique identifier within a `CrateInfo`, where
105 /// `used_crate_source` contains all `CrateSource` of the dependents, and maintains a mapping from
106 /// identifiers (`CrateNum`) to `CrateSource`. The other fields map `CrateNum` to the crate's own
107 /// additional properties, so that effectively we can retrieve each dependent crate's `CrateSource`
108 /// and the corresponding properties without referencing information outside of a `CrateInfo`.
109 #[derive(Debug, RustcEncodable, RustcDecodable)]
110 pub struct CrateInfo {
111 pub panic_runtime: Option<CrateNum>,
112 pub compiler_builtins: Option<CrateNum>,
113 pub profiler_runtime: Option<CrateNum>,
114 pub is_no_builtins: FxHashSet<CrateNum>,
115 pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLib>>>,
116 pub crate_name: FxHashMap<CrateNum, String>,
117 pub used_libraries: Lrc<Vec<NativeLib>>,
118 pub link_args: Lrc<Vec<String>>,
119 pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
120 pub used_crates_static: Vec<(CrateNum, LibSource)>,
121 pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
122 pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
123 pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
124 pub dependency_formats: Lrc<Dependencies>,
127 #[derive(RustcEncodable, RustcDecodable)]
128 pub struct CodegenResults {
129 pub crate_name: Symbol,
130 pub modules: Vec<CompiledModule>,
131 pub allocator_module: Option<CompiledModule>,
132 pub metadata_module: Option<CompiledModule>,
134 pub metadata: rustc_middle::middle::cstore::EncodedMetadata,
135 pub windows_subsystem: Option<String>,
136 pub linker_info: back::linker::LinkerInfo,
137 pub crate_info: CrateInfo,
140 pub fn provide(providers: &mut Providers<'_>) {
141 crate::back::symbol_export::provide(providers);
142 crate::base::provide_both(providers);
145 pub fn provide_extern(providers: &mut Providers<'_>) {
146 crate::back::symbol_export::provide_extern(providers);
147 crate::base::provide_both(providers);
150 /// Checks if the given filename ends with the `.rcgu.o` extension that `rustc`
151 /// uses for the object files it generates.
152 pub fn looks_like_rust_object_file(filename: &str) -> bool {
153 let path = Path::new(filename);
154 let ext = path.extension().and_then(|s| s.to_str());
155 if ext != Some(OutputType::Object.extension()) {
156 // The file name does not end with ".o", so it can't be an object file.
160 // Strip the ".o" at the end
161 let ext2 = path.file_stem().and_then(|s| Path::new(s).extension()).and_then(|s| s.to_str());
163 // Check if the "inner" extension
164 ext2 == Some(RUST_CGU_EXT)