5 //! This API is completely unstable and subject to change.
7 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
8 #![feature(bool_to_option)]
9 #![feature(const_cstr_unchecked)]
10 #![feature(crate_visibility_modifier)]
11 #![feature(extern_types)]
12 #![feature(in_band_lifetimes)]
15 #![recursion_limit = "256"]
17 use back::write::{create_informational_target_machine, create_target_machine};
19 pub use llvm_util::target_features;
20 use rustc_ast::expand::allocator::AllocatorKind;
21 use rustc_codegen_ssa::back::lto::{LtoModuleCodegen, SerializedModule, ThinModule};
22 use rustc_codegen_ssa::back::write::{
23 CodegenContext, FatLTOInput, ModuleConfig, TargetMachineFactoryConfig, TargetMachineFactoryFn,
25 use rustc_codegen_ssa::traits::*;
26 use rustc_codegen_ssa::ModuleCodegen;
27 use rustc_codegen_ssa::{CodegenResults, CompiledModule};
28 use rustc_data_structures::fx::FxHashMap;
29 use rustc_errors::{ErrorReported, FatalError, Handler};
30 use rustc_metadata::EncodedMetadata;
31 use rustc_middle::dep_graph::{WorkProduct, WorkProductId};
32 use rustc_middle::ty::TyCtxt;
33 use rustc_session::config::{OptLevel, OutputFilenames, PrintRequest};
34 use rustc_session::Session;
35 use rustc_span::symbol::Symbol;
62 // The following is a work around that replaces `pub mod llvm;` and that fixes issue 53912.
63 #[path = "llvm/mod.rs"]
66 pub use super::llvm_::*;
77 pub struct LlvmCodegenBackend(());
79 impl ExtraBackendMethods for LlvmCodegenBackend {
80 fn new_metadata(&self, tcx: TyCtxt<'_>, mod_name: &str) -> ModuleLlvm {
81 ModuleLlvm::new_metadata(tcx, mod_name)
84 fn write_compressed_metadata<'tcx>(
87 metadata: &EncodedMetadata,
88 llvm_module: &mut ModuleLlvm,
90 base::write_compressed_metadata(tcx, metadata, llvm_module)
92 fn codegen_allocator<'tcx>(
95 module_llvm: &mut ModuleLlvm,
98 has_alloc_error_handler: bool,
100 unsafe { allocator::codegen(tcx, module_llvm, module_name, kind, has_alloc_error_handler) }
102 fn compile_codegen_unit(
106 ) -> (ModuleCodegen<ModuleLlvm>, u64) {
107 base::compile_codegen_unit(tcx, cgu_name)
109 fn target_machine_factory(
113 ) -> TargetMachineFactoryFn<Self> {
114 back::write::target_machine_factory(sess, optlvl)
116 fn target_cpu<'b>(&self, sess: &'b Session) -> &'b str {
117 llvm_util::target_cpu(sess)
119 fn tune_cpu<'b>(&self, sess: &'b Session) -> Option<&'b str> {
120 llvm_util::tune_cpu(sess)
124 impl WriteBackendMethods for LlvmCodegenBackend {
125 type Module = ModuleLlvm;
126 type ModuleBuffer = back::lto::ModuleBuffer;
127 type Context = llvm::Context;
128 type TargetMachine = &'static mut llvm::TargetMachine;
129 type ThinData = back::lto::ThinData;
130 type ThinBuffer = back::lto::ThinBuffer;
131 fn print_pass_timings(&self) {
133 llvm::LLVMRustPrintPassTimings();
137 cgcx: &CodegenContext<Self>,
138 diag_handler: &Handler,
139 modules: Vec<ModuleCodegen<Self::Module>>,
140 ) -> Result<ModuleCodegen<Self::Module>, FatalError> {
141 back::write::link(cgcx, diag_handler, modules)
144 cgcx: &CodegenContext<Self>,
145 modules: Vec<FatLTOInput<Self>>,
146 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
147 ) -> Result<LtoModuleCodegen<Self>, FatalError> {
148 back::lto::run_fat(cgcx, modules, cached_modules)
151 cgcx: &CodegenContext<Self>,
152 modules: Vec<(String, Self::ThinBuffer)>,
153 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
154 ) -> Result<(Vec<LtoModuleCodegen<Self>>, Vec<WorkProduct>), FatalError> {
155 back::lto::run_thin(cgcx, modules, cached_modules)
158 cgcx: &CodegenContext<Self>,
159 diag_handler: &Handler,
160 module: &ModuleCodegen<Self::Module>,
161 config: &ModuleConfig,
162 ) -> Result<(), FatalError> {
163 back::write::optimize(cgcx, diag_handler, module, config)
165 unsafe fn optimize_thin(
166 cgcx: &CodegenContext<Self>,
167 thin: &mut ThinModule<Self>,
168 ) -> Result<ModuleCodegen<Self::Module>, FatalError> {
169 back::lto::optimize_thin_module(thin, cgcx)
172 cgcx: &CodegenContext<Self>,
173 diag_handler: &Handler,
174 module: ModuleCodegen<Self::Module>,
175 config: &ModuleConfig,
176 ) -> Result<CompiledModule, FatalError> {
177 back::write::codegen(cgcx, diag_handler, module, config)
179 fn prepare_thin(module: ModuleCodegen<Self::Module>) -> (String, Self::ThinBuffer) {
180 back::lto::prepare_thin(module)
182 fn serialize_module(module: ModuleCodegen<Self::Module>) -> (String, Self::ModuleBuffer) {
183 (module.name, back::lto::ModuleBuffer::new(module.module_llvm.llmod()))
185 fn run_lto_pass_manager(
186 cgcx: &CodegenContext<Self>,
187 module: &ModuleCodegen<Self::Module>,
188 config: &ModuleConfig,
190 ) -> Result<(), FatalError> {
191 let diag_handler = cgcx.create_diag_handler();
192 back::lto::run_pass_manager(cgcx, &diag_handler, module, config, thin)
196 unsafe impl Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
197 unsafe impl Sync for LlvmCodegenBackend {}
199 impl LlvmCodegenBackend {
200 pub fn new() -> Box<dyn CodegenBackend> {
201 Box::new(LlvmCodegenBackend(()))
205 impl CodegenBackend for LlvmCodegenBackend {
206 fn init(&self, sess: &Session) {
207 llvm_util::init(sess); // Make sure llvm is inited
210 fn print(&self, req: PrintRequest, sess: &Session) {
212 PrintRequest::RelocationModels => {
213 println!("Available relocation models:");
224 println!(" {}", name);
228 PrintRequest::CodeModels => {
229 println!("Available code models:");
230 for name in &["tiny", "small", "kernel", "medium", "large"] {
231 println!(" {}", name);
235 PrintRequest::TlsModels => {
236 println!("Available TLS models:");
237 for name in &["global-dynamic", "local-dynamic", "initial-exec", "local-exec"] {
238 println!(" {}", name);
242 req => llvm_util::print(req, sess),
246 fn print_passes(&self) {
247 llvm_util::print_passes();
250 fn print_version(&self) {
251 llvm_util::print_version();
254 fn target_features(&self, sess: &Session) -> Vec<Symbol> {
255 target_features(sess)
258 fn codegen_crate<'tcx>(
261 metadata: EncodedMetadata,
262 need_metadata_module: bool,
264 Box::new(rustc_codegen_ssa::base::codegen_crate(
265 LlvmCodegenBackend(()),
267 crate::llvm_util::target_cpu(tcx.sess).to_string(),
269 need_metadata_module,
275 ongoing_codegen: Box<dyn Any>,
277 ) -> Result<(CodegenResults, FxHashMap<WorkProductId, WorkProduct>), ErrorReported> {
278 let (codegen_results, work_products) = ongoing_codegen
279 .downcast::<rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
280 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
283 sess.time("llvm_dump_timing_file", || {
284 if sess.opts.debugging_opts.llvm_time_trace {
285 llvm_util::time_trace_profiler_finish("llvm_timings.json");
289 Ok((codegen_results, work_products))
295 codegen_results: CodegenResults,
296 outputs: &OutputFilenames,
297 ) -> Result<(), ErrorReported> {
298 use crate::back::archive::LlvmArchiveBuilder;
299 use rustc_codegen_ssa::back::link::link_binary;
301 // Run the linker on any artifacts that resulted from the LLVM run.
302 // This should produce either a finished executable or library.
303 link_binary::<LlvmArchiveBuilder<'_>>(sess, &codegen_results, outputs)
307 pub struct ModuleLlvm {
308 llcx: &'static mut llvm::Context,
309 llmod_raw: *const llvm::Module,
310 tm: &'static mut llvm::TargetMachine,
313 unsafe impl Send for ModuleLlvm {}
314 unsafe impl Sync for ModuleLlvm {}
317 fn new(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
319 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
320 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
321 ModuleLlvm { llmod_raw, llcx, tm: create_target_machine(tcx, mod_name) }
325 fn new_metadata(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
327 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
328 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
329 ModuleLlvm { llmod_raw, llcx, tm: create_informational_target_machine(tcx.sess) }
334 cgcx: &CodegenContext<LlvmCodegenBackend>,
338 ) -> Result<Self, FatalError> {
340 let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
341 let llmod_raw = back::lto::parse_module(llcx, name, buffer, handler)?;
342 let tm_factory_config = TargetMachineFactoryConfig::new(cgcx, name.to_str().unwrap());
343 let tm = match (cgcx.tm_factory)(tm_factory_config) {
346 handler.struct_err(&e).emit();
347 return Err(FatalError);
351 Ok(ModuleLlvm { llmod_raw, llcx, tm })
355 fn llmod(&self) -> &llvm::Module {
356 unsafe { &*self.llmod_raw }
360 impl Drop for ModuleLlvm {
363 llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));
364 llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));