compiler/rustc_codegen_llvm/src/lib.rs

   1 //! The Rust compiler.
   2 //!
   3 //! # Note
   4 //!
   5 //! This API is completely unstable and subject to change.
   6
   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)]
  13 #![feature(iter_zip)]
  14 #![feature(nll)]
  15 #![recursion_limit = "256"]
  16
  17 use back::write::{create_informational_target_machine, create_target_machine};
  18
  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,
  24 };
  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;
  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;
  36
  37 use std::any::Any;
  38 use std::ffi::CStr;
  39
  40 mod back {
  41     pub mod archive;
  42     pub mod lto;
  43     mod profiling;
  44     pub mod write;
  45 }
  46
  47 mod abi;
  48 mod allocator;
  49 mod asm;
  50 mod attributes;
  51 mod base;
  52 mod builder;
  53 mod callee;
  54 mod common;
  55 mod consts;
  56 mod context;
  57 mod coverageinfo;
  58 mod debuginfo;
  59 mod declare;
  60 mod intrinsic;
  61
  62 // The following is a work around that replaces `pub mod llvm;` and that fixes issue 53912.
  63 #[path = "llvm/mod.rs"]
  64 mod llvm_;
  65 pub mod llvm {
  66     pub use super::llvm_::*;
  67 }
  68
  69 mod llvm_util;
  70 mod mono_item;
  71 mod type_;
  72 mod type_of;
  73 mod va_arg;
  74 mod value;
  75
  76 #[derive(Clone)]
  77 pub struct LlvmCodegenBackend(());
  78
  79 impl ExtraBackendMethods for LlvmCodegenBackend {
  80     fn new_metadata(&self, tcx: TyCtxt<'_>, mod_name: &str) -> ModuleLlvm {
  81         ModuleLlvm::new_metadata(tcx, mod_name)
  82     }
  83
  84     fn write_compressed_metadata<'tcx>(
  85         &self,
  86         tcx: TyCtxt<'tcx>,
  87         metadata: &EncodedMetadata,
  88         llvm_module: &mut ModuleLlvm,
  89     ) {
  90         base::write_compressed_metadata(tcx, metadata, llvm_module)
  91     }
  92     fn codegen_allocator<'tcx>(
  93         &self,
  94         tcx: TyCtxt<'tcx>,
  95         mods: &mut ModuleLlvm,
  96         kind: AllocatorKind,
  97         has_alloc_error_handler: bool,
  98     ) {
  99         unsafe { allocator::codegen(tcx, mods, kind, has_alloc_error_handler) }
 100     }
 101     fn compile_codegen_unit(
 102         &self,
 103         tcx: TyCtxt<'_>,
 104         cgu_name: Symbol,
 105     ) -> (ModuleCodegen<ModuleLlvm>, u64) {
 106         base::compile_codegen_unit(tcx, cgu_name)
 107     }
 108     fn target_machine_factory(
 109         &self,
 110         sess: &Session,
 111         optlvl: OptLevel,
 112     ) -> TargetMachineFactoryFn<Self> {
 113         back::write::target_machine_factory(sess, optlvl)
 114     }
 115     fn target_cpu<'b>(&self, sess: &'b Session) -> &'b str {
 116         llvm_util::target_cpu(sess)
 117     }
 118     fn tune_cpu<'b>(&self, sess: &'b Session) -> Option<&'b str> {
 119         llvm_util::tune_cpu(sess)
 120     }
 121 }
 122
 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) {
 131         unsafe {
 132             llvm::LLVMRustPrintPassTimings();
 133         }
 134     }
 135     fn run_link(
 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)
 141     }
 142     fn run_fat_lto(
 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)
 148     }
 149     fn run_thin_lto(
 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)
 155     }
 156     unsafe fn optimize(
 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)
 163     }
 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)
 169     }
 170     unsafe fn codegen(
 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)
 177     }
 178     fn prepare_thin(module: ModuleCodegen<Self::Module>) -> (String, Self::ThinBuffer) {
 179         back::lto::prepare_thin(module)
 180     }
 181     fn serialize_module(module: ModuleCodegen<Self::Module>) -> (String, Self::ModuleBuffer) {
 182         (module.name, back::lto::ModuleBuffer::new(module.module_llvm.llmod()))
 183     }
 184     fn run_lto_pass_manager(
 185         cgcx: &CodegenContext<Self>,
 186         module: &ModuleCodegen<Self::Module>,
 187         config: &ModuleConfig,
 188         thin: bool,
 189     ) -> Result<(), FatalError> {
 190         let diag_handler = cgcx.create_diag_handler();
 191         back::lto::run_pass_manager(cgcx, &diag_handler, module, config, thin)
 192     }
 193 }
 194
 195 unsafe impl Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
 196 unsafe impl Sync for LlvmCodegenBackend {}
 197
 198 impl LlvmCodegenBackend {
 199     pub fn new() -> Box<dyn CodegenBackend> {
 200         Box::new(LlvmCodegenBackend(()))
 201     }
 202 }
 203
 204 impl CodegenBackend for LlvmCodegenBackend {
 205     fn init(&self, sess: &Session) {
 206         llvm_util::init(sess); // Make sure llvm is inited
 207     }
 208
 209     fn print(&self, req: PrintRequest, sess: &Session) {
 210         match req {
 211             PrintRequest::RelocationModels => {
 212                 println!("Available relocation models:");
 213                 for name in
 214                     &["static", "pic", "dynamic-no-pic", "ropi", "rwpi", "ropi-rwpi", "default"]
 215                 {
 216                     println!("    {}", name);
 217                 }
 218                 println!();
 219             }
 220             PrintRequest::CodeModels => {
 221                 println!("Available code models:");
 222                 for name in &["tiny", "small", "kernel", "medium", "large"] {
 223                     println!("    {}", name);
 224                 }
 225                 println!();
 226             }
 227             PrintRequest::TlsModels => {
 228                 println!("Available TLS models:");
 229                 for name in &["global-dynamic", "local-dynamic", "initial-exec", "local-exec"] {
 230                     println!("    {}", name);
 231                 }
 232                 println!();
 233             }
 234             req => llvm_util::print(req, sess),
 235         }
 236     }
 237
 238     fn print_passes(&self) {
 239         llvm_util::print_passes();
 240     }
 241
 242     fn print_version(&self) {
 243         llvm_util::print_version();
 244     }
 245
 246     fn target_features(&self, sess: &Session) -> Vec<Symbol> {
 247         target_features(sess)
 248     }
 249
 250     fn codegen_crate<'tcx>(
 251         &self,
 252         tcx: TyCtxt<'tcx>,
 253         metadata: EncodedMetadata,
 254         need_metadata_module: bool,
 255     ) -> Box<dyn Any> {
 256         Box::new(rustc_codegen_ssa::base::codegen_crate(
 257             LlvmCodegenBackend(()),
 258             tcx,
 259             crate::llvm_util::target_cpu(tcx.sess).to_string(),
 260             metadata,
 261             need_metadata_module,
 262         ))
 263     }
 264
 265     fn join_codegen(
 266         &self,
 267         ongoing_codegen: Box<dyn Any>,
 268         sess: &Session,
 269     ) -> Result<(CodegenResults, FxHashMap<WorkProductId, WorkProduct>), ErrorReported> {
 270         let (codegen_results, work_products) = ongoing_codegen
 271             .downcast::<rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
 272             .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
 273             .join(sess);
 274
 275         sess.time("llvm_dump_timing_file", || {
 276             if sess.opts.debugging_opts.llvm_time_trace {
 277                 llvm_util::time_trace_profiler_finish("llvm_timings.json");
 278             }
 279         });
 280
 281         Ok((codegen_results, work_products))
 282     }
 283
 284     fn link(
 285         &self,
 286         sess: &Session,
 287         codegen_results: CodegenResults,
 288         outputs: &OutputFilenames,
 289     ) -> Result<(), ErrorReported> {
 290         use crate::back::archive::LlvmArchiveBuilder;
 291         use rustc_codegen_ssa::back::link::link_binary;
 292
 293         // Run the linker on any artifacts that resulted from the LLVM run.
 294         // This should produce either a finished executable or library.
 295         link_binary::<LlvmArchiveBuilder<'_>>(sess, &codegen_results, outputs)
 296     }
 297 }
 298
 299 pub struct ModuleLlvm {
 300     llcx: &'static mut llvm::Context,
 301     llmod_raw: *const llvm::Module,
 302     tm: &'static mut llvm::TargetMachine,
 303 }
 304
 305 unsafe impl Send for ModuleLlvm {}
 306 unsafe impl Sync for ModuleLlvm {}
 307
 308 impl ModuleLlvm {
 309     fn new(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
 310         unsafe {
 311             let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
 312             let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
 313             ModuleLlvm { llmod_raw, llcx, tm: create_target_machine(tcx, mod_name) }
 314         }
 315     }
 316
 317     fn new_metadata(tcx: TyCtxt<'_>, mod_name: &str) -> Self {
 318         unsafe {
 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_informational_target_machine(tcx.sess) }
 322         }
 323     }
 324
 325     fn parse(
 326         cgcx: &CodegenContext<LlvmCodegenBackend>,
 327         name: &CStr,
 328         buffer: &[u8],
 329         handler: &Handler,
 330     ) -> Result<Self, FatalError> {
 331         unsafe {
 332             let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
 333             let llmod_raw = back::lto::parse_module(llcx, name, buffer, handler)?;
 334             let tm_factory_config = TargetMachineFactoryConfig::new(&cgcx, name.to_str().unwrap());
 335             let tm = match (cgcx.tm_factory)(tm_factory_config) {
 336                 Ok(m) => m,
 337                 Err(e) => {
 338                     handler.struct_err(&e).emit();
 339                     return Err(FatalError);
 340                 }
 341             };
 342
 343             Ok(ModuleLlvm { llmod_raw, llcx, tm })
 344         }
 345     }
 346
 347     fn llmod(&self) -> &llvm::Module {
 348         unsafe { &*self.llmod_raw }
 349     }
 350 }
 351
 352 impl Drop for ModuleLlvm {
 353     fn drop(&mut self) {
 354         unsafe {
 355             llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
 356             llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));
 357         }
 358     }
 359 }