src/librustc_trans/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 #![deny(warnings)]
  21
  22 #![feature(box_patterns)]
  23 #![feature(box_syntax)]
  24 #![feature(custom_attribute)]
  25 #![feature(fs_read_write)]
  26 #![allow(unused_attributes)]
  27 #![feature(i128_type)]
  28 #![feature(i128)]
  29 #![feature(inclusive_range)]
  30 #![feature(inclusive_range_syntax)]
  31 #![feature(libc)]
  32 #![feature(quote)]
  33 #![feature(rustc_diagnostic_macros)]
  34 #![feature(slice_patterns)]
  35 #![feature(conservative_impl_trait)]
  36 #![feature(optin_builtin_traits)]
  37
  38 use rustc::dep_graph::WorkProduct;
  39 use syntax_pos::symbol::Symbol;
  40
  41 #[macro_use]
  42 extern crate bitflags;
  43 extern crate flate2;
  44 extern crate libc;
  45 #[macro_use] extern crate rustc;
  46 extern crate jobserver;
  47 extern crate num_cpus;
  48 extern crate rustc_mir;
  49 extern crate rustc_allocator;
  50 extern crate rustc_apfloat;
  51 extern crate rustc_back;
  52 extern crate rustc_binaryen;
  53 extern crate rustc_const_math;
  54 extern crate rustc_data_structures;
  55 extern crate rustc_demangle;
  56 extern crate rustc_incremental;
  57 extern crate rustc_llvm as llvm;
  58 extern crate rustc_platform_intrinsics as intrinsics;
  59 extern crate rustc_trans_utils;
  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 #[cfg(windows)]
  67 extern crate cc; // Used to locate MSVC
  68 extern crate tempdir;
  69
  70 use back::bytecode::RLIB_BYTECODE_EXTENSION;
  71
  72 pub use llvm_util::{target_features, print_version, print_passes};
  73
  74 use std::any::Any;
  75 use std::path::PathBuf;
  76 use std::rc::Rc;
  77 use std::sync::mpsc;
  78
  79 use rustc::dep_graph::DepGraph;
  80 use rustc::hir::def_id::CrateNum;
  81 use rustc::middle::cstore::MetadataLoader;
  82 use rustc::middle::cstore::{NativeLibrary, CrateSource, LibSource};
  83 use rustc::session::{Session, CompileIncomplete};
  84 use rustc::session::config::{OutputFilenames, OutputType, PrintRequest};
  85 use rustc::ty::{self, TyCtxt};
  86 use rustc::util::nodemap::{FxHashSet, FxHashMap};
  87 use rustc_mir::monomorphize;
  88 use rustc_trans_utils::trans_crate::TransCrate;
  89
  90 mod diagnostics;
  91
  92 mod back {
  93     pub use rustc_trans_utils::symbol_names;
  94     mod archive;
  95     pub mod bytecode;
  96     mod command;
  97     pub mod linker;
  98     pub mod link;
  99     mod lto;
 100     pub mod symbol_export;
 101     pub mod write;
 102     mod rpath;
 103 }
 104
 105 mod abi;
 106 mod allocator;
 107 mod asm;
 108 mod attributes;
 109 mod base;
 110 mod builder;
 111 mod cabi_aarch64;
 112 mod cabi_arm;
 113 mod cabi_asmjs;
 114 mod cabi_hexagon;
 115 mod cabi_mips;
 116 mod cabi_mips64;
 117 mod cabi_msp430;
 118 mod cabi_nvptx;
 119 mod cabi_nvptx64;
 120 mod cabi_powerpc;
 121 mod cabi_powerpc64;
 122 mod cabi_s390x;
 123 mod cabi_sparc;
 124 mod cabi_sparc64;
 125 mod cabi_x86;
 126 mod cabi_x86_64;
 127 mod cabi_x86_win64;
 128 mod callee;
 129 mod common;
 130 mod consts;
 131 mod context;
 132 mod debuginfo;
 133 mod declare;
 134 mod glue;
 135 mod intrinsic;
 136 mod llvm_util;
 137 mod metadata;
 138 mod meth;
 139 mod mir;
 140 mod time_graph;
 141 mod trans_item;
 142 mod type_;
 143 mod type_of;
 144 mod value;
 145
 146 pub struct LlvmTransCrate(());
 147
 148 impl !Send for LlvmTransCrate {} // Llvm is on a per-thread basis
 149 impl !Sync for LlvmTransCrate {}
 150
 151 impl LlvmTransCrate {
 152     pub fn new(sess: &Session) -> Box<TransCrate> {
 153         llvm_util::init(sess); // Make sure llvm is inited
 154         box LlvmTransCrate(())
 155     }
 156 }
 157
 158 impl TransCrate for LlvmTransCrate {
 159     fn print(&self, req: PrintRequest, sess: &Session) {
 160         match req {
 161             PrintRequest::RelocationModels => {
 162                 println!("Available relocation models:");
 163                 for &(name, _) in back::write::RELOC_MODEL_ARGS.iter() {
 164                     println!("    {}", name);
 165                 }
 166                 println!("");
 167             }
 168             PrintRequest::CodeModels => {
 169                 println!("Available code models:");
 170                 for &(name, _) in back::write::CODE_GEN_MODEL_ARGS.iter(){
 171                     println!("    {}", name);
 172                 }
 173                 println!("");
 174             }
 175             PrintRequest::TlsModels => {
 176                 println!("Available TLS models:");
 177                 for &(name, _) in back::write::TLS_MODEL_ARGS.iter(){
 178                     println!("    {}", name);
 179                 }
 180                 println!("");
 181             }
 182             req => llvm_util::print(req, sess),
 183         }
 184     }
 185
 186     fn target_features(&self, sess: &Session) -> Vec<Symbol> {
 187         target_features(sess)
 188     }
 189
 190     fn metadata_loader(&self) -> Box<MetadataLoader> {
 191         box metadata::LlvmMetadataLoader
 192     }
 193
 194     fn provide(&self, providers: &mut ty::maps::Providers) {
 195         back::symbol_names::provide(providers);
 196         back::symbol_export::provide(providers);
 197         base::provide(providers);
 198         attributes::provide(providers);
 199     }
 200
 201     fn provide_extern(&self, providers: &mut ty::maps::Providers) {
 202         back::symbol_export::provide_extern(providers);
 203     }
 204
 205     fn trans_crate<'a, 'tcx>(
 206         &self,
 207         tcx: TyCtxt<'a, 'tcx, 'tcx>,
 208         rx: mpsc::Receiver<Box<Any + Send>>
 209     ) -> Box<Any> {
 210         box base::trans_crate(tcx, rx)
 211     }
 212
 213     fn join_trans_and_link(
 214         &self,
 215         trans: Box<Any>,
 216         sess: &Session,
 217         dep_graph: &DepGraph,
 218         outputs: &OutputFilenames,
 219     ) -> Result<(), CompileIncomplete>{
 220         use rustc::util::common::time;
 221         let trans = trans.downcast::<::back::write::OngoingCrateTranslation>()
 222             .expect("Expected LlvmTransCrate's OngoingCrateTranslation, found Box<Any>")
 223             .join(sess, dep_graph);
 224         if sess.opts.debugging_opts.incremental_info {
 225             back::write::dump_incremental_data(&trans);
 226         }
 227
 228         time(sess.time_passes(),
 229              "serialize work products",
 230              move || rustc_incremental::save_work_products(sess, &dep_graph));
 231
 232         sess.compile_status()?;
 233
 234         if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
 235                                                    i == OutputType::Metadata) {
 236             return Ok(());
 237         }
 238
 239         // Run the linker on any artifacts that resulted from the LLVM run.
 240         // This should produce either a finished executable or library.
 241         time(sess.time_passes(), "linking", || {
 242             back::link::link_binary(sess, &trans, outputs, &trans.crate_name.as_str());
 243         });
 244
 245         // Now that we won't touch anything in the incremental compilation directory
 246         // any more, we can finalize it (which involves renaming it)
 247         rustc_incremental::finalize_session_directory(sess, trans.link.crate_hash);
 248
 249         Ok(())
 250     }
 251 }
 252
 253 /// This is the entrypoint for a hot plugged rustc_trans
 254 #[no_mangle]
 255 pub fn __rustc_codegen_backend(sess: &Session) -> Box<TransCrate> {
 256     LlvmTransCrate::new(sess)
 257 }
 258
 259 struct ModuleTranslation {
 260     /// The name of the module. When the crate may be saved between
 261     /// compilations, incremental compilation requires that name be
 262     /// unique amongst **all** crates.  Therefore, it should contain
 263     /// something unique to this crate (e.g., a module path) as well
 264     /// as the crate name and disambiguator.
 265     name: String,
 266     llmod_id: String,
 267     source: ModuleSource,
 268     kind: ModuleKind,
 269 }
 270
 271 #[derive(Copy, Clone, Debug, PartialEq)]
 272 enum ModuleKind {
 273     Regular,
 274     Metadata,
 275     Allocator,
 276 }
 277
 278 impl ModuleTranslation {
 279     fn llvm(&self) -> Option<&ModuleLlvm> {
 280         match self.source {
 281             ModuleSource::Translated(ref llvm) => Some(llvm),
 282             ModuleSource::Preexisting(_) => None,
 283         }
 284     }
 285
 286     fn into_compiled_module(self,
 287                                 emit_obj: bool,
 288                                 emit_bc: bool,
 289                                 emit_bc_compressed: bool,
 290                                 outputs: &OutputFilenames) -> CompiledModule {
 291         let pre_existing = match self.source {
 292             ModuleSource::Preexisting(_) => true,
 293             ModuleSource::Translated(_) => false,
 294         };
 295         let object = if emit_obj {
 296             Some(outputs.temp_path(OutputType::Object, Some(&self.name)))
 297         } else {
 298             None
 299         };
 300         let bytecode = if emit_bc {
 301             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name)))
 302         } else {
 303             None
 304         };
 305         let bytecode_compressed = if emit_bc_compressed {
 306             Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name))
 307                     .with_extension(RLIB_BYTECODE_EXTENSION))
 308         } else {
 309             None
 310         };
 311
 312         CompiledModule {
 313             llmod_id: self.llmod_id,
 314             name: self.name.clone(),
 315             kind: self.kind,
 316             pre_existing,
 317             object,
 318             bytecode,
 319             bytecode_compressed,
 320         }
 321     }
 322 }
 323
 324 #[derive(Debug)]
 325 struct CompiledModule {
 326     name: String,
 327     llmod_id: String,
 328     kind: ModuleKind,
 329     pre_existing: bool,
 330     object: Option<PathBuf>,
 331     bytecode: Option<PathBuf>,
 332     bytecode_compressed: Option<PathBuf>,
 333 }
 334
 335 enum ModuleSource {
 336     /// Copy the `.o` files or whatever from the incr. comp. directory.
 337     Preexisting(WorkProduct),
 338
 339     /// Rebuild from this LLVM module.
 340     Translated(ModuleLlvm),
 341 }
 342
 343 #[derive(Debug)]
 344 struct ModuleLlvm {
 345     llcx: llvm::ContextRef,
 346     llmod: llvm::ModuleRef,
 347     tm: llvm::TargetMachineRef,
 348 }
 349
 350 unsafe impl Send for ModuleLlvm { }
 351 unsafe impl Sync for ModuleLlvm { }
 352
 353 impl Drop for ModuleLlvm {
 354     fn drop(&mut self) {
 355         unsafe {
 356             llvm::LLVMDisposeModule(self.llmod);
 357             llvm::LLVMContextDispose(self.llcx);
 358             llvm::LLVMRustDisposeTargetMachine(self.tm);
 359         }
 360     }
 361 }
 362
 363 struct CrateTranslation {
 364     crate_name: Symbol,
 365     modules: Vec<CompiledModule>,
 366     allocator_module: Option<CompiledModule>,
 367     metadata_module: CompiledModule,
 368     link: rustc::middle::cstore::LinkMeta,
 369     metadata: rustc::middle::cstore::EncodedMetadata,
 370     windows_subsystem: Option<String>,
 371     linker_info: back::linker::LinkerInfo,
 372     crate_info: CrateInfo,
 373 }
 374
 375 // Misc info we load from metadata to persist beyond the tcx
 376 struct CrateInfo {
 377     panic_runtime: Option<CrateNum>,
 378     compiler_builtins: Option<CrateNum>,
 379     profiler_runtime: Option<CrateNum>,
 380     sanitizer_runtime: Option<CrateNum>,
 381     is_no_builtins: FxHashSet<CrateNum>,
 382     native_libraries: FxHashMap<CrateNum, Rc<Vec<NativeLibrary>>>,
 383     crate_name: FxHashMap<CrateNum, String>,
 384     used_libraries: Rc<Vec<NativeLibrary>>,
 385     link_args: Rc<Vec<String>>,
 386     used_crate_source: FxHashMap<CrateNum, Rc<CrateSource>>,
 387     used_crates_static: Vec<(CrateNum, LibSource)>,
 388     used_crates_dynamic: Vec<(CrateNum, LibSource)>,
 389 }
 390
 391 #[cfg(not(stage0))] // remove after the next snapshot
 392 __build_diagnostic_array! { librustc_trans, DIAGNOSTICS }