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(const_fn)]
  25 #![feature(custom_attribute)]
  26 #![allow(unused_attributes)]
  27 #![feature(i128_type)]
  28 #![feature(libc)]
  29 #![feature(quote)]
  30 #![feature(rustc_diagnostic_macros)]
  31 #![feature(slice_patterns)]
  32 #![feature(conservative_impl_trait)]
  33
  34 use rustc::dep_graph::WorkProduct;
  35 use syntax_pos::symbol::Symbol;
  36
  37 extern crate flate2;
  38 extern crate libc;
  39 extern crate owning_ref;
  40 #[macro_use] extern crate rustc;
  41 extern crate rustc_allocator;
  42 extern crate rustc_back;
  43 extern crate rustc_data_structures;
  44 extern crate rustc_incremental;
  45 extern crate rustc_llvm as llvm;
  46 extern crate rustc_platform_intrinsics as intrinsics;
  47 extern crate rustc_const_math;
  48 #[macro_use]
  49 #[no_link]
  50 extern crate rustc_bitflags;
  51 extern crate rustc_demangle;
  52 extern crate jobserver;
  53 extern crate num_cpus;
  54
  55 #[macro_use] extern crate log;
  56 #[macro_use] extern crate syntax;
  57 extern crate syntax_pos;
  58 extern crate rustc_errors as errors;
  59 extern crate serialize;
  60 #[cfg(windows)]
  61 extern crate gcc; // Used to locate MSVC, not gcc :)
  62
  63 pub use base::trans_crate;
  64 pub use back::symbol_names::provide;
  65
  66 pub use metadata::LlvmMetadataLoader;
  67 pub use llvm_util::{init, target_features, print_version, print_passes, print, enable_llvm_debug};
  68 use rustc::hir::def_id::CrateNum;
  69 use rustc::util::nodemap::FxHashSet;
  70
  71 pub mod back {
  72     mod archive;
  73     pub(crate) mod linker;
  74     pub mod link;
  75     mod lto;
  76     pub(crate) mod symbol_export;
  77     pub(crate) mod symbol_names;
  78     pub mod write;
  79     mod rpath;
  80 }
  81
  82 mod diagnostics;
  83
  84 mod abi;
  85 mod adt;
  86 mod allocator;
  87 mod asm;
  88 mod assert_module_sources;
  89 mod attributes;
  90 mod base;
  91 mod builder;
  92 mod cabi_aarch64;
  93 mod cabi_arm;
  94 mod cabi_asmjs;
  95 mod cabi_hexagon;
  96 mod cabi_mips;
  97 mod cabi_mips64;
  98 mod cabi_msp430;
  99 mod cabi_nvptx;
 100 mod cabi_nvptx64;
 101 mod cabi_powerpc;
 102 mod cabi_powerpc64;
 103 mod cabi_s390x;
 104 mod cabi_sparc;
 105 mod cabi_sparc64;
 106 mod cabi_x86;
 107 mod cabi_x86_64;
 108 mod cabi_x86_win64;
 109 mod callee;
 110 mod collector;
 111 mod common;
 112 mod consts;
 113 mod context;
 114 mod debuginfo;
 115 mod declare;
 116 mod glue;
 117 mod intrinsic;
 118 mod llvm_util;
 119 mod machine;
 120 mod metadata;
 121 mod meth;
 122 mod mir;
 123 mod monomorphize;
 124 mod partitioning;
 125 mod symbol_names_test;
 126 mod time_graph;
 127 mod trans_item;
 128 mod tvec;
 129 mod type_;
 130 mod type_of;
 131 mod value;
 132
 133 pub struct ModuleTranslation {
 134     /// The name of the module. When the crate may be saved between
 135     /// compilations, incremental compilation requires that name be
 136     /// unique amongst **all** crates.  Therefore, it should contain
 137     /// something unique to this crate (e.g., a module path) as well
 138     /// as the crate name and disambiguator.
 139     name: String,
 140     symbol_name_hash: u64,
 141     pub source: ModuleSource,
 142     pub kind: ModuleKind,
 143 }
 144
 145 #[derive(Copy, Clone, Debug)]
 146 pub enum ModuleKind {
 147     Regular,
 148     Metadata,
 149     Allocator,
 150 }
 151
 152 impl ModuleTranslation {
 153     pub fn into_compiled_module(self, emit_obj: bool, emit_bc: bool) -> CompiledModule {
 154         let pre_existing = match self.source {
 155             ModuleSource::Preexisting(_) => true,
 156             ModuleSource::Translated(_) => false,
 157         };
 158
 159         CompiledModule {
 160             name: self.name.clone(),
 161             kind: self.kind,
 162             symbol_name_hash: self.symbol_name_hash,
 163             pre_existing,
 164             emit_obj,
 165             emit_bc,
 166         }
 167     }
 168 }
 169
 170 impl Drop for ModuleTranslation {
 171     fn drop(&mut self) {
 172         match self.source {
 173             ModuleSource::Preexisting(_) => {
 174                 // Nothing to dispose.
 175             },
 176             ModuleSource::Translated(llvm) => {
 177                 unsafe {
 178                     llvm::LLVMDisposeModule(llvm.llmod);
 179                     llvm::LLVMContextDispose(llvm.llcx);
 180                 }
 181             },
 182         }
 183     }
 184 }
 185
 186 #[derive(Debug)]
 187 pub struct CompiledModule {
 188     pub name: String,
 189     pub kind: ModuleKind,
 190     pub symbol_name_hash: u64,
 191     pub pre_existing: bool,
 192     pub emit_obj: bool,
 193     pub emit_bc: bool,
 194 }
 195
 196 #[derive(Clone)]
 197 pub enum ModuleSource {
 198     /// Copy the `.o` files or whatever from the incr. comp. directory.
 199     Preexisting(WorkProduct),
 200
 201     /// Rebuild from this LLVM module.
 202     Translated(ModuleLlvm),
 203 }
 204
 205 #[derive(Copy, Clone, Debug)]
 206 pub struct ModuleLlvm {
 207     llcx: llvm::ContextRef,
 208     pub llmod: llvm::ModuleRef,
 209 }
 210
 211 unsafe impl Send for ModuleTranslation { }
 212 unsafe impl Sync for ModuleTranslation { }
 213
 214 pub struct CrateTranslation {
 215     pub crate_name: Symbol,
 216     pub modules: Vec<CompiledModule>,
 217     allocator_module: Option<CompiledModule>,
 218     pub link: rustc::middle::cstore::LinkMeta,
 219     pub metadata: rustc::middle::cstore::EncodedMetadata,
 220     windows_subsystem: Option<String>,
 221     linker_info: back::linker::LinkerInfo,
 222     crate_info: CrateInfo,
 223 }
 224
 225 // Misc info we load from metadata to persist beyond the tcx
 226 pub struct CrateInfo {
 227     panic_runtime: Option<CrateNum>,
 228     compiler_builtins: Option<CrateNum>,
 229     profiler_runtime: Option<CrateNum>,
 230     sanitizer_runtime: Option<CrateNum>,
 231     is_no_builtins: FxHashSet<CrateNum>,
 232 }
 233
 234 __build_diagnostic_array! { librustc_trans, DIAGNOSTICS }