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