]> git.lizzy.rs Git - rust.git/blob - src/librustc_codegen_llvm/lib.rs
Rollup merge of #60366 - lzutao:patch-1, r=pietroalbini
[rust.git] / src / librustc_codegen_llvm / lib.rs
1 //! The Rust compiler.
2 //!
3 //! # Note
4 //!
5 //! This API is completely unstable and subject to change.
6
7 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
8
9 #![feature(box_patterns)]
10 #![feature(box_syntax)]
11 #![feature(crate_visibility_modifier)]
12 #![feature(custom_attribute)]
13 #![feature(extern_types)]
14 #![feature(in_band_lifetimes)]
15 #![allow(unused_attributes)]
16 #![feature(libc)]
17 #![feature(nll)]
18 #![feature(rustc_diagnostic_macros)]
19 #![feature(optin_builtin_traits)]
20 #![feature(concat_idents)]
21 #![feature(link_args)]
22 #![feature(static_nobundle)]
23 #![feature(trusted_len)]
24 #![deny(rust_2018_idioms)]
25 #![allow(explicit_outlives_requirements)]
26
27 use back::write::{create_target_machine, create_informational_target_machine};
28 use syntax_pos::symbol::Symbol;
29
30 extern crate flate2;
31 #[macro_use] extern crate bitflags;
32 extern crate libc;
33 #[macro_use] extern crate rustc;
34 extern crate rustc_mir;
35 extern crate rustc_allocator;
36 extern crate rustc_target;
37 #[macro_use] extern crate rustc_data_structures;
38 extern crate rustc_incremental;
39 extern crate rustc_codegen_utils;
40 extern crate rustc_codegen_ssa;
41 extern crate rustc_fs_util;
42
43 #[macro_use] extern crate log;
44 #[macro_use] extern crate syntax;
45 extern crate syntax_pos;
46 extern crate rustc_errors as errors;
47
48 use rustc_codegen_ssa::traits::*;
49 use rustc_codegen_ssa::back::write::{CodegenContext, ModuleConfig, FatLTOInput};
50 use rustc_codegen_ssa::back::lto::{SerializedModule, LtoModuleCodegen, ThinModule};
51 use rustc_codegen_ssa::CompiledModule;
52 use errors::{FatalError, Handler};
53 use rustc::dep_graph::WorkProduct;
54 use syntax_pos::symbol::InternedString;
55 use rustc::mir::mono::Stats;
56 pub use llvm_util::target_features;
57 use std::any::Any;
58 use std::sync::{mpsc, Arc};
59
60 use rustc::dep_graph::DepGraph;
61 use rustc::middle::allocator::AllocatorKind;
62 use rustc::middle::cstore::{EncodedMetadata, MetadataLoader};
63 use rustc::session::Session;
64 use rustc::session::config::{OutputFilenames, OutputType, PrintRequest, OptLevel};
65 use rustc::ty::{self, TyCtxt};
66 use rustc::util::common::ErrorReported;
67 use rustc_mir::monomorphize;
68 use rustc_codegen_ssa::ModuleCodegen;
69 use rustc_codegen_utils::codegen_backend::CodegenBackend;
70
71 mod error_codes;
72
73 mod back {
74     pub mod archive;
75     pub mod bytecode;
76     pub mod lto;
77     pub mod write;
78 }
79
80 mod abi;
81 mod allocator;
82 mod asm;
83 mod attributes;
84 mod base;
85 mod builder;
86 mod callee;
87 mod common;
88 mod consts;
89 mod context;
90 mod debuginfo;
91 mod declare;
92 mod intrinsic;
93
94 // The following is a work around that replaces `pub mod llvm;` and that fixes issue 53912.
95 #[path = "llvm/mod.rs"] mod llvm_; pub mod llvm { pub use super::llvm_::*; }
96
97 mod llvm_util;
98 mod metadata;
99 mod mono_item;
100 mod type_;
101 mod type_of;
102 mod value;
103 mod va_arg;
104
105 #[derive(Clone)]
106 pub struct LlvmCodegenBackend(());
107
108 impl ExtraBackendMethods for LlvmCodegenBackend {
109     fn new_metadata(&self, tcx: TyCtxt<'_, '_, '_>, mod_name: &str) -> ModuleLlvm {
110         ModuleLlvm::new_metadata(tcx, mod_name)
111     }
112
113     fn write_metadata<'b, 'gcx>(
114         &self,
115         tcx: TyCtxt<'b, 'gcx, 'gcx>,
116         metadata: &mut ModuleLlvm
117     ) -> EncodedMetadata {
118         base::write_metadata(tcx, metadata)
119     }
120     fn codegen_allocator<'b, 'gcx>(
121         &self,
122         tcx: TyCtxt<'b, 'gcx, 'gcx>,
123         mods: &mut ModuleLlvm,
124         kind: AllocatorKind
125     ) {
126         unsafe { allocator::codegen(tcx, mods, kind) }
127     }
128     fn compile_codegen_unit<'a, 'tcx: 'a>(
129         &self,
130         tcx: TyCtxt<'a, 'tcx, 'tcx>,
131         cgu_name: InternedString,
132     ) -> Stats {
133         base::compile_codegen_unit(tcx, cgu_name)
134     }
135     fn target_machine_factory(
136         &self,
137         sess: &Session,
138         optlvl: OptLevel,
139         find_features: bool
140     ) -> Arc<dyn Fn() ->
141         Result<&'static mut llvm::TargetMachine, String> + Send + Sync> {
142         back::write::target_machine_factory(sess, optlvl, find_features)
143     }
144     fn target_cpu<'b>(&self, sess: &'b Session) -> &'b str {
145         llvm_util::target_cpu(sess)
146     }
147 }
148
149 impl WriteBackendMethods for LlvmCodegenBackend {
150     type Module = ModuleLlvm;
151     type ModuleBuffer = back::lto::ModuleBuffer;
152     type Context = llvm::Context;
153     type TargetMachine = &'static mut llvm::TargetMachine;
154     type ThinData = back::lto::ThinData;
155     type ThinBuffer = back::lto::ThinBuffer;
156     fn print_pass_timings(&self) {
157             unsafe { llvm::LLVMRustPrintPassTimings(); }
158     }
159     fn run_fat_lto(
160         cgcx: &CodegenContext<Self>,
161         modules: Vec<FatLTOInput<Self>>,
162         cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
163     ) -> Result<LtoModuleCodegen<Self>, FatalError> {
164         back::lto::run_fat(cgcx, modules, cached_modules)
165     }
166     fn run_thin_lto(
167         cgcx: &CodegenContext<Self>,
168         modules: Vec<(String, Self::ThinBuffer)>,
169         cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
170     ) -> Result<(Vec<LtoModuleCodegen<Self>>, Vec<WorkProduct>), FatalError> {
171         back::lto::run_thin(cgcx, modules, cached_modules)
172     }
173     unsafe fn optimize(
174         cgcx: &CodegenContext<Self>,
175         diag_handler: &Handler,
176         module: &ModuleCodegen<Self::Module>,
177         config: &ModuleConfig,
178     ) -> Result<(), FatalError> {
179         back::write::optimize(cgcx, diag_handler, module, config)
180     }
181     unsafe fn optimize_thin(
182         cgcx: &CodegenContext<Self>,
183         thin: &mut ThinModule<Self>,
184     ) -> Result<ModuleCodegen<Self::Module>, FatalError> {
185         back::lto::optimize_thin_module(thin, cgcx)
186     }
187     unsafe fn codegen(
188         cgcx: &CodegenContext<Self>,
189         diag_handler: &Handler,
190         module: ModuleCodegen<Self::Module>,
191         config: &ModuleConfig,
192     ) -> Result<CompiledModule, FatalError> {
193         back::write::codegen(cgcx, diag_handler, module, config)
194     }
195     fn prepare_thin(
196         module: ModuleCodegen<Self::Module>
197     ) -> (String, Self::ThinBuffer) {
198         back::lto::prepare_thin(module)
199     }
200     fn serialize_module(
201         module: ModuleCodegen<Self::Module>
202     ) -> (String, Self::ModuleBuffer) {
203         (module.name, back::lto::ModuleBuffer::new(module.module_llvm.llmod()))
204     }
205     fn run_lto_pass_manager(
206         cgcx: &CodegenContext<Self>,
207         module: &ModuleCodegen<Self::Module>,
208         config: &ModuleConfig,
209         thin: bool
210     ) {
211         back::lto::run_pass_manager(cgcx, module, config, thin)
212     }
213 }
214
215 unsafe impl Send for LlvmCodegenBackend {} // Llvm is on a per-thread basis
216 unsafe impl Sync for LlvmCodegenBackend {}
217
218 impl LlvmCodegenBackend {
219     pub fn new() -> Box<dyn CodegenBackend> {
220         box LlvmCodegenBackend(())
221     }
222 }
223
224 impl CodegenBackend for LlvmCodegenBackend {
225     fn init(&self, sess: &Session) {
226         llvm_util::init(sess); // Make sure llvm is inited
227     }
228
229     fn print(&self, req: PrintRequest, sess: &Session) {
230         match req {
231             PrintRequest::RelocationModels => {
232                 println!("Available relocation models:");
233                 for &(name, _) in back::write::RELOC_MODEL_ARGS.iter() {
234                     println!("    {}", name);
235                 }
236                 println!("");
237             }
238             PrintRequest::CodeModels => {
239                 println!("Available code models:");
240                 for &(name, _) in back::write::CODE_GEN_MODEL_ARGS.iter(){
241                     println!("    {}", name);
242                 }
243                 println!("");
244             }
245             PrintRequest::TlsModels => {
246                 println!("Available TLS models:");
247                 for &(name, _) in back::write::TLS_MODEL_ARGS.iter(){
248                     println!("    {}", name);
249                 }
250                 println!("");
251             }
252             req => llvm_util::print(req, sess),
253         }
254     }
255
256     fn print_passes(&self) {
257         llvm_util::print_passes();
258     }
259
260     fn print_version(&self) {
261         llvm_util::print_version();
262     }
263
264     fn diagnostics(&self) -> &[(&'static str, &'static str)] {
265         &DIAGNOSTICS
266     }
267
268     fn target_features(&self, sess: &Session) -> Vec<Symbol> {
269         target_features(sess)
270     }
271
272     fn metadata_loader(&self) -> Box<dyn MetadataLoader + Sync> {
273         box metadata::LlvmMetadataLoader
274     }
275
276     fn provide(&self, providers: &mut ty::query::Providers<'_>) {
277         rustc_codegen_utils::symbol_names::provide(providers);
278         rustc_codegen_ssa::back::symbol_export::provide(providers);
279         rustc_codegen_ssa::base::provide_both(providers);
280         attributes::provide(providers);
281     }
282
283     fn provide_extern(&self, providers: &mut ty::query::Providers<'_>) {
284         rustc_codegen_ssa::back::symbol_export::provide_extern(providers);
285         rustc_codegen_ssa::base::provide_both(providers);
286         attributes::provide_extern(providers);
287     }
288
289     fn codegen_crate<'b, 'tcx>(
290         &self,
291         tcx: TyCtxt<'b, 'tcx, 'tcx>,
292         rx: mpsc::Receiver<Box<dyn Any + Send>>
293     ) -> Box<dyn Any> {
294         box rustc_codegen_ssa::base::codegen_crate(LlvmCodegenBackend(()), tcx, rx)
295     }
296
297     fn join_codegen_and_link(
298         &self,
299         ongoing_codegen: Box<dyn Any>,
300         sess: &Session,
301         dep_graph: &DepGraph,
302         outputs: &OutputFilenames,
303     ) -> Result<(), ErrorReported> {
304         use rustc::util::common::time;
305         let (codegen_results, work_products) =
306             ongoing_codegen.downcast::
307                 <rustc_codegen_ssa::back::write::OngoingCodegen<LlvmCodegenBackend>>()
308                 .expect("Expected LlvmCodegenBackend's OngoingCodegen, found Box<Any>")
309                 .join(sess);
310         if sess.opts.debugging_opts.incremental_info {
311             rustc_codegen_ssa::back::write::dump_incremental_data(&codegen_results);
312         }
313
314         time(sess,
315              "serialize work products",
316              move || rustc_incremental::save_work_product_index(sess, &dep_graph, work_products));
317
318         sess.compile_status()?;
319
320         if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
321                                                    i == OutputType::Metadata) {
322             return Ok(());
323         }
324
325         // Run the linker on any artifacts that resulted from the LLVM run.
326         // This should produce either a finished executable or library.
327         sess.profiler(|p| p.start_activity("link_crate"));
328         time(sess, "linking", || {
329             use rustc_codegen_ssa::back::link::link_binary;
330             use crate::back::archive::LlvmArchiveBuilder;
331
332             let target_cpu = crate::llvm_util::target_cpu(sess);
333             link_binary::<LlvmArchiveBuilder<'_>>(
334                 sess,
335                 &codegen_results,
336                 outputs,
337                 &codegen_results.crate_name.as_str(),
338                 target_cpu,
339             );
340         });
341         sess.profiler(|p| p.end_activity("link_crate"));
342
343         // Now that we won't touch anything in the incremental compilation directory
344         // any more, we can finalize it (which involves renaming it)
345         rustc_incremental::finalize_session_directory(sess, codegen_results.crate_hash);
346
347         Ok(())
348     }
349 }
350
351 /// This is the entrypoint for a hot plugged rustc_codegen_llvm
352 #[no_mangle]
353 pub fn __rustc_codegen_backend() -> Box<dyn CodegenBackend> {
354     LlvmCodegenBackend::new()
355 }
356
357 pub struct ModuleLlvm {
358     llcx: &'static mut llvm::Context,
359     llmod_raw: *const llvm::Module,
360     tm: &'static mut llvm::TargetMachine,
361 }
362
363 unsafe impl Send for ModuleLlvm { }
364 unsafe impl Sync for ModuleLlvm { }
365
366 impl ModuleLlvm {
367     fn new(tcx: TyCtxt<'_, '_, '_>, mod_name: &str) -> Self {
368         unsafe {
369             let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
370             let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
371             ModuleLlvm {
372                 llmod_raw,
373                 llcx,
374                 tm: create_target_machine(tcx, false),
375             }
376         }
377     }
378
379     fn new_metadata(tcx: TyCtxt<'_, '_, '_>, mod_name: &str) -> Self {
380         unsafe {
381             let llcx = llvm::LLVMRustContextCreate(tcx.sess.fewer_names());
382             let llmod_raw = context::create_module(tcx, llcx, mod_name) as *const _;
383             ModuleLlvm {
384                 llmod_raw,
385                 llcx,
386                 tm: create_informational_target_machine(&tcx.sess, false),
387             }
388         }
389     }
390
391     fn parse(
392         cgcx: &CodegenContext<LlvmCodegenBackend>,
393         name: &str,
394         buffer: &back::lto::ModuleBuffer,
395         handler: &Handler,
396     ) -> Result<Self, FatalError> {
397         unsafe {
398             let llcx = llvm::LLVMRustContextCreate(cgcx.fewer_names);
399             let llmod_raw = buffer.parse(name, llcx, handler)?;
400             let tm = match (cgcx.tm_factory.0)() {
401                 Ok(m) => m,
402                 Err(e) => {
403                     handler.struct_err(&e).emit();
404                     return Err(FatalError)
405                 }
406             };
407
408             Ok(ModuleLlvm {
409                 llmod_raw,
410                 llcx,
411                 tm,
412             })
413         }
414     }
415
416     fn llmod(&self) -> &llvm::Module {
417         unsafe {
418             &*self.llmod_raw
419         }
420     }
421 }
422
423 impl Drop for ModuleLlvm {
424     fn drop(&mut self) {
425         unsafe {
426             llvm::LLVMContextDispose(&mut *(self.llcx as *mut _));
427             llvm::LLVMRustDisposeTargetMachine(&mut *(self.tm as *mut _));
428         }
429     }
430 }
431
432 __build_diagnostic_array! { librustc_codegen_llvm, DIAGNOSTICS }