5 //! This API is completely unstable and subject to change.
7 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
9 #![feature(box_patterns)]
10 #![feature(box_syntax)]
11 #![feature(crate_visibility_modifier)]
12 #![feature(custom_attribute)]
13 #![feature(extern_types)]
14 #![feature(in_band_lifetimes)]
15 #![allow(unused_attributes)]
18 #![feature(rustc_diagnostic_macros)]
19 #![feature(optin_builtin_traits)]
20 #![feature(concat_idents)]
21 #![feature(link_args)]
22 #![feature(static_nobundle)]
23 #![feature(trusted_len)]
24 #![deny(rust_2018_idioms)]
25 #![allow(explicit_outlives_requirements)]
27 use back::write::{create_target_machine, create_informational_target_machine};
28 use syntax_pos::symbol::Symbol;
31 #[macro_use] extern crate bitflags;
33 #[macro_use] extern crate rustc;
34 extern crate rustc_mir;
35 extern crate rustc_allocator;
36 extern crate rustc_target;
37 #[macro_use] extern crate rustc_data_structures;
38 extern crate rustc_incremental;
39 extern crate rustc_codegen_utils;
40 extern crate rustc_codegen_ssa;
41 extern crate rustc_fs_util;
43 #[macro_use] extern crate log;
44 #[macro_use] extern crate syntax;
45 extern crate syntax_pos;
46 extern crate rustc_errors as errors;
48 use rustc_codegen_ssa::traits::*;
49 use rustc_codegen_ssa::back::write::{CodegenContext, ModuleConfig, FatLTOInput};
50 use rustc_codegen_ssa::back::lto::{SerializedModule, LtoModuleCodegen, ThinModule};
51 use rustc_codegen_ssa::CompiledModule;
52 use errors::{FatalError, Handler};
53 use rustc::dep_graph::WorkProduct;
54 use syntax_pos::symbol::InternedString;
55 use rustc::mir::mono::Stats;
56 pub use llvm_util::target_features;
58 use std::sync::{mpsc, Arc};
60 use rustc::dep_graph::DepGraph;
61 use rustc::middle::allocator::AllocatorKind;
62 use rustc::middle::cstore::{EncodedMetadata, MetadataLoader};
63 use rustc::session::Session;
64 use rustc::session::config::{OutputFilenames, OutputType, PrintRequest, OptLevel};
65 use rustc::ty::{self, TyCtxt};
66 use rustc::util::common::ErrorReported;
67 use rustc_mir::monomorphize;
68 use rustc_codegen_ssa::ModuleCodegen;
69 use rustc_codegen_utils::codegen_backend::CodegenBackend;
94 // The following is a work around that replaces `pub mod llvm;` and that fixes issue 53912.
95 #[path = "llvm/mod.rs"] mod llvm_; pub mod llvm { pub use super::llvm_::*; }
106 pub struct LlvmCodegenBackend(());
108 impl ExtraBackendMethods for LlvmCodegenBackend {
109 fn new_metadata(&self, tcx: TyCtxt<'_, '_, '_>, mod_name: &str) -> ModuleLlvm {
110 ModuleLlvm::new_metadata(tcx, mod_name)
113 fn write_compressed_metadata<'b, 'gcx>(
115 tcx: TyCtxt<'b, 'gcx, 'gcx>,
116 metadata: &EncodedMetadata,
117 llvm_module: &mut ModuleLlvm
119 base::write_compressed_metadata(tcx, metadata, llvm_module)
121 fn codegen_allocator<'b, 'gcx>(
123 tcx: TyCtxt<'b, 'gcx, 'gcx>,
124 mods: &mut ModuleLlvm,
127 unsafe { allocator::codegen(tcx, mods, kind) }
129 fn compile_codegen_unit<'a, 'tcx: 'a>(
131 tcx: TyCtxt<'a, 'tcx, 'tcx>,
132 cgu_name: InternedString,
134 base::compile_codegen_unit(tcx, cgu_name)
136 fn target_machine_factory(
142 Result<&'static mut llvm::TargetMachine, String> + Send + Sync> {
143 back::write::target_machine_factory(sess, optlvl, find_features)
145 fn target_cpu<'b>(&self, sess: &'b Session) -> &'b str {
146 llvm_util::target_cpu(sess)
150 impl WriteBackendMethods for LlvmCodegenBackend {
151 type Module = ModuleLlvm;
152 type ModuleBuffer = back::lto::ModuleBuffer;
153 type Context = llvm::Context;
154 type TargetMachine = &'static mut llvm::TargetMachine;
155 type ThinData = back::lto::ThinData;
156 type ThinBuffer = back::lto::ThinBuffer;
157 fn print_pass_timings(&self) {
158 unsafe { llvm::LLVMRustPrintPassTimings(); }
161 cgcx: &CodegenContext<Self>,
162 modules: Vec<FatLTOInput<Self>>,
163 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
164 ) -> Result<LtoModuleCodegen<Self>, FatalError> {
165 back::lto::run_fat(cgcx, modules, cached_modules)
168 cgcx: &CodegenContext<Self>,
169 modules: Vec<(String, Self::ThinBuffer)>,
170 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
171 ) -> Result<(Vec<LtoModuleCodegen<Self>>, Vec<WorkProduct>), FatalError> {
172 back::lto::run_thin(cgcx, modules, cached_modules)
175 cgcx: &CodegenContext<Self>,
176 diag_handler: &Handler,
177 module: &ModuleCodegen<Self::Module>,
178 config: &ModuleConfig,
179 ) -> Result<(), FatalError> {
180 back::write::optimize(cgcx, diag_handler, module, config)
182 unsafe fn optimize_thin(
183 cgcx: &CodegenContext<Self>,
184 thin: &mut ThinModule<Self>,
185 ) -> Result<ModuleCodegen<Self::Module>, FatalError> {
186 back::lto::optimize_thin_module(thin, cgcx)
189 cgcx: &CodegenContext<Self>,
190 diag_handler: &Handler,
191 module: ModuleCodegen<Self::Module>,
192 config: &ModuleConfig,
193 ) -> Result<CompiledModule, FatalError> {
194 back::write::codegen(cgcx, diag_handler, module, config)
197 module: ModuleCodegen<Self::Module>
198 ) -> (String, Self::ThinBuffer) {
199 back::lto::prepare_thin(module)
202 module: ModuleCodegen<Self::Module>
203 ) -> (String, Self::ModuleBuffer) {
204 (module.name, back::lto::ModuleBuffer::new(module.module_llvm.llmod()))
206 fn run_lto_pass_manager(
207 cgcx: &CodegenContext<Self>,
208 module: &ModuleCodegen<Self::Module>,
209 config: &ModuleConfig,
212 back::lto::run_pass_manager(cgcx, module, config, thin)
216 unsafe impl Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
217 unsafe impl Sync for LlvmCodegenBackend {}
219 impl LlvmCodegenBackend {
220 pub fn new() -> Box<dyn CodegenBackend> {
221 box LlvmCodegenBackend(())
225 impl CodegenBackend for LlvmCodegenBackend {
226 fn init(&self, sess: &Session) {
227 llvm_util::init(sess); // Make sure llvm is inited
230 fn print(&self, req: PrintRequest, sess: &Session) {
232 PrintRequest::RelocationModels => {
233 println!("Available relocation models:");
234 for &(name, _) in back::write::RELOC_MODEL_ARGS.iter() {
235 println!(" {}", name);
239 PrintRequest::CodeModels => {
240 println!("Available code models:");
241 for &(name, _) in back::write::CODE_GEN_MODEL_ARGS.iter(){
242 println!(" {}", name);
246 PrintRequest::TlsModels => {
247 println!("Available TLS models:");
248 for &(name, _) in back::write::TLS_MODEL_ARGS.iter(){
249 println!(" {}", name);
253 req => llvm_util::print(req, sess),
257 fn print_passes(&self) {
258 llvm_util::print_passes();
261 fn print_version(&self) {
262 llvm_util::print_version();
265 fn diagnostics(&self) -> &[(&'static str, &'static str)] {
269 fn target_features(&self, sess: &Session) -> Vec<Symbol> {
270 target_features(sess)
273 fn metadata_loader(&self) -> Box<dyn MetadataLoader + Sync> {
274 box metadata::LlvmMetadataLoader
277 fn provide(&self, providers: &mut ty::query::Providers<'_>) {
278 rustc_codegen_utils::symbol_names::provide(providers);
279 rustc_codegen_ssa::back::symbol_export::provide(providers);
280 rustc_codegen_ssa::base::provide_both(providers);
281 attributes::provide(providers);
284 fn provide_extern(&self, providers: &mut ty::query::Providers<'_>) {
285 rustc_codegen_ssa::back::symbol_export::provide_extern(providers);
286 rustc_codegen_ssa::base::provide_both(providers);
287 attributes::provide_extern(providers);
290 fn codegen_crate<'b, 'tcx>(
292 tcx: TyCtxt<'b, 'tcx, 'tcx>,
293 metadata: EncodedMetadata,
294 need_metadata_module: bool,
295 rx: mpsc::Receiver<Box<dyn Any + Send>>
297 box rustc_codegen_ssa::base::codegen_crate(
298 LlvmCodegenBackend(()), tcx, metadata, need_metadata_module, rx)
301 fn join_codegen_and_link(
303 ongoing_codegen: Box<dyn Any>,
305 dep_graph: &DepGraph,
306 outputs: &OutputFilenames,
307 ) -> Result<(), ErrorReported> {
308 use rustc::util::common::time;
309 let (codegen_results, work_products) =
310 ongoing_codegen.downcast::
311 <rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
312 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
314 if sess.opts.debugging_opts.incremental_info {
315 rustc_codegen_ssa::back::write::dump_incremental_data(&codegen_results);
319 "serialize work products",
320 move || rustc_incremental::save_work_product_index(sess, &dep_graph, work_products));
322 sess.compile_status()?;
324 if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
325 i == OutputType::Metadata) {
329 // Run the linker on any artifacts that resulted from the LLVM run.
330 // This should produce either a finished executable or library.
331 sess.profiler(|p| p.start_activity("link_crate"));
332 time(sess, "linking", || {
333 use rustc_codegen_ssa::back::link::link_binary;
334 use crate::back::archive::LlvmArchiveBuilder;
336 let target_cpu = crate::llvm_util::target_cpu(sess);
337 link_binary::<LlvmArchiveBuilder<'_>>(
341 &codegen_results.crate_name.as_str(),
345 sess.profiler(|p| p.end_activity("link_crate"));
347 // Now that we won't touch anything in the incremental compilation directory
348 // any more, we can finalize it (which involves renaming it)
349 rustc_incremental::finalize_session_directory(sess, codegen_results.crate_hash);
355 /// This is the entrypoint for a hot plugged rustc_codegen_llvm
357 pub fn __rustc_codegen_backend() -> Box<dyn CodegenBackend> {
358 LlvmCodegenBackend::new()
361 pub struct ModuleLlvm {
362 llcx: &'static mut llvm::Context,
363 llmod_raw: *const llvm::Module,
364 tm: &'static mut llvm::TargetMachine,
367 unsafe impl Send for ModuleLlvm { }
368 unsafe impl Sync for ModuleLlvm { }
371 fn new(tcx: TyCtxt<'_, '_, '_>, mod_name: &str) -> Self {
373 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
374 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
378 tm: create_target_machine(tcx, false),
383 fn new_metadata(tcx: TyCtxt<'_, '_, '_>, mod_name: &str) -> Self {
385 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
386 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
390 tm: create_informational_target_machine(&tcx.sess, false),
396 cgcx: &CodegenContext<LlvmCodegenBackend>,
398 buffer: &back::lto::ModuleBuffer,
400 ) -> Result<Self, FatalError> {
402 let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
403 let llmod_raw = buffer.parse(name, llcx, handler)?;
404 let tm = match (cgcx.tm_factory.0)() {
407 handler.struct_err(&e).emit();
408 return Err(FatalError)
420 fn llmod(&self) -> &llvm::Module {
427 impl Drop for ModuleLlvm {
430 llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
431 llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));
436 __build_diagnostic_array! { librustc_codegen_llvm, DIAGNOSTICS }