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)]
25 #![deny(rust_2018_idioms)]
26 #![deny(unused_lifetimes)]
28 use back::write::{create_target_machine, create_informational_target_machine};
29 use syntax_pos::symbol::Symbol;
32 #[macro_use] extern crate bitflags;
34 #[macro_use] extern crate rustc;
35 extern crate rustc_target;
36 #[macro_use] extern crate rustc_data_structures;
37 extern crate rustc_incremental;
38 extern crate rustc_codegen_utils;
39 extern crate rustc_codegen_ssa;
40 extern crate rustc_fs_util;
41 extern crate rustc_driver as _;
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::ext::allocator::AllocatorKind;
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::cstore::{EncodedMetadata, MetadataLoader};
62 use rustc::session::Session;
63 use rustc::session::config::{OutputFilenames, OutputType, PrintRequest, OptLevel};
64 use rustc::ty::{self, TyCtxt};
65 use rustc::util::common::ErrorReported;
66 use rustc_codegen_ssa::ModuleCodegen;
67 use rustc_codegen_utils::codegen_backend::CodegenBackend;
92 // The following is a work around that replaces `pub mod llvm;` and that fixes issue 53912.
93 #[path = "llvm/mod.rs"] mod llvm_; pub mod llvm { pub use super::llvm_::*; }
104 pub struct LlvmCodegenBackend(());
106 impl ExtraBackendMethods for LlvmCodegenBackend {
107 fn new_metadata(&self, tcx: TyCtxt<'_>, mod_name: &str) -> ModuleLlvm {
108 ModuleLlvm::new_metadata(tcx, mod_name)
111 fn write_compressed_metadata<'tcx>(
114 metadata: &EncodedMetadata,
115 llvm_module: &mut ModuleLlvm,
117 base::write_compressed_metadata(tcx, metadata, llvm_module)
119 fn codegen_allocator<'tcx>(
122 mods: &mut ModuleLlvm,
125 unsafe { allocator::codegen(tcx, mods, kind) }
127 fn compile_codegen_unit(&self, tcx: TyCtxt<'_>, cgu_name: InternedString) {
128 base::compile_codegen_unit(tcx, cgu_name);
130 fn target_machine_factory(
136 Result<&'static mut llvm::TargetMachine, String> + Send + Sync> {
137 back::write::target_machine_factory(sess, optlvl, find_features)
139 fn target_cpu<'b>(&self, sess: &'b Session) -> &'b str {
140 llvm_util::target_cpu(sess)
144 impl WriteBackendMethods for LlvmCodegenBackend {
145 type Module = ModuleLlvm;
146 type ModuleBuffer = back::lto::ModuleBuffer;
147 type Context = llvm::Context;
148 type TargetMachine = &'static mut llvm::TargetMachine;
149 type ThinData = back::lto::ThinData;
150 type ThinBuffer = back::lto::ThinBuffer;
151 fn print_pass_timings(&self) {
152 unsafe { llvm::LLVMRustPrintPassTimings(); }
155 cgcx: &CodegenContext<Self>,
156 modules: Vec<FatLTOInput<Self>>,
157 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
158 ) -> Result<LtoModuleCodegen<Self>, FatalError> {
159 back::lto::run_fat(cgcx, modules, cached_modules)
162 cgcx: &CodegenContext<Self>,
163 modules: Vec<(String, Self::ThinBuffer)>,
164 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
165 ) -> Result<(Vec<LtoModuleCodegen<Self>>, Vec<WorkProduct>), FatalError> {
166 back::lto::run_thin(cgcx, modules, cached_modules)
169 cgcx: &CodegenContext<Self>,
170 diag_handler: &Handler,
171 module: &ModuleCodegen<Self::Module>,
172 config: &ModuleConfig,
173 ) -> Result<(), FatalError> {
174 back::write::optimize(cgcx, diag_handler, module, config)
176 unsafe fn optimize_thin(
177 cgcx: &CodegenContext<Self>,
178 thin: &mut ThinModule<Self>,
179 ) -> Result<ModuleCodegen<Self::Module>, FatalError> {
180 back::lto::optimize_thin_module(thin, cgcx)
183 cgcx: &CodegenContext<Self>,
184 diag_handler: &Handler,
185 module: ModuleCodegen<Self::Module>,
186 config: &ModuleConfig,
187 ) -> Result<CompiledModule, FatalError> {
188 back::write::codegen(cgcx, diag_handler, module, config)
191 module: ModuleCodegen<Self::Module>
192 ) -> (String, Self::ThinBuffer) {
193 back::lto::prepare_thin(module)
196 module: ModuleCodegen<Self::Module>
197 ) -> (String, Self::ModuleBuffer) {
198 (module.name, back::lto::ModuleBuffer::new(module.module_llvm.llmod()))
200 fn run_lto_pass_manager(
201 cgcx: &CodegenContext<Self>,
202 module: &ModuleCodegen<Self::Module>,
203 config: &ModuleConfig,
206 back::lto::run_pass_manager(cgcx, module, config, thin)
210 unsafe impl Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
211 unsafe impl Sync for LlvmCodegenBackend {}
213 impl LlvmCodegenBackend {
214 pub fn new() -> Box<dyn CodegenBackend> {
215 box LlvmCodegenBackend(())
219 impl CodegenBackend for LlvmCodegenBackend {
220 fn init(&self, sess: &Session) {
221 llvm_util::init(sess); // Make sure llvm is inited
224 fn print(&self, req: PrintRequest, sess: &Session) {
226 PrintRequest::RelocationModels => {
227 println!("Available relocation models:");
228 for &(name, _) in back::write::RELOC_MODEL_ARGS.iter() {
229 println!(" {}", name);
233 PrintRequest::CodeModels => {
234 println!("Available code models:");
235 for &(name, _) in back::write::CODE_GEN_MODEL_ARGS.iter(){
236 println!(" {}", name);
240 PrintRequest::TlsModels => {
241 println!("Available TLS models:");
242 for &(name, _) in back::write::TLS_MODEL_ARGS.iter(){
243 println!(" {}", name);
247 req => llvm_util::print(req, sess),
251 fn print_passes(&self) {
252 llvm_util::print_passes();
255 fn print_version(&self) {
256 llvm_util::print_version();
259 fn diagnostics(&self) -> &[(&'static str, &'static str)] {
263 fn target_features(&self, sess: &Session) -> Vec<Symbol> {
264 target_features(sess)
267 fn metadata_loader(&self) -> Box<dyn MetadataLoader + Sync> {
268 box metadata::LlvmMetadataLoader
271 fn provide(&self, providers: &mut ty::query::Providers<'_>) {
272 rustc_codegen_utils::symbol_names::provide(providers);
273 rustc_codegen_ssa::back::symbol_export::provide(providers);
274 rustc_codegen_ssa::base::provide_both(providers);
275 attributes::provide(providers);
278 fn provide_extern(&self, providers: &mut ty::query::Providers<'_>) {
279 rustc_codegen_ssa::back::symbol_export::provide_extern(providers);
280 rustc_codegen_ssa::base::provide_both(providers);
281 attributes::provide_extern(providers);
284 fn codegen_crate<'tcx>(
287 metadata: EncodedMetadata,
288 need_metadata_module: bool,
289 rx: mpsc::Receiver<Box<dyn Any + Send>>,
291 box rustc_codegen_ssa::base::codegen_crate(
292 LlvmCodegenBackend(()), tcx, metadata, need_metadata_module, rx)
295 fn join_codegen_and_link(
297 ongoing_codegen: Box<dyn Any>,
299 dep_graph: &DepGraph,
300 outputs: &OutputFilenames,
301 ) -> Result<(), ErrorReported> {
302 use rustc::util::common::time;
303 let (codegen_results, work_products) =
304 ongoing_codegen.downcast::
305 <rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
306 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
308 if sess.opts.debugging_opts.incremental_info {
309 rustc_codegen_ssa::back::write::dump_incremental_data(&codegen_results);
313 "serialize work products",
314 move || rustc_incremental::save_work_product_index(sess, &dep_graph, work_products));
316 sess.compile_status()?;
318 if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
319 i == OutputType::Metadata) {
323 // Run the linker on any artifacts that resulted from the LLVM run.
324 // This should produce either a finished executable or library.
325 sess.profiler(|p| p.start_activity("link_crate"));
326 time(sess, "linking", || {
327 use rustc_codegen_ssa::back::link::link_binary;
328 use crate::back::archive::LlvmArchiveBuilder;
330 let target_cpu = crate::llvm_util::target_cpu(sess);
331 link_binary::<LlvmArchiveBuilder<'_>>(
335 &codegen_results.crate_name.as_str(),
339 sess.profiler(|p| p.end_activity("link_crate"));
341 // Now that we won't touch anything in the incremental compilation directory
342 // any more, we can finalize it (which involves renaming it)
343 rustc_incremental::finalize_session_directory(sess, codegen_results.crate_hash);
349 /// This is the entrypoint for a hot plugged rustc_codegen_llvm
351 pub fn __rustc_codegen_backend() -> Box<dyn CodegenBackend> {
352 LlvmCodegenBackend::new()
355 pub struct ModuleLlvm {
356 llcx: &'static mut llvm::Context,
357 llmod_raw: *const llvm::Module,
358 tm: &'static mut llvm::TargetMachine,
361 unsafe impl Send for ModuleLlvm { }
362 unsafe impl Sync for ModuleLlvm { }
365 fn new(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
367 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
368 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
372 tm: create_target_machine(tcx, false),
377 fn new_metadata(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
379 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
380 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
384 tm: create_informational_target_machine(&tcx.sess, false),
390 cgcx: &CodegenContext<LlvmCodegenBackend>,
392 buffer: &back::lto::ModuleBuffer,
394 ) -> Result<Self, FatalError> {
396 let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
397 let llmod_raw = buffer.parse(name, llcx, handler)?;
398 let tm = match (cgcx.tm_factory.0)() {
401 handler.struct_err(&e).emit();
402 return Err(FatalError)
414 fn llmod(&self) -> &llvm::Module {
421 impl Drop for ModuleLlvm {
424 llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
425 llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));
430 __build_diagnostic_array! { librustc_codegen_llvm, DIAGNOSTICS }