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(const_cstr_unchecked)]
12 #![feature(crate_visibility_modifier)]
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)]
26 #![deny(unused_lifetimes)]
27 #![allow(explicit_outlives_requirements)]
29 use back::write::{create_target_machine, create_informational_target_machine};
30 use syntax_pos::symbol::Symbol;
33 #[macro_use] extern crate bitflags;
35 #[macro_use] extern crate rustc;
36 extern crate rustc_allocator;
37 extern crate rustc_target;
38 #[macro_use] extern crate rustc_data_structures;
39 extern crate rustc_incremental;
40 extern crate rustc_codegen_utils;
41 extern crate rustc_codegen_ssa;
42 extern crate rustc_fs_util;
44 #[macro_use] extern crate log;
45 #[macro_use] extern crate syntax;
46 extern crate syntax_pos;
47 extern crate rustc_errors as errors;
49 use rustc_codegen_ssa::traits::*;
50 use rustc_codegen_ssa::back::write::{CodegenContext, ModuleConfig, FatLTOInput};
51 use rustc_codegen_ssa::back::lto::{SerializedModule, LtoModuleCodegen, ThinModule};
52 use rustc_codegen_ssa::CompiledModule;
53 use errors::{FatalError, Handler};
54 use rustc::dep_graph::WorkProduct;
55 use syntax_pos::symbol::InternedString;
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_codegen_ssa::ModuleCodegen;
68 use rustc_codegen_utils::codegen_backend::CodegenBackend;
93 // The following is a work around that replaces `pub mod llvm;` and that fixes issue 53912.
94 #[path = "llvm/mod.rs"] mod llvm_; pub mod llvm { pub use super::llvm_::*; }
105 pub struct LlvmCodegenBackend(());
107 impl ExtraBackendMethods for LlvmCodegenBackend {
108 fn new_metadata(&self, tcx: TyCtxt<'_>, mod_name: &str) -> ModuleLlvm {
109 ModuleLlvm::new_metadata(tcx, mod_name)
112 fn write_compressed_metadata<'tcx>(
115 metadata: &EncodedMetadata,
116 llvm_module: &mut ModuleLlvm,
118 base::write_compressed_metadata(tcx, metadata, llvm_module)
120 fn codegen_allocator<'tcx>(
123 mods: &mut ModuleLlvm,
126 unsafe { allocator::codegen(tcx, mods, kind) }
128 fn compile_codegen_unit<'a, 'tcx: 'a>(&self, tcx: TyCtxt<'tcx>, cgu_name: InternedString) {
129 base::compile_codegen_unit(tcx, cgu_name);
131 fn target_machine_factory(
137 Result<&'static mut llvm::TargetMachine, String> + Send + Sync> {
138 back::write::target_machine_factory(sess, optlvl, find_features)
140 fn target_cpu<'b>(&self, sess: &'b Session) -> &'b str {
141 llvm_util::target_cpu(sess)
145 impl WriteBackendMethods for LlvmCodegenBackend {
146 type Module = ModuleLlvm;
147 type ModuleBuffer = back::lto::ModuleBuffer;
148 type Context = llvm::Context;
149 type TargetMachine = &'static mut llvm::TargetMachine;
150 type ThinData = back::lto::ThinData;
151 type ThinBuffer = back::lto::ThinBuffer;
152 fn print_pass_timings(&self) {
153 unsafe { llvm::LLVMRustPrintPassTimings(); }
156 cgcx: &CodegenContext<Self>,
157 modules: Vec<FatLTOInput<Self>>,
158 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
159 ) -> Result<LtoModuleCodegen<Self>, FatalError> {
160 back::lto::run_fat(cgcx, modules, cached_modules)
163 cgcx: &CodegenContext<Self>,
164 modules: Vec<(String, Self::ThinBuffer)>,
165 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
166 ) -> Result<(Vec<LtoModuleCodegen<Self>>, Vec<WorkProduct>), FatalError> {
167 back::lto::run_thin(cgcx, modules, cached_modules)
170 cgcx: &CodegenContext<Self>,
171 diag_handler: &Handler,
172 module: &ModuleCodegen<Self::Module>,
173 config: &ModuleConfig,
174 ) -> Result<(), FatalError> {
175 back::write::optimize(cgcx, diag_handler, module, config)
177 unsafe fn optimize_thin(
178 cgcx: &CodegenContext<Self>,
179 thin: &mut ThinModule<Self>,
180 ) -> Result<ModuleCodegen<Self::Module>, FatalError> {
181 back::lto::optimize_thin_module(thin, cgcx)
184 cgcx: &CodegenContext<Self>,
185 diag_handler: &Handler,
186 module: ModuleCodegen<Self::Module>,
187 config: &ModuleConfig,
188 ) -> Result<CompiledModule, FatalError> {
189 back::write::codegen(cgcx, diag_handler, module, config)
192 module: ModuleCodegen<Self::Module>
193 ) -> (String, Self::ThinBuffer) {
194 back::lto::prepare_thin(module)
197 module: ModuleCodegen<Self::Module>
198 ) -> (String, Self::ModuleBuffer) {
199 (module.name, back::lto::ModuleBuffer::new(module.module_llvm.llmod()))
201 fn run_lto_pass_manager(
202 cgcx: &CodegenContext<Self>,
203 module: &ModuleCodegen<Self::Module>,
204 config: &ModuleConfig,
207 back::lto::run_pass_manager(cgcx, module, config, thin)
211 unsafe impl Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
212 unsafe impl Sync for LlvmCodegenBackend {}
214 impl LlvmCodegenBackend {
215 pub fn new() -> Box<dyn CodegenBackend> {
216 box LlvmCodegenBackend(())
220 impl CodegenBackend for LlvmCodegenBackend {
221 fn init(&self, sess: &Session) {
222 llvm_util::init(sess); // Make sure llvm is inited
225 fn print(&self, req: PrintRequest, sess: &Session) {
227 PrintRequest::RelocationModels => {
228 println!("Available relocation models:");
229 for &(name, _) in back::write::RELOC_MODEL_ARGS.iter() {
230 println!(" {}", name);
234 PrintRequest::CodeModels => {
235 println!("Available code models:");
236 for &(name, _) in back::write::CODE_GEN_MODEL_ARGS.iter(){
237 println!(" {}", name);
241 PrintRequest::TlsModels => {
242 println!("Available TLS models:");
243 for &(name, _) in back::write::TLS_MODEL_ARGS.iter(){
244 println!(" {}", name);
248 req => llvm_util::print(req, sess),
252 fn print_passes(&self) {
253 llvm_util::print_passes();
256 fn print_version(&self) {
257 llvm_util::print_version();
260 fn diagnostics(&self) -> &[(&'static str, &'static str)] {
264 fn target_features(&self, sess: &Session) -> Vec<Symbol> {
265 target_features(sess)
268 fn metadata_loader(&self) -> Box<dyn MetadataLoader + Sync> {
269 box metadata::LlvmMetadataLoader
272 fn provide(&self, providers: &mut ty::query::Providers<'_>) {
273 rustc_codegen_utils::symbol_names::provide(providers);
274 rustc_codegen_ssa::back::symbol_export::provide(providers);
275 rustc_codegen_ssa::base::provide_both(providers);
276 attributes::provide(providers);
279 fn provide_extern(&self, providers: &mut ty::query::Providers<'_>) {
280 rustc_codegen_ssa::back::symbol_export::provide_extern(providers);
281 rustc_codegen_ssa::base::provide_both(providers);
282 attributes::provide_extern(providers);
285 fn codegen_crate<'tcx>(
288 metadata: EncodedMetadata,
289 need_metadata_module: bool,
290 rx: mpsc::Receiver<Box<dyn Any + Send>>,
292 box rustc_codegen_ssa::base::codegen_crate(
293 LlvmCodegenBackend(()), tcx, metadata, need_metadata_module, rx)
296 fn join_codegen_and_link(
298 ongoing_codegen: Box<dyn Any>,
300 dep_graph: &DepGraph,
301 outputs: &OutputFilenames,
302 ) -> Result<(), ErrorReported> {
303 use rustc::util::common::time;
304 let (codegen_results, work_products) =
305 ongoing_codegen.downcast::
306 <rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
307 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
309 if sess.opts.debugging_opts.incremental_info {
310 rustc_codegen_ssa::back::write::dump_incremental_data(&codegen_results);
314 "serialize work products",
315 move || rustc_incremental::save_work_product_index(sess, &dep_graph, work_products));
317 sess.compile_status()?;
319 if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
320 i == OutputType::Metadata) {
324 // Run the linker on any artifacts that resulted from the LLVM run.
325 // This should produce either a finished executable or library.
326 sess.profiler(|p| p.start_activity("link_crate"));
327 time(sess, "linking", || {
328 use rustc_codegen_ssa::back::link::link_binary;
329 use crate::back::archive::LlvmArchiveBuilder;
331 let target_cpu = crate::llvm_util::target_cpu(sess);
332 link_binary::<LlvmArchiveBuilder<'_>>(
336 &codegen_results.crate_name.as_str(),
340 sess.profiler(|p| p.end_activity("link_crate"));
342 // Now that we won't touch anything in the incremental compilation directory
343 // any more, we can finalize it (which involves renaming it)
344 rustc_incremental::finalize_session_directory(sess, codegen_results.crate_hash);
350 /// This is the entrypoint for a hot plugged rustc_codegen_llvm
352 pub fn __rustc_codegen_backend() -> Box<dyn CodegenBackend> {
353 LlvmCodegenBackend::new()
356 pub struct ModuleLlvm {
357 llcx: &'static mut llvm::Context,
358 llmod_raw: *const llvm::Module,
359 tm: &'static mut llvm::TargetMachine,
362 unsafe impl Send for ModuleLlvm { }
363 unsafe impl Sync for ModuleLlvm { }
366 fn new(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_target_machine(tcx, false),
378 fn new_metadata(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
380 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
381 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
385 tm: create_informational_target_machine(&tcx.sess, false),
391 cgcx: &CodegenContext<LlvmCodegenBackend>,
393 buffer: &back::lto::ModuleBuffer,
395 ) -> Result<Self, FatalError> {
397 let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
398 let llmod_raw = buffer.parse(name, llcx, handler)?;
399 let tm = match (cgcx.tm_factory.0)() {
402 handler.struct_err(&e).emit();
403 return Err(FatalError)
415 fn llmod(&self) -> &llvm::Module {
422 impl Drop for ModuleLlvm {
425 llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
426 llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));
431 __build_diagnostic_array! { librustc_codegen_llvm, DIAGNOSTICS }