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)]
14 #![feature(or_patterns)]
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::{CodegenContext, FatLTOInput, ModuleConfig};
23 use rustc_codegen_ssa::traits::*;
24 use rustc_codegen_ssa::ModuleCodegen;
25 use rustc_codegen_ssa::{CodegenResults, CompiledModule};
26 use rustc_data_structures::fx::FxHashMap;
27 use rustc_errors::{ErrorReported, FatalError, Handler};
28 use rustc_middle::dep_graph::{WorkProduct, WorkProductId};
29 use rustc_middle::middle::cstore::{EncodedMetadata, MetadataLoaderDyn};
30 use rustc_middle::ty::{self, TyCtxt};
31 use rustc_session::config::{OptLevel, OutputFilenames, PrintRequest};
32 use rustc_session::Session;
33 use rustc_span::symbol::Symbol;
61 // The following is a work around that replaces `pub mod llvm;` and that fixes issue 53912.
62 #[path = "llvm/mod.rs"]
65 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 mods: &mut ModuleLlvm,
97 has_alloc_error_handler: bool,
99 unsafe { allocator::codegen(tcx, mods, kind, has_alloc_error_handler) }
101 fn compile_codegen_unit(
105 ) -> (ModuleCodegen<ModuleLlvm>, u64) {
106 base::compile_codegen_unit(tcx, cgu_name)
108 fn target_machine_factory(
112 ) -> Arc<dyn Fn() -> Result<&'static mut llvm::TargetMachine, String> + Send + Sync> {
113 back::write::target_machine_factory(sess, optlvl)
115 fn target_cpu<'b>(&self, sess: &'b Session) -> &'b str {
116 llvm_util::target_cpu(sess)
118 fn tune_cpu<'b>(&self, sess: &'b Session) -> Option<&'b str> {
119 llvm_util::tune_cpu(sess)
123 impl WriteBackendMethods for LlvmCodegenBackend {
124 type Module = ModuleLlvm;
125 type ModuleBuffer = back::lto::ModuleBuffer;
126 type Context = llvm::Context;
127 type TargetMachine = &'static mut llvm::TargetMachine;
128 type ThinData = back::lto::ThinData;
129 type ThinBuffer = back::lto::ThinBuffer;
130 fn print_pass_timings(&self) {
132 llvm::LLVMRustPrintPassTimings();
136 cgcx: &CodegenContext<Self>,
137 diag_handler: &Handler,
138 modules: Vec<ModuleCodegen<Self::Module>>,
139 ) -> Result<ModuleCodegen<Self::Module>, FatalError> {
140 back::write::link(cgcx, diag_handler, modules)
143 cgcx: &CodegenContext<Self>,
144 modules: Vec<FatLTOInput<Self>>,
145 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
146 ) -> Result<LtoModuleCodegen<Self>, FatalError> {
147 back::lto::run_fat(cgcx, modules, cached_modules)
150 cgcx: &CodegenContext<Self>,
151 modules: Vec<(String, Self::ThinBuffer)>,
152 cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
153 ) -> Result<(Vec<LtoModuleCodegen<Self>>, Vec<WorkProduct>), FatalError> {
154 back::lto::run_thin(cgcx, modules, cached_modules)
157 cgcx: &CodegenContext<Self>,
158 diag_handler: &Handler,
159 module: &ModuleCodegen<Self::Module>,
160 config: &ModuleConfig,
161 ) -> Result<(), FatalError> {
162 back::write::optimize(cgcx, diag_handler, module, config)
164 unsafe fn optimize_thin(
165 cgcx: &CodegenContext<Self>,
166 thin: &mut ThinModule<Self>,
167 ) -> Result<ModuleCodegen<Self::Module>, FatalError> {
168 back::lto::optimize_thin_module(thin, cgcx)
171 cgcx: &CodegenContext<Self>,
172 diag_handler: &Handler,
173 module: ModuleCodegen<Self::Module>,
174 config: &ModuleConfig,
175 ) -> Result<CompiledModule, FatalError> {
176 back::write::codegen(cgcx, diag_handler, module, config)
178 fn prepare_thin(module: ModuleCodegen<Self::Module>) -> (String, Self::ThinBuffer) {
179 back::lto::prepare_thin(module)
181 fn serialize_module(module: ModuleCodegen<Self::Module>) -> (String, Self::ModuleBuffer) {
182 (module.name, back::lto::ModuleBuffer::new(module.module_llvm.llmod()))
184 fn run_lto_pass_manager(
185 cgcx: &CodegenContext<Self>,
186 module: &ModuleCodegen<Self::Module>,
187 config: &ModuleConfig,
190 back::lto::run_pass_manager(cgcx, module, config, thin)
194 unsafe impl Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
195 unsafe impl Sync for LlvmCodegenBackend {}
197 impl LlvmCodegenBackend {
198 pub fn new() -> Box<dyn CodegenBackend> {
199 Box::new(LlvmCodegenBackend(()))
203 impl CodegenBackend for LlvmCodegenBackend {
204 fn init(&self, sess: &Session) {
205 llvm_util::init(sess); // Make sure llvm is inited
208 fn print(&self, req: PrintRequest, sess: &Session) {
210 PrintRequest::RelocationModels => {
211 println!("Available relocation models:");
213 &["static", "pic", "dynamic-no-pic", "ropi", "rwpi", "ropi-rwpi", "default"]
215 println!(" {}", name);
219 PrintRequest::CodeModels => {
220 println!("Available code models:");
221 for name in &["tiny", "small", "kernel", "medium", "large"] {
222 println!(" {}", name);
226 PrintRequest::TlsModels => {
227 println!("Available TLS models:");
228 for name in &["global-dynamic", "local-dynamic", "initial-exec", "local-exec"] {
229 println!(" {}", name);
233 req => llvm_util::print(req, sess),
237 fn print_passes(&self) {
238 llvm_util::print_passes();
241 fn print_version(&self) {
242 llvm_util::print_version();
245 fn target_features(&self, sess: &Session) -> Vec<Symbol> {
246 target_features(sess)
249 fn metadata_loader(&self) -> Box<MetadataLoaderDyn> {
250 Box::new(metadata::LlvmMetadataLoader)
253 fn provide(&self, providers: &mut ty::query::Providers) {
254 attributes::provide_both(providers);
257 fn provide_extern(&self, providers: &mut ty::query::Providers) {
258 attributes::provide_both(providers);
261 fn codegen_crate<'tcx>(
264 metadata: EncodedMetadata,
265 need_metadata_module: bool,
267 Box::new(rustc_codegen_ssa::base::codegen_crate(
268 LlvmCodegenBackend(()),
271 need_metadata_module,
277 ongoing_codegen: Box<dyn Any>,
279 ) -> Result<(CodegenResults, FxHashMap<WorkProductId, WorkProduct>), ErrorReported> {
280 let (codegen_results, work_products) = ongoing_codegen
281 .downcast::<rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
282 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
285 sess.time("llvm_dump_timing_file", || {
286 if sess.opts.debugging_opts.llvm_time_trace {
287 llvm_util::time_trace_profiler_finish("llvm_timings.json");
291 Ok((codegen_results, work_products))
297 codegen_results: CodegenResults,
298 outputs: &OutputFilenames,
299 ) -> Result<(), ErrorReported> {
300 // Run the linker on any artifacts that resulted from the LLVM run.
301 // This should produce either a finished executable or library.
302 sess.time("link_crate", || {
303 use crate::back::archive::LlvmArchiveBuilder;
304 use rustc_codegen_ssa::back::link::link_binary;
306 let target_cpu = crate::llvm_util::target_cpu(sess);
307 link_binary::<LlvmArchiveBuilder<'_>>(
311 &codegen_results.crate_name.as_str(),
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 _;
334 ModuleLlvm { llmod_raw, llcx, tm: create_target_machine(tcx) }
338 fn new_metadata(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
340 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
341 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
342 ModuleLlvm { llmod_raw, llcx, tm: create_informational_target_machine(tcx.sess) }
347 cgcx: &CodegenContext<LlvmCodegenBackend>,
351 ) -> Result<Self, FatalError> {
353 let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
354 let llmod_raw = back::lto::parse_module(llcx, name, buffer, handler)?;
355 let tm = match (cgcx.tm_factory.0)() {
358 handler.struct_err(&e).emit();
359 return Err(FatalError);
363 Ok(ModuleLlvm { llmod_raw, llcx, tm })
367 fn llmod(&self) -> &llvm::Module {
368 unsafe { &*self.llmod_raw }
372 impl Drop for ModuleLlvm {
375 llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
376 llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));