src/librustc_codegen_llvm/lib.rs

   1 // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! The Rust compiler.
  12 //!
  13 //! # Note
  14 //!
  15 //! This API is completely unstable and subject to change.
  16
  17 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  18       html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  19       html_root_url = "https://doc.rust-lang.org/nightly/")]
  20
  21 #![feature(box_patterns)]
  22 #![feature(box_syntax)]
  23 #![feature(crate_visibility_modifier)]
  24 #![feature(custom_attribute)]
  25 #![feature(extern_types)]
  26 #![feature(in_band_lifetimes)]
  27 #![allow(unused_attributes)]
  28 #![feature(libc)]
  29 #![feature(nll)]
  30 #![feature(quote)]
  31 #![feature(range_contains)]
  32 #![feature(rustc_diagnostic_macros)]
  33 #![feature(slice_sort_by_cached_key)]
  34 #![feature(optin_builtin_traits)]
  35 #![feature(concat_idents)]
  36 #![feature(link_args)]
  37 #![feature(static_nobundle)]
  38
  39 use back::write::create_target_machine;
  40 use rustc::dep_graph::WorkProduct;
  41 use syntax_pos::symbol::Symbol;
  42
  43 #[macro_use] extern crate bitflags;
  44 extern crate flate2;
  45 extern crate libc;
  46 #[macro_use] extern crate rustc;
  47 extern crate jobserver;
  48 extern crate num_cpus;
  49 extern crate rustc_mir;
  50 extern crate rustc_allocator;
  51 extern crate rustc_apfloat;
  52 extern crate rustc_target;
  53 #[macro_use] extern crate rustc_data_structures;
  54 extern crate rustc_demangle;
  55 extern crate rustc_incremental;
  56 extern crate rustc_llvm;
  57 extern crate rustc_platform_intrinsics as intrinsics;
  58 extern crate rustc_codegen_utils;
  59 extern crate rustc_fs_util;
  60
  61 #[macro_use] extern crate log;
  62 #[macro_use] extern crate syntax;
  63 extern crate syntax_pos;
  64 extern crate rustc_errors as errors;
  65 extern crate serialize;
  66 extern crate cc; // Used to locate MSVC
  67 extern crate tempfile;
  68 extern crate memmap;
  69
  70 use back::bytecode::RLIB_BYTECODE_EXTENSION;
  71
  72 pub use llvm_util::target_features;
  73 use std::any::Any;
  74 use std::sync::mpsc;
  75 use rustc_data_structures::sync::Lrc;
  76
  77 use rustc::dep_graph::DepGraph;
  78 use rustc::hir::def_id::CrateNum;
  79 use rustc::middle::cstore::MetadataLoader;
  80 use rustc::middle::cstore::{NativeLibrary, CrateSource, LibSource};
  81 use rustc::middle::lang_items::LangItem;
  82 use rustc::session::{Session, CompileIncomplete};
  83 use rustc::session::config::{OutputFilenames, OutputType, PrintRequest};
  84 use rustc::ty::{self, TyCtxt};
  85 use rustc::util::time_graph;
  86 use rustc::util::nodemap::{FxHashSet, FxHashMap};
  87 use rustc::util::profiling::ProfileCategory;
  88 use rustc_mir::monomorphize;
  89 use rustc_codegen_utils::{CompiledModule, ModuleKind};
  90 use rustc_codegen_utils::codegen_backend::CodegenBackend;
  91 use rustc_data_structures::svh::Svh;
  92
  93 mod diagnostics;
  94
  95 mod back {
  96     mod archive;
  97     pub mod bytecode;
  98     pub mod link;
  99     pub mod lto;
 100     pub mod write;
 101     mod rpath;
 102     pub mod wasm;
 103 }
 104
 105 mod abi;
 106 mod allocator;
 107 mod asm;
 108 mod attributes;
 109 mod base;
 110 mod builder;
 111 mod callee;
 112 mod common;
 113 mod consts;
 114 mod context;
 115 mod debuginfo;
 116 mod declare;
 117 mod glue;
 118 mod intrinsic;
 119 pub mod llvm;
 120 mod llvm_util;
 121 mod metadata;
 122 mod meth;
 123 mod mir;
 124 mod mono_item;
 125 mod type_;
 126 mod type_of;
 127 mod value;
 128
 129 pub struct LlvmCodegenBackend(());
 130
 131 impl !Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
 132 impl !Sync for LlvmCodegenBackend {}
 133
 134 impl LlvmCodegenBackend {
 135     pub fn new() -> Box<dyn CodegenBackend> {
 136         box LlvmCodegenBackend(())
 137     }
 138 }
 139
 140 impl CodegenBackend for LlvmCodegenBackend {
 141     fn init(&self, sess: &Session) {
 142         llvm_util::init(sess); // Make sure llvm is inited
 143     }
 144
 145     fn print(&self, req: PrintRequest, sess: &Session) {
 146         match req {
 147             PrintRequest::RelocationModels => {
 148                 println!("Available relocation models:");
 149                 for &(name, _) in back::write::RELOC_MODEL_ARGS.iter() {
 150                     println!("    {}", name);
 151                 }
 152                 println!("");
 153             }
 154             PrintRequest::CodeModels => {
 155                 println!("Available code models:");
 156                 for &(name, _) in back::write::CODE_GEN_MODEL_ARGS.iter(){
 157                     println!("    {}", name);
 158                 }
 159                 println!("");
 160             }
 161             PrintRequest::TlsModels => {
 162                 println!("Available TLS models:");
 163                 for &(name, _) in back::write::TLS_MODEL_ARGS.iter(){
 164                     println!("    {}", name);
 165                 }
 166                 println!("");
 167             }
 168             req => llvm_util::print(req, sess),
 169         }
 170     }
 171
 172     fn print_passes(&self) {
 173         llvm_util::print_passes();
 174     }
 175
 176     fn print_version(&self) {
 177         llvm_util::print_version();
 178     }
 179
 180     fn diagnostics(&self) -> &[(&'static str, &'static str)] {
 181         &DIAGNOSTICS
 182     }
 183
 184     fn target_features(&self, sess: &Session) -> Vec<Symbol> {
 185         target_features(sess)
 186     }
 187
 188     fn metadata_loader(&self) -> Box<dyn MetadataLoader + Sync> {
 189         box metadata::LlvmMetadataLoader
 190     }
 191
 192     fn provide(&self, providers: &mut ty::query::Providers) {
 193         rustc_codegen_utils::symbol_export::provide(providers);
 194         rustc_codegen_utils::symbol_names::provide(providers);
 195         base::provide_both(providers);
 196         attributes::provide(providers);
 197     }
 198
 199     fn provide_extern(&self, providers: &mut ty::query::Providers) {
 200         rustc_codegen_utils::symbol_export::provide_extern(providers);
 201         base::provide_both(providers);
 202         attributes::provide_extern(providers);
 203     }
 204
 205     fn codegen_crate<'a, 'tcx>(
 206         &self,
 207         tcx: TyCtxt<'a, 'tcx, 'tcx>,
 208         rx: mpsc::Receiver<Box<dyn Any + Send>>
 209     ) -> Box<dyn Any> {
 210         box base::codegen_crate(tcx, rx)
 211     }
 212
 213     fn join_codegen_and_link(
 214         &self,
 215         ongoing_codegen: Box<dyn Any>,
 216         sess: &Session,
 217         dep_graph: &DepGraph,
 218         outputs: &OutputFilenames,
 219     ) -> Result<(), CompileIncomplete>{
 220         use rustc::util::common::time;
 221         let (ongoing_codegen, work_products) =
 222             ongoing_codegen.downcast::<::back::write::OngoingCodegen>()
 223                 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
 224                 .join(sess);
 225         if sess.opts.debugging_opts.incremental_info {
 226             back::write::dump_incremental_data(&ongoing_codegen);
 227         }
 228
 229         time(sess,
 230              "serialize work products",
 231              move || rustc_incremental::save_work_product_index(sess, &dep_graph, work_products));
 232
 233         sess.compile_status()?;
 234
 235         if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
 236                                                    i == OutputType::Metadata) {
 237             return Ok(());
 238         }
 239
 240         // Run the linker on any artifacts that resulted from the LLVM run.
 241         // This should produce either a finished executable or library.
 242         sess.profiler(|p| p.start_activity(ProfileCategory::Linking));
 243         time(sess, "linking", || {
 244             back::link::link_binary(sess, &ongoing_codegen,
 245                                     outputs, &ongoing_codegen.crate_name.as_str());
 246         });
 247         sess.profiler(|p| p.end_activity(ProfileCategory::Linking));
 248
 249         // Now that we won't touch anything in the incremental compilation directory
 250         // any more, we can finalize it (which involves renaming it)
 251         rustc_incremental::finalize_session_directory(sess, ongoing_codegen.crate_hash);
 252
 253         Ok(())
 254     }
 255 }
 256
 257 /// This is the entrypoint for a hot plugged rustc_codegen_llvm
 258 #[no_mangle]
 259 pub fn __rustc_codegen_backend() -> Box<dyn CodegenBackend> {
 260     LlvmCodegenBackend::new()
 261 }
 262
 263 struct ModuleCodegen {
 264     /// The name of the module. When the crate may be saved between
 265     /// compilations, incremental compilation requires that name be
 266     /// unique amongst **all** crates.  Therefore, it should contain
 267     /// something unique to this crate (e.g., a module path) as well
 268     /// as the crate name and disambiguator.
 269     /// We currently generate these names via CodegenUnit::build_cgu_name().
 270     name: String,
 271     module_llvm: ModuleLlvm,
 272     kind: ModuleKind,
 273 }
 274
 275 struct CachedModuleCodegen {
 276     name: String,
 277     source: WorkProduct,
 278 }
 279
 280 impl ModuleCodegen {
 281     fn into_compiled_module(self,
 282                             emit_obj: bool,
 283                             emit_bc: bool,
 284                             emit_bc_compressed: bool,
 285                             outputs: &OutputFilenames) -> CompiledModule {
 286         let object = if emit_obj {
 287             Some(outputs.temp_path(OutputType::Object, Some(&self.name)))
 288         } else {
 289             None
 290         };
 291         let bytecode = if emit_bc {
 292             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name)))
 293         } else {
 294             None
 295         };
 296         let bytecode_compressed = if emit_bc_compressed {
 297             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name))
 298                         .with_extension(RLIB_BYTECODE_EXTENSION))
 299         } else {
 300             None
 301         };
 302
 303         CompiledModule {
 304             name: self.name.clone(),
 305             kind: self.kind,
 306             object,
 307             bytecode,
 308             bytecode_compressed,
 309         }
 310     }
 311 }
 312
 313 struct ModuleLlvm {
 314     llcx: &'static mut llvm::Context,
 315     llmod_raw: *const llvm::Module,
 316     tm: &'static mut llvm::TargetMachine,
 317 }
 318
 319 unsafe impl Send for ModuleLlvm { }
 320 unsafe impl Sync for ModuleLlvm { }
 321
 322 impl ModuleLlvm {
 323     fn new(sess: &Session, mod_name: &str) -> Self {
 324         unsafe {
 325             let llcx = llvm::LLVMRustContextCreate(sess.fewer_names());
 326             let llmod_raw = context::create_module(sess, llcx, mod_name) as *const _;
 327
 328             ModuleLlvm {
 329                 llmod_raw,
 330                 llcx,
 331                 tm: create_target_machine(sess, false),
 332             }
 333         }
 334     }
 335
 336     fn llmod(&self) -> &llvm::Module {
 337         unsafe {
 338             &*self.llmod_raw
 339         }
 340     }
 341 }
 342
 343 impl Drop for ModuleLlvm {
 344     fn drop(&mut self) {
 345         unsafe {
 346             llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
 347             llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));
 348         }
 349     }
 350 }
 351
 352 struct CodegenResults {
 353     crate_name: Symbol,
 354     modules: Vec<CompiledModule>,
 355     allocator_module: Option<CompiledModule>,
 356     metadata_module: CompiledModule,
 357     crate_hash: Svh,
 358     metadata: rustc::middle::cstore::EncodedMetadata,
 359     windows_subsystem: Option<String>,
 360     linker_info: rustc_codegen_utils::linker::LinkerInfo,
 361     crate_info: CrateInfo,
 362 }
 363
 364 /// Misc info we load from metadata to persist beyond the tcx
 365 struct CrateInfo {
 366     panic_runtime: Option<CrateNum>,
 367     compiler_builtins: Option<CrateNum>,
 368     profiler_runtime: Option<CrateNum>,
 369     sanitizer_runtime: Option<CrateNum>,
 370     is_no_builtins: FxHashSet<CrateNum>,
 371     native_libraries: FxHashMap<CrateNum, Lrc<Vec<NativeLibrary>>>,
 372     crate_name: FxHashMap<CrateNum, String>,
 373     used_libraries: Lrc<Vec<NativeLibrary>>,
 374     link_args: Lrc<Vec<String>>,
 375     used_crate_source: FxHashMap<CrateNum, Lrc<CrateSource>>,
 376     used_crates_static: Vec<(CrateNum, LibSource)>,
 377     used_crates_dynamic: Vec<(CrateNum, LibSource)>,
 378     wasm_imports: FxHashMap<String, String>,
 379     lang_item_to_crate: FxHashMap<LangItem, CrateNum>,
 380     missing_lang_items: FxHashMap<CrateNum, Vec<LangItem>>,
 381 }
 382
 383 __build_diagnostic_array! { librustc_codegen_llvm, DIAGNOSTICS }