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::{
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_middle::dep_graph::{WorkProduct, WorkProductId};
31 use rustc_middle::middle::cstore::{EncodedMetadata, MetadataLoaderDyn};
32 use rustc_middle::ty::{self, 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_::*;
78 pub struct LlvmCodegenBackend(());
80 impl ExtraBackendMethods for LlvmCodegenBackend {
81 fn new_metadata(&self, tcx: TyCtxt<'_>, mod_name: &str) -> ModuleLlvm {
82 ModuleLlvm::new_metadata(tcx, mod_name)
85 fn write_compressed_metadata<'tcx>(
88 metadata: &EncodedMetadata,
89 llvm_module: &mut ModuleLlvm,
91 base::write_compressed_metadata(tcx, metadata, llvm_module)
93 fn codegen_allocator<'tcx>(
96 mods: &mut ModuleLlvm,
98 has_alloc_error_handler: bool,
100 unsafe { allocator::codegen(tcx, mods, 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,
191 back::lto::run_pass_manager(cgcx, module, config, thin)
195 unsafe impl Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
196 unsafe impl Sync for LlvmCodegenBackend {}
198 impl LlvmCodegenBackend {
199 pub fn new() -> Box<dyn CodegenBackend> {
200 Box::new(LlvmCodegenBackend(()))
204 impl CodegenBackend for LlvmCodegenBackend {
205 fn init(&self, sess: &Session) {
206 llvm_util::init(sess); // Make sure llvm is inited
209 fn print(&self, req: PrintRequest, sess: &Session) {
211 PrintRequest::RelocationModels => {
212 println!("Available relocation models:");
214 &["static", "pic", "dynamic-no-pic", "ropi", "rwpi", "ropi-rwpi", "default"]
216 println!(" {}", name);
220 PrintRequest::CodeModels => {
221 println!("Available code models:");
222 for name in &["tiny", "small", "kernel", "medium", "large"] {
223 println!(" {}", name);
227 PrintRequest::TlsModels => {
228 println!("Available TLS models:");
229 for name in &["global-dynamic", "local-dynamic", "initial-exec", "local-exec"] {
230 println!(" {}", name);
234 req => llvm_util::print(req, sess),
238 fn print_passes(&self) {
239 llvm_util::print_passes();
242 fn print_version(&self) {
243 llvm_util::print_version();
246 fn target_features(&self, sess: &Session) -> Vec<Symbol> {
247 target_features(sess)
250 fn metadata_loader(&self) -> Box<MetadataLoaderDyn> {
251 Box::new(metadata::LlvmMetadataLoader)
254 fn provide(&self, providers: &mut ty::query::Providers) {
255 attributes::provide_both(providers);
258 fn provide_extern(&self, providers: &mut ty::query::Providers) {
259 attributes::provide_both(providers);
262 fn codegen_crate<'tcx>(
265 metadata: EncodedMetadata,
266 need_metadata_module: bool,
268 Box::new(rustc_codegen_ssa::base::codegen_crate(
269 LlvmCodegenBackend(()),
272 need_metadata_module,
278 ongoing_codegen: Box<dyn Any>,
280 ) -> Result<(CodegenResults, FxHashMap<WorkProductId, WorkProduct>), ErrorReported> {
281 let (codegen_results, work_products) = ongoing_codegen
282 .downcast::<rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
283 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
286 sess.time("llvm_dump_timing_file", || {
287 if sess.opts.debugging_opts.llvm_time_trace {
288 llvm_util::time_trace_profiler_finish("llvm_timings.json");
292 Ok((codegen_results, work_products))
298 codegen_results: CodegenResults,
299 outputs: &OutputFilenames,
300 ) -> Result<(), ErrorReported> {
301 // Run the linker on any artifacts that resulted from the LLVM run.
302 // This should produce either a finished executable or library.
303 sess.time("link_crate", || {
304 use crate::back::archive::LlvmArchiveBuilder;
305 use rustc_codegen_ssa::back::link::link_binary;
307 let target_cpu = crate::llvm_util::target_cpu(sess);
308 link_binary::<LlvmArchiveBuilder<'_>>(
312 &codegen_results.crate_name.as_str(),
321 pub struct ModuleLlvm {
322 llcx: &'static mut llvm::Context,
323 llmod_raw: *const llvm::Module,
324 tm: &'static mut llvm::TargetMachine,
327 unsafe impl Send for ModuleLlvm {}
328 unsafe impl Sync for ModuleLlvm {}
331 fn new(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
333 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
334 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
335 ModuleLlvm { llmod_raw, llcx, tm: create_target_machine(tcx, mod_name) }
339 fn new_metadata(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
341 let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
342 let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
343 ModuleLlvm { llmod_raw, llcx, tm: create_informational_target_machine(tcx.sess) }
348 cgcx: &CodegenContext<LlvmCodegenBackend>,
352 ) -> Result<Self, FatalError> {
354 let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
355 let llmod_raw = back::lto::parse_module(llcx, name, buffer, handler)?;
357 let split_dwarf_file = cgcx
359 .split_dwarf_filename(cgcx.split_dwarf_kind, Some(name.to_str().unwrap()));
360 let tm_factory_config = TargetMachineFactoryConfig { split_dwarf_file };
362 let tm = match (cgcx.tm_factory)(tm_factory_config) {
365 handler.struct_err(&e).emit();
366 return Err(FatalError);
370 Ok(ModuleLlvm { llmod_raw, llcx, tm })
374 fn llmod(&self) -> &llvm::Module {
375 unsafe { &*self.llmod_raw }
379 impl Drop for ModuleLlvm {
382 llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
383 llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));