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)]
17 #![feature(optin_builtin_traits)]
18 #![feature(concat_idents)]
19 #![feature(link_args)]
20 #![feature(static_nobundle)]
21 #![feature(trusted_len)]
23 use back::write::{create_target_machine, create_informational_target_machine};
24 use syntax_pos::symbol::Symbol;
26 extern crate rustc_demangle;
28 #[macro_use] extern crate bitflags;
30 #[macro_use] extern crate rustc;
31 extern crate rustc_target;
32 #[macro_use] extern crate rustc_data_structures;
33 extern crate rustc_feature;
34 extern crate rustc_index;
35 extern crate rustc_incremental;
36 extern crate rustc_codegen_utils;
37 extern crate rustc_codegen_ssa;
38 extern crate rustc_fs_util;
39 extern crate rustc_driver as _;
41 #[macro_use] extern crate log;
42 extern crate smallvec;
44 extern crate syntax_pos;
45 extern crate rustc_errors as errors;
47 use rustc_codegen_ssa::traits::*;
48 use rustc_codegen_ssa::back::write::{CodegenContext, ModuleConfig, FatLTOInput};
49 use rustc_codegen_ssa::back::lto::{SerializedModule, LtoModuleCodegen, ThinModule};
50 use rustc_codegen_ssa::CompiledModule;
51 use errors::{FatalError, Handler};
52 use rustc::dep_graph::WorkProduct;
53 use syntax::expand::allocator::AllocatorKind;
54 pub use llvm_util::target_features;
59 use rustc::dep_graph::DepGraph;
60 use rustc::middle::cstore::{EncodedMetadata, MetadataLoaderDyn};
61 use rustc::session::Session;
62 use rustc::session::config::{OutputFilenames, OutputType, PrintRequest, OptLevel};
63 use rustc::ty::{self, TyCtxt};
64 use rustc::util::common::ErrorReported;
65 use rustc_codegen_ssa::ModuleCodegen;
66 use rustc_codegen_utils::codegen_backend::CodegenBackend;
89 // The following is a work around that replaces `pub mod llvm;` and that fixes issue 53912.
90 #[path = "llvm/mod.rs"] mod llvm_; pub mod llvm { pub use super::llvm_::*; }
101 pub struct LlvmCodegenBackend(());
103 impl ExtraBackendMethods for LlvmCodegenBackend {
104 fn new_metadata(&self, tcx: TyCtxt<'_>, mod_name: &str) -> ModuleLlvm {
105 ModuleLlvm::new_metadata(tcx, mod_name)
108 fn write_compressed_metadata<'tcx>(
111 metadata: &EncodedMetadata,
112 llvm_module: &mut ModuleLlvm,
114 base::write_compressed_metadata(tcx, metadata, llvm_module)
116 fn codegen_allocator<'tcx>(
119 mods: &mut ModuleLlvm,
122 unsafe { allocator::codegen(tcx, mods, kind) }
124 fn compile_codegen_unit(
125 &self, tcx: TyCtxt<'_>,
127 tx: &std::sync::mpsc::Sender<Box<dyn Any + Send>>,
129 base::compile_codegen_unit(tcx, cgu_name, tx);
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 target_features(&self, sess: &Session) -> Vec<Symbol> {
261 target_features(sess)
264 fn metadata_loader(&self) -> Box<MetadataLoaderDyn> {
265 box metadata::LlvmMetadataLoader
268 fn provide(&self, providers: &mut ty::query::Providers<'_>) {
269 attributes::provide(providers);
272 fn provide_extern(&self, providers: &mut ty::query::Providers<'_>) {
273 attributes::provide_extern(providers);
276 fn codegen_crate<'tcx>(
279 metadata: EncodedMetadata,
280 need_metadata_module: bool,
282 box rustc_codegen_ssa::base::codegen_crate(
283 LlvmCodegenBackend(()), tcx, metadata, need_metadata_module)
286 fn join_codegen_and_link(
288 ongoing_codegen: Box<dyn Any>,
290 dep_graph: &DepGraph,
291 outputs: &OutputFilenames,
292 ) -> Result<(), ErrorReported> {
293 use rustc::util::common::time;
294 let (codegen_results, work_products) =
295 ongoing_codegen.downcast::
296 <rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
297 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
299 if sess.opts.debugging_opts.incremental_info {
300 rustc_codegen_ssa::back::write::dump_incremental_data(&codegen_results);
304 "serialize work products",
305 move || rustc_incremental::save_work_product_index(sess, &dep_graph, work_products));
307 sess.compile_status()?;
309 if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
310 i == OutputType::Metadata) {
314 // Run the linker on any artifacts that resulted from the LLVM run.
315 // This should produce either a finished executable or library.
316 time(sess, "linking", || {
317 let _prof_timer = sess.prof.generic_activity("link_crate");
319 use rustc_codegen_ssa::back::link::link_binary;
320 use crate::back::archive::LlvmArchiveBuilder;
322 let target_cpu = crate::llvm_util::target_cpu(sess);
323 link_binary::<LlvmArchiveBuilder<'_>>(
327 &codegen_results.crate_name.as_str(),
332 // Now that we won't touch anything in the incremental compilation directory
333 // any more, we can finalize it (which involves renaming it)
334 rustc_incremental::finalize_session_directory(sess, codegen_results.crate_hash);
340 /// This is the entrypoint for a hot plugged rustc_codegen_llvm
342 pub fn __rustc_codegen_backend() -> Box<dyn CodegenBackend> {
343 LlvmCodegenBackend::new()
346 pub struct ModuleLlvm {
347 llcx: &'static mut llvm::Context,
348 llmod_raw: *const llvm::Module,
349 tm: &'static mut llvm::TargetMachine,
352 unsafe impl Send for ModuleLlvm { }
353 unsafe impl Sync for ModuleLlvm { }
356 fn new(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
358 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
359 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
363 tm: create_target_machine(tcx, false),
368 fn new_metadata(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
370 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
371 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
375 tm: create_informational_target_machine(&tcx.sess, false),
381 cgcx: &CodegenContext<LlvmCodegenBackend>,
385 ) -> Result<Self, FatalError> {
387 let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
388 let llmod_raw = back::lto::parse_module(llcx, name, buffer, handler)?;
389 let tm = match (cgcx.tm_factory.0)() {
392 handler.struct_err(&e).emit();
393 return Err(FatalError)
405 fn llmod(&self) -> &llvm::Module {
412 impl Drop for ModuleLlvm {
415 llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
416 llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));