]> git.lizzy.rs Git - rust.git/blob - src/librustc/back/link.rs
auto merge of #13397 : alexcrichton/rust/rollup, r=alexcrichton
[rust.git] / src / librustc / back / link.rs
1 // Copyright 2012-2014 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::archive::{Archive, METADATA_FILENAME};
12 use back::rpath;
13 use back::svh::Svh;
14 use driver::driver::{CrateTranslation, OutputFilenames};
15 use driver::session::{NoDebugInfo, Session};
16 use driver::session;
17 use lib::llvm::llvm;
18 use lib::llvm::ModuleRef;
19 use lib;
20 use metadata::common::LinkMeta;
21 use metadata::{encoder, cstore, filesearch, csearch};
22 use middle::trans::context::CrateContext;
23 use middle::trans::common::gensym_name;
24 use middle::ty;
25 use util::common::time;
26 use util::ppaux;
27 use util::sha2::{Digest, Sha256};
28
29 use std::c_str::{ToCStr, CString};
30 use std::char;
31 use std::os::consts::{macos, freebsd, linux, android, win32};
32 use std::ptr;
33 use std::str;
34 use std::io;
35 use std::io::{fs, TempDir, Process};
36 use flate;
37 use serialize::hex::ToHex;
38 use syntax::abi;
39 use syntax::ast;
40 use syntax::ast_map::{PathElem, PathElems, PathName};
41 use syntax::ast_map;
42 use syntax::attr;
43 use syntax::attr::AttrMetaMethods;
44 use syntax::crateid::CrateId;
45 use syntax::parse::token;
46
47 #[deriving(Clone, Eq, Ord, TotalOrd, TotalEq)]
48 pub enum OutputType {
49     OutputTypeBitcode,
50     OutputTypeAssembly,
51     OutputTypeLlvmAssembly,
52     OutputTypeObject,
53     OutputTypeExe,
54 }
55
56 pub fn llvm_err(sess: &Session, msg: ~str) -> ! {
57     unsafe {
58         let cstr = llvm::LLVMRustGetLastError();
59         if cstr == ptr::null() {
60             sess.fatal(msg);
61         } else {
62             let err = CString::new(cstr, false);
63             let err = str::from_utf8_lossy(err.as_bytes());
64             sess.fatal(msg + ": " + err.as_slice());
65         }
66     }
67 }
68
69 pub fn WriteOutputFile(
70         sess: &Session,
71         target: lib::llvm::TargetMachineRef,
72         pm: lib::llvm::PassManagerRef,
73         m: ModuleRef,
74         output: &Path,
75         file_type: lib::llvm::FileType) {
76     unsafe {
77         output.with_c_str(|output| {
78             let result = llvm::LLVMRustWriteOutputFile(
79                     target, pm, m, output, file_type);
80             if !result {
81                 llvm_err(sess, ~"could not write output");
82             }
83         })
84     }
85 }
86
87 pub mod write {
88
89     use back::lto;
90     use back::link::{WriteOutputFile, OutputType};
91     use back::link::{OutputTypeAssembly, OutputTypeBitcode};
92     use back::link::{OutputTypeExe, OutputTypeLlvmAssembly};
93     use back::link::{OutputTypeObject};
94     use driver::driver::{CrateTranslation, OutputFilenames};
95     use driver::session::{NoDebugInfo, Session};
96     use driver::session;
97     use lib::llvm::llvm;
98     use lib::llvm::{ModuleRef, TargetMachineRef, PassManagerRef};
99     use lib;
100     use util::common::time;
101     use syntax::abi;
102
103     use std::c_str::ToCStr;
104     use std::io::Process;
105     use libc::{c_uint, c_int};
106     use std::str;
107
108     // On android, we by default compile for armv7 processors. This enables
109     // things like double word CAS instructions (rather than emulating them)
110     // which are *far* more efficient. This is obviously undesirable in some
111     // cases, so if any sort of target feature is specified we don't append v7
112     // to the feature list.
113     fn target_feature<'a>(sess: &'a Session) -> &'a str {
114         match sess.targ_cfg.os {
115             abi::OsAndroid => {
116                 if "" == sess.opts.cg.target_feature {
117                     "+v7"
118                 } else {
119                     sess.opts.cg.target_feature.as_slice()
120                 }
121             }
122             _ => sess.opts.cg.target_feature.as_slice()
123         }
124     }
125
126     pub fn run_passes(sess: &Session,
127                       trans: &CrateTranslation,
128                       output_types: &[OutputType],
129                       output: &OutputFilenames) {
130         let llmod = trans.module;
131         let llcx = trans.context;
132         unsafe {
133             configure_llvm(sess);
134
135             if sess.opts.cg.save_temps {
136                 output.with_extension("no-opt.bc").with_c_str(|buf| {
137                     llvm::LLVMWriteBitcodeToFile(llmod, buf);
138                 })
139             }
140
141             let opt_level = match sess.opts.optimize {
142               session::No => lib::llvm::CodeGenLevelNone,
143               session::Less => lib::llvm::CodeGenLevelLess,
144               session::Default => lib::llvm::CodeGenLevelDefault,
145               session::Aggressive => lib::llvm::CodeGenLevelAggressive,
146             };
147             let use_softfp = sess.opts.cg.soft_float;
148
149             // FIXME: #11906: Omitting frame pointers breaks retrieving the value of a parameter.
150             // FIXME: #11954: mac64 unwinding may not work with fp elim
151             let no_fp_elim = (sess.opts.debuginfo != NoDebugInfo) ||
152                              (sess.targ_cfg.os == abi::OsMacos &&
153                               sess.targ_cfg.arch == abi::X86_64);
154
155             let reloc_model = match sess.opts.cg.relocation_model.as_slice() {
156                 "pic" => lib::llvm::RelocPIC,
157                 "static" => lib::llvm::RelocStatic,
158                 "default" => lib::llvm::RelocDefault,
159                 "dynamic-no-pic" => lib::llvm::RelocDynamicNoPic,
160                 _ => {
161                     sess.err(format!("{} is not a valid relocation mode",
162                              sess.opts.cg.relocation_model));
163                     sess.abort_if_errors();
164                     return;
165                 }
166             };
167
168             let tm = sess.targ_cfg.target_strs.target_triple.with_c_str(|t| {
169                 sess.opts.cg.target_cpu.with_c_str(|cpu| {
170                     target_feature(sess).with_c_str(|features| {
171                         llvm::LLVMRustCreateTargetMachine(
172                             t, cpu, features,
173                             lib::llvm::CodeModelDefault,
174                             reloc_model,
175                             opt_level,
176                             true,
177                             use_softfp,
178                             no_fp_elim
179                         )
180                     })
181                 })
182             });
183
184             // Create the two optimizing pass managers. These mirror what clang
185             // does, and are by populated by LLVM's default PassManagerBuilder.
186             // Each manager has a different set of passes, but they also share
187             // some common passes.
188             let fpm = llvm::LLVMCreateFunctionPassManagerForModule(llmod);
189             let mpm = llvm::LLVMCreatePassManager();
190
191             // If we're verifying or linting, add them to the function pass
192             // manager.
193             let addpass = |pass: &str| {
194                 pass.with_c_str(|s| llvm::LLVMRustAddPass(fpm, s))
195             };
196             if !sess.no_verify() { assert!(addpass("verify")); }
197
198             if !sess.opts.cg.no_prepopulate_passes {
199                 llvm::LLVMRustAddAnalysisPasses(tm, fpm, llmod);
200                 llvm::LLVMRustAddAnalysisPasses(tm, mpm, llmod);
201                 populate_llvm_passes(fpm, mpm, llmod, opt_level);
202             }
203
204             for pass in sess.opts.cg.passes.iter() {
205                 pass.with_c_str(|s| {
206                     if !llvm::LLVMRustAddPass(mpm, s) {
207                         sess.warn(format!("unknown pass {}, ignoring", *pass));
208                     }
209                 })
210             }
211
212             // Finally, run the actual optimization passes
213             time(sess.time_passes(), "llvm function passes", (), |()|
214                  llvm::LLVMRustRunFunctionPassManager(fpm, llmod));
215             time(sess.time_passes(), "llvm module passes", (), |()|
216                  llvm::LLVMRunPassManager(mpm, llmod));
217
218             // Deallocate managers that we're now done with
219             llvm::LLVMDisposePassManager(fpm);
220             llvm::LLVMDisposePassManager(mpm);
221
222             // Emit the bytecode if we're either saving our temporaries or
223             // emitting an rlib. Whenever an rlib is created, the bytecode is
224             // inserted into the archive in order to allow LTO against it.
225             if sess.opts.cg.save_temps ||
226                (sess.crate_types.borrow().contains(&session::CrateTypeRlib) &&
227                 sess.opts.output_types.contains(&OutputTypeExe)) {
228                 output.temp_path(OutputTypeBitcode).with_c_str(|buf| {
229                     llvm::LLVMWriteBitcodeToFile(llmod, buf);
230                 })
231             }
232
233             if sess.lto() {
234                 time(sess.time_passes(), "all lto passes", (), |()|
235                      lto::run(sess, llmod, tm, trans.reachable.as_slice()));
236
237                 if sess.opts.cg.save_temps {
238                     output.with_extension("lto.bc").with_c_str(|buf| {
239                         llvm::LLVMWriteBitcodeToFile(llmod, buf);
240                     })
241                 }
242             }
243
244             // A codegen-specific pass manager is used to generate object
245             // files for an LLVM module.
246             //
247             // Apparently each of these pass managers is a one-shot kind of
248             // thing, so we create a new one for each type of output. The
249             // pass manager passed to the closure should be ensured to not
250             // escape the closure itself, and the manager should only be
251             // used once.
252             fn with_codegen(tm: TargetMachineRef, llmod: ModuleRef,
253                             f: |PassManagerRef|) {
254                 unsafe {
255                     let cpm = llvm::LLVMCreatePassManager();
256                     llvm::LLVMRustAddAnalysisPasses(tm, cpm, llmod);
257                     llvm::LLVMRustAddLibraryInfo(cpm, llmod);
258                     f(cpm);
259                     llvm::LLVMDisposePassManager(cpm);
260                 }
261             }
262
263             let mut object_file = None;
264             let mut needs_metadata = false;
265             for output_type in output_types.iter() {
266                 let path = output.path(*output_type);
267                 match *output_type {
268                     OutputTypeBitcode => {
269                         path.with_c_str(|buf| {
270                             llvm::LLVMWriteBitcodeToFile(llmod, buf);
271                         })
272                     }
273                     OutputTypeLlvmAssembly => {
274                         path.with_c_str(|output| {
275                             with_codegen(tm, llmod, |cpm| {
276                                 llvm::LLVMRustPrintModule(cpm, llmod, output);
277                             })
278                         })
279                     }
280                     OutputTypeAssembly => {
281                         // If we're not using the LLVM assembler, this function
282                         // could be invoked specially with output_type_assembly,
283                         // so in this case we still want the metadata object
284                         // file.
285                         let ty = OutputTypeAssembly;
286                         let path = if sess.opts.output_types.contains(&ty) {
287                            path
288                         } else {
289                             needs_metadata = true;
290                             output.temp_path(OutputTypeAssembly)
291                         };
292                         with_codegen(tm, llmod, |cpm| {
293                             WriteOutputFile(sess, tm, cpm, llmod, &path,
294                                             lib::llvm::AssemblyFile);
295                         });
296                     }
297                     OutputTypeObject => {
298                         object_file = Some(path);
299                     }
300                     OutputTypeExe => {
301                         object_file = Some(output.temp_path(OutputTypeObject));
302                         needs_metadata = true;
303                     }
304                 }
305             }
306
307             time(sess.time_passes(), "codegen passes", (), |()| {
308                 match object_file {
309                     Some(ref path) => {
310                         with_codegen(tm, llmod, |cpm| {
311                             WriteOutputFile(sess, tm, cpm, llmod, path,
312                                             lib::llvm::ObjectFile);
313                         });
314                     }
315                     None => {}
316                 }
317                 if needs_metadata {
318                     with_codegen(tm, trans.metadata_module, |cpm| {
319                         let out = output.temp_path(OutputTypeObject)
320                                         .with_extension("metadata.o");
321                         WriteOutputFile(sess, tm, cpm,
322                                         trans.metadata_module, &out,
323                                         lib::llvm::ObjectFile);
324                     })
325                 }
326             });
327
328             llvm::LLVMRustDisposeTargetMachine(tm);
329             llvm::LLVMDisposeModule(trans.metadata_module);
330             llvm::LLVMDisposeModule(llmod);
331             llvm::LLVMContextDispose(llcx);
332             if sess.time_llvm_passes() { llvm::LLVMRustPrintPassTimings(); }
333         }
334     }
335
336     pub fn run_assembler(sess: &Session, outputs: &OutputFilenames) {
337         let cc = super::get_cc_prog(sess);
338         let assembly = outputs.temp_path(OutputTypeAssembly);
339         let object = outputs.path(OutputTypeObject);
340
341         // FIXME (#9639): This needs to handle non-utf8 paths
342         let args = [
343             ~"-c",
344             ~"-o", object.as_str().unwrap().to_owned(),
345             assembly.as_str().unwrap().to_owned()];
346
347         debug!("{} '{}'", cc, args.connect("' '"));
348         match Process::output(cc, args) {
349             Ok(prog) => {
350                 if !prog.status.success() {
351                     sess.err(format!("linking with `{}` failed: {}", cc, prog.status));
352                     sess.note(format!("{} arguments: '{}'", cc, args.connect("' '")));
353                     let mut note = prog.error.clone();
354                     note.push_all(prog.output.as_slice());
355                     sess.note(str::from_utf8(note.as_slice()).unwrap().to_owned());
356                     sess.abort_if_errors();
357                 }
358             },
359             Err(e) => {
360                 sess.err(format!("could not exec the linker `{}`: {}", cc, e));
361                 sess.abort_if_errors();
362             }
363         }
364     }
365
366     unsafe fn configure_llvm(sess: &Session) {
367         use sync::one::{Once, ONCE_INIT};
368         static mut INIT: Once = ONCE_INIT;
369
370         // Copy what clang does by turning on loop vectorization at O2 and
371         // slp vectorization at O3
372         let vectorize_loop = !sess.opts.cg.no_vectorize_loops &&
373                              (sess.opts.optimize == session::Default ||
374                               sess.opts.optimize == session::Aggressive);
375         let vectorize_slp = !sess.opts.cg.no_vectorize_slp &&
376                             sess.opts.optimize == session::Aggressive;
377
378         let mut llvm_c_strs = Vec::new();
379         let mut llvm_args = Vec::new();
380         {
381             let add = |arg: &str| {
382                 let s = arg.to_c_str();
383                 llvm_args.push(s.with_ref(|p| p));
384                 llvm_c_strs.push(s);
385             };
386             add("rustc"); // fake program name
387             if vectorize_loop { add("-vectorize-loops"); }
388             if vectorize_slp  { add("-vectorize-slp");   }
389             if sess.time_llvm_passes() { add("-time-passes"); }
390             if sess.print_llvm_passes() { add("-debug-pass=Structure"); }
391
392             for arg in sess.opts.cg.llvm_args.iter() {
393                 add(*arg);
394             }
395         }
396
397         INIT.doit(|| {
398             llvm::LLVMInitializePasses();
399
400             // Only initialize the platforms supported by Rust here, because
401             // using --llvm-root will have multiple platforms that rustllvm
402             // doesn't actually link to and it's pointless to put target info
403             // into the registry that Rust cannot generate machine code for.
404             llvm::LLVMInitializeX86TargetInfo();
405             llvm::LLVMInitializeX86Target();
406             llvm::LLVMInitializeX86TargetMC();
407             llvm::LLVMInitializeX86AsmPrinter();
408             llvm::LLVMInitializeX86AsmParser();
409
410             llvm::LLVMInitializeARMTargetInfo();
411             llvm::LLVMInitializeARMTarget();
412             llvm::LLVMInitializeARMTargetMC();
413             llvm::LLVMInitializeARMAsmPrinter();
414             llvm::LLVMInitializeARMAsmParser();
415
416             llvm::LLVMInitializeMipsTargetInfo();
417             llvm::LLVMInitializeMipsTarget();
418             llvm::LLVMInitializeMipsTargetMC();
419             llvm::LLVMInitializeMipsAsmPrinter();
420             llvm::LLVMInitializeMipsAsmParser();
421
422             llvm::LLVMRustSetLLVMOptions(llvm_args.len() as c_int,
423                                          llvm_args.as_ptr());
424         });
425     }
426
427     unsafe fn populate_llvm_passes(fpm: lib::llvm::PassManagerRef,
428                                    mpm: lib::llvm::PassManagerRef,
429                                    llmod: ModuleRef,
430                                    opt: lib::llvm::CodeGenOptLevel) {
431         // Create the PassManagerBuilder for LLVM. We configure it with
432         // reasonable defaults and prepare it to actually populate the pass
433         // manager.
434         let builder = llvm::LLVMPassManagerBuilderCreate();
435         match opt {
436             lib::llvm::CodeGenLevelNone => {
437                 // Don't add lifetime intrinsics at O0
438                 llvm::LLVMRustAddAlwaysInlinePass(builder, false);
439             }
440             lib::llvm::CodeGenLevelLess => {
441                 llvm::LLVMRustAddAlwaysInlinePass(builder, true);
442             }
443             // numeric values copied from clang
444             lib::llvm::CodeGenLevelDefault => {
445                 llvm::LLVMPassManagerBuilderUseInlinerWithThreshold(builder,
446                                                                     225);
447             }
448             lib::llvm::CodeGenLevelAggressive => {
449                 llvm::LLVMPassManagerBuilderUseInlinerWithThreshold(builder,
450                                                                     275);
451             }
452         }
453         llvm::LLVMPassManagerBuilderSetOptLevel(builder, opt as c_uint);
454         llvm::LLVMRustAddBuilderLibraryInfo(builder, llmod);
455
456         // Use the builder to populate the function/module pass managers.
457         llvm::LLVMPassManagerBuilderPopulateFunctionPassManager(builder, fpm);
458         llvm::LLVMPassManagerBuilderPopulateModulePassManager(builder, mpm);
459         llvm::LLVMPassManagerBuilderDispose(builder);
460     }
461 }
462
463
464 /*
465  * Name mangling and its relationship to metadata. This is complex. Read
466  * carefully.
467  *
468  * The semantic model of Rust linkage is, broadly, that "there's no global
469  * namespace" between crates. Our aim is to preserve the illusion of this
470  * model despite the fact that it's not *quite* possible to implement on
471  * modern linkers. We initially didn't use system linkers at all, but have
472  * been convinced of their utility.
473  *
474  * There are a few issues to handle:
475  *
476  *  - Linkers operate on a flat namespace, so we have to flatten names.
477  *    We do this using the C++ namespace-mangling technique. Foo::bar
478  *    symbols and such.
479  *
480  *  - Symbols with the same name but different types need to get different
481  *    linkage-names. We do this by hashing a string-encoding of the type into
482  *    a fixed-size (currently 16-byte hex) cryptographic hash function (CHF:
483  *    we use SHA256) to "prevent collisions". This is not airtight but 16 hex
484  *    digits on uniform probability means you're going to need 2**32 same-name
485  *    symbols in the same process before you're even hitting birthday-paradox
486  *    collision probability.
487  *
488  *  - Symbols in different crates but with same names "within" the crate need
489  *    to get different linkage-names.
490  *
491  *  - The hash shown in the filename needs to be predictable and stable for
492  *    build tooling integration. It also needs to be using a hash function
493  *    which is easy to use from Python, make, etc.
494  *
495  * So here is what we do:
496  *
497  *  - Consider the package id; every crate has one (specified with crate_id
498  *    attribute).  If a package id isn't provided explicitly, we infer a
499  *    versionless one from the output name. The version will end up being 0.0
500  *    in this case. CNAME and CVERS are taken from this package id. For
501  *    example, github.com/mozilla/CNAME#CVERS.
502  *
503  *  - Define CMH as SHA256(crateid).
504  *
505  *  - Define CMH8 as the first 8 characters of CMH.
506  *
507  *  - Compile our crate to lib CNAME-CMH8-CVERS.so
508  *
509  *  - Define STH(sym) as SHA256(CMH, type_str(sym))
510  *
511  *  - Suffix a mangled sym with ::STH@CVERS, so that it is unique in the
512  *    name, non-name metadata, and type sense, and versioned in the way
513  *    system linkers understand.
514  */
515
516 pub fn find_crate_id(attrs: &[ast::Attribute], out_filestem: &str) -> CrateId {
517     match attr::find_crateid(attrs) {
518         None => from_str(out_filestem).unwrap(),
519         Some(s) => s,
520     }
521 }
522
523 pub fn crate_id_hash(crate_id: &CrateId) -> ~str {
524     // This calculates CMH as defined above. Note that we don't use the path of
525     // the crate id in the hash because lookups are only done by (name/vers),
526     // not by path.
527     let mut s = Sha256::new();
528     s.input_str(crate_id.short_name_with_version());
529     truncated_hash_result(&mut s).slice_to(8).to_owned()
530 }
531
532 pub fn build_link_meta(krate: &ast::Crate, out_filestem: &str) -> LinkMeta {
533     let r = LinkMeta {
534         crateid: find_crate_id(krate.attrs.as_slice(), out_filestem),
535         crate_hash: Svh::calculate(krate),
536     };
537     info!("{}", r);
538     return r;
539 }
540
541 fn truncated_hash_result(symbol_hasher: &mut Sha256) -> ~str {
542     let output = symbol_hasher.result_bytes();
543     // 64 bits should be enough to avoid collisions.
544     output.slice_to(8).to_hex()
545 }
546
547
548 // This calculates STH for a symbol, as defined above
549 fn symbol_hash(tcx: &ty::ctxt, symbol_hasher: &mut Sha256,
550                t: ty::t, link_meta: &LinkMeta) -> ~str {
551     // NB: do *not* use abbrevs here as we want the symbol names
552     // to be independent of one another in the crate.
553
554     symbol_hasher.reset();
555     symbol_hasher.input_str(link_meta.crateid.name);
556     symbol_hasher.input_str("-");
557     symbol_hasher.input_str(link_meta.crate_hash.as_str());
558     symbol_hasher.input_str("-");
559     symbol_hasher.input_str(encoder::encoded_ty(tcx, t));
560     let mut hash = truncated_hash_result(symbol_hasher);
561     // Prefix with 'h' so that it never blends into adjacent digits
562     hash.unshift_char('h');
563     hash
564 }
565
566 fn get_symbol_hash(ccx: &CrateContext, t: ty::t) -> ~str {
567     match ccx.type_hashcodes.borrow().find(&t) {
568         Some(h) => return h.to_str(),
569         None => {}
570     }
571
572     let mut symbol_hasher = ccx.symbol_hasher.borrow_mut();
573     let hash = symbol_hash(ccx.tcx(), &mut *symbol_hasher, t, &ccx.link_meta);
574     ccx.type_hashcodes.borrow_mut().insert(t, hash.clone());
575     hash
576 }
577
578
579 // Name sanitation. LLVM will happily accept identifiers with weird names, but
580 // gas doesn't!
581 // gas accepts the following characters in symbols: a-z, A-Z, 0-9, ., _, $
582 pub fn sanitize(s: &str) -> ~str {
583     let mut result = ~"";
584     for c in s.chars() {
585         match c {
586             // Escape these with $ sequences
587             '@' => result.push_str("$SP$"),
588             '~' => result.push_str("$UP$"),
589             '*' => result.push_str("$RP$"),
590             '&' => result.push_str("$BP$"),
591             '<' => result.push_str("$LT$"),
592             '>' => result.push_str("$GT$"),
593             '(' => result.push_str("$LP$"),
594             ')' => result.push_str("$RP$"),
595             ',' => result.push_str("$C$"),
596
597             // '.' doesn't occur in types and functions, so reuse it
598             // for ':' and '-'
599             '-' | ':' => result.push_char('.'),
600
601             // These are legal symbols
602             'a' .. 'z'
603             | 'A' .. 'Z'
604             | '0' .. '9'
605             | '_' | '.' | '$' => result.push_char(c),
606
607             _ => {
608                 let mut tstr = ~"";
609                 char::escape_unicode(c, |c| tstr.push_char(c));
610                 result.push_char('$');
611                 result.push_str(tstr.slice_from(1));
612             }
613         }
614     }
615
616     // Underscore-qualify anything that didn't start as an ident.
617     if result.len() > 0u &&
618         result[0] != '_' as u8 &&
619         ! char::is_XID_start(result[0] as char) {
620         return ~"_" + result;
621     }
622
623     return result;
624 }
625
626 pub fn mangle<PI: Iterator<PathElem>>(mut path: PI,
627                                       hash: Option<&str>,
628                                       vers: Option<&str>) -> ~str {
629     // Follow C++ namespace-mangling style, see
630     // http://en.wikipedia.org/wiki/Name_mangling for more info.
631     //
632     // It turns out that on OSX you can actually have arbitrary symbols in
633     // function names (at least when given to LLVM), but this is not possible
634     // when using unix's linker. Perhaps one day when we just use a linker from LLVM
635     // we won't need to do this name mangling. The problem with name mangling is
636     // that it seriously limits the available characters. For example we can't
637     // have things like &T or ~[T] in symbol names when one would theoretically
638     // want them for things like impls of traits on that type.
639     //
640     // To be able to work on all platforms and get *some* reasonable output, we
641     // use C++ name-mangling.
642
643     let mut n = ~"_ZN"; // _Z == Begin name-sequence, N == nested
644
645     fn push(n: &mut ~str, s: &str) {
646         let sani = sanitize(s);
647         n.push_str(format!("{}{}", sani.len(), sani));
648     }
649
650     // First, connect each component with <len, name> pairs.
651     for e in path {
652         push(&mut n, token::get_name(e.name()).get().as_slice())
653     }
654
655     match hash {
656         Some(s) => push(&mut n, s),
657         None => {}
658     }
659     match vers {
660         Some(s) => push(&mut n, s),
661         None => {}
662     }
663
664     n.push_char('E'); // End name-sequence.
665     n
666 }
667
668 pub fn exported_name(path: PathElems, hash: &str, vers: &str) -> ~str {
669     // The version will get mangled to have a leading '_', but it makes more
670     // sense to lead with a 'v' b/c this is a version...
671     let vers = if vers.len() > 0 && !char::is_XID_start(vers.char_at(0)) {
672         "v" + vers
673     } else {
674         vers.to_owned()
675     };
676
677     mangle(path, Some(hash), Some(vers.as_slice()))
678 }
679
680 pub fn mangle_exported_name(ccx: &CrateContext, path: PathElems,
681                             t: ty::t, id: ast::NodeId) -> ~str {
682     let mut hash = get_symbol_hash(ccx, t);
683
684     // Paths can be completely identical for different nodes,
685     // e.g. `fn foo() { { fn a() {} } { fn a() {} } }`, so we
686     // generate unique characters from the node id. For now
687     // hopefully 3 characters is enough to avoid collisions.
688     static EXTRA_CHARS: &'static str =
689         "abcdefghijklmnopqrstuvwxyz\
690          ABCDEFGHIJKLMNOPQRSTUVWXYZ\
691          0123456789";
692     let id = id as uint;
693     let extra1 = id % EXTRA_CHARS.len();
694     let id = id / EXTRA_CHARS.len();
695     let extra2 = id % EXTRA_CHARS.len();
696     let id = id / EXTRA_CHARS.len();
697     let extra3 = id % EXTRA_CHARS.len();
698     hash.push_char(EXTRA_CHARS[extra1] as char);
699     hash.push_char(EXTRA_CHARS[extra2] as char);
700     hash.push_char(EXTRA_CHARS[extra3] as char);
701
702     exported_name(path, hash, ccx.link_meta.crateid.version_or_default())
703 }
704
705 pub fn mangle_internal_name_by_type_and_seq(ccx: &CrateContext,
706                                             t: ty::t,
707                                             name: &str) -> ~str {
708     let s = ppaux::ty_to_str(ccx.tcx(), t);
709     let path = [PathName(token::intern(s)),
710                 gensym_name(name)];
711     let hash = get_symbol_hash(ccx, t);
712     mangle(ast_map::Values(path.iter()), Some(hash.as_slice()), None)
713 }
714
715 pub fn mangle_internal_name_by_path_and_seq(path: PathElems, flav: &str) -> ~str {
716     mangle(path.chain(Some(gensym_name(flav)).move_iter()), None, None)
717 }
718
719 pub fn output_lib_filename(id: &CrateId) -> ~str {
720     format!("{}-{}-{}", id.name, crate_id_hash(id), id.version_or_default())
721 }
722
723 pub fn get_cc_prog(sess: &Session) -> ~str {
724     match sess.opts.cg.linker {
725         Some(ref linker) => return linker.to_owned(),
726         None => {}
727     }
728
729     // In the future, FreeBSD will use clang as default compiler.
730     // It would be flexible to use cc (system's default C compiler)
731     // instead of hard-coded gcc.
732     // For win32, there is no cc command, so we add a condition to make it use gcc.
733     match sess.targ_cfg.os {
734         abi::OsWin32 => return ~"gcc",
735         _ => {},
736     }
737
738     get_system_tool(sess, "cc")
739 }
740
741 pub fn get_ar_prog(sess: &Session) -> ~str {
742     match sess.opts.cg.ar {
743         Some(ref ar) => return ar.to_owned(),
744         None => {}
745     }
746
747     get_system_tool(sess, "ar")
748 }
749
750 fn get_system_tool(sess: &Session, tool: &str) -> ~str {
751     match sess.targ_cfg.os {
752         abi::OsAndroid => match sess.opts.cg.android_cross_path {
753             Some(ref path) => {
754                 let tool_str = match tool {
755                     "cc" => "gcc",
756                     _ => tool
757                 };
758                 format!("{}/bin/arm-linux-androideabi-{}", *path, tool_str)
759             }
760             None => {
761                 sess.fatal(format!("need Android NDK path for the '{}' tool \
762                                     (-C android-cross-path)", tool))
763             }
764         },
765         _ => tool.to_owned(),
766     }
767 }
768
769 fn remove(sess: &Session, path: &Path) {
770     match fs::unlink(path) {
771         Ok(..) => {}
772         Err(e) => {
773             sess.err(format!("failed to remove {}: {}", path.display(), e));
774         }
775     }
776 }
777
778 /// Perform the linkage portion of the compilation phase. This will generate all
779 /// of the requested outputs for this compilation session.
780 pub fn link_binary(sess: &Session,
781                    trans: &CrateTranslation,
782                    outputs: &OutputFilenames,
783                    id: &CrateId) -> Vec<Path> {
784     let mut out_filenames = Vec::new();
785     for &crate_type in sess.crate_types.borrow().iter() {
786         let out_file = link_binary_output(sess, trans, crate_type, outputs, id);
787         out_filenames.push(out_file);
788     }
789
790     // Remove the temporary object file and metadata if we aren't saving temps
791     if !sess.opts.cg.save_temps {
792         let obj_filename = outputs.temp_path(OutputTypeObject);
793         if !sess.opts.output_types.contains(&OutputTypeObject) {
794             remove(sess, &obj_filename);
795         }
796         remove(sess, &obj_filename.with_extension("metadata.o"));
797     }
798
799     out_filenames
800 }
801
802 fn is_writeable(p: &Path) -> bool {
803     match p.stat() {
804         Err(..) => true,
805         Ok(m) => m.perm & io::UserWrite == io::UserWrite
806     }
807 }
808
809 pub fn filename_for_input(sess: &Session, crate_type: session::CrateType,
810                           id: &CrateId, out_filename: &Path) -> Path {
811     let libname = output_lib_filename(id);
812     match crate_type {
813         session::CrateTypeRlib => {
814             out_filename.with_filename(format!("lib{}.rlib", libname))
815         }
816         session::CrateTypeDylib => {
817             let (prefix, suffix) = match sess.targ_cfg.os {
818                 abi::OsWin32 => (win32::DLL_PREFIX, win32::DLL_SUFFIX),
819                 abi::OsMacos => (macos::DLL_PREFIX, macos::DLL_SUFFIX),
820                 abi::OsLinux => (linux::DLL_PREFIX, linux::DLL_SUFFIX),
821                 abi::OsAndroid => (android::DLL_PREFIX, android::DLL_SUFFIX),
822                 abi::OsFreebsd => (freebsd::DLL_PREFIX, freebsd::DLL_SUFFIX),
823             };
824             out_filename.with_filename(format!("{}{}{}", prefix, libname, suffix))
825         }
826         session::CrateTypeStaticlib => {
827             out_filename.with_filename(format!("lib{}.a", libname))
828         }
829         session::CrateTypeExecutable => out_filename.clone(),
830     }
831 }
832
833 fn link_binary_output(sess: &Session,
834                       trans: &CrateTranslation,
835                       crate_type: session::CrateType,
836                       outputs: &OutputFilenames,
837                       id: &CrateId) -> Path {
838     let obj_filename = outputs.temp_path(OutputTypeObject);
839     let out_filename = match outputs.single_output_file {
840         Some(ref file) => file.clone(),
841         None => {
842             let out_filename = outputs.path(OutputTypeExe);
843             filename_for_input(sess, crate_type, id, &out_filename)
844         }
845     };
846
847     // Make sure the output and obj_filename are both writeable.
848     // Mac, FreeBSD, and Windows system linkers check this already --
849     // however, the Linux linker will happily overwrite a read-only file.
850     // We should be consistent.
851     let obj_is_writeable = is_writeable(&obj_filename);
852     let out_is_writeable = is_writeable(&out_filename);
853     if !out_is_writeable {
854         sess.fatal(format!("output file {} is not writeable -- check its permissions.",
855                            out_filename.display()));
856     }
857     else if !obj_is_writeable {
858         sess.fatal(format!("object file {} is not writeable -- check its permissions.",
859                            obj_filename.display()));
860     }
861
862     match crate_type {
863         session::CrateTypeRlib => {
864             link_rlib(sess, Some(trans), &obj_filename, &out_filename);
865         }
866         session::CrateTypeStaticlib => {
867             link_staticlib(sess, &obj_filename, &out_filename);
868         }
869         session::CrateTypeExecutable => {
870             link_natively(sess, false, &obj_filename, &out_filename);
871         }
872         session::CrateTypeDylib => {
873             link_natively(sess, true, &obj_filename, &out_filename);
874         }
875     }
876
877     out_filename
878 }
879
880 // Create an 'rlib'
881 //
882 // An rlib in its current incarnation is essentially a renamed .a file. The
883 // rlib primarily contains the object file of the crate, but it also contains
884 // all of the object files from native libraries. This is done by unzipping
885 // native libraries and inserting all of the contents into this archive.
886 fn link_rlib<'a>(sess: &'a Session,
887                  trans: Option<&CrateTranslation>, // None == no metadata/bytecode
888                  obj_filename: &Path,
889                  out_filename: &Path) -> Archive<'a> {
890     let mut a = Archive::create(sess, out_filename, obj_filename);
891
892     for &(ref l, kind) in sess.cstore.get_used_libraries().borrow().iter() {
893         match kind {
894             cstore::NativeStatic => {
895                 a.add_native_library(l.as_slice()).unwrap();
896             }
897             cstore::NativeFramework | cstore::NativeUnknown => {}
898         }
899     }
900
901     // Note that it is important that we add all of our non-object "magical
902     // files" *after* all of the object files in the archive. The reason for
903     // this is as follows:
904     //
905     // * When performing LTO, this archive will be modified to remove
906     //   obj_filename from above. The reason for this is described below.
907     //
908     // * When the system linker looks at an archive, it will attempt to
909     //   determine the architecture of the archive in order to see whether its
910     //   linkable.
911     //
912     //   The algorithm for this detection is: iterate over the files in the
913     //   archive. Skip magical SYMDEF names. Interpret the first file as an
914     //   object file. Read architecture from the object file.
915     //
916     // * As one can probably see, if "metadata" and "foo.bc" were placed
917     //   before all of the objects, then the architecture of this archive would
918     //   not be correctly inferred once 'foo.o' is removed.
919     //
920     // Basically, all this means is that this code should not move above the
921     // code above.
922     match trans {
923         Some(trans) => {
924             // Instead of putting the metadata in an object file section, rlibs
925             // contain the metadata in a separate file. We use a temp directory
926             // here so concurrent builds in the same directory don't try to use
927             // the same filename for metadata (stomping over one another)
928             let tmpdir = TempDir::new("rustc").expect("needs a temp dir");
929             let metadata = tmpdir.path().join(METADATA_FILENAME);
930             match fs::File::create(&metadata).write(trans.metadata
931                                                          .as_slice()) {
932                 Ok(..) => {}
933                 Err(e) => {
934                     sess.err(format!("failed to write {}: {}",
935                                      metadata.display(), e));
936                     sess.abort_if_errors();
937                 }
938             }
939             a.add_file(&metadata, false);
940             remove(sess, &metadata);
941
942             // For LTO purposes, the bytecode of this library is also inserted
943             // into the archive.
944             let bc = obj_filename.with_extension("bc");
945             let bc_deflated = obj_filename.with_extension("bc.deflate");
946             match fs::File::open(&bc).read_to_end().and_then(|data| {
947                 fs::File::create(&bc_deflated)
948                     .write(match flate::deflate_bytes(data.as_slice()) {
949                         Some(compressed) => compressed,
950                         None => sess.fatal("failed to compress bytecode")
951                      }.as_slice())
952             }) {
953                 Ok(()) => {}
954                 Err(e) => {
955                     sess.err(format!("failed to write compressed bytecode: {}", e));
956                     sess.abort_if_errors()
957                 }
958             }
959             a.add_file(&bc_deflated, false);
960             remove(sess, &bc_deflated);
961             if !sess.opts.cg.save_temps &&
962                !sess.opts.output_types.contains(&OutputTypeBitcode) {
963                 remove(sess, &bc);
964             }
965
966             // After adding all files to the archive, we need to update the
967             // symbol table of the archive. This currently dies on OSX (see
968             // #11162), and isn't necessary there anyway
969             match sess.targ_cfg.os {
970                 abi::OsMacos => {}
971                 _ => { a.update_symbols(); }
972             }
973         }
974
975         None => {}
976     }
977     return a;
978 }
979
980 // Create a static archive
981 //
982 // This is essentially the same thing as an rlib, but it also involves adding
983 // all of the upstream crates' objects into the archive. This will slurp in
984 // all of the native libraries of upstream dependencies as well.
985 //
986 // Additionally, there's no way for us to link dynamic libraries, so we warn
987 // about all dynamic library dependencies that they're not linked in.
988 //
989 // There's no need to include metadata in a static archive, so ensure to not
990 // link in the metadata object file (and also don't prepare the archive with a
991 // metadata file).
992 fn link_staticlib(sess: &Session, obj_filename: &Path, out_filename: &Path) {
993     let mut a = link_rlib(sess, None, obj_filename, out_filename);
994     a.add_native_library("morestack").unwrap();
995     a.add_native_library("compiler-rt").unwrap();
996
997     let crates = sess.cstore.get_used_crates(cstore::RequireStatic);
998     for &(cnum, ref path) in crates.iter() {
999         let name = sess.cstore.get_crate_data(cnum).name.clone();
1000         let p = match *path {
1001             Some(ref p) => p.clone(), None => {
1002                 sess.err(format!("could not find rlib for: `{}`", name));
1003                 continue
1004             }
1005         };
1006         a.add_rlib(&p, name, sess.lto()).unwrap();
1007         let native_libs = csearch::get_native_libraries(&sess.cstore, cnum);
1008         for &(kind, ref lib) in native_libs.iter() {
1009             let name = match kind {
1010                 cstore::NativeStatic => "static library",
1011                 cstore::NativeUnknown => "library",
1012                 cstore::NativeFramework => "framework",
1013             };
1014             sess.warn(format!("unlinked native {}: {}", name, *lib));
1015         }
1016     }
1017 }
1018
1019 // Create a dynamic library or executable
1020 //
1021 // This will invoke the system linker/cc to create the resulting file. This
1022 // links to all upstream files as well.
1023 fn link_natively(sess: &Session, dylib: bool, obj_filename: &Path,
1024                  out_filename: &Path) {
1025     let tmpdir = TempDir::new("rustc").expect("needs a temp dir");
1026     // The invocations of cc share some flags across platforms
1027     let cc_prog = get_cc_prog(sess);
1028     let mut cc_args = sess.targ_cfg.target_strs.cc_args.clone();
1029     cc_args.push_all_move(link_args(sess, dylib, tmpdir.path(),
1030                                     obj_filename, out_filename));
1031     if (sess.opts.debugging_opts & session::PRINT_LINK_ARGS) != 0 {
1032         println!("{} link args: '{}'", cc_prog, cc_args.connect("' '"));
1033     }
1034
1035     // May have not found libraries in the right formats.
1036     sess.abort_if_errors();
1037
1038     // Invoke the system linker
1039     debug!("{} {}", cc_prog, cc_args.connect(" "));
1040     let prog = time(sess.time_passes(), "running linker", (), |()|
1041                     Process::output(cc_prog, cc_args.as_slice()));
1042     match prog {
1043         Ok(prog) => {
1044             if !prog.status.success() {
1045                 sess.err(format!("linking with `{}` failed: {}", cc_prog, prog.status));
1046                 sess.note(format!("{} arguments: '{}'", cc_prog, cc_args.connect("' '")));
1047                 let mut output = prog.error.clone();
1048                 output.push_all(prog.output.as_slice());
1049                 sess.note(str::from_utf8(output.as_slice()).unwrap().to_owned());
1050                 sess.abort_if_errors();
1051             }
1052         },
1053         Err(e) => {
1054             sess.err(format!("could not exec the linker `{}`: {}", cc_prog, e));
1055             sess.abort_if_errors();
1056         }
1057     }
1058
1059
1060     // On OSX, debuggers need this utility to get run to do some munging of
1061     // the symbols
1062     if sess.targ_cfg.os == abi::OsMacos && (sess.opts.debuginfo != NoDebugInfo) {
1063         // FIXME (#9639): This needs to handle non-utf8 paths
1064         match Process::status("dsymutil",
1065                                   [out_filename.as_str().unwrap().to_owned()]) {
1066             Ok(..) => {}
1067             Err(e) => {
1068                 sess.err(format!("failed to run dsymutil: {}", e));
1069                 sess.abort_if_errors();
1070             }
1071         }
1072     }
1073 }
1074
1075 fn link_args(sess: &Session,
1076              dylib: bool,
1077              tmpdir: &Path,
1078              obj_filename: &Path,
1079              out_filename: &Path) -> Vec<~str> {
1080
1081     // The default library location, we need this to find the runtime.
1082     // The location of crates will be determined as needed.
1083     // FIXME (#9639): This needs to handle non-utf8 paths
1084     let lib_path = sess.filesearch().get_target_lib_path();
1085     let stage: ~str = ~"-L" + lib_path.as_str().unwrap();
1086
1087     let mut args = vec!(stage);
1088
1089     // FIXME (#9639): This needs to handle non-utf8 paths
1090     args.push_all([
1091         ~"-o", out_filename.as_str().unwrap().to_owned(),
1092         obj_filename.as_str().unwrap().to_owned()]);
1093
1094     // Stack growth requires statically linking a __morestack function. Note
1095     // that this is listed *before* all other libraries, even though it may be
1096     // used to resolve symbols in other libraries. The only case that this
1097     // wouldn't be pulled in by the object file is if the object file had no
1098     // functions.
1099     //
1100     // If we're building an executable, there must be at least one function (the
1101     // main function), and if we're building a dylib then we don't need it for
1102     // later libraries because they're all dylibs (not rlibs).
1103     //
1104     // I'm honestly not entirely sure why this needs to come first. Apparently
1105     // the --as-needed flag above sometimes strips out libstd from the command
1106     // line, but inserting this farther to the left makes the
1107     // "rust_stack_exhausted" symbol an outstanding undefined symbol, which
1108     // flags libstd as a required library (or whatever provides the symbol).
1109     args.push(~"-lmorestack");
1110
1111     // When linking a dynamic library, we put the metadata into a section of the
1112     // executable. This metadata is in a separate object file from the main
1113     // object file, so we link that in here.
1114     if dylib {
1115         let metadata = obj_filename.with_extension("metadata.o");
1116         args.push(metadata.as_str().unwrap().to_owned());
1117     }
1118
1119     // We want to prevent the compiler from accidentally leaking in any system
1120     // libraries, so we explicitly ask gcc to not link to any libraries by
1121     // default. Note that this does not happen for windows because windows pulls
1122     // in some large number of libraries and I couldn't quite figure out which
1123     // subset we wanted.
1124     //
1125     // FIXME(#11937) we should invoke the system linker directly
1126     if sess.targ_cfg.os != abi::OsWin32 {
1127         args.push(~"-nodefaultlibs");
1128     }
1129
1130     if sess.targ_cfg.os == abi::OsLinux {
1131         // GNU-style linkers will use this to omit linking to libraries which
1132         // don't actually fulfill any relocations, but only for libraries which
1133         // follow this flag. Thus, use it before specifying libraries to link to.
1134         args.push(~"-Wl,--as-needed");
1135
1136         // GNU-style linkers support optimization with -O. --gc-sections
1137         // removes metadata and potentially other useful things, so don't
1138         // include it. GNU ld doesn't need a numeric argument, but other linkers
1139         // do.
1140         if sess.opts.optimize == session::Default ||
1141            sess.opts.optimize == session::Aggressive {
1142             args.push(~"-Wl,-O1");
1143         }
1144     }
1145
1146     if sess.targ_cfg.os == abi::OsWin32 {
1147         // Make sure that we link to the dynamic libgcc, otherwise cross-module
1148         // DWARF stack unwinding will not work.
1149         // This behavior may be overridden by --link-args "-static-libgcc"
1150         args.push(~"-shared-libgcc");
1151
1152         // And here, we see obscure linker flags #45. On windows, it has been
1153         // found to be necessary to have this flag to compile liblibc.
1154         //
1155         // First a bit of background. On Windows, the file format is not ELF,
1156         // but COFF (at least according to LLVM). COFF doesn't officially allow
1157         // for section names over 8 characters, apparently. Our metadata
1158         // section, ".note.rustc", you'll note is over 8 characters.
1159         //
1160         // On more recent versions of gcc on mingw, apparently the section name
1161         // is *not* truncated, but rather stored elsewhere in a separate lookup
1162         // table. On older versions of gcc, they apparently always truncated the
1163         // section names (at least in some cases). Truncating the section name
1164         // actually creates "invalid" objects [1] [2], but only for some
1165         // introspection tools, not in terms of whether it can be loaded.
1166         //
1167         // Long story shory, passing this flag forces the linker to *not*
1168         // truncate section names (so we can find the metadata section after
1169         // it's compiled). The real kicker is that rust compiled just fine on
1170         // windows for quite a long time *without* this flag, so I have no idea
1171         // why it suddenly started failing for liblibc. Regardless, we
1172         // definitely don't want section name truncation, so we're keeping this
1173         // flag for windows.
1174         //
1175         // [1] - https://sourceware.org/bugzilla/show_bug.cgi?id=13130
1176         // [2] - https://code.google.com/p/go/issues/detail?id=2139
1177         args.push(~"-Wl,--enable-long-section-names");
1178     }
1179
1180     if sess.targ_cfg.os == abi::OsAndroid {
1181         // Many of the symbols defined in compiler-rt are also defined in libgcc.
1182         // Android linker doesn't like that by default.
1183         args.push(~"-Wl,--allow-multiple-definition");
1184     }
1185
1186     // Take careful note of the ordering of the arguments we pass to the linker
1187     // here. Linkers will assume that things on the left depend on things to the
1188     // right. Things on the right cannot depend on things on the left. This is
1189     // all formally implemented in terms of resolving symbols (libs on the right
1190     // resolve unknown symbols of libs on the left, but not vice versa).
1191     //
1192     // For this reason, we have organized the arguments we pass to the linker as
1193     // such:
1194     //
1195     //  1. The local object that LLVM just generated
1196     //  2. Upstream rust libraries
1197     //  3. Local native libraries
1198     //  4. Upstream native libraries
1199     //
1200     // This is generally fairly natural, but some may expect 2 and 3 to be
1201     // swapped. The reason that all native libraries are put last is that it's
1202     // not recommended for a native library to depend on a symbol from a rust
1203     // crate. If this is the case then a staticlib crate is recommended, solving
1204     // the problem.
1205     //
1206     // Additionally, it is occasionally the case that upstream rust libraries
1207     // depend on a local native library. In the case of libraries such as
1208     // lua/glfw/etc the name of the library isn't the same across all platforms,
1209     // so only the consumer crate of a library knows the actual name. This means
1210     // that downstream crates will provide the #[link] attribute which upstream
1211     // crates will depend on. Hence local native libraries are after out
1212     // upstream rust crates.
1213     //
1214     // In theory this means that a symbol in an upstream native library will be
1215     // shadowed by a local native library when it wouldn't have been before, but
1216     // this kind of behavior is pretty platform specific and generally not
1217     // recommended anyway, so I don't think we're shooting ourself in the foot
1218     // much with that.
1219     add_upstream_rust_crates(&mut args, sess, dylib, tmpdir);
1220     add_local_native_libraries(&mut args, sess);
1221     add_upstream_native_libraries(&mut args, sess);
1222
1223     // # Telling the linker what we're doing
1224
1225     if dylib {
1226         // On mac we need to tell the linker to let this library be rpathed
1227         if sess.targ_cfg.os == abi::OsMacos {
1228             args.push(~"-dynamiclib");
1229             args.push(~"-Wl,-dylib");
1230             // FIXME (#9639): This needs to handle non-utf8 paths
1231             if !sess.opts.cg.no_rpath {
1232                 args.push(~"-Wl,-install_name,@rpath/" +
1233                           out_filename.filename_str().unwrap());
1234             }
1235         } else {
1236             args.push(~"-shared")
1237         }
1238     }
1239
1240     if sess.targ_cfg.os == abi::OsFreebsd {
1241         args.push_all([~"-L/usr/local/lib",
1242                        ~"-L/usr/local/lib/gcc46",
1243                        ~"-L/usr/local/lib/gcc44"]);
1244     }
1245
1246     // FIXME (#2397): At some point we want to rpath our guesses as to
1247     // where extern libraries might live, based on the
1248     // addl_lib_search_paths
1249     if !sess.opts.cg.no_rpath {
1250         args.push_all(rpath::get_rpath_flags(sess, out_filename).as_slice());
1251     }
1252
1253     // compiler-rt contains implementations of low-level LLVM helpers. This is
1254     // used to resolve symbols from the object file we just created, as well as
1255     // any system static libraries that may be expecting gcc instead. Most
1256     // symbols in libgcc also appear in compiler-rt.
1257     //
1258     // This is the end of the command line, so this library is used to resolve
1259     // *all* undefined symbols in all other libraries, and this is intentional.
1260     args.push(~"-lcompiler-rt");
1261
1262     // Finally add all the linker arguments provided on the command line along
1263     // with any #[link_args] attributes found inside the crate
1264     args.push_all(sess.opts.cg.link_args.as_slice());
1265     for arg in sess.cstore.get_used_link_args().borrow().iter() {
1266         args.push(arg.clone());
1267     }
1268     return args;
1269 }
1270
1271 // # Native library linking
1272 //
1273 // User-supplied library search paths (-L on the command line). These are
1274 // the same paths used to find Rust crates, so some of them may have been
1275 // added already by the previous crate linking code. This only allows them
1276 // to be found at compile time so it is still entirely up to outside
1277 // forces to make sure that library can be found at runtime.
1278 //
1279 // Also note that the native libraries linked here are only the ones located
1280 // in the current crate. Upstream crates with native library dependencies
1281 // may have their native library pulled in above.
1282 fn add_local_native_libraries(args: &mut Vec<~str>, sess: &Session) {
1283     for path in sess.opts.addl_lib_search_paths.borrow().iter() {
1284         // FIXME (#9639): This needs to handle non-utf8 paths
1285         args.push("-L" + path.as_str().unwrap().to_owned());
1286     }
1287
1288     let rustpath = filesearch::rust_path();
1289     for path in rustpath.iter() {
1290         // FIXME (#9639): This needs to handle non-utf8 paths
1291         args.push("-L" + path.as_str().unwrap().to_owned());
1292     }
1293
1294     for &(ref l, kind) in sess.cstore.get_used_libraries().borrow().iter() {
1295         match kind {
1296             cstore::NativeUnknown | cstore::NativeStatic => {
1297                 args.push("-l" + *l);
1298             }
1299             cstore::NativeFramework => {
1300                 args.push(~"-framework");
1301                 args.push(l.to_owned());
1302             }
1303         }
1304     }
1305 }
1306
1307 // # Rust Crate linking
1308 //
1309 // Rust crates are not considered at all when creating an rlib output. All
1310 // dependencies will be linked when producing the final output (instead of
1311 // the intermediate rlib version)
1312 fn add_upstream_rust_crates(args: &mut Vec<~str>, sess: &Session,
1313                             dylib: bool, tmpdir: &Path) {
1314
1315     // As a limitation of the current implementation, we require that everything
1316     // must be static or everything must be dynamic. The reasons for this are a
1317     // little subtle, but as with staticlibs and rlibs, the goal is to prevent
1318     // duplicate copies of the same library showing up. For example, a static
1319     // immediate dependency might show up as an upstream dynamic dependency and
1320     // we currently have no way of knowing that. We know that all dynamic
1321     // libraries require dynamic dependencies (see above), so it's satisfactory
1322     // to include either all static libraries or all dynamic libraries.
1323     //
1324     // With this limitation, we expose a compiler default linkage type and an
1325     // option to reverse that preference. The current behavior looks like:
1326     //
1327     // * If a dylib is being created, upstream dependencies must be dylibs
1328     // * If nothing else is specified, static linking is preferred
1329     // * If the -C prefer-dynamic flag is given, dynamic linking is preferred
1330     // * If one form of linking fails, the second is also attempted
1331     // * If both forms fail, then we emit an error message
1332
1333     let dynamic = get_deps(&sess.cstore, cstore::RequireDynamic);
1334     let statik = get_deps(&sess.cstore, cstore::RequireStatic);
1335     match (dynamic, statik, sess.opts.cg.prefer_dynamic, dylib) {
1336         (_, Some(deps), false, false) => {
1337             add_static_crates(args, sess, tmpdir, deps)
1338         }
1339
1340         (None, Some(deps), true, false) => {
1341             // If you opted in to dynamic linking and we decided to emit a
1342             // static output, you should probably be notified of such an event!
1343             sess.warn("dynamic linking was preferred, but dependencies \
1344                        could not all be found in an dylib format.");
1345             sess.warn("linking statically instead, using rlibs");
1346             add_static_crates(args, sess, tmpdir, deps)
1347         }
1348
1349         (Some(deps), _, _, _) => add_dynamic_crates(args, sess, deps),
1350
1351         (None, _, _, true) => {
1352             sess.err("dylib output requested, but some depenencies could not \
1353                       be found in the dylib format");
1354             let deps = sess.cstore.get_used_crates(cstore::RequireDynamic);
1355             for (cnum, path) in deps.move_iter() {
1356                 if path.is_some() { continue }
1357                 let name = sess.cstore.get_crate_data(cnum).name.clone();
1358                 sess.note(format!("dylib not found: {}", name));
1359             }
1360         }
1361
1362         (None, None, pref, false) => {
1363             let (pref, name) = if pref {
1364                 sess.err("dynamic linking is preferred, but dependencies were \
1365                           not found in either dylib or rlib format");
1366                 (cstore::RequireDynamic, "dylib")
1367             } else {
1368                 sess.err("dependencies were not all found in either dylib or \
1369                           rlib format");
1370                 (cstore::RequireStatic, "rlib")
1371             };
1372             sess.note(format!("dependencies not found in the `{}` format",
1373                               name));
1374             for (cnum, path) in sess.cstore.get_used_crates(pref).move_iter() {
1375                 if path.is_some() { continue }
1376                 let name = sess.cstore.get_crate_data(cnum).name.clone();
1377                 sess.note(name);
1378             }
1379         }
1380     }
1381
1382     // Converts a library file-stem into a cc -l argument
1383     fn unlib(config: &session::Config, stem: &str) -> ~str {
1384         if stem.starts_with("lib") && config.os != abi::OsWin32 {
1385             stem.slice(3, stem.len()).to_owned()
1386         } else {
1387             stem.to_owned()
1388         }
1389     }
1390
1391     // Attempts to find all dependencies with a certain linkage preference,
1392     // returning `None` if not all libraries could be found with that
1393     // preference.
1394     fn get_deps(cstore: &cstore::CStore,  preference: cstore::LinkagePreference)
1395             -> Option<Vec<(ast::CrateNum, Path)> >
1396     {
1397         let crates = cstore.get_used_crates(preference);
1398         if crates.iter().all(|&(_, ref p)| p.is_some()) {
1399             Some(crates.move_iter().map(|(a, b)| (a, b.unwrap())).collect())
1400         } else {
1401             None
1402         }
1403     }
1404
1405     // Adds the static "rlib" versions of all crates to the command line.
1406     fn add_static_crates(args: &mut Vec<~str>, sess: &Session, tmpdir: &Path,
1407                          crates: Vec<(ast::CrateNum, Path)>) {
1408         for (cnum, cratepath) in crates.move_iter() {
1409             // When performing LTO on an executable output, all of the
1410             // bytecode from the upstream libraries has already been
1411             // included in our object file output. We need to modify all of
1412             // the upstream archives to remove their corresponding object
1413             // file to make sure we don't pull the same code in twice.
1414             //
1415             // We must continue to link to the upstream archives to be sure
1416             // to pull in native static dependencies. As the final caveat,
1417             // on linux it is apparently illegal to link to a blank archive,
1418             // so if an archive no longer has any object files in it after
1419             // we remove `lib.o`, then don't link against it at all.
1420             //
1421             // If we're not doing LTO, then our job is simply to just link
1422             // against the archive.
1423             if sess.lto() {
1424                 let name = sess.cstore.get_crate_data(cnum).name.clone();
1425                 time(sess.time_passes(), format!("altering {}.rlib", name),
1426                      (), |()| {
1427                     let dst = tmpdir.join(cratepath.filename().unwrap());
1428                     match fs::copy(&cratepath, &dst) {
1429                         Ok(..) => {}
1430                         Err(e) => {
1431                             sess.err(format!("failed to copy {} to {}: {}",
1432                                              cratepath.display(),
1433                                              dst.display(),
1434                                              e));
1435                             sess.abort_if_errors();
1436                         }
1437                     }
1438                     let dst_str = dst.as_str().unwrap().to_owned();
1439                     let mut archive = Archive::open(sess, dst);
1440                     archive.remove_file(format!("{}.o", name));
1441                     let files = archive.files();
1442                     if files.iter().any(|s| s.ends_with(".o")) {
1443                         args.push(dst_str);
1444                     }
1445                 });
1446             } else {
1447                 args.push(cratepath.as_str().unwrap().to_owned());
1448             }
1449         }
1450     }
1451
1452     // Same thing as above, but for dynamic crates instead of static crates.
1453     fn add_dynamic_crates(args: &mut Vec<~str>, sess: &Session,
1454                           crates: Vec<(ast::CrateNum, Path)> ) {
1455         // If we're performing LTO, then it should have been previously required
1456         // that all upstream rust dependencies were available in an rlib format.
1457         assert!(!sess.lto());
1458
1459         for (_, cratepath) in crates.move_iter() {
1460             // Just need to tell the linker about where the library lives and
1461             // what its name is
1462             let dir = cratepath.dirname_str().unwrap();
1463             if !dir.is_empty() { args.push("-L" + dir); }
1464             let libarg = unlib(&sess.targ_cfg, cratepath.filestem_str().unwrap());
1465             args.push("-l" + libarg);
1466         }
1467     }
1468 }
1469
1470 // Link in all of our upstream crates' native dependencies. Remember that
1471 // all of these upstream native depenencies are all non-static
1472 // dependencies. We've got two cases then:
1473 //
1474 // 1. The upstream crate is an rlib. In this case we *must* link in the
1475 //    native dependency because the rlib is just an archive.
1476 //
1477 // 2. The upstream crate is a dylib. In order to use the dylib, we have to
1478 //    have the dependency present on the system somewhere. Thus, we don't
1479 //    gain a whole lot from not linking in the dynamic dependency to this
1480 //    crate as well.
1481 //
1482 // The use case for this is a little subtle. In theory the native
1483 // dependencies of a crate a purely an implementation detail of the crate
1484 // itself, but the problem arises with generic and inlined functions. If a
1485 // generic function calls a native function, then the generic function must
1486 // be instantiated in the target crate, meaning that the native symbol must
1487 // also be resolved in the target crate.
1488 fn add_upstream_native_libraries(args: &mut Vec<~str>, sess: &Session) {
1489     let cstore = &sess.cstore;
1490     cstore.iter_crate_data(|cnum, _| {
1491         let libs = csearch::get_native_libraries(cstore, cnum);
1492         for &(kind, ref lib) in libs.iter() {
1493             match kind {
1494                 cstore::NativeUnknown => args.push("-l" + *lib),
1495                 cstore::NativeFramework => {
1496                     args.push(~"-framework");
1497                     args.push(lib.to_owned());
1498                 }
1499                 cstore::NativeStatic => {
1500                     sess.bug("statics shouldn't be propagated");
1501                 }
1502             }
1503         }
1504     });
1505 }