src/librustc_trans/back/write.rs

   1 // Copyright 2013-2015 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 use back::lto;
  12 use back::link::{get_linker, remove};
  13 use session::config::{OutputFilenames, Passes, SomePasses, AllPasses};
  14 use session::Session;
  15 use session::config::{self, OutputType};
  16 use llvm;
  17 use llvm::{ModuleRef, TargetMachineRef, PassManagerRef, DiagnosticInfoRef, ContextRef};
  18 use llvm::SMDiagnosticRef;
  19 use trans::{CrateTranslation, ModuleTranslation};
  20 use util::common::time;
  21 use util::common::path2cstr;
  22 use syntax::codemap;
  23 use syntax::errors::{self, Handler, Level};
  24 use syntax::errors::emitter::Emitter;
  25
  26 use std::collections::HashMap;
  27 use std::ffi::{CStr, CString};
  28 use std::fs;
  29 use std::path::{Path, PathBuf};
  30 use std::ptr;
  31 use std::str;
  32 use std::sync::{Arc, Mutex};
  33 use std::sync::mpsc::channel;
  34 use std::thread;
  35 use libc::{self, c_uint, c_int, c_void};
  36
  37 pub fn llvm_err(handler: &errors::Handler, msg: String) -> ! {
  38     unsafe {
  39         let cstr = llvm::LLVMRustGetLastError();
  40         if cstr == ptr::null() {
  41             panic!(handler.fatal(&msg[..]));
  42         } else {
  43             let err = CStr::from_ptr(cstr).to_bytes();
  44             let err = String::from_utf8_lossy(err).to_string();
  45             libc::free(cstr as *mut _);
  46             panic!(handler.fatal(&format!("{}: {}", &msg[..], &err[..])));
  47         }
  48     }
  49 }
  50
  51 pub fn write_output_file(
  52         handler: &errors::Handler,
  53         target: llvm::TargetMachineRef,
  54         pm: llvm::PassManagerRef,
  55         m: ModuleRef,
  56         output: &Path,
  57         file_type: llvm::FileType) {
  58     unsafe {
  59         let output_c = path2cstr(output);
  60         let result = llvm::LLVMRustWriteOutputFile(
  61                 target, pm, m, output_c.as_ptr(), file_type);
  62         if !result {
  63             llvm_err(handler, format!("could not write output to {}", output.display()));
  64         }
  65     }
  66 }
  67
  68
  69 struct Diagnostic {
  70     msg: String,
  71     code: Option<String>,
  72     lvl: Level,
  73 }
  74
  75 // We use an Arc instead of just returning a list of diagnostics from the
  76 // child thread because we need to make sure that the messages are seen even
  77 // if the child thread panics (for example, when `fatal` is called).
  78 #[derive(Clone)]
  79 struct SharedEmitter {
  80     buffer: Arc<Mutex<Vec<Diagnostic>>>,
  81 }
  82
  83 impl SharedEmitter {
  84     fn new() -> SharedEmitter {
  85         SharedEmitter {
  86             buffer: Arc::new(Mutex::new(Vec::new())),
  87         }
  88     }
  89
  90     fn dump(&mut self, handler: &Handler) {
  91         let mut buffer = self.buffer.lock().unwrap();
  92         for diag in &*buffer {
  93             match diag.code {
  94                 Some(ref code) => {
  95                     handler.emit_with_code(None,
  96                                            &diag.msg,
  97                                            &code[..],
  98                                            diag.lvl);
  99                 },
 100                 None => {
 101                     handler.emit(None,
 102                                  &diag.msg,
 103                                  diag.lvl);
 104                 },
 105             }
 106         }
 107         buffer.clear();
 108     }
 109 }
 110
 111 impl Emitter for SharedEmitter {
 112     fn emit(&mut self, sp: Option<codemap::Span>,
 113             msg: &str, code: Option<&str>, lvl: Level) {
 114         assert!(sp.is_none(), "SharedEmitter doesn't support spans");
 115
 116         self.buffer.lock().unwrap().push(Diagnostic {
 117             msg: msg.to_string(),
 118             code: code.map(|s| s.to_string()),
 119             lvl: lvl,
 120         });
 121     }
 122
 123     fn custom_emit(&mut self, _sp: errors::RenderSpan, _msg: &str, _lvl: Level) {
 124         panic!("SharedEmitter doesn't support custom_emit");
 125     }
 126 }
 127
 128
 129 // On android, we by default compile for armv7 processors. This enables
 130 // things like double word CAS instructions (rather than emulating them)
 131 // which are *far* more efficient. This is obviously undesirable in some
 132 // cases, so if any sort of target feature is specified we don't append v7
 133 // to the feature list.
 134 //
 135 // On iOS only armv7 and newer are supported. So it is useful to
 136 // get all hardware potential via VFP3 (hardware floating point)
 137 // and NEON (SIMD) instructions supported by LLVM.
 138 // Note that without those flags various linking errors might
 139 // arise as some of intrinsics are converted into function calls
 140 // and nobody provides implementations those functions
 141 fn target_feature(sess: &Session) -> String {
 142     format!("{},{}", sess.target.target.options.features, sess.opts.cg.target_feature)
 143 }
 144
 145 fn get_llvm_opt_level(optimize: config::OptLevel) -> llvm::CodeGenOptLevel {
 146     match optimize {
 147       config::No => llvm::CodeGenLevelNone,
 148       config::Less => llvm::CodeGenLevelLess,
 149       config::Default => llvm::CodeGenLevelDefault,
 150       config::Aggressive => llvm::CodeGenLevelAggressive,
 151     }
 152 }
 153
 154 pub fn create_target_machine(sess: &Session) -> TargetMachineRef {
 155     let reloc_model_arg = match sess.opts.cg.relocation_model {
 156         Some(ref s) => &s[..],
 157         None => &sess.target.target.options.relocation_model[..],
 158     };
 159     let reloc_model = match reloc_model_arg {
 160         "pic" => llvm::RelocPIC,
 161         "static" => llvm::RelocStatic,
 162         "default" => llvm::RelocDefault,
 163         "dynamic-no-pic" => llvm::RelocDynamicNoPic,
 164         _ => {
 165             sess.err(&format!("{:?} is not a valid relocation mode",
 166                              sess.opts
 167                                  .cg
 168                                  .relocation_model));
 169             sess.abort_if_errors();
 170             unreachable!();
 171         }
 172     };
 173
 174     let opt_level = get_llvm_opt_level(sess.opts.optimize);
 175     let use_softfp = sess.opts.cg.soft_float;
 176
 177     let any_library = sess.crate_types.borrow().iter().any(|ty| {
 178         *ty != config::CrateTypeExecutable
 179     });
 180
 181     let ffunction_sections = sess.target.target.options.function_sections;
 182     let fdata_sections = ffunction_sections;
 183
 184     let code_model_arg = match sess.opts.cg.code_model {
 185         Some(ref s) => &s[..],
 186         None => &sess.target.target.options.code_model[..],
 187     };
 188
 189     let code_model = match code_model_arg {
 190         "default" => llvm::CodeModelDefault,
 191         "small" => llvm::CodeModelSmall,
 192         "kernel" => llvm::CodeModelKernel,
 193         "medium" => llvm::CodeModelMedium,
 194         "large" => llvm::CodeModelLarge,
 195         _ => {
 196             sess.err(&format!("{:?} is not a valid code model",
 197                              sess.opts
 198                                  .cg
 199                                  .code_model));
 200             sess.abort_if_errors();
 201             unreachable!();
 202         }
 203     };
 204
 205     let triple = &sess.target.target.llvm_target;
 206
 207     let tm = unsafe {
 208         let triple = CString::new(triple.as_bytes()).unwrap();
 209         let cpu = match sess.opts.cg.target_cpu {
 210             Some(ref s) => &**s,
 211             None => &*sess.target.target.options.cpu
 212         };
 213         let cpu = CString::new(cpu.as_bytes()).unwrap();
 214         let features = CString::new(target_feature(sess).as_bytes()).unwrap();
 215         llvm::LLVMRustCreateTargetMachine(
 216             triple.as_ptr(), cpu.as_ptr(), features.as_ptr(),
 217             code_model,
 218             reloc_model,
 219             opt_level,
 220             use_softfp,
 221             !any_library && reloc_model == llvm::RelocPIC,
 222             ffunction_sections,
 223             fdata_sections,
 224         )
 225     };
 226
 227     if tm.is_null() {
 228         llvm_err(sess.diagnostic(),
 229                  format!("Could not create LLVM TargetMachine for triple: {}",
 230                          triple).to_string());
 231     } else {
 232         return tm;
 233     };
 234 }
 235
 236
 237 /// Module-specific configuration for `optimize_and_codegen`.
 238 #[derive(Clone)]
 239 pub struct ModuleConfig {
 240     /// LLVM TargetMachine to use for codegen.
 241     tm: TargetMachineRef,
 242     /// Names of additional optimization passes to run.
 243     passes: Vec<String>,
 244     /// Some(level) to optimize at a certain level, or None to run
 245     /// absolutely no optimizations (used for the metadata module).
 246     opt_level: Option<llvm::CodeGenOptLevel>,
 247
 248     // Flags indicating which outputs to produce.
 249     emit_no_opt_bc: bool,
 250     emit_bc: bool,
 251     emit_lto_bc: bool,
 252     emit_ir: bool,
 253     emit_asm: bool,
 254     emit_obj: bool,
 255
 256     // Miscellaneous flags.  These are mostly copied from command-line
 257     // options.
 258     no_verify: bool,
 259     no_prepopulate_passes: bool,
 260     no_builtins: bool,
 261     time_passes: bool,
 262     vectorize_loop: bool,
 263     vectorize_slp: bool,
 264     merge_functions: bool,
 265     inline_threshold: Option<usize>
 266 }
 267
 268 unsafe impl Send for ModuleConfig { }
 269
 270 impl ModuleConfig {
 271     fn new(tm: TargetMachineRef, passes: Vec<String>) -> ModuleConfig {
 272         ModuleConfig {
 273             tm: tm,
 274             passes: passes,
 275             opt_level: None,
 276
 277             emit_no_opt_bc: false,
 278             emit_bc: false,
 279             emit_lto_bc: false,
 280             emit_ir: false,
 281             emit_asm: false,
 282             emit_obj: false,
 283
 284             no_verify: false,
 285             no_prepopulate_passes: false,
 286             no_builtins: false,
 287             time_passes: false,
 288             vectorize_loop: false,
 289             vectorize_slp: false,
 290             merge_functions: false,
 291             inline_threshold: None
 292         }
 293     }
 294
 295     fn set_flags(&mut self, sess: &Session, trans: &CrateTranslation) {
 296         self.no_verify = sess.no_verify();
 297         self.no_prepopulate_passes = sess.opts.cg.no_prepopulate_passes;
 298         self.no_builtins = trans.no_builtins;
 299         self.time_passes = sess.time_passes();
 300         self.inline_threshold = sess.opts.cg.inline_threshold;
 301
 302         // Copy what clang does by turning on loop vectorization at O2 and
 303         // slp vectorization at O3. Otherwise configure other optimization aspects
 304         // of this pass manager builder.
 305         self.vectorize_loop = !sess.opts.cg.no_vectorize_loops &&
 306                              (sess.opts.optimize == config::Default ||
 307                               sess.opts.optimize == config::Aggressive);
 308         self.vectorize_slp = !sess.opts.cg.no_vectorize_slp &&
 309                             sess.opts.optimize == config::Aggressive;
 310
 311         self.merge_functions = sess.opts.optimize == config::Default ||
 312                                sess.opts.optimize == config::Aggressive;
 313     }
 314 }
 315
 316 /// Additional resources used by optimize_and_codegen (not module specific)
 317 struct CodegenContext<'a> {
 318     // Extra resources used for LTO: (sess, reachable).  This will be `None`
 319     // when running in a worker thread.
 320     lto_ctxt: Option<(&'a Session, &'a [String])>,
 321     // Handler to use for diagnostics produced during codegen.
 322     handler: &'a Handler,
 323     // LLVM passes added by plugins.
 324     plugin_passes: Vec<String>,
 325     // LLVM optimizations for which we want to print remarks.
 326     remark: Passes,
 327     // Worker thread number
 328     worker: usize,
 329 }
 330
 331 impl<'a> CodegenContext<'a> {
 332     fn new_with_session(sess: &'a Session, reachable: &'a [String]) -> CodegenContext<'a> {
 333         CodegenContext {
 334             lto_ctxt: Some((sess, reachable)),
 335             handler: sess.diagnostic(),
 336             plugin_passes: sess.plugin_llvm_passes.borrow().clone(),
 337             remark: sess.opts.cg.remark.clone(),
 338             worker: 0,
 339         }
 340     }
 341 }
 342
 343 struct HandlerFreeVars<'a> {
 344     llcx: ContextRef,
 345     cgcx: &'a CodegenContext<'a>,
 346 }
 347
 348 unsafe extern "C" fn report_inline_asm<'a, 'b>(cgcx: &'a CodegenContext<'a>,
 349                                                msg: &'b str,
 350                                                cookie: c_uint) {
 351     use syntax::codemap::ExpnId;
 352
 353     match cgcx.lto_ctxt {
 354         Some((sess, _)) => {
 355             sess.codemap().with_expn_info(ExpnId::from_u32(cookie), |info| match info {
 356                 Some(ei) => sess.span_err(ei.call_site, msg),
 357                 None     => sess.err(msg),
 358             });
 359         }
 360
 361         None => {
 362             cgcx.handler.struct_err(msg)
 363                         .note("build without -C codegen-units for more exact errors")
 364                         .emit();
 365         }
 366     }
 367 }
 368
 369 unsafe extern "C" fn inline_asm_handler(diag: SMDiagnosticRef,
 370                                         user: *const c_void,
 371                                         cookie: c_uint) {
 372     let HandlerFreeVars { cgcx, .. } = *(user as *const HandlerFreeVars);
 373
 374     let msg = llvm::build_string(|s| llvm::LLVMWriteSMDiagnosticToString(diag, s))
 375         .expect("non-UTF8 SMDiagnostic");
 376
 377     report_inline_asm(cgcx, &msg[..], cookie);
 378 }
 379
 380 unsafe extern "C" fn diagnostic_handler(info: DiagnosticInfoRef, user: *mut c_void) {
 381     let HandlerFreeVars { llcx, cgcx } = *(user as *const HandlerFreeVars);
 382
 383     match llvm::diagnostic::Diagnostic::unpack(info) {
 384         llvm::diagnostic::InlineAsm(inline) => {
 385             report_inline_asm(cgcx,
 386                               &*llvm::twine_to_string(inline.message),
 387                               inline.cookie);
 388         }
 389
 390         llvm::diagnostic::Optimization(opt) => {
 391             let pass_name = str::from_utf8(CStr::from_ptr(opt.pass_name).to_bytes())
 392                                 .ok()
 393                                 .expect("got a non-UTF8 pass name from LLVM");
 394             let enabled = match cgcx.remark {
 395                 AllPasses => true,
 396                 SomePasses(ref v) => v.iter().any(|s| *s == pass_name),
 397             };
 398
 399             if enabled {
 400                 let loc = llvm::debug_loc_to_string(llcx, opt.debug_loc);
 401                 cgcx.handler.note_without_error(&format!("optimization {} for {} at {}: {}",
 402                                                 opt.kind.describe(),
 403                                                 pass_name,
 404                                                 if loc.is_empty() { "[unknown]" } else { &*loc },
 405                                                 llvm::twine_to_string(opt.message)));
 406             }
 407         }
 408
 409         _ => (),
 410     }
 411 }
 412
 413 // Unsafe due to LLVM calls.
 414 unsafe fn optimize_and_codegen(cgcx: &CodegenContext,
 415                                mtrans: ModuleTranslation,
 416                                config: ModuleConfig,
 417                                name_extra: String,
 418                                output_names: OutputFilenames) {
 419     let ModuleTranslation { llmod, llcx } = mtrans;
 420     let tm = config.tm;
 421
 422     // llcx doesn't outlive this function, so we can put this on the stack.
 423     let fv = HandlerFreeVars {
 424         llcx: llcx,
 425         cgcx: cgcx,
 426     };
 427     let fv = &fv as *const HandlerFreeVars as *mut c_void;
 428
 429     llvm::LLVMSetInlineAsmDiagnosticHandler(llcx, inline_asm_handler, fv);
 430     llvm::LLVMContextSetDiagnosticHandler(llcx, diagnostic_handler, fv);
 431
 432     if config.emit_no_opt_bc {
 433         let ext = format!("{}.no-opt.bc", name_extra);
 434         let out = output_names.with_extension(&ext);
 435         let out = path2cstr(&out);
 436         llvm::LLVMWriteBitcodeToFile(llmod, out.as_ptr());
 437     }
 438
 439     if config.opt_level.is_some() {
 440         // Create the two optimizing pass managers. These mirror what clang
 441         // does, and are by populated by LLVM's default PassManagerBuilder.
 442         // Each manager has a different set of passes, but they also share
 443         // some common passes.
 444         let fpm = llvm::LLVMCreateFunctionPassManagerForModule(llmod);
 445         let mpm = llvm::LLVMCreatePassManager();
 446
 447         // If we're verifying or linting, add them to the function pass
 448         // manager.
 449         let addpass = |pass: &str| {
 450             let pass = CString::new(pass).unwrap();
 451             llvm::LLVMRustAddPass(fpm, pass.as_ptr())
 452         };
 453
 454         if !config.no_verify { assert!(addpass("verify")); }
 455         if !config.no_prepopulate_passes {
 456             llvm::LLVMRustAddAnalysisPasses(tm, fpm, llmod);
 457             llvm::LLVMRustAddAnalysisPasses(tm, mpm, llmod);
 458             with_llvm_pmb(llmod, &config, &mut |b| {
 459                 llvm::LLVMPassManagerBuilderPopulateFunctionPassManager(b, fpm);
 460                 llvm::LLVMPassManagerBuilderPopulateModulePassManager(b, mpm);
 461             })
 462         }
 463
 464         for pass in &config.passes {
 465             if !addpass(pass) {
 466                 cgcx.handler.warn(&format!("unknown pass `{}`, ignoring",
 467                                            pass));
 468             }
 469         }
 470
 471         for pass in &cgcx.plugin_passes {
 472             if !addpass(pass) {
 473                 cgcx.handler.err(&format!("a plugin asked for LLVM pass \
 474                                            `{}` but LLVM does not \
 475                                            recognize it", pass));
 476             }
 477         }
 478
 479         cgcx.handler.abort_if_errors();
 480
 481         // Finally, run the actual optimization passes
 482         time(config.time_passes, &format!("llvm function passes [{}]", cgcx.worker), ||
 483              llvm::LLVMRustRunFunctionPassManager(fpm, llmod));
 484         time(config.time_passes, &format!("llvm module passes [{}]", cgcx.worker), ||
 485              llvm::LLVMRunPassManager(mpm, llmod));
 486
 487         // Deallocate managers that we're now done with
 488         llvm::LLVMDisposePassManager(fpm);
 489         llvm::LLVMDisposePassManager(mpm);
 490
 491         match cgcx.lto_ctxt {
 492             Some((sess, reachable)) if sess.lto() =>  {
 493                 time(sess.time_passes(), "all lto passes", ||
 494                      lto::run(sess, llmod, tm, reachable, &config,
 495                               &name_extra, &output_names));
 496
 497                 if config.emit_lto_bc {
 498                     let name = format!("{}.lto.bc", name_extra);
 499                     let out = output_names.with_extension(&name);
 500                     let out = path2cstr(&out);
 501                     llvm::LLVMWriteBitcodeToFile(llmod, out.as_ptr());
 502                 }
 503             },
 504             _ => {},
 505         }
 506     }
 507
 508     // A codegen-specific pass manager is used to generate object
 509     // files for an LLVM module.
 510     //
 511     // Apparently each of these pass managers is a one-shot kind of
 512     // thing, so we create a new one for each type of output. The
 513     // pass manager passed to the closure should be ensured to not
 514     // escape the closure itself, and the manager should only be
 515     // used once.
 516     unsafe fn with_codegen<F>(tm: TargetMachineRef,
 517                               llmod: ModuleRef,
 518                               no_builtins: bool,
 519                               f: F) where
 520         F: FnOnce(PassManagerRef),
 521     {
 522         let cpm = llvm::LLVMCreatePassManager();
 523         llvm::LLVMRustAddAnalysisPasses(tm, cpm, llmod);
 524         llvm::LLVMRustAddLibraryInfo(cpm, llmod, no_builtins);
 525         f(cpm);
 526     }
 527
 528     if config.emit_bc {
 529         let ext = format!("{}.bc", name_extra);
 530         let out = output_names.with_extension(&ext);
 531         let out = path2cstr(&out);
 532         llvm::LLVMWriteBitcodeToFile(llmod, out.as_ptr());
 533     }
 534
 535     time(config.time_passes, &format!("codegen passes [{}]", cgcx.worker), || {
 536         if config.emit_ir {
 537             let ext = format!("{}.ll", name_extra);
 538             let out = output_names.with_extension(&ext);
 539             let out = path2cstr(&out);
 540             with_codegen(tm, llmod, config.no_builtins, |cpm| {
 541                 llvm::LLVMRustPrintModule(cpm, llmod, out.as_ptr());
 542                 llvm::LLVMDisposePassManager(cpm);
 543             })
 544         }
 545
 546         if config.emit_asm {
 547             let path = output_names.with_extension(&format!("{}.s", name_extra));
 548
 549             // We can't use the same module for asm and binary output, because that triggers
 550             // various errors like invalid IR or broken binaries, so we might have to clone the
 551             // module to produce the asm output
 552             let llmod = if config.emit_obj {
 553                 llvm::LLVMCloneModule(llmod)
 554             } else {
 555                 llmod
 556             };
 557             with_codegen(tm, llmod, config.no_builtins, |cpm| {
 558                 write_output_file(cgcx.handler, tm, cpm, llmod, &path,
 559                                   llvm::AssemblyFileType);
 560             });
 561             if config.emit_obj {
 562                 llvm::LLVMDisposeModule(llmod);
 563             }
 564         }
 565
 566         if config.emit_obj {
 567             let path = output_names.with_extension(&format!("{}.o", name_extra));
 568             with_codegen(tm, llmod, config.no_builtins, |cpm| {
 569                 write_output_file(cgcx.handler, tm, cpm, llmod, &path, llvm::ObjectFileType);
 570             });
 571         }
 572     });
 573
 574     llvm::LLVMDisposeModule(llmod);
 575     llvm::LLVMContextDispose(llcx);
 576     llvm::LLVMRustDisposeTargetMachine(tm);
 577 }
 578
 579 pub fn run_passes(sess: &Session,
 580                   trans: &CrateTranslation,
 581                   output_types: &HashMap<OutputType, Option<PathBuf>>,
 582                   crate_output: &OutputFilenames) {
 583     // It's possible that we have `codegen_units > 1` but only one item in
 584     // `trans.modules`.  We could theoretically proceed and do LTO in that
 585     // case, but it would be confusing to have the validity of
 586     // `-Z lto -C codegen-units=2` depend on details of the crate being
 587     // compiled, so we complain regardless.
 588     if sess.lto() && sess.opts.cg.codegen_units > 1 {
 589         // This case is impossible to handle because LTO expects to be able
 590         // to combine the entire crate and all its dependencies into a
 591         // single compilation unit, but each codegen unit is in a separate
 592         // LLVM context, so they can't easily be combined.
 593         sess.fatal("can't perform LTO when using multiple codegen units");
 594     }
 595
 596     // Sanity check
 597     assert!(trans.modules.len() == sess.opts.cg.codegen_units);
 598
 599     let tm = create_target_machine(sess);
 600
 601     // Figure out what we actually need to build.
 602
 603     let mut modules_config = ModuleConfig::new(tm, sess.opts.cg.passes.clone());
 604     let mut metadata_config = ModuleConfig::new(tm, vec!());
 605
 606     modules_config.opt_level = Some(get_llvm_opt_level(sess.opts.optimize));
 607
 608     // Save all versions of the bytecode if we're saving our temporaries.
 609     if sess.opts.cg.save_temps {
 610         modules_config.emit_no_opt_bc = true;
 611         modules_config.emit_bc = true;
 612         modules_config.emit_lto_bc = true;
 613         metadata_config.emit_bc = true;
 614     }
 615
 616     // Emit bitcode files for the crate if we're emitting an rlib.
 617     // Whenever an rlib is created, the bitcode is inserted into the
 618     // archive in order to allow LTO against it.
 619     let needs_crate_bitcode =
 620             sess.crate_types.borrow().contains(&config::CrateTypeRlib) &&
 621             sess.opts.output_types.contains_key(&OutputType::Exe);
 622     let needs_crate_object =
 623             sess.opts.output_types.contains_key(&OutputType::Exe);
 624     if needs_crate_bitcode {
 625         modules_config.emit_bc = true;
 626     }
 627
 628     for output_type in output_types.keys() {
 629         match *output_type {
 630             OutputType::Bitcode => { modules_config.emit_bc = true; },
 631             OutputType::LlvmAssembly => { modules_config.emit_ir = true; },
 632             OutputType::Assembly => {
 633                 modules_config.emit_asm = true;
 634                 // If we're not using the LLVM assembler, this function
 635                 // could be invoked specially with output_type_assembly, so
 636                 // in this case we still want the metadata object file.
 637                 if !sess.opts.output_types.contains_key(&OutputType::Assembly) {
 638                     metadata_config.emit_obj = true;
 639                 }
 640             },
 641             OutputType::Object => { modules_config.emit_obj = true; },
 642             OutputType::Exe => {
 643                 modules_config.emit_obj = true;
 644                 metadata_config.emit_obj = true;
 645             },
 646             OutputType::DepInfo => {}
 647         }
 648     }
 649
 650     modules_config.set_flags(sess, trans);
 651     metadata_config.set_flags(sess, trans);
 652
 653
 654     // Populate a buffer with a list of codegen threads.  Items are processed in
 655     // LIFO order, just because it's a tiny bit simpler that way.  (The order
 656     // doesn't actually matter.)
 657     let mut work_items = Vec::with_capacity(1 + trans.modules.len());
 658
 659     {
 660         let work = build_work_item(sess,
 661                                    trans.metadata_module,
 662                                    metadata_config.clone(),
 663                                    crate_output.clone(),
 664                                    "metadata".to_string());
 665         work_items.push(work);
 666     }
 667
 668     for (index, mtrans) in trans.modules.iter().enumerate() {
 669         let work = build_work_item(sess,
 670                                    *mtrans,
 671                                    modules_config.clone(),
 672                                    crate_output.clone(),
 673                                    format!("{}", index));
 674         work_items.push(work);
 675     }
 676
 677     // Process the work items, optionally using worker threads.
 678     if sess.opts.cg.codegen_units == 1 {
 679         run_work_singlethreaded(sess, &trans.reachable, work_items);
 680     } else {
 681         run_work_multithreaded(sess, work_items, sess.opts.cg.codegen_units);
 682     }
 683
 684     // All codegen is finished.
 685     unsafe {
 686         llvm::LLVMRustDisposeTargetMachine(tm);
 687     }
 688
 689     // Produce final compile outputs.
 690     let copy_gracefully = |from: &Path, to: &Path| {
 691         if let Err(e) = fs::copy(from, to) {
 692             sess.err(&format!("could not copy {:?} to {:?}: {}", from, to, e));
 693         }
 694     };
 695
 696     let copy_if_one_unit = |ext: &str,
 697                             output_type: OutputType,
 698                             keep_numbered: bool| {
 699         if sess.opts.cg.codegen_units == 1 {
 700             // 1) Only one codegen unit.  In this case it's no difficulty
 701             //    to copy `foo.0.x` to `foo.x`.
 702             copy_gracefully(&crate_output.with_extension(ext),
 703                             &crate_output.path(output_type));
 704             if !sess.opts.cg.save_temps && !keep_numbered {
 705                 // The user just wants `foo.x`, not `foo.0.x`.
 706                 remove(sess, &crate_output.with_extension(ext));
 707             }
 708         } else if crate_output.outputs.contains_key(&output_type) {
 709             // 2) Multiple codegen units, with `--emit foo=some_name`.  We have
 710             //    no good solution for this case, so warn the user.
 711             sess.warn(&format!("ignoring emit path because multiple .{} files \
 712                                 were produced", ext));
 713         } else if crate_output.single_output_file.is_some() {
 714             // 3) Multiple codegen units, with `-o some_name`.  We have
 715             //    no good solution for this case, so warn the user.
 716             sess.warn(&format!("ignoring -o because multiple .{} files \
 717                                 were produced", ext));
 718         } else {
 719             // 4) Multiple codegen units, but no explicit name.  We
 720             //    just leave the `foo.0.x` files in place.
 721             // (We don't have to do any work in this case.)
 722         }
 723     };
 724
 725     // Flag to indicate whether the user explicitly requested bitcode.
 726     // Otherwise, we produced it only as a temporary output, and will need
 727     // to get rid of it.
 728     let mut user_wants_bitcode = false;
 729     let mut user_wants_objects = false;
 730     for output_type in output_types.keys() {
 731         match *output_type {
 732             OutputType::Bitcode => {
 733                 user_wants_bitcode = true;
 734                 // Copy to .bc, but always keep the .0.bc.  There is a later
 735                 // check to figure out if we should delete .0.bc files, or keep
 736                 // them for making an rlib.
 737                 copy_if_one_unit("0.bc", OutputType::Bitcode, true);
 738             }
 739             OutputType::LlvmAssembly => {
 740                 copy_if_one_unit("0.ll", OutputType::LlvmAssembly, false);
 741             }
 742             OutputType::Assembly => {
 743                 copy_if_one_unit("0.s", OutputType::Assembly, false);
 744             }
 745             OutputType::Object => {
 746                 user_wants_objects = true;
 747                 copy_if_one_unit("0.o", OutputType::Object, true);
 748             }
 749             OutputType::Exe |
 750             OutputType::DepInfo => {}
 751         }
 752     }
 753     let user_wants_bitcode = user_wants_bitcode;
 754
 755     // Clean up unwanted temporary files.
 756
 757     // We create the following files by default:
 758     //  - crate.0.bc
 759     //  - crate.0.o
 760     //  - crate.metadata.bc
 761     //  - crate.metadata.o
 762     //  - crate.o (linked from crate.##.o)
 763     //  - crate.bc (copied from crate.0.bc)
 764     // We may create additional files if requested by the user (through
 765     // `-C save-temps` or `--emit=` flags).
 766
 767     if !sess.opts.cg.save_temps {
 768         // Remove the temporary .0.o objects.  If the user didn't
 769         // explicitly request bitcode (with --emit=bc), and the bitcode is not
 770         // needed for building an rlib, then we must remove .0.bc as well.
 771
 772         // Specific rules for keeping .0.bc:
 773         //  - If we're building an rlib (`needs_crate_bitcode`), then keep
 774         //    it.
 775         //  - If the user requested bitcode (`user_wants_bitcode`), and
 776         //    codegen_units > 1, then keep it.
 777         //  - If the user requested bitcode but codegen_units == 1, then we
 778         //    can toss .0.bc because we copied it to .bc earlier.
 779         //  - If we're not building an rlib and the user didn't request
 780         //    bitcode, then delete .0.bc.
 781         // If you change how this works, also update back::link::link_rlib,
 782         // where .0.bc files are (maybe) deleted after making an rlib.
 783         let keep_numbered_bitcode = needs_crate_bitcode ||
 784                 (user_wants_bitcode && sess.opts.cg.codegen_units > 1);
 785
 786         let keep_numbered_objects = needs_crate_object ||
 787                 (user_wants_objects && sess.opts.cg.codegen_units > 1);
 788
 789         for i in 0..trans.modules.len() {
 790             if modules_config.emit_obj && !keep_numbered_objects {
 791                 let ext = format!("{}.o", i);
 792                 remove(sess, &crate_output.with_extension(&ext));
 793             }
 794
 795             if modules_config.emit_bc && !keep_numbered_bitcode {
 796                 let ext = format!("{}.bc", i);
 797                 remove(sess, &crate_output.with_extension(&ext));
 798             }
 799         }
 800
 801         if metadata_config.emit_bc && !user_wants_bitcode {
 802             remove(sess, &crate_output.with_extension("metadata.bc"));
 803         }
 804     }
 805
 806     // We leave the following files around by default:
 807     //  - crate.o
 808     //  - crate.metadata.o
 809     //  - crate.bc
 810     // These are used in linking steps and will be cleaned up afterward.
 811
 812     // FIXME: time_llvm_passes support - does this use a global context or
 813     // something?
 814     if sess.opts.cg.codegen_units == 1 && sess.time_llvm_passes() {
 815         unsafe { llvm::LLVMRustPrintPassTimings(); }
 816     }
 817 }
 818
 819 struct WorkItem {
 820     mtrans: ModuleTranslation,
 821     config: ModuleConfig,
 822     output_names: OutputFilenames,
 823     name_extra: String
 824 }
 825
 826 fn build_work_item(sess: &Session,
 827                    mtrans: ModuleTranslation,
 828                    config: ModuleConfig,
 829                    output_names: OutputFilenames,
 830                    name_extra: String)
 831                    -> WorkItem
 832 {
 833     let mut config = config;
 834     config.tm = create_target_machine(sess);
 835     WorkItem { mtrans: mtrans, config: config, output_names: output_names,
 836                name_extra: name_extra }
 837 }
 838
 839 fn execute_work_item(cgcx: &CodegenContext,
 840                      work_item: WorkItem) {
 841     unsafe {
 842         optimize_and_codegen(cgcx, work_item.mtrans, work_item.config,
 843                              work_item.name_extra, work_item.output_names);
 844     }
 845 }
 846
 847 fn run_work_singlethreaded(sess: &Session,
 848                            reachable: &[String],
 849                            work_items: Vec<WorkItem>) {
 850     let cgcx = CodegenContext::new_with_session(sess, reachable);
 851
 852     // Since we're running single-threaded, we can pass the session to
 853     // the proc, allowing `optimize_and_codegen` to perform LTO.
 854     for work in work_items.into_iter().rev() {
 855         execute_work_item(&cgcx, work);
 856     }
 857 }
 858
 859 fn run_work_multithreaded(sess: &Session,
 860                           work_items: Vec<WorkItem>,
 861                           num_workers: usize) {
 862     // Run some workers to process the work items.
 863     let work_items_arc = Arc::new(Mutex::new(work_items));
 864     let mut diag_emitter = SharedEmitter::new();
 865     let mut futures = Vec::with_capacity(num_workers);
 866
 867     for i in 0..num_workers {
 868         let work_items_arc = work_items_arc.clone();
 869         let diag_emitter = diag_emitter.clone();
 870         let plugin_passes = sess.plugin_llvm_passes.borrow().clone();
 871         let remark = sess.opts.cg.remark.clone();
 872
 873         let (tx, rx) = channel();
 874         let mut tx = Some(tx);
 875         futures.push(rx);
 876
 877         thread::Builder::new().name(format!("codegen-{}", i)).spawn(move || {
 878             let diag_handler = Handler::with_emitter(true, false, box diag_emitter);
 879
 880             // Must construct cgcx inside the proc because it has non-Send
 881             // fields.
 882             let cgcx = CodegenContext {
 883                 lto_ctxt: None,
 884                 handler: &diag_handler,
 885                 plugin_passes: plugin_passes,
 886                 remark: remark,
 887                 worker: i,
 888             };
 889
 890             loop {
 891                 // Avoid holding the lock for the entire duration of the match.
 892                 let maybe_work = work_items_arc.lock().unwrap().pop();
 893                 match maybe_work {
 894                     Some(work) => {
 895                         execute_work_item(&cgcx, work);
 896
 897                         // Make sure to fail the worker so the main thread can
 898                         // tell that there were errors.
 899                         cgcx.handler.abort_if_errors();
 900                     }
 901                     None => break,
 902                 }
 903             }
 904
 905             tx.take().unwrap().send(()).unwrap();
 906         }).unwrap();
 907     }
 908
 909     let mut panicked = false;
 910     for rx in futures {
 911         match rx.recv() {
 912             Ok(()) => {},
 913             Err(_) => {
 914                 panicked = true;
 915             },
 916         }
 917         // Display any new diagnostics.
 918         diag_emitter.dump(sess.diagnostic());
 919     }
 920     if panicked {
 921         sess.fatal("aborting due to worker thread panic");
 922     }
 923 }
 924
 925 pub fn run_assembler(sess: &Session, outputs: &OutputFilenames) {
 926     let (pname, mut cmd) = get_linker(sess);
 927
 928     cmd.arg("-c").arg("-o").arg(&outputs.path(OutputType::Object))
 929                            .arg(&outputs.temp_path(OutputType::Assembly));
 930     debug!("{:?}", cmd);
 931
 932     match cmd.output() {
 933         Ok(prog) => {
 934             if !prog.status.success() {
 935                 let mut note = prog.stderr.clone();
 936                 note.extend_from_slice(&prog.stdout);
 937
 938                 sess.struct_err(&format!("linking with `{}` failed: {}",
 939                                          pname,
 940                                          prog.status))
 941                     .note(&format!("{:?}", &cmd))
 942                     .note(str::from_utf8(&note[..]).unwrap())
 943                     .emit();
 944                 sess.abort_if_errors();
 945             }
 946         },
 947         Err(e) => {
 948             sess.err(&format!("could not exec the linker `{}`: {}", pname, e));
 949             sess.abort_if_errors();
 950         }
 951     }
 952 }
 953
 954 pub unsafe fn configure_llvm(sess: &Session) {
 955     let mut llvm_c_strs = Vec::new();
 956     let mut llvm_args = Vec::new();
 957
 958     {
 959         let mut add = |arg: &str| {
 960             let s = CString::new(arg).unwrap();
 961             llvm_args.push(s.as_ptr());
 962             llvm_c_strs.push(s);
 963         };
 964         add("rustc"); // fake program name
 965         if sess.time_llvm_passes() { add("-time-passes"); }
 966         if sess.print_llvm_passes() { add("-debug-pass=Structure"); }
 967
 968         // FIXME #21627 disable faulty FastISel on AArch64 (even for -O0)
 969         if sess.target.target.arch == "aarch64" { add("-fast-isel=0"); }
 970
 971         for arg in &sess.opts.cg.llvm_args {
 972             add(&(*arg));
 973         }
 974     }
 975
 976     llvm::LLVMInitializePasses();
 977
 978     llvm::initialize_available_targets();
 979
 980     llvm::LLVMRustSetLLVMOptions(llvm_args.len() as c_int,
 981                                  llvm_args.as_ptr());
 982 }
 983
 984 pub unsafe fn with_llvm_pmb(llmod: ModuleRef,
 985                             config: &ModuleConfig,
 986                             f: &mut FnMut(llvm::PassManagerBuilderRef)) {
 987     // Create the PassManagerBuilder for LLVM. We configure it with
 988     // reasonable defaults and prepare it to actually populate the pass
 989     // manager.
 990     let builder = llvm::LLVMPassManagerBuilderCreate();
 991     let opt = config.opt_level.unwrap_or(llvm::CodeGenLevelNone);
 992     let inline_threshold = config.inline_threshold;
 993
 994     llvm::LLVMRustConfigurePassManagerBuilder(builder, opt,
 995                                               config.merge_functions,
 996                                               config.vectorize_slp,
 997                                               config.vectorize_loop);
 998
 999     llvm::LLVMRustAddBuilderLibraryInfo(builder, llmod, config.no_builtins);
1000
1001     // Here we match what clang does (kinda). For O0 we only inline
1002     // always-inline functions (but don't add lifetime intrinsics), at O1 we
1003     // inline with lifetime intrinsics, and O2+ we add an inliner with a
1004     // thresholds copied from clang.
1005     match (opt, inline_threshold) {
1006         (_, Some(t)) => {
1007             llvm::LLVMPassManagerBuilderUseInlinerWithThreshold(builder, t as u32);
1008         }
1009         (llvm::CodeGenLevelNone, _) => {
1010             llvm::LLVMRustAddAlwaysInlinePass(builder, false);
1011         }
1012         (llvm::CodeGenLevelLess, _) => {
1013             llvm::LLVMRustAddAlwaysInlinePass(builder, true);
1014         }
1015         (llvm::CodeGenLevelDefault, _) => {
1016             llvm::LLVMPassManagerBuilderUseInlinerWithThreshold(builder, 225);
1017         }
1018         (llvm::CodeGenLevelAggressive, _) => {
1019             llvm::LLVMPassManagerBuilderUseInlinerWithThreshold(builder, 275);
1020         }
1021     }
1022
1023     f(builder);
1024     llvm::LLVMPassManagerBuilderDispose(builder);
1025 }