5 //! This API is completely unstable and subject to change.
7 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
8 #![feature(bool_to_option)]
9 #![feature(box_patterns)]
10 #![feature(box_syntax)]
11 #![feature(const_cstr_unchecked)]
12 #![feature(crate_visibility_modifier)]
13 #![feature(extern_types)]
14 #![feature(in_band_lifetimes)]
17 #![feature(optin_builtin_traits)]
18 #![feature(concat_idents)]
19 #![feature(link_args)]
20 #![feature(static_nobundle)]
21 #![feature(trusted_len)]
22 #![recursion_limit = "256"]
24 use back::write::{create_informational_target_machine, create_target_machine};
25 use rustc_span::symbol::Symbol;
27 pub use llvm_util::target_features;
28 use rustc::dep_graph::WorkProduct;
29 use rustc_codegen_ssa::back::lto::{LtoModuleCodegen, SerializedModule, ThinModule};
30 use rustc_codegen_ssa::back::write::{CodegenContext, FatLTOInput, ModuleConfig};
31 use rustc_codegen_ssa::traits::*;
32 use rustc_codegen_ssa::{CodegenResults, CompiledModule};
33 use rustc_errors::{FatalError, Handler};
38 use syntax::expand::allocator::AllocatorKind;
40 use rustc::dep_graph::DepGraph;
41 use rustc::middle::cstore::{EncodedMetadata, MetadataLoaderDyn};
42 use rustc::session::config::{OptLevel, OutputFilenames, PrintRequest};
43 use rustc::session::Session;
44 use rustc::ty::{self, TyCtxt};
45 use rustc::util::common::ErrorReported;
46 use rustc_codegen_ssa::ModuleCodegen;
47 use rustc_codegen_utils::codegen_backend::CodegenBackend;
48 use rustc_serialize::json;
71 // The following is a work around that replaces `pub mod llvm;` and that fixes issue 53912.
72 #[path = "llvm/mod.rs"]
75 pub use super::llvm_::*;
87 pub struct LlvmCodegenBackend(());
89 impl ExtraBackendMethods for LlvmCodegenBackend {
90 fn new_metadata(&self, tcx: TyCtxt<'_>, mod_name: &str) -> ModuleLlvm {
91 ModuleLlvm::new_metadata(tcx, mod_name)
94 fn write_compressed_metadata<'tcx>(
97 metadata: &EncodedMetadata,
98 llvm_module: &mut ModuleLlvm,
100 base::write_compressed_metadata(tcx, metadata, llvm_module)
102 fn codegen_allocator<'tcx>(
105 mods: &mut ModuleLlvm,
108 unsafe { allocator::codegen(tcx, mods, kind) }
110 fn compile_codegen_unit(
114 ) -> (ModuleCodegen<ModuleLlvm>, u64) {
115 base::compile_codegen_unit(tcx, cgu_name)
117 fn target_machine_factory(
122 ) -> Arc<dyn Fn() -> Result<&'static mut llvm::TargetMachine, String> + Send + Sync> {
123 back::write::target_machine_factory(sess, optlvl, find_features)
125 fn target_cpu<'b>(&self, sess: &'b Session) -> &'b str {
126 llvm_util::target_cpu(sess)
130 impl WriteBackendMethods for LlvmCodegenBackend {
131 type Module = ModuleLlvm;
132 type ModuleBuffer = back::lto::ModuleBuffer;
133 type Context = llvm::Context;
134 type TargetMachine = &'static mut llvm::TargetMachine;
135 type ThinData = back::lto::ThinData;
136 type ThinBuffer = back::lto::ThinBuffer;
137 fn print_pass_timings(&self) {
139 llvm::LLVMRustPrintPassTimings();
143 cgcx: &CodegenContext<Self>,
144 modules: Vec<FatLTOInput<Self>>,
145 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
146 ) -> Result<LtoModuleCodegen<Self>, FatalError> {
147 back::lto::run_fat(cgcx, modules, cached_modules)
150 cgcx: &CodegenContext<Self>,
151 modules: Vec<(String, Self::ThinBuffer)>,
152 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
153 ) -> Result<(Vec<LtoModuleCodegen<Self>>, Vec<WorkProduct>), FatalError> {
154 back::lto::run_thin(cgcx, modules, cached_modules)
157 cgcx: &CodegenContext<Self>,
158 diag_handler: &Handler,
159 module: &ModuleCodegen<Self::Module>,
160 config: &ModuleConfig,
161 ) -> Result<(), FatalError> {
162 back::write::optimize(cgcx, diag_handler, module, config)
164 unsafe fn optimize_thin(
165 cgcx: &CodegenContext<Self>,
166 thin: &mut ThinModule<Self>,
167 ) -> Result<ModuleCodegen<Self::Module>, FatalError> {
168 back::lto::optimize_thin_module(thin, cgcx)
171 cgcx: &CodegenContext<Self>,
172 diag_handler: &Handler,
173 module: ModuleCodegen<Self::Module>,
174 config: &ModuleConfig,
175 ) -> Result<CompiledModule, FatalError> {
176 back::write::codegen(cgcx, diag_handler, module, config)
178 fn prepare_thin(module: ModuleCodegen<Self::Module>) -> (String, Self::ThinBuffer) {
179 back::lto::prepare_thin(module)
181 fn serialize_module(module: ModuleCodegen<Self::Module>) -> (String, Self::ModuleBuffer) {
182 (module.name, back::lto::ModuleBuffer::new(module.module_llvm.llmod()))
184 fn run_lto_pass_manager(
185 cgcx: &CodegenContext<Self>,
186 module: &ModuleCodegen<Self::Module>,
187 config: &ModuleConfig,
190 back::lto::run_pass_manager(cgcx, module, config, thin)
194 unsafe impl Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
195 unsafe impl Sync for LlvmCodegenBackend {}
197 impl LlvmCodegenBackend {
198 pub fn new() -> Box<dyn CodegenBackend> {
199 box LlvmCodegenBackend(())
203 impl CodegenBackend for LlvmCodegenBackend {
204 fn init(&self, sess: &Session) {
205 llvm_util::init(sess); // Make sure llvm is inited
208 fn print(&self, req: PrintRequest, sess: &Session) {
210 PrintRequest::RelocationModels => {
211 println!("Available relocation models:");
212 for &(name, _) in back::write::RELOC_MODEL_ARGS.iter() {
213 println!(" {}", name);
217 PrintRequest::CodeModels => {
218 println!("Available code models:");
219 for &(name, _) in back::write::CODE_GEN_MODEL_ARGS.iter() {
220 println!(" {}", name);
224 PrintRequest::TlsModels => {
225 println!("Available TLS models:");
226 for &(name, _) in back::write::TLS_MODEL_ARGS.iter() {
227 println!(" {}", name);
231 req => llvm_util::print(req, sess),
235 fn print_passes(&self) {
236 llvm_util::print_passes();
239 fn print_version(&self) {
240 llvm_util::print_version();
243 fn target_features(&self, sess: &Session) -> Vec<Symbol> {
244 target_features(sess)
247 fn metadata_loader(&self) -> Box<MetadataLoaderDyn> {
248 box metadata::LlvmMetadataLoader
251 fn provide(&self, providers: &mut ty::query::Providers<'_>) {
252 attributes::provide(providers);
255 fn provide_extern(&self, providers: &mut ty::query::Providers<'_>) {
256 attributes::provide_extern(providers);
259 fn codegen_crate<'tcx>(
262 metadata: EncodedMetadata,
263 need_metadata_module: bool,
265 box rustc_codegen_ssa::base::codegen_crate(
266 LlvmCodegenBackend(()),
269 need_metadata_module,
275 ongoing_codegen: Box<dyn Any>,
277 dep_graph: &DepGraph,
278 ) -> Result<Box<dyn Any>, ErrorReported> {
279 let (codegen_results, work_products) = ongoing_codegen
280 .downcast::<rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
281 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
283 if sess.opts.debugging_opts.incremental_info {
284 rustc_codegen_ssa::back::write::dump_incremental_data(&codegen_results);
287 sess.time("serialize_work_products", move || {
288 rustc_incremental::save_work_product_index(sess, &dep_graph, work_products)
291 sess.compile_status()?;
293 Ok(Box::new(codegen_results))
299 codegen_results: Box<dyn Any>,
300 outputs: &OutputFilenames,
301 ) -> Result<(), ErrorReported> {
302 let codegen_results = codegen_results
303 .downcast::<CodegenResults>()
304 .expect("Expected CodegenResults, found Box<Any>");
306 if sess.opts.debugging_opts.no_link {
307 // FIXME: use a binary format to encode the `.rlink` file
308 let rlink_data = json::encode(&codegen_results).map_err(|err| {
309 sess.fatal(&format!("failed to encode rlink: {}", err));
311 let rlink_file = outputs.with_extension("rlink");
312 fs::write(&rlink_file, rlink_data).map_err(|err| {
313 sess.fatal(&format!("failed to write file {}: {}", rlink_file.display(), err));
318 // Run the linker on any artifacts that resulted from the LLVM run.
319 // This should produce either a finished executable or library.
320 sess.time("link_crate", || {
321 use crate::back::archive::LlvmArchiveBuilder;
322 use rustc_codegen_ssa::back::link::link_binary;
324 let target_cpu = crate::llvm_util::target_cpu(sess);
325 link_binary::<LlvmArchiveBuilder<'_>>(
329 &codegen_results.crate_name.as_str(),
334 // Now that we won't touch anything in the incremental compilation directory
335 // any more, we can finalize it (which involves renaming it)
336 rustc_incremental::finalize_session_directory(sess, codegen_results.crate_hash);
338 sess.time("llvm_dump_timing_file", || {
339 if sess.opts.debugging_opts.llvm_time_trace {
340 llvm_util::time_trace_profiler_finish("llvm_timings.json");
348 pub struct ModuleLlvm {
349 llcx: &'static mut llvm::Context,
350 llmod_raw: *const llvm::Module,
351 tm: &'static mut llvm::TargetMachine,
354 unsafe impl Send for ModuleLlvm {}
355 unsafe impl Sync for ModuleLlvm {}
358 fn new(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
360 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
361 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
362 ModuleLlvm { llmod_raw, llcx, tm: create_target_machine(tcx, false) }
366 fn new_metadata(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
368 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
369 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
373 tm: create_informational_target_machine(&tcx.sess, false),
379 cgcx: &CodegenContext<LlvmCodegenBackend>,
383 ) -> Result<Self, FatalError> {
385 let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
386 let llmod_raw = back::lto::parse_module(llcx, name, buffer, handler)?;
387 let tm = match (cgcx.tm_factory.0)() {
390 handler.struct_err(&e).emit();
391 return Err(FatalError);
395 Ok(ModuleLlvm { llmod_raw, llcx, tm })
399 fn llmod(&self) -> &llvm::Module {
400 unsafe { &*self.llmod_raw }
404 impl Drop for ModuleLlvm {
407 llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
408 llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));