1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
2 #![feature(bool_to_option)]
3 #![feature(box_patterns)]
4 #![feature(box_syntax)]
5 #![feature(core_intrinsics)]
7 #![cfg_attr(bootstrap, feature(slice_patterns))]
8 #![feature(stmt_expr_attributes)]
9 #![feature(try_blocks)]
10 #![feature(in_band_lifetimes)]
12 #![feature(trusted_len)]
13 #![feature(associated_type_bounds)]
14 #![recursion_limit = "256"]
16 //! This crate contains codegen code that is used by all codegen backends (LLVM and others).
17 //! The backend-agnostic functions of this crate use functions defined in various traits that
18 //! have to be implemented by each backends.
25 use rustc::dep_graph::WorkProduct;
26 use rustc::middle::cstore::{CrateSource, LibSource, NativeLibrary};
27 use rustc::middle::dependency_format::Dependencies;
28 use rustc::middle::lang_items::LangItem;
29 use rustc::session::config::{OutputFilenames, OutputType, RUST_CGU_EXT};
30 use rustc::ty::query::Providers;
31 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
32 use rustc_data_structures::svh::Svh;
33 use rustc_data_structures::sync::Lrc;
34 use rustc_hir::def_id::CrateNum;
35 use rustc_span::symbol::Symbol;
36 use std::path::{Path, PathBuf};
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";
62 pub const RLIB_BYTECODE_EXTENSION: &str = "bc.z";
64 impl<M> ModuleCodegen<M> {
65 pub fn into_compiled_module(
69 emit_bc_compressed: bool,
70 outputs: &OutputFilenames,
72 let object = emit_obj.then(|| outputs.temp_path(OutputType::Object, Some(&self.name)));
73 let bytecode = emit_bc.then(|| outputs.temp_path(OutputType::Bitcode, Some(&self.name)));
74 let bytecode_compressed = emit_bc_compressed.then(|| {
76 .temp_path(OutputType::Bitcode, Some(&self.name))
77 .with_extension(RLIB_BYTECODE_EXTENSION)
81 name: self.name.clone(),
90 #[derive(Debug, RustcEncodable, RustcDecodable)]
91 pub struct CompiledModule {
94 pub object: Option<PathBuf>,
95 pub bytecode: Option<PathBuf>,
96 pub bytecode_compressed: Option<PathBuf>,
99 pub struct CachedModuleCodegen {
101 pub source: WorkProduct,
104 #[derive(Copy, Clone, Debug, PartialEq, RustcEncodable, RustcDecodable)]
105 pub enum ModuleKind {
111 bitflags::bitflags! {
112 pub struct MemFlags: u8 {
113 const VOLATILE = 1 << 0;
114 const NONTEMPORAL = 1 << 1;
115 const UNALIGNED = 1 << 2;
119 /// Misc info we load from metadata to persist beyond the tcx.
121 /// Note: though `CrateNum` is only meaningful within the same tcx, information within `CrateInfo`
122 /// is self-contained. `CrateNum` can be viewed as a unique identifier within a `CrateInfo`, where
123 /// `used_crate_source` contains all `CrateSource` of the dependents, and maintains a mapping from
124 /// identifiers (`CrateNum`) to `CrateSource`. The other fields map `CrateNum` to the crate's own
125 /// additional properties, so that effectively we can retrieve each dependent crate's `CrateSource`
126 /// and the corresponding properties without referencing information outside of a `CrateInfo`.
127 #[derive(Debug, RustcEncodable, RustcDecodable)]
128 pub struct CrateInfo {
129 pub panic_runtime: Option<CrateNum>,
130 pub compiler_builtins: Option<CrateNum>,
131 pub profiler_runtime: Option<CrateNum>,
132 pub is_no_builtins: FxHashSet<CrateNum>,
133 pub native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLibrary>>>,
134 pub crate_name: FxHashMap<CrateNum, String>,
135 pub used_libraries: Lrc<Vec<NativeLibrary>>,
136 pub link_args: Lrc<Vec<String>>,
137 pub used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
138 pub used_crates_static: Vec<(CrateNum, LibSource)>,
139 pub used_crates_dynamic: Vec<(CrateNum, LibSource)>,
140 pub lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
141 pub missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
142 pub dependency_formats: Lrc<Dependencies>,
145 #[derive(RustcEncodable, RustcDecodable)]
146 pub struct CodegenResults {
147 pub crate_name: Symbol,
148 pub modules: Vec<CompiledModule>,
149 pub allocator_module: Option<CompiledModule>,
150 pub metadata_module: Option<CompiledModule>,
152 pub metadata: rustc::middle::cstore::EncodedMetadata,
153 pub windows_subsystem: Option<String>,
154 pub linker_info: back::linker::LinkerInfo,
155 pub crate_info: CrateInfo,
158 pub fn provide(providers: &mut Providers<'_>) {
159 crate::back::symbol_export::provide(providers);
160 crate::base::provide_both(providers);
163 pub fn provide_extern(providers: &mut Providers<'_>) {
164 crate::back::symbol_export::provide_extern(providers);
165 crate::base::provide_both(providers);
168 /// Checks if the given filename ends with the `.rcgu.o` extension that `rustc`
169 /// uses for the object files it generates.
170 pub fn looks_like_rust_object_file(filename: &str) -> bool {
171 let path = Path::new(filename);
172 let ext = path.extension().and_then(|s| s.to_str());
173 if ext != Some(OutputType::Object.extension()) {
174 // The file name does not end with ".o", so it can't be an object file.
178 // Strip the ".o" at the end
179 let ext2 = path.file_stem().and_then(|s| Path::new(s).extension()).and_then(|s| s.to_str());
181 // Check if the "inner" extension
182 ext2 == Some(RUST_CGU_EXT)