5 //! This API is completely unstable and subject to change.
7 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
9 #![feature(bool_to_option)]
10 #![feature(box_patterns)]
11 #![feature(box_syntax)]
12 #![feature(const_cstr_unchecked)]
13 #![feature(crate_visibility_modifier)]
14 #![feature(extern_types)]
15 #![feature(in_band_lifetimes)]
18 #![feature(optin_builtin_traits)]
19 #![feature(concat_idents)]
20 #![feature(link_args)]
21 #![feature(static_nobundle)]
22 #![feature(trusted_len)]
24 use back::write::{create_target_machine, create_informational_target_machine};
25 use syntax_pos::symbol::Symbol;
27 use rustc_codegen_ssa::traits::*;
28 use rustc_codegen_ssa::back::write::{CodegenContext, ModuleConfig, FatLTOInput};
29 use rustc_codegen_ssa::back::lto::{SerializedModule, LtoModuleCodegen, ThinModule};
30 use rustc_codegen_ssa::CompiledModule;
31 use rustc_errors::{FatalError, Handler};
32 use rustc::dep_graph::WorkProduct;
33 use syntax::expand::allocator::AllocatorKind;
34 pub use llvm_util::target_features;
39 use rustc::dep_graph::DepGraph;
40 use rustc::middle::cstore::{EncodedMetadata, MetadataLoaderDyn};
41 use rustc::session::Session;
42 use rustc::session::config::{OutputFilenames, OutputType, PrintRequest, OptLevel};
43 use rustc::ty::{self, TyCtxt};
44 use rustc::util::common::ErrorReported;
45 use rustc_codegen_ssa::ModuleCodegen;
46 use rustc_codegen_utils::codegen_backend::CodegenBackend;
69 // The following is a work around that replaces `pub mod llvm;` and that fixes issue 53912.
70 #[path = "llvm/mod.rs"] mod llvm_; pub mod llvm { pub use super::llvm_::*; }
81 pub struct LlvmCodegenBackend(());
83 impl ExtraBackendMethods for LlvmCodegenBackend {
84 fn new_metadata(&self, tcx: TyCtxt<'_>, mod_name: &str) -> ModuleLlvm {
85 ModuleLlvm::new_metadata(tcx, mod_name)
88 fn write_compressed_metadata<'tcx>(
91 metadata: &EncodedMetadata,
92 llvm_module: &mut ModuleLlvm,
94 base::write_compressed_metadata(tcx, metadata, llvm_module)
96 fn codegen_allocator<'tcx>(
99 mods: &mut ModuleLlvm,
102 unsafe { allocator::codegen(tcx, mods, kind) }
104 fn compile_codegen_unit(
105 &self, tcx: TyCtxt<'_>,
107 tx: &std::sync::mpsc::Sender<Box<dyn Any + Send>>,
109 base::compile_codegen_unit(tcx, cgu_name, tx);
111 fn target_machine_factory(
117 Result<&'static mut llvm::TargetMachine, String> + Send + Sync> {
118 back::write::target_machine_factory(sess, optlvl, find_features)
120 fn target_cpu<'b>(&self, sess: &'b Session) -> &'b str {
121 llvm_util::target_cpu(sess)
125 impl WriteBackendMethods for LlvmCodegenBackend {
126 type Module = ModuleLlvm;
127 type ModuleBuffer = back::lto::ModuleBuffer;
128 type Context = llvm::Context;
129 type TargetMachine = &'static mut llvm::TargetMachine;
130 type ThinData = back::lto::ThinData;
131 type ThinBuffer = back::lto::ThinBuffer;
132 fn print_pass_timings(&self) {
133 unsafe { llvm::LLVMRustPrintPassTimings(); }
136 cgcx: &CodegenContext<Self>,
137 modules: Vec<FatLTOInput<Self>>,
138 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
139 ) -> Result<LtoModuleCodegen<Self>, FatalError> {
140 back::lto::run_fat(cgcx, modules, cached_modules)
143 cgcx: &CodegenContext<Self>,
144 modules: Vec<(String, Self::ThinBuffer)>,
145 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
146 ) -> Result<(Vec<LtoModuleCodegen<Self>>, Vec<WorkProduct>), FatalError> {
147 back::lto::run_thin(cgcx, modules, cached_modules)
150 cgcx: &CodegenContext<Self>,
151 diag_handler: &Handler,
152 module: &ModuleCodegen<Self::Module>,
153 config: &ModuleConfig,
154 ) -> Result<(), FatalError> {
155 back::write::optimize(cgcx, diag_handler, module, config)
157 unsafe fn optimize_thin(
158 cgcx: &CodegenContext<Self>,
159 thin: &mut ThinModule<Self>,
160 ) -> Result<ModuleCodegen<Self::Module>, FatalError> {
161 back::lto::optimize_thin_module(thin, cgcx)
164 cgcx: &CodegenContext<Self>,
165 diag_handler: &Handler,
166 module: ModuleCodegen<Self::Module>,
167 config: &ModuleConfig,
168 ) -> Result<CompiledModule, FatalError> {
169 back::write::codegen(cgcx, diag_handler, module, config)
172 module: ModuleCodegen<Self::Module>
173 ) -> (String, Self::ThinBuffer) {
174 back::lto::prepare_thin(module)
177 module: ModuleCodegen<Self::Module>
178 ) -> (String, Self::ModuleBuffer) {
179 (module.name, back::lto::ModuleBuffer::new(module.module_llvm.llmod()))
181 fn run_lto_pass_manager(
182 cgcx: &CodegenContext<Self>,
183 module: &ModuleCodegen<Self::Module>,
184 config: &ModuleConfig,
187 back::lto::run_pass_manager(cgcx, module, config, thin)
191 unsafe impl Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
192 unsafe impl Sync for LlvmCodegenBackend {}
194 impl LlvmCodegenBackend {
195 pub fn new() -> Box<dyn CodegenBackend> {
196 box LlvmCodegenBackend(())
200 impl CodegenBackend for LlvmCodegenBackend {
201 fn init(&self, sess: &Session) {
202 llvm_util::init(sess); // Make sure llvm is inited
205 fn print(&self, req: PrintRequest, sess: &Session) {
207 PrintRequest::RelocationModels => {
208 println!("Available relocation models:");
209 for &(name, _) in back::write::RELOC_MODEL_ARGS.iter() {
210 println!(" {}", name);
214 PrintRequest::CodeModels => {
215 println!("Available code models:");
216 for &(name, _) in back::write::CODE_GEN_MODEL_ARGS.iter(){
217 println!(" {}", name);
221 PrintRequest::TlsModels => {
222 println!("Available TLS models:");
223 for &(name, _) in back::write::TLS_MODEL_ARGS.iter(){
224 println!(" {}", name);
228 req => llvm_util::print(req, sess),
232 fn print_passes(&self) {
233 llvm_util::print_passes();
236 fn print_version(&self) {
237 llvm_util::print_version();
240 fn target_features(&self, sess: &Session) -> Vec<Symbol> {
241 target_features(sess)
244 fn metadata_loader(&self) -> Box<MetadataLoaderDyn> {
245 box metadata::LlvmMetadataLoader
248 fn provide(&self, providers: &mut ty::query::Providers<'_>) {
249 attributes::provide(providers);
252 fn provide_extern(&self, providers: &mut ty::query::Providers<'_>) {
253 attributes::provide_extern(providers);
256 fn codegen_crate<'tcx>(
259 metadata: EncodedMetadata,
260 need_metadata_module: bool,
262 box rustc_codegen_ssa::base::codegen_crate(
263 LlvmCodegenBackend(()), tcx, metadata, need_metadata_module)
266 fn join_codegen_and_link(
268 ongoing_codegen: Box<dyn Any>,
270 dep_graph: &DepGraph,
271 outputs: &OutputFilenames,
272 ) -> Result<(), ErrorReported> {
273 use rustc::util::common::time;
274 let (codegen_results, work_products) =
275 ongoing_codegen.downcast::
276 <rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
277 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
279 if sess.opts.debugging_opts.incremental_info {
280 rustc_codegen_ssa::back::write::dump_incremental_data(&codegen_results);
284 "serialize work products",
285 move || rustc_incremental::save_work_product_index(sess, &dep_graph, work_products));
287 sess.compile_status()?;
289 if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
290 i == OutputType::Metadata) {
294 // Run the linker on any artifacts that resulted from the LLVM run.
295 // This should produce either a finished executable or library.
296 time(sess, "linking", || {
297 let _prof_timer = sess.prof.generic_activity("link_crate");
299 use rustc_codegen_ssa::back::link::link_binary;
300 use crate::back::archive::LlvmArchiveBuilder;
302 let target_cpu = crate::llvm_util::target_cpu(sess);
303 link_binary::<LlvmArchiveBuilder<'_>>(
307 &codegen_results.crate_name.as_str(),
312 // Now that we won't touch anything in the incremental compilation directory
313 // any more, we can finalize it (which involves renaming it)
314 rustc_incremental::finalize_session_directory(sess, codegen_results.crate_hash);
320 pub struct ModuleLlvm {
321 llcx: &'static mut llvm::Context,
322 llmod_raw: *const llvm::Module,
323 tm: &'static mut llvm::TargetMachine,
326 unsafe impl Send for ModuleLlvm { }
327 unsafe impl Sync for ModuleLlvm { }
330 fn new(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
332 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
333 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
337 tm: create_target_machine(tcx, false),
342 fn new_metadata(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
344 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
345 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
349 tm: create_informational_target_machine(&tcx.sess, false),
355 cgcx: &CodegenContext<LlvmCodegenBackend>,
359 ) -> Result<Self, FatalError> {
361 let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
362 let llmod_raw = back::lto::parse_module(llcx, name, buffer, handler)?;
363 let tm = match (cgcx.tm_factory.0)() {
366 handler.struct_err(&e).emit();
367 return Err(FatalError)
379 fn llmod(&self) -> &llvm::Module {
386 impl Drop for ModuleLlvm {
389 llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
390 llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));