1 // Copyright 2012-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.
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.
11 //! Validates all used crates and extern libraries and loads their metadata
13 use cstore::{self, CStore, CrateSource, MetadataBlob};
14 use locator::{self, CratePaths};
15 use schema::CrateRoot;
17 use rustc::hir::def_id::{CrateNum, DefIndex};
18 use rustc::hir::svh::Svh;
19 use rustc::middle::cstore::DepKind;
20 use rustc::session::Session;
21 use rustc::session::config::{Sanitizer, self};
22 use rustc_back::PanicStrategy;
23 use rustc::session::search_paths::PathKind;
25 use rustc::middle::cstore::{CrateStore, validate_crate_name, ExternCrate};
26 use rustc::util::common::record_time;
27 use rustc::util::nodemap::FxHashSet;
28 use rustc::middle::cstore::NativeLibrary;
29 use rustc::hir::map::Definitions;
31 use std::cell::{RefCell, Cell};
33 use std::path::PathBuf;
40 use syntax::ext::base::SyntaxExtension;
41 use syntax::feature_gate::{self, GateIssue};
42 use syntax::symbol::Symbol;
43 use syntax_pos::{Span, DUMMY_SP};
47 pub dylib: Option<(PathBuf, PathKind)>,
48 pub rlib: Option<(PathBuf, PathKind)>,
49 pub rmeta: Option<(PathBuf, PathKind)>,
50 pub metadata: MetadataBlob,
53 pub struct CrateLoader<'a> {
54 pub sess: &'a Session,
56 next_crate_num: CrateNum,
57 local_crate_name: Symbol,
60 fn dump_crates(cstore: &CStore) {
61 info!("resolved crates:");
62 cstore.iter_crate_data(|_, data| {
63 info!(" name: {}", data.name());
64 info!(" cnum: {}", data.cnum);
65 info!(" hash: {}", data.hash());
66 info!(" reqd: {:?}", data.dep_kind.get());
67 let CrateSource { dylib, rlib, rmeta } = data.source.clone();
68 dylib.map(|dl| info!(" dylib: {}", dl.0.display()));
69 rlib.map(|rl| info!(" rlib: {}", rl.0.display()));
70 rmeta.map(|rl| info!(" rmeta: {}", rl.0.display()));
75 struct ExternCrateInfo {
82 fn register_native_lib(sess: &Session,
86 if lib.name.as_str().is_empty() {
89 struct_span_err!(sess, span, E0454,
90 "#[link(name = \"\")] given with empty name")
91 .span_label(span, &format!("empty name given"))
95 sess.err("empty library name given via `-l`");
100 let is_osx = sess.target.target.options.is_like_osx;
101 if lib.kind == cstore::NativeFramework && !is_osx {
102 let msg = "native frameworks are only available on OSX targets";
104 Some(span) => span_err!(sess, span, E0455, "{}", msg),
105 None => sess.err(msg),
108 if lib.cfg.is_some() && !sess.features.borrow().link_cfg {
109 feature_gate::emit_feature_err(&sess.parse_sess,
115 if lib.kind == cstore::NativeStaticNobundle && !sess.features.borrow().static_nobundle {
116 feature_gate::emit_feature_err(&sess.parse_sess,
120 "kind=\"static-nobundle\" is feature gated");
122 cstore.add_used_library(lib);
125 fn relevant_lib(sess: &Session, lib: &NativeLibrary) -> bool {
127 Some(ref cfg) => attr::cfg_matches(cfg, &sess.parse_sess, None),
132 // Extra info about a crate loaded for plugins or exported macros.
133 struct ExtensionCrate {
135 dylib: Option<PathBuf>,
140 Registered(Rc<cstore::CrateMetadata>),
144 impl Deref for PMDSource {
145 type Target = MetadataBlob;
147 fn deref(&self) -> &MetadataBlob {
149 PMDSource::Registered(ref cmd) => &cmd.blob,
150 PMDSource::Owned(ref lib) => &lib.metadata
160 impl<'a> CrateLoader<'a> {
161 pub fn new(sess: &'a Session, cstore: &'a CStore, local_crate_name: &str) -> Self {
165 next_crate_num: cstore.next_crate_num(),
166 local_crate_name: Symbol::intern(local_crate_name),
170 fn extract_crate_info(&self, i: &ast::Item) -> Option<ExternCrateInfo> {
172 ast::ItemKind::ExternCrate(ref path_opt) => {
173 debug!("resolving extern crate stmt. ident: {} path_opt: {:?}",
175 let name = match *path_opt {
177 validate_crate_name(Some(self.sess), &name.as_str(),
181 None => i.ident.name,
183 Some(ExternCrateInfo {
187 dep_kind: if attr::contains_name(&i.attrs, "no_link") {
188 DepKind::UnexportedMacrosOnly
198 fn existing_match(&self, name: Symbol, hash: Option<&Svh>, kind: PathKind)
199 -> Option<CrateNum> {
201 self.cstore.iter_crate_data(|cnum, data| {
202 if data.name != name { return }
205 Some(hash) if *hash == data.hash() => { ret = Some(cnum); return }
210 // When the hash is None we're dealing with a top-level dependency
211 // in which case we may have a specification on the command line for
212 // this library. Even though an upstream library may have loaded
213 // something of the same name, we have to make sure it was loaded
214 // from the exact same location as well.
216 // We're also sure to compare *paths*, not actual byte slices. The
217 // `source` stores paths which are normalized which may be different
218 // from the strings on the command line.
219 let source = self.cstore.used_crate_source(cnum);
220 if let Some(locs) = self.sess.opts.externs.get(&*name.as_str()) {
221 let found = locs.iter().any(|l| {
222 let l = fs::canonicalize(l).ok();
223 source.dylib.as_ref().map(|p| &p.0) == l.as_ref() ||
224 source.rlib.as_ref().map(|p| &p.0) == l.as_ref()
232 // Alright, so we've gotten this far which means that `data` has the
233 // right name, we don't have a hash, and we don't have a --extern
234 // pointing for ourselves. We're still not quite yet done because we
235 // have to make sure that this crate was found in the crate lookup
236 // path (this is a top-level dependency) as we don't want to
237 // implicitly load anything inside the dependency lookup path.
238 let prev_kind = source.dylib.as_ref().or(source.rlib.as_ref())
240 if ret.is_none() && (prev_kind == kind || prev_kind == PathKind::All) {
247 fn verify_no_symbol_conflicts(&self,
250 // Check for (potential) conflicts with the local crate
251 if self.local_crate_name == root.name &&
252 self.sess.local_crate_disambiguator() == root.disambiguator {
253 span_fatal!(self.sess, span, E0519,
254 "the current crate is indistinguishable from one of its \
255 dependencies: it has the same crate-name `{}` and was \
256 compiled with the same `-C metadata` arguments. This \
257 will result in symbol conflicts between the two.",
261 // Check for conflicts with any crate loaded so far
262 self.cstore.iter_crate_data(|_, other| {
263 if other.name() == root.name && // same crate-name
264 other.disambiguator() == root.disambiguator && // same crate-disambiguator
265 other.hash() != root.hash { // but different SVH
266 span_fatal!(self.sess, span, E0523,
267 "found two different crates with name `{}` that are \
268 not distinguished by differing `-C metadata`. This \
269 will result in symbol conflicts between the two.",
275 fn register_crate(&mut self,
276 root: &Option<CratePaths>,
282 -> (CrateNum, Rc<cstore::CrateMetadata>) {
283 info!("register crate `extern crate {} as {}`", name, ident);
284 let crate_root = lib.metadata.get_root();
285 self.verify_no_symbol_conflicts(span, &crate_root);
287 // Claim this crate number and cache it
288 let cnum = self.next_crate_num;
289 self.next_crate_num = CrateNum::from_u32(cnum.as_u32() + 1);
291 // Stash paths for top-most crate locally if necessary.
292 let crate_paths = if root.is_none() {
294 ident: ident.to_string(),
295 dylib: lib.dylib.clone().map(|p| p.0),
296 rlib: lib.rlib.clone().map(|p| p.0),
297 rmeta: lib.rmeta.clone().map(|p| p.0),
302 // Maintain a reference to the top most crate.
303 let root = if root.is_some() { root } else { &crate_paths };
305 let Library { dylib, rlib, rmeta, metadata } = lib;
307 let cnum_map = self.resolve_crate_deps(root, &crate_root, &metadata, cnum, span, dep_kind);
309 let def_path_table = record_time(&self.sess.perf_stats.decode_def_path_tables_time, || {
310 crate_root.def_path_table.decode(&metadata)
313 let exported_symbols = crate_root.exported_symbols.decode(&metadata).collect();
315 let mut cmeta = cstore::CrateMetadata {
317 extern_crate: Cell::new(None),
318 def_path_table: def_path_table,
319 exported_symbols: exported_symbols,
320 proc_macros: crate_root.macro_derive_registrar.map(|_| {
321 self.load_derive_macros(&crate_root, dylib.clone().map(|p| p.0), span)
325 cnum_map: RefCell::new(cnum_map),
327 codemap_import_info: RefCell::new(vec![]),
328 dep_kind: Cell::new(dep_kind),
329 source: cstore::CrateSource {
334 dllimport_foreign_items: FxHashSet(),
337 let dllimports: Vec<_> = cmeta.get_native_libraries().iter()
338 .filter(|lib| relevant_lib(self.sess, lib) &&
339 lib.kind == cstore::NativeLibraryKind::NativeUnknown)
340 .flat_map(|lib| &lib.foreign_items)
343 cmeta.dllimport_foreign_items.extend(dllimports);
345 let cmeta = Rc::new(cmeta);
346 self.cstore.set_crate_data(cnum, cmeta.clone());
350 fn resolve_crate(&mut self,
351 root: &Option<CratePaths>,
357 mut dep_kind: DepKind)
358 -> (CrateNum, Rc<cstore::CrateMetadata>) {
359 info!("resolving crate `extern crate {} as {}`", name, ident);
360 let result = if let Some(cnum) = self.existing_match(name, hash, path_kind) {
361 LoadResult::Previous(cnum)
363 info!("falling back to a load");
364 let mut locate_ctxt = locator::Context {
369 hash: hash.map(|a| &*a),
370 filesearch: self.sess.target_filesearch(path_kind),
371 target: &self.sess.target.target,
372 triple: &self.sess.opts.target_triple,
374 rejected_via_hash: vec![],
375 rejected_via_triple: vec![],
376 rejected_via_kind: vec![],
377 rejected_via_version: vec![],
378 rejected_via_filename: vec![],
379 should_match_name: true,
380 is_proc_macro: Some(false),
383 self.load(&mut locate_ctxt).or_else(|| {
384 dep_kind = DepKind::UnexportedMacrosOnly;
386 let mut proc_macro_locator = locator::Context {
387 target: &self.sess.host,
388 triple: config::host_triple(),
389 filesearch: self.sess.host_filesearch(path_kind),
390 rejected_via_hash: vec![],
391 rejected_via_triple: vec![],
392 rejected_via_kind: vec![],
393 rejected_via_version: vec![],
394 rejected_via_filename: vec![],
395 is_proc_macro: Some(true),
399 self.load(&mut proc_macro_locator)
400 }).unwrap_or_else(|| locate_ctxt.report_errs())
404 LoadResult::Previous(cnum) => {
405 let data = self.cstore.get_crate_data(cnum);
406 if data.root.macro_derive_registrar.is_some() {
407 dep_kind = DepKind::UnexportedMacrosOnly;
409 data.dep_kind.set(cmp::max(data.dep_kind.get(), dep_kind));
412 LoadResult::Loaded(library) => {
413 self.register_crate(root, ident, name, span, library, dep_kind)
418 fn load(&mut self, locate_ctxt: &mut locator::Context) -> Option<LoadResult> {
419 let library = match locate_ctxt.maybe_load_library_crate() {
424 // In the case that we're loading a crate, but not matching
425 // against a hash, we could load a crate which has the same hash
426 // as an already loaded crate. If this is the case prevent
427 // duplicates by just using the first crate.
429 // Note that we only do this for target triple crates, though, as we
430 // don't want to match a host crate against an equivalent target one
432 let root = library.metadata.get_root();
433 if locate_ctxt.triple == self.sess.opts.target_triple {
434 let mut result = LoadResult::Loaded(library);
435 self.cstore.iter_crate_data(|cnum, data| {
436 if data.name() == root.name && root.hash == data.hash() {
437 assert!(locate_ctxt.hash.is_none());
438 info!("load success, going to previous cnum: {}", cnum);
439 result = LoadResult::Previous(cnum);
444 Some(LoadResult::Loaded(library))
448 fn update_extern_crate(&mut self,
450 mut extern_crate: ExternCrate,
451 visited: &mut FxHashSet<(CrateNum, bool)>)
453 if !visited.insert((cnum, extern_crate.direct)) { return }
455 let cmeta = self.cstore.get_crate_data(cnum);
456 let old_extern_crate = cmeta.extern_crate.get();
459 // - something over nothing (tuple.0);
460 // - direct extern crate to indirect (tuple.1);
461 // - shorter paths to longer (tuple.2).
462 let new_rank = (true, extern_crate.direct, !extern_crate.path_len);
463 let old_rank = match old_extern_crate {
464 None => (false, false, !0),
465 Some(ref c) => (true, c.direct, !c.path_len),
468 if old_rank >= new_rank {
469 return; // no change needed
472 cmeta.extern_crate.set(Some(extern_crate));
473 // Propagate the extern crate info to dependencies.
474 extern_crate.direct = false;
475 for &dep_cnum in cmeta.cnum_map.borrow().iter() {
476 self.update_extern_crate(dep_cnum, extern_crate, visited);
480 // Go through the crate metadata and load any crates that it references
481 fn resolve_crate_deps(&mut self,
482 root: &Option<CratePaths>,
483 crate_root: &CrateRoot,
484 metadata: &MetadataBlob,
488 -> cstore::CrateNumMap {
489 debug!("resolving deps of external crate");
490 if crate_root.macro_derive_registrar.is_some() {
491 return cstore::CrateNumMap::new();
494 // The map from crate numbers in the crate we're resolving to local crate numbers.
495 // We map 0 and all other holes in the map to our parent crate. The "additional"
496 // self-dependencies should be harmless.
497 ::std::iter::once(krate).chain(crate_root.crate_deps.decode(metadata).map(|dep| {
498 debug!("resolving dep crate {} hash: `{}`", dep.name, dep.hash);
499 if dep.kind == DepKind::UnexportedMacrosOnly {
502 let dep_kind = match dep_kind {
503 DepKind::MacrosOnly => DepKind::MacrosOnly,
506 let (local_cnum, ..) = self.resolve_crate(
507 root, dep.name, dep.name, Some(&dep.hash), span, PathKind::Dependency, dep_kind,
513 fn read_extension_crate(&mut self, span: Span, info: &ExternCrateInfo) -> ExtensionCrate {
514 info!("read extension crate {} `extern crate {} as {}` dep_kind={:?}",
515 info.id, info.name, info.ident, info.dep_kind);
516 let target_triple = &self.sess.opts.target_triple[..];
517 let is_cross = target_triple != config::host_triple();
518 let mut target_only = false;
519 let mut locate_ctxt = locator::Context {
523 crate_name: info.name,
525 filesearch: self.sess.host_filesearch(PathKind::Crate),
526 target: &self.sess.host,
527 triple: config::host_triple(),
529 rejected_via_hash: vec![],
530 rejected_via_triple: vec![],
531 rejected_via_kind: vec![],
532 rejected_via_version: vec![],
533 rejected_via_filename: vec![],
534 should_match_name: true,
537 let library = self.load(&mut locate_ctxt).or_else(|| {
541 // Try loading from target crates. This will abort later if we
542 // try to load a plugin registrar function,
545 locate_ctxt.target = &self.sess.target.target;
546 locate_ctxt.triple = target_triple;
547 locate_ctxt.filesearch = self.sess.target_filesearch(PathKind::Crate);
549 self.load(&mut locate_ctxt)
551 let library = match library {
553 None => locate_ctxt.report_errs(),
556 let (dylib, metadata) = match library {
557 LoadResult::Previous(cnum) => {
558 let data = self.cstore.get_crate_data(cnum);
559 (data.source.dylib.clone(), PMDSource::Registered(data))
561 LoadResult::Loaded(library) => {
562 let dylib = library.dylib.clone();
563 let metadata = PMDSource::Owned(library);
570 dylib: dylib.map(|p| p.0),
571 target_only: target_only,
575 /// Load custom derive macros.
577 /// Note that this is intentionally similar to how we load plugins today,
578 /// but also intentionally separate. Plugins are likely always going to be
579 /// implemented as dynamic libraries, but we have a possible future where
580 /// custom derive (and other macro-1.1 style features) are implemented via
581 /// executables and custom IPC.
582 fn load_derive_macros(&mut self, root: &CrateRoot, dylib: Option<PathBuf>, span: Span)
583 -> Vec<(ast::Name, Rc<SyntaxExtension>)> {
585 use proc_macro::TokenStream;
586 use proc_macro::__internal::Registry;
587 use rustc_back::dynamic_lib::DynamicLibrary;
588 use syntax_ext::deriving::custom::ProcMacroDerive;
589 use syntax_ext::proc_macro_impl::AttrProcMacro;
591 let path = match dylib {
592 Some(dylib) => dylib,
593 None => span_bug!(span, "proc-macro crate not dylib"),
595 // Make sure the path contains a / or the linker will search for it.
596 let path = env::current_dir().unwrap().join(path);
597 let lib = match DynamicLibrary::open(Some(&path)) {
599 Err(err) => self.sess.span_fatal(span, &err),
602 let sym = self.sess.generate_derive_registrar_symbol(&root.hash,
603 root.macro_derive_registrar.unwrap());
604 let registrar = unsafe {
605 let sym = match lib.symbol(&sym) {
607 Err(err) => self.sess.span_fatal(span, &err),
609 mem::transmute::<*mut u8, fn(&mut Registry)>(sym)
612 struct MyRegistrar(Vec<(ast::Name, Rc<SyntaxExtension>)>);
614 impl Registry for MyRegistrar {
615 fn register_custom_derive(&mut self,
617 expand: fn(TokenStream) -> TokenStream,
618 attributes: &[&'static str]) {
619 let attrs = attributes.iter().cloned().map(Symbol::intern).collect();
620 let derive = SyntaxExtension::ProcMacroDerive(
621 Box::new(ProcMacroDerive::new(expand, attrs))
623 self.0.push((Symbol::intern(trait_name), Rc::new(derive)));
626 fn register_attr_proc_macro(&mut self,
628 expand: fn(TokenStream, TokenStream) -> TokenStream) {
629 let expand = SyntaxExtension::AttrProcMacro(
630 Box::new(AttrProcMacro { inner: expand })
632 self.0.push((Symbol::intern(name), Rc::new(expand)));
636 let mut my_registrar = MyRegistrar(Vec::new());
637 registrar(&mut my_registrar);
639 // Intentionally leak the dynamic library. We can't ever unload it
640 // since the library can make things that will live arbitrarily long.
645 /// Look for a plugin registrar. Returns library path, crate
646 /// SVH and DefIndex of the registrar function.
647 pub fn find_plugin_registrar(&mut self, span: Span, name: &str)
648 -> Option<(PathBuf, Svh, DefIndex)> {
649 let ekrate = self.read_extension_crate(span, &ExternCrateInfo {
650 name: Symbol::intern(name),
651 ident: Symbol::intern(name),
652 id: ast::DUMMY_NODE_ID,
653 dep_kind: DepKind::UnexportedMacrosOnly,
656 if ekrate.target_only {
657 // Need to abort before syntax expansion.
658 let message = format!("plugin `{}` is not available for triple `{}` \
661 config::host_triple(),
662 self.sess.opts.target_triple);
663 span_fatal!(self.sess, span, E0456, "{}", &message[..]);
666 let root = ekrate.metadata.get_root();
667 match (ekrate.dylib.as_ref(), root.plugin_registrar_fn) {
668 (Some(dylib), Some(reg)) => {
669 Some((dylib.to_path_buf(), root.hash, reg))
672 span_err!(self.sess, span, E0457,
673 "plugin `{}` only found in rlib format, but must be available \
676 // No need to abort because the loading code will just ignore this
684 fn get_foreign_items_of_kind(&self, kind: cstore::NativeLibraryKind) -> Vec<DefIndex> {
685 let mut items = vec![];
686 let libs = self.cstore.get_used_libraries();
687 for lib in libs.borrow().iter() {
688 if relevant_lib(self.sess, lib) && lib.kind == kind {
689 items.extend(&lib.foreign_items);
695 fn register_statically_included_foreign_items(&mut self) {
696 for id in self.get_foreign_items_of_kind(cstore::NativeStatic) {
697 self.cstore.add_statically_included_foreign_item(id);
699 for id in self.get_foreign_items_of_kind(cstore::NativeStaticNobundle) {
700 self.cstore.add_statically_included_foreign_item(id);
704 fn register_dllimport_foreign_items(&mut self) {
705 let mut dllimports = self.cstore.dllimport_foreign_items.borrow_mut();
706 for id in self.get_foreign_items_of_kind(cstore::NativeUnknown) {
707 dllimports.insert(id);
711 fn inject_panic_runtime(&mut self, krate: &ast::Crate) {
712 // If we're only compiling an rlib, then there's no need to select a
713 // panic runtime, so we just skip this section entirely.
714 let any_non_rlib = self.sess.crate_types.borrow().iter().any(|ct| {
715 *ct != config::CrateTypeRlib
718 info!("panic runtime injection skipped, only generating rlib");
722 // If we need a panic runtime, we try to find an existing one here. At
723 // the same time we perform some general validation of the DAG we've got
724 // going such as ensuring everything has a compatible panic strategy.
726 // The logic for finding the panic runtime here is pretty much the same
727 // as the allocator case with the only addition that the panic strategy
728 // compilation mode also comes into play.
729 let desired_strategy = self.sess.panic_strategy();
730 let mut runtime_found = false;
731 let mut needs_panic_runtime = attr::contains_name(&krate.attrs,
732 "needs_panic_runtime");
733 self.cstore.iter_crate_data(|cnum, data| {
734 needs_panic_runtime = needs_panic_runtime || data.needs_panic_runtime();
735 if data.is_panic_runtime() {
736 // Inject a dependency from all #![needs_panic_runtime] to this
737 // #![panic_runtime] crate.
738 self.inject_dependency_if(cnum, "a panic runtime",
739 &|data| data.needs_panic_runtime());
740 runtime_found = runtime_found || data.dep_kind.get() == DepKind::Explicit;
744 // If an explicitly linked and matching panic runtime was found, or if
745 // we just don't need one at all, then we're done here and there's
746 // nothing else to do.
747 if !needs_panic_runtime || runtime_found {
751 // By this point we know that we (a) need a panic runtime and (b) no
752 // panic runtime was explicitly linked. Here we just load an appropriate
753 // default runtime for our panic strategy and then inject the
756 // We may resolve to an already loaded crate (as the crate may not have
757 // been explicitly linked prior to this) and we may re-inject
758 // dependencies again, but both of those situations are fine.
760 // Also note that we have yet to perform validation of the crate graph
761 // in terms of everyone has a compatible panic runtime format, that's
762 // performed later as part of the `dependency_format` module.
763 let name = match desired_strategy {
764 PanicStrategy::Unwind => Symbol::intern("panic_unwind"),
765 PanicStrategy::Abort => Symbol::intern("panic_abort"),
767 info!("panic runtime not found -- loading {}", name);
769 let dep_kind = DepKind::Implicit;
771 self.resolve_crate(&None, name, name, None, DUMMY_SP, PathKind::Crate, dep_kind);
773 // Sanity check the loaded crate to ensure it is indeed a panic runtime
774 // and the panic strategy is indeed what we thought it was.
775 if !data.is_panic_runtime() {
776 self.sess.err(&format!("the crate `{}` is not a panic runtime",
779 if data.panic_strategy() != desired_strategy {
780 self.sess.err(&format!("the crate `{}` does not have the panic \
782 name, desired_strategy.desc()));
785 self.sess.injected_panic_runtime.set(Some(cnum));
786 self.inject_dependency_if(cnum, "a panic runtime",
787 &|data| data.needs_panic_runtime());
790 fn inject_sanitizer_runtime(&mut self) {
791 if let Some(ref sanitizer) = self.sess.opts.debugging_opts.sanitizer {
792 // Sanitizers can only be used with x86_64 Linux executables linked
794 if self.sess.target.target.llvm_target != "x86_64-unknown-linux-gnu" {
795 self.sess.err(&format!("Sanitizers only work with the \
796 `x86_64-unknown-linux-gnu` target."));
800 if !self.sess.crate_types.borrow().iter().all(|ct| {
803 config::CrateTypeExecutable => true,
804 // This crate will be compiled with the required
805 // instrumentation pass
806 config::CrateTypeRlib => false,
808 self.sess.err(&format!("Only executables and rlibs can be \
809 compiled with `-Z sanitizer`"));
817 let mut uses_std = false;
818 self.cstore.iter_crate_data(|_, data| {
819 if data.name == "std" {
825 let name = match *sanitizer {
826 Sanitizer::Address => "rustc_asan",
827 Sanitizer::Leak => "rustc_lsan",
828 Sanitizer::Memory => "rustc_msan",
829 Sanitizer::Thread => "rustc_tsan",
831 info!("loading sanitizer: {}", name);
833 let symbol = Symbol::intern(name);
834 let dep_kind = DepKind::Implicit;
836 self.resolve_crate(&None, symbol, symbol, None, DUMMY_SP,
837 PathKind::Crate, dep_kind);
839 // Sanity check the loaded crate to ensure it is indeed a sanitizer runtime
840 if !data.is_sanitizer_runtime() {
841 self.sess.err(&format!("the crate `{}` is not a sanitizer runtime",
848 fn inject_allocator_crate(&mut self) {
849 // Make sure that we actually need an allocator, if none of our
850 // dependencies need one then we definitely don't!
852 // Also, if one of our dependencies has an explicit allocator, then we
853 // also bail out as we don't need to implicitly inject one.
854 let mut needs_allocator = false;
855 let mut found_required_allocator = false;
856 self.cstore.iter_crate_data(|cnum, data| {
857 needs_allocator = needs_allocator || data.needs_allocator();
858 if data.is_allocator() {
859 info!("{} required by rlib and is an allocator", data.name());
860 self.inject_dependency_if(cnum, "an allocator",
861 &|data| data.needs_allocator());
862 found_required_allocator = found_required_allocator ||
863 data.dep_kind.get() == DepKind::Explicit;
866 if !needs_allocator || found_required_allocator { return }
868 // At this point we've determined that we need an allocator and no
869 // previous allocator has been activated. We look through our outputs of
870 // crate types to see what kind of allocator types we may need.
872 // The main special output type here is that rlibs do **not** need an
873 // allocator linked in (they're just object files), only final products
874 // (exes, dylibs, staticlibs) need allocators.
875 let mut need_lib_alloc = false;
876 let mut need_exe_alloc = false;
877 for ct in self.sess.crate_types.borrow().iter() {
879 config::CrateTypeExecutable => need_exe_alloc = true,
880 config::CrateTypeDylib |
881 config::CrateTypeProcMacro |
882 config::CrateTypeCdylib |
883 config::CrateTypeStaticlib => need_lib_alloc = true,
884 config::CrateTypeRlib => {}
887 if !need_lib_alloc && !need_exe_alloc { return }
889 // The default allocator crate comes from the custom target spec, and we
890 // choose between the standard library allocator or exe allocator. This
891 // distinction exists because the default allocator for binaries (where
892 // the world is Rust) is different than library (where the world is
893 // likely *not* Rust).
895 // If a library is being produced, but we're also flagged with `-C
896 // prefer-dynamic`, then we interpret this as a *Rust* dynamic library
897 // is being produced so we use the exe allocator instead.
899 // What this boils down to is:
901 // * Binaries use jemalloc
902 // * Staticlibs and Rust dylibs use system malloc
903 // * Rust dylibs used as dependencies to rust use jemalloc
904 let name = if need_lib_alloc && !self.sess.opts.cg.prefer_dynamic {
905 Symbol::intern(&self.sess.target.target.options.lib_allocation_crate)
907 Symbol::intern(&self.sess.target.target.options.exe_allocation_crate)
909 let dep_kind = DepKind::Implicit;
911 self.resolve_crate(&None, name, name, None, DUMMY_SP, PathKind::Crate, dep_kind);
913 // Sanity check the crate we loaded to ensure that it is indeed an
915 if !data.is_allocator() {
916 self.sess.err(&format!("the allocator crate `{}` is not tagged \
917 with #![allocator]", data.name()));
920 self.sess.injected_allocator.set(Some(cnum));
921 self.inject_dependency_if(cnum, "an allocator",
922 &|data| data.needs_allocator());
925 fn inject_dependency_if(&self,
928 needs_dep: &Fn(&cstore::CrateMetadata) -> bool) {
929 // don't perform this validation if the session has errors, as one of
930 // those errors may indicate a circular dependency which could cause
931 // this to stack overflow.
932 if self.sess.has_errors() {
936 // Before we inject any dependencies, make sure we don't inject a
937 // circular dependency by validating that this crate doesn't
938 // transitively depend on any crates satisfying `needs_dep`.
939 for dep in self.cstore.crate_dependencies_in_rpo(krate) {
940 let data = self.cstore.get_crate_data(dep);
941 if needs_dep(&data) {
942 self.sess.err(&format!("the crate `{}` cannot depend \
943 on a crate that needs {}, but \
945 self.cstore.get_crate_data(krate).name(),
951 // All crates satisfying `needs_dep` do not explicitly depend on the
952 // crate provided for this compile, but in order for this compilation to
953 // be successfully linked we need to inject a dependency (to order the
954 // crates on the command line correctly).
955 self.cstore.iter_crate_data(|cnum, data| {
956 if !needs_dep(data) {
960 info!("injecting a dep from {} to {}", cnum, krate);
961 data.cnum_map.borrow_mut().push(krate);
966 impl<'a> CrateLoader<'a> {
967 pub fn preprocess(&mut self, krate: &ast::Crate) {
968 for attr in krate.attrs.iter().filter(|m| m.name() == "link_args") {
969 if let Some(linkarg) = attr.value_str() {
970 self.cstore.add_used_link_args(&linkarg.as_str());
975 fn process_foreign_mod(&mut self, i: &ast::Item, fm: &ast::ForeignMod,
976 definitions: &Definitions) {
977 if fm.abi == Abi::Rust || fm.abi == Abi::RustIntrinsic || fm.abi == Abi::PlatformIntrinsic {
981 // First, add all of the custom #[link_args] attributes
982 for m in i.attrs.iter().filter(|a| a.check_name("link_args")) {
983 if let Some(linkarg) = m.value_str() {
984 self.cstore.add_used_link_args(&linkarg.as_str());
988 // Next, process all of the #[link(..)]-style arguments
989 for m in i.attrs.iter().filter(|a| a.check_name("link")) {
990 let items = match m.meta_item_list() {
994 let kind = items.iter().find(|k| {
996 }).and_then(|a| a.value_str()).map(Symbol::as_str);
997 let kind = match kind.as_ref().map(|s| &s[..]) {
998 Some("static") => cstore::NativeStatic,
999 Some("static-nobundle") => cstore::NativeStaticNobundle,
1000 Some("dylib") => cstore::NativeUnknown,
1001 Some("framework") => cstore::NativeFramework,
1003 struct_span_err!(self.sess, m.span, E0458,
1004 "unknown kind: `{}`", k)
1005 .span_label(m.span, &format!("unknown kind")).emit();
1006 cstore::NativeUnknown
1008 None => cstore::NativeUnknown
1010 let n = items.iter().find(|n| {
1011 n.check_name("name")
1012 }).and_then(|a| a.value_str());
1016 struct_span_err!(self.sess, m.span, E0459,
1017 "#[link(...)] specified without `name = \"foo\"`")
1018 .span_label(m.span, &format!("missing `name` argument")).emit();
1019 Symbol::intern("foo")
1022 let cfg = items.iter().find(|k| {
1024 }).and_then(|a| a.meta_item_list());
1025 let cfg = cfg.map(|list| {
1026 list[0].meta_item().unwrap().clone()
1028 let foreign_items = fm.items.iter()
1029 .map(|it| definitions.opt_def_index(it.id).unwrap())
1031 let lib = NativeLibrary {
1035 foreign_items: foreign_items,
1037 register_native_lib(self.sess, self.cstore, Some(m.span), lib);
1042 impl<'a> middle::cstore::CrateLoader for CrateLoader<'a> {
1043 fn postprocess(&mut self, krate: &ast::Crate) {
1044 // inject the sanitizer runtime before the allocator runtime because all
1045 // sanitizers force the use of the `alloc_system` allocator
1046 self.inject_sanitizer_runtime();
1047 self.inject_allocator_crate();
1048 self.inject_panic_runtime(krate);
1050 if log_enabled!(log::INFO) {
1051 dump_crates(&self.cstore);
1054 // Process libs passed on the command line
1055 // First, check for errors
1056 let mut renames = FxHashSet();
1057 for &(ref name, ref new_name, _) in &self.sess.opts.libs {
1058 if let &Some(ref new_name) = new_name {
1059 if new_name.is_empty() {
1061 &format!("an empty renaming target was specified for library `{}`",name));
1062 } else if !self.cstore.get_used_libraries().borrow().iter()
1063 .any(|lib| lib.name == name as &str) {
1064 self.sess.err(&format!("renaming of the library `{}` was specified, \
1065 however this crate contains no #[link(...)] \
1066 attributes referencing this library.", name));
1067 } else if renames.contains(name) {
1068 self.sess.err(&format!("multiple renamings were specified for library `{}` .",
1071 renames.insert(name);
1075 // Update kind and, optionally, the name of all native libaries
1076 // (there may be more than one) with the specified name.
1077 for &(ref name, ref new_name, kind) in &self.sess.opts.libs {
1078 let mut found = false;
1079 for lib in self.cstore.get_used_libraries().borrow_mut().iter_mut() {
1080 if lib.name == name as &str {
1082 if let &Some(ref new_name) = new_name {
1083 lib.name = Symbol::intern(new_name);
1090 let new_name = new_name.as_ref().map(|s| &**s); // &Option<String> -> Option<&str>
1091 let lib = NativeLibrary {
1092 name: Symbol::intern(new_name.unwrap_or(name)),
1095 foreign_items: Vec::new(),
1097 register_native_lib(self.sess, self.cstore, None, lib);
1100 self.register_statically_included_foreign_items();
1101 self.register_dllimport_foreign_items();
1104 fn process_item(&mut self, item: &ast::Item, definitions: &Definitions) {
1106 ast::ItemKind::ForeignMod(ref fm) => {
1107 self.process_foreign_mod(item, fm, definitions)
1109 ast::ItemKind::ExternCrate(_) => {
1110 let info = self.extract_crate_info(item).unwrap();
1111 let (cnum, ..) = self.resolve_crate(
1112 &None, info.ident, info.name, None, item.span, PathKind::Crate, info.dep_kind,
1115 let def_id = definitions.opt_local_def_id(item.id).unwrap();
1116 let len = definitions.def_path(def_id.index).data.len();
1119 ExternCrate { def_id: def_id, span: item.span, direct: true, path_len: len };
1120 self.update_extern_crate(cnum, extern_crate, &mut FxHashSet());
1121 self.cstore.add_extern_mod_stmt_cnum(info.id, cnum);