]> git.lizzy.rs Git - rust.git/blob - src/librustc_trans/lib.rs
Rollup merge of #42370 - mbrubeck:docs, r=frewsxcv
[rust.git] / 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 #![crate_name = "rustc_trans"]
18 #![crate_type = "dylib"]
19 #![crate_type = "rlib"]
20 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
21       html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
22       html_root_url = "https://doc.rust-lang.org/nightly/")]
23 #![deny(warnings)]
24
25 #![feature(associated_consts)]
26 #![feature(box_patterns)]
27 #![feature(box_syntax)]
28 #![feature(const_fn)]
29 #![feature(custom_attribute)]
30 #![allow(unused_attributes)]
31 #![feature(i128_type)]
32 #![feature(libc)]
33 #![feature(quote)]
34 #![feature(rustc_diagnostic_macros)]
35 #![feature(slice_patterns)]
36 #![feature(unicode)]
37 #![feature(conservative_impl_trait)]
38 #![feature(command_envs)]
39
40 #![cfg_attr(stage0, unstable(feature = "rustc_private", issue = "27812"))]
41 #![cfg_attr(stage0, feature(rustc_private))]
42 #![cfg_attr(stage0, feature(staged_api))]
43
44 use rustc::dep_graph::WorkProduct;
45 use syntax_pos::symbol::Symbol;
46
47 extern crate flate;
48 extern crate libc;
49 extern crate owning_ref;
50 #[macro_use] extern crate rustc;
51 extern crate rustc_back;
52 extern crate rustc_data_structures;
53 extern crate rustc_incremental;
54 pub extern crate rustc_llvm as llvm;
55 extern crate rustc_platform_intrinsics as intrinsics;
56 extern crate rustc_const_math;
57 #[macro_use]
58 #[no_link]
59 extern crate rustc_bitflags;
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 gcc; // Used to locate MSVC, not gcc :)
68
69 pub use base::trans_crate;
70 pub use back::symbol_names::provide;
71
72 pub use metadata::LlvmMetadataLoader;
73 pub use llvm_util::{init, target_features, print_version, print_passes, print, enable_llvm_debug};
74
75 pub mod back {
76     mod archive;
77     pub(crate) mod linker;
78     pub mod link;
79     mod lto;
80     pub(crate) mod symbol_export;
81     pub(crate) mod symbol_names;
82     pub mod write;
83     pub mod rpath;
84 }
85
86 mod diagnostics;
87
88 mod abi;
89 mod adt;
90 mod asm;
91 mod assert_module_sources;
92 mod attributes;
93 mod base;
94 mod builder;
95 mod cabi_aarch64;
96 mod cabi_arm;
97 mod cabi_asmjs;
98 mod cabi_hexagon;
99 mod cabi_mips;
100 mod cabi_mips64;
101 mod cabi_msp430;
102 mod cabi_nvptx;
103 mod cabi_nvptx64;
104 mod cabi_powerpc;
105 mod cabi_powerpc64;
106 mod cabi_s390x;
107 mod cabi_sparc;
108 mod cabi_sparc64;
109 mod cabi_x86;
110 mod cabi_x86_64;
111 mod cabi_x86_win64;
112 mod callee;
113 mod collector;
114 mod common;
115 mod consts;
116 mod context;
117 mod debuginfo;
118 mod declare;
119 mod glue;
120 mod intrinsic;
121 mod llvm_util;
122 mod machine;
123 mod metadata;
124 mod meth;
125 mod mir;
126 mod monomorphize;
127 mod partitioning;
128 mod symbol_names_test;
129 mod trans_item;
130 mod tvec;
131 mod type_;
132 mod type_of;
133 mod value;
134
135 #[derive(Clone)]
136 pub struct ModuleTranslation {
137     /// The name of the module. When the crate may be saved between
138     /// compilations, incremental compilation requires that name be
139     /// unique amongst **all** crates.  Therefore, it should contain
140     /// something unique to this crate (e.g., a module path) as well
141     /// as the crate name and disambiguator.
142     pub name: String,
143     pub symbol_name_hash: u64,
144     pub source: ModuleSource,
145 }
146
147 #[derive(Clone)]
148 pub enum ModuleSource {
149     /// Copy the `.o` files or whatever from the incr. comp. directory.
150     Preexisting(WorkProduct),
151
152     /// Rebuild from this LLVM module.
153     Translated(ModuleLlvm),
154 }
155
156 #[derive(Copy, Clone)]
157 pub struct ModuleLlvm {
158     pub llcx: llvm::ContextRef,
159     pub llmod: llvm::ModuleRef,
160 }
161
162 unsafe impl Send for ModuleTranslation { }
163 unsafe impl Sync for ModuleTranslation { }
164
165 pub struct CrateTranslation {
166     pub crate_name: Symbol,
167     pub modules: Vec<ModuleTranslation>,
168     pub metadata_module: ModuleTranslation,
169     pub link: rustc::middle::cstore::LinkMeta,
170     pub metadata: rustc::middle::cstore::EncodedMetadata,
171     pub exported_symbols: back::symbol_export::ExportedSymbols,
172     pub no_builtins: bool,
173     pub windows_subsystem: Option<String>,
174     pub linker_info: back::linker::LinkerInfo
175 }
176
177 __build_diagnostic_array! { librustc_trans, DIAGNOSTICS }