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.
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.
11 //! The Rust compiler.
15 //! This API is completely unstable and subject to change.
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/")]
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)]
29 #![feature(inclusive_range)]
30 #![feature(inclusive_range_syntax)]
33 #![feature(rustc_diagnostic_macros)]
34 #![feature(slice_patterns)]
35 #![feature(conservative_impl_trait)]
36 #![feature(optin_builtin_traits)]
38 use rustc::dep_graph::WorkProduct;
39 use syntax_pos::symbol::Symbol;
42 extern crate bitflags;
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;
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;
67 extern crate cc; // Used to locate MSVC
70 use back::bytecode::RLIB_BYTECODE_EXTENSION;
72 pub use llvm_util::{target_features, print_version, print_passes};
75 use std::path::PathBuf;
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;
93 pub use rustc_trans_utils::symbol_names;
100 pub mod symbol_export;
146 pub struct LlvmTransCrate(());
148 impl !Send for LlvmTransCrate {} // Llvm is on a per-thread basis
149 impl !Sync for LlvmTransCrate {}
151 impl LlvmTransCrate {
152 pub fn new(sess: &Session) -> Box<TransCrate> {
153 llvm_util::init(sess); // Make sure llvm is inited
154 box LlvmTransCrate(())
158 impl TransCrate for LlvmTransCrate {
159 fn print(&self, req: PrintRequest, sess: &Session) {
161 PrintRequest::RelocationModels => {
162 println!("Available relocation models:");
163 for &(name, _) in back::write::RELOC_MODEL_ARGS.iter() {
164 println!(" {}", name);
168 PrintRequest::CodeModels => {
169 println!("Available code models:");
170 for &(name, _) in back::write::CODE_GEN_MODEL_ARGS.iter(){
171 println!(" {}", name);
175 PrintRequest::TlsModels => {
176 println!("Available TLS models:");
177 for &(name, _) in back::write::TLS_MODEL_ARGS.iter(){
178 println!(" {}", name);
182 req => llvm_util::print(req, sess),
186 fn target_features(&self, sess: &Session) -> Vec<Symbol> {
187 target_features(sess)
190 fn metadata_loader(&self) -> Box<MetadataLoader> {
191 box metadata::LlvmMetadataLoader
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);
201 fn provide_extern(&self, providers: &mut ty::maps::Providers) {
202 back::symbol_export::provide_extern(providers);
205 fn trans_crate<'a, 'tcx>(
207 tcx: TyCtxt<'a, 'tcx, 'tcx>,
208 rx: mpsc::Receiver<Box<Any + Send>>
210 box base::trans_crate(tcx, rx)
213 fn join_trans_and_link(
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);
228 time(sess.time_passes(),
229 "serialize work products",
230 move || rustc_incremental::save_work_products(sess, &dep_graph));
232 sess.compile_status()?;
234 if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
235 i == OutputType::Metadata) {
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());
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);
253 /// This is the entrypoint for a hot plugged rustc_trans
255 pub fn __rustc_codegen_backend(sess: &Session) -> Box<TransCrate> {
256 LlvmTransCrate::new(sess)
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.
267 source: ModuleSource,
271 #[derive(Copy, Clone, Debug, PartialEq)]
278 impl ModuleTranslation {
279 fn llvm(&self) -> Option<&ModuleLlvm> {
281 ModuleSource::Translated(ref llvm) => Some(llvm),
282 ModuleSource::Preexisting(_) => None,
286 fn into_compiled_module(self,
289 emit_bc_compressed: bool,
290 outputs: &OutputFilenames) -> CompiledModule {
291 let pre_existing = match self.source {
292 ModuleSource::Preexisting(_) => true,
293 ModuleSource::Translated(_) => false,
295 let object = if emit_obj {
296 Some(outputs.temp_path(OutputType::Object, Some(&self.name)))
300 let bytecode = if emit_bc {
301 Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name)))
305 let bytecode_compressed = if emit_bc_compressed {
306 Some(outputs.temp_path(OutputType::Bitcode, Some(&self.name))
307 .with_extension(RLIB_BYTECODE_EXTENSION))
313 llmod_id: self.llmod_id,
314 name: self.name.clone(),
325 struct CompiledModule {
330 object: Option<PathBuf>,
331 bytecode: Option<PathBuf>,
332 bytecode_compressed: Option<PathBuf>,
336 /// Copy the `.o` files or whatever from the incr. comp. directory.
337 Preexisting(WorkProduct),
339 /// Rebuild from this LLVM module.
340 Translated(ModuleLlvm),
345 llcx: llvm::ContextRef,
346 llmod: llvm::ModuleRef,
347 tm: llvm::TargetMachineRef,
350 unsafe impl Send for ModuleLlvm { }
351 unsafe impl Sync for ModuleLlvm { }
353 impl Drop for ModuleLlvm {
356 llvm::LLVMDisposeModule(self.llmod);
357 llvm::LLVMContextDispose(self.llcx);
358 llvm::LLVMRustDisposeTargetMachine(self.tm);
363 struct CrateTranslation {
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,
375 // Misc info we load from metadata to persist beyond the tcx
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)>,
391 #[cfg(not(stage0))] // remove after the next snapshot
392 __build_diagnostic_array! { librustc_trans, DIAGNOSTICS }