src/librustc_metadata/creader.rs

   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.
   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 //! Validates all used crates and extern libraries and loads their metadata
  12
  13 use cstore::{self, CStore, CrateSource, MetadataBlob};
  14 use locator::{self, CratePaths};
  15 use schema::{CrateRoot, Tracked};
  16
  17 use rustc::dep_graph::{DepNode, GlobalMetaDataKind};
  18 use rustc::hir::def_id::{DefId, CrateNum, DefIndex, CRATE_DEF_INDEX};
  19 use rustc::hir::svh::Svh;
  20 use rustc::middle::cstore::DepKind;
  21 use rustc::session::Session;
  22 use rustc::session::config::{Sanitizer, self};
  23 use rustc_back::PanicStrategy;
  24 use rustc::session::search_paths::PathKind;
  25 use rustc::middle;
  26 use rustc::middle::cstore::{CrateStore, validate_crate_name, ExternCrate};
  27 use rustc::util::common::record_time;
  28 use rustc::util::nodemap::FxHashSet;
  29 use rustc::middle::cstore::NativeLibrary;
  30 use rustc::hir::map::Definitions;
  31
  32 use std::cell::{RefCell, Cell};
  33 use std::ops::Deref;
  34 use std::path::PathBuf;
  35 use std::rc::Rc;
  36 use std::{cmp, fs};
  37
  38 use syntax::ast;
  39 use syntax::abi::Abi;
  40 use syntax::attr;
  41 use syntax::ext::base::SyntaxExtension;
  42 use syntax::feature_gate::{self, GateIssue};
  43 use syntax::symbol::Symbol;
  44 use syntax_pos::{Span, DUMMY_SP};
  45 use log;
  46
  47 pub struct Library {
  48     pub dylib: Option<(PathBuf, PathKind)>,
  49     pub rlib: Option<(PathBuf, PathKind)>,
  50     pub rmeta: Option<(PathBuf, PathKind)>,
  51     pub metadata: MetadataBlob,
  52 }
  53
  54 pub struct CrateLoader<'a> {
  55     pub sess: &'a Session,
  56     cstore: &'a CStore,
  57     next_crate_num: CrateNum,
  58     local_crate_name: Symbol,
  59 }
  60
  61 fn dump_crates(cstore: &CStore) {
  62     info!("resolved crates:");
  63     cstore.iter_crate_data(|_, data| {
  64         info!("  name: {}", data.name());
  65         info!("  cnum: {}", data.cnum);
  66         info!("  hash: {}", data.hash());
  67         info!("  reqd: {:?}", data.dep_kind.get());
  68         let CrateSource { dylib, rlib, rmeta } = data.source.clone();
  69         dylib.map(|dl| info!("  dylib: {}", dl.0.display()));
  70         rlib.map(|rl|  info!("   rlib: {}", rl.0.display()));
  71         rmeta.map(|rl| info!("   rmeta: {}", rl.0.display()));
  72     });
  73 }
  74
  75 #[derive(Debug)]
  76 struct ExternCrateInfo {
  77     ident: Symbol,
  78     name: Symbol,
  79     id: ast::NodeId,
  80     dep_kind: DepKind,
  81 }
  82
  83 fn register_native_lib(sess: &Session,
  84                        cstore: &CStore,
  85                        span: Option<Span>,
  86                        lib: NativeLibrary) {
  87     if lib.name.as_str().is_empty() {
  88         match span {
  89             Some(span) => {
  90                 struct_span_err!(sess, span, E0454,
  91                                  "#[link(name = \"\")] given with empty name")
  92                     .span_label(span, "empty name given")
  93                     .emit();
  94             }
  95             None => {
  96                 sess.err("empty library name given via `-l`");
  97             }
  98         }
  99         return
 100     }
 101     let is_osx = sess.target.target.options.is_like_osx;
 102     if lib.kind == cstore::NativeFramework && !is_osx {
 103         let msg = "native frameworks are only available on macOS targets";
 104         match span {
 105             Some(span) => span_err!(sess, span, E0455, "{}", msg),
 106             None => sess.err(msg),
 107         }
 108     }
 109     if lib.cfg.is_some() && !sess.features.borrow().link_cfg {
 110         feature_gate::emit_feature_err(&sess.parse_sess,
 111                                        "link_cfg",
 112                                        span.unwrap(),
 113                                        GateIssue::Language,
 114                                        "is feature gated");
 115     }
 116     if lib.kind == cstore::NativeStaticNobundle && !sess.features.borrow().static_nobundle {
 117         feature_gate::emit_feature_err(&sess.parse_sess,
 118                                        "static_nobundle",
 119                                        span.unwrap(),
 120                                        GateIssue::Language,
 121                                        "kind=\"static-nobundle\" is feature gated");
 122     }
 123     cstore.add_used_library(lib);
 124 }
 125
 126 fn relevant_lib(sess: &Session, lib: &NativeLibrary) -> bool {
 127     match lib.cfg {
 128         Some(ref cfg) => attr::cfg_matches(cfg, &sess.parse_sess, None),
 129         None => true,
 130     }
 131 }
 132
 133 // Extra info about a crate loaded for plugins or exported macros.
 134 struct ExtensionCrate {
 135     metadata: PMDSource,
 136     dylib: Option<PathBuf>,
 137     target_only: bool,
 138 }
 139
 140 enum PMDSource {
 141     Registered(Rc<cstore::CrateMetadata>),
 142     Owned(Library),
 143 }
 144
 145 impl Deref for PMDSource {
 146     type Target = MetadataBlob;
 147
 148     fn deref(&self) -> &MetadataBlob {
 149         match *self {
 150             PMDSource::Registered(ref cmd) => &cmd.blob,
 151             PMDSource::Owned(ref lib) => &lib.metadata
 152         }
 153     }
 154 }
 155
 156 enum LoadResult {
 157     Previous(CrateNum),
 158     Loaded(Library),
 159 }
 160
 161 impl<'a> CrateLoader<'a> {
 162     pub fn new(sess: &'a Session, cstore: &'a CStore, local_crate_name: &str) -> Self {
 163         CrateLoader {
 164             sess: sess,
 165             cstore: cstore,
 166             next_crate_num: cstore.next_crate_num(),
 167             local_crate_name: Symbol::intern(local_crate_name),
 168         }
 169     }
 170
 171     fn extract_crate_info(&self, i: &ast::Item) -> Option<ExternCrateInfo> {
 172         match i.node {
 173             ast::ItemKind::ExternCrate(ref path_opt) => {
 174                 debug!("resolving extern crate stmt. ident: {} path_opt: {:?}",
 175                        i.ident, path_opt);
 176                 let name = match *path_opt {
 177                     Some(name) => {
 178                         validate_crate_name(Some(self.sess), &name.as_str(),
 179                                             Some(i.span));
 180                         name
 181                     }
 182                     None => i.ident.name,
 183                 };
 184                 Some(ExternCrateInfo {
 185                     ident: i.ident.name,
 186                     name: name,
 187                     id: i.id,
 188                     dep_kind: if attr::contains_name(&i.attrs, "no_link") {
 189                         DepKind::UnexportedMacrosOnly
 190                     } else {
 191                         DepKind::Explicit
 192                     },
 193                 })
 194             }
 195             _ => None
 196         }
 197     }
 198
 199     fn existing_match(&self, name: Symbol, hash: Option<&Svh>, kind: PathKind)
 200                       -> Option<CrateNum> {
 201         let mut ret = None;
 202         self.cstore.iter_crate_data(|cnum, data| {
 203             if data.name != name { return }
 204
 205             match hash {
 206                 Some(hash) if *hash == data.hash() => { ret = Some(cnum); return }
 207                 Some(..) => return,
 208                 None => {}
 209             }
 210
 211             // When the hash is None we're dealing with a top-level dependency
 212             // in which case we may have a specification on the command line for
 213             // this library. Even though an upstream library may have loaded
 214             // something of the same name, we have to make sure it was loaded
 215             // from the exact same location as well.
 216             //
 217             // We're also sure to compare *paths*, not actual byte slices. The
 218             // `source` stores paths which are normalized which may be different
 219             // from the strings on the command line.
 220             let source = self.cstore.used_crate_source(cnum);
 221             if let Some(locs) = self.sess.opts.externs.get(&*name.as_str()) {
 222                 let found = locs.iter().any(|l| {
 223                     let l = fs::canonicalize(l).ok();
 224                     source.dylib.as_ref().map(|p| &p.0) == l.as_ref() ||
 225                     source.rlib.as_ref().map(|p| &p.0) == l.as_ref()
 226                 });
 227                 if found {
 228                     ret = Some(cnum);
 229                 }
 230                 return
 231             }
 232
 233             // Alright, so we've gotten this far which means that `data` has the
 234             // right name, we don't have a hash, and we don't have a --extern
 235             // pointing for ourselves. We're still not quite yet done because we
 236             // have to make sure that this crate was found in the crate lookup
 237             // path (this is a top-level dependency) as we don't want to
 238             // implicitly load anything inside the dependency lookup path.
 239             let prev_kind = source.dylib.as_ref().or(source.rlib.as_ref())
 240                                   .or(source.rmeta.as_ref())
 241                                   .expect("No sources for crate").1;
 242             if ret.is_none() && (prev_kind == kind || prev_kind == PathKind::All) {
 243                 ret = Some(cnum);
 244             }
 245         });
 246         return ret;
 247     }
 248
 249     fn verify_no_symbol_conflicts(&self,
 250                                   span: Span,
 251                                   root: &CrateRoot) {
 252         // Check for (potential) conflicts with the local crate
 253         if self.local_crate_name == root.name &&
 254            self.sess.local_crate_disambiguator() == root.disambiguator {
 255             span_fatal!(self.sess, span, E0519,
 256                         "the current crate is indistinguishable from one of its \
 257                          dependencies: it has the same crate-name `{}` and was \
 258                          compiled with the same `-C metadata` arguments. This \
 259                          will result in symbol conflicts between the two.",
 260                         root.name)
 261         }
 262
 263         // Check for conflicts with any crate loaded so far
 264         self.cstore.iter_crate_data(|_, other| {
 265             if other.name() == root.name && // same crate-name
 266                other.disambiguator() == root.disambiguator &&  // same crate-disambiguator
 267                other.hash() != root.hash { // but different SVH
 268                 span_fatal!(self.sess, span, E0523,
 269                         "found two different crates with name `{}` that are \
 270                          not distinguished by differing `-C metadata`. This \
 271                          will result in symbol conflicts between the two.",
 272                         root.name)
 273             }
 274         });
 275     }
 276
 277     fn register_crate(&mut self,
 278                       root: &Option<CratePaths>,
 279                       ident: Symbol,
 280                       name: Symbol,
 281                       span: Span,
 282                       lib: Library,
 283                       dep_kind: DepKind)
 284                       -> (CrateNum, Rc<cstore::CrateMetadata>) {
 285         info!("register crate `extern crate {} as {}`", name, ident);
 286         let crate_root = lib.metadata.get_root();
 287         self.verify_no_symbol_conflicts(span, &crate_root);
 288
 289         // Claim this crate number and cache it
 290         let cnum = self.next_crate_num;
 291         self.next_crate_num = CrateNum::from_u32(cnum.as_u32() + 1);
 292
 293         // Stash paths for top-most crate locally if necessary.
 294         let crate_paths = if root.is_none() {
 295             Some(CratePaths {
 296                 ident: ident.to_string(),
 297                 dylib: lib.dylib.clone().map(|p| p.0),
 298                 rlib:  lib.rlib.clone().map(|p| p.0),
 299                 rmeta: lib.rmeta.clone().map(|p| p.0),
 300             })
 301         } else {
 302             None
 303         };
 304         // Maintain a reference to the top most crate.
 305         let root = if root.is_some() { root } else { &crate_paths };
 306
 307         let Library { dylib, rlib, rmeta, metadata } = lib;
 308
 309         let cnum_map = self.resolve_crate_deps(root, &crate_root, &metadata, cnum, span, dep_kind);
 310
 311         let def_path_table = record_time(&self.sess.perf_stats.decode_def_path_tables_time, || {
 312             crate_root.def_path_table.decode(&metadata)
 313         });
 314
 315         let exported_symbols = crate_root.exported_symbols
 316                                          .map(|x| x.decode(&metadata).collect());
 317
 318         let mut cmeta = cstore::CrateMetadata {
 319             name: name,
 320             extern_crate: Cell::new(None),
 321             def_path_table: def_path_table,
 322             exported_symbols: exported_symbols,
 323             proc_macros: crate_root.macro_derive_registrar.map(|_| {
 324                 self.load_derive_macros(&crate_root, dylib.clone().map(|p| p.0), span)
 325             }),
 326             root: crate_root,
 327             blob: metadata,
 328             cnum_map: RefCell::new(cnum_map),
 329             cnum: cnum,
 330             codemap_import_info: RefCell::new(vec![]),
 331             attribute_cache: RefCell::new([Vec::new(), Vec::new()]),
 332             dep_kind: Cell::new(dep_kind),
 333             source: cstore::CrateSource {
 334                 dylib: dylib,
 335                 rlib: rlib,
 336                 rmeta: rmeta,
 337             },
 338             // Initialize this with an empty set. The field is populated below
 339             // after we were able to deserialize its contents.
 340             dllimport_foreign_items: Tracked::new(FxHashSet()),
 341         };
 342
 343         let dllimports: Tracked<FxHashSet<_>> = cmeta
 344             .root
 345             .native_libraries
 346             .map(|native_libraries| {
 347                 let native_libraries: Vec<_> = native_libraries.decode(&cmeta)
 348                                                                .collect();
 349                 native_libraries
 350                     .iter()
 351                     .filter(|lib| relevant_lib(self.sess, lib) &&
 352                                   lib.kind == cstore::NativeLibraryKind::NativeUnknown)
 353                     .flat_map(|lib| lib.foreign_items.iter())
 354                     .map(|id| *id)
 355                     .collect()
 356             });
 357
 358         cmeta.dllimport_foreign_items = dllimports;
 359
 360         let cmeta = Rc::new(cmeta);
 361         self.cstore.set_crate_data(cnum, cmeta.clone());
 362         (cnum, cmeta)
 363     }
 364
 365     fn resolve_crate(&mut self,
 366                      root: &Option<CratePaths>,
 367                      ident: Symbol,
 368                      name: Symbol,
 369                      hash: Option<&Svh>,
 370                      span: Span,
 371                      path_kind: PathKind,
 372                      mut dep_kind: DepKind)
 373                      -> (CrateNum, Rc<cstore::CrateMetadata>) {
 374         info!("resolving crate `extern crate {} as {}`", name, ident);
 375         let result = if let Some(cnum) = self.existing_match(name, hash, path_kind) {
 376             LoadResult::Previous(cnum)
 377         } else {
 378             info!("falling back to a load");
 379             let mut locate_ctxt = locator::Context {
 380                 sess: self.sess,
 381                 span: span,
 382                 ident: ident,
 383                 crate_name: name,
 384                 hash: hash.map(|a| &*a),
 385                 filesearch: self.sess.target_filesearch(path_kind),
 386                 target: &self.sess.target.target,
 387                 triple: &self.sess.opts.target_triple,
 388                 root: root,
 389                 rejected_via_hash: vec![],
 390                 rejected_via_triple: vec![],
 391                 rejected_via_kind: vec![],
 392                 rejected_via_version: vec![],
 393                 rejected_via_filename: vec![],
 394                 should_match_name: true,
 395                 is_proc_macro: Some(false),
 396                 metadata_loader: &*self.cstore.metadata_loader,
 397             };
 398
 399             self.load(&mut locate_ctxt).or_else(|| {
 400                 dep_kind = DepKind::UnexportedMacrosOnly;
 401
 402                 let mut proc_macro_locator = locator::Context {
 403                     target: &self.sess.host,
 404                     triple: config::host_triple(),
 405                     filesearch: self.sess.host_filesearch(path_kind),
 406                     rejected_via_hash: vec![],
 407                     rejected_via_triple: vec![],
 408                     rejected_via_kind: vec![],
 409                     rejected_via_version: vec![],
 410                     rejected_via_filename: vec![],
 411                     is_proc_macro: Some(true),
 412                     ..locate_ctxt
 413                 };
 414
 415                 self.load(&mut proc_macro_locator)
 416             }).unwrap_or_else(|| locate_ctxt.report_errs())
 417         };
 418
 419         match result {
 420             LoadResult::Previous(cnum) => {
 421                 let data = self.cstore.get_crate_data(cnum);
 422                 if data.root.macro_derive_registrar.is_some() {
 423                     dep_kind = DepKind::UnexportedMacrosOnly;
 424                 }
 425                 data.dep_kind.set(cmp::max(data.dep_kind.get(), dep_kind));
 426                 (cnum, data)
 427             }
 428             LoadResult::Loaded(library) => {
 429                 self.register_crate(root, ident, name, span, library, dep_kind)
 430             }
 431         }
 432     }
 433
 434     fn load(&mut self, locate_ctxt: &mut locator::Context) -> Option<LoadResult> {
 435         let library = match locate_ctxt.maybe_load_library_crate() {
 436             Some(lib) => lib,
 437             None => return None,
 438         };
 439
 440         // In the case that we're loading a crate, but not matching
 441         // against a hash, we could load a crate which has the same hash
 442         // as an already loaded crate. If this is the case prevent
 443         // duplicates by just using the first crate.
 444         //
 445         // Note that we only do this for target triple crates, though, as we
 446         // don't want to match a host crate against an equivalent target one
 447         // already loaded.
 448         let root = library.metadata.get_root();
 449         if locate_ctxt.triple == self.sess.opts.target_triple {
 450             let mut result = LoadResult::Loaded(library);
 451             self.cstore.iter_crate_data(|cnum, data| {
 452                 if data.name() == root.name && root.hash == data.hash() {
 453                     assert!(locate_ctxt.hash.is_none());
 454                     info!("load success, going to previous cnum: {}", cnum);
 455                     result = LoadResult::Previous(cnum);
 456                 }
 457             });
 458             Some(result)
 459         } else {
 460             Some(LoadResult::Loaded(library))
 461         }
 462     }
 463
 464     fn update_extern_crate(&mut self,
 465                            cnum: CrateNum,
 466                            mut extern_crate: ExternCrate,
 467                            visited: &mut FxHashSet<(CrateNum, bool)>)
 468     {
 469         if !visited.insert((cnum, extern_crate.direct)) { return }
 470
 471         let cmeta = self.cstore.get_crate_data(cnum);
 472         let old_extern_crate = cmeta.extern_crate.get();
 473
 474         // Prefer:
 475         // - something over nothing (tuple.0);
 476         // - direct extern crate to indirect (tuple.1);
 477         // - shorter paths to longer (tuple.2).
 478         let new_rank = (true, extern_crate.direct, !extern_crate.path_len);
 479         let old_rank = match old_extern_crate {
 480             None => (false, false, !0),
 481             Some(ref c) => (true, c.direct, !c.path_len),
 482         };
 483
 484         if old_rank >= new_rank {
 485             return; // no change needed
 486         }
 487
 488         cmeta.extern_crate.set(Some(extern_crate));
 489         // Propagate the extern crate info to dependencies.
 490         extern_crate.direct = false;
 491         for &dep_cnum in cmeta.cnum_map.borrow().iter() {
 492             self.update_extern_crate(dep_cnum, extern_crate, visited);
 493         }
 494     }
 495
 496     // Go through the crate metadata and load any crates that it references
 497     fn resolve_crate_deps(&mut self,
 498                           root: &Option<CratePaths>,
 499                           crate_root: &CrateRoot,
 500                           metadata: &MetadataBlob,
 501                           krate: CrateNum,
 502                           span: Span,
 503                           dep_kind: DepKind)
 504                           -> cstore::CrateNumMap {
 505         debug!("resolving deps of external crate");
 506         if crate_root.macro_derive_registrar.is_some() {
 507             return cstore::CrateNumMap::new();
 508         }
 509
 510         let dep_node = DepNode::GlobalMetaData(DefId { krate, index: CRATE_DEF_INDEX },
 511                                                GlobalMetaDataKind::CrateDeps);
 512
 513         // The map from crate numbers in the crate we're resolving to local crate numbers.
 514         // We map 0 and all other holes in the map to our parent crate. The "additional"
 515         // self-dependencies should be harmless.
 516         ::std::iter::once(krate).chain(crate_root.crate_deps
 517                                                  .get(&self.sess.dep_graph, dep_node)
 518                                                  .decode(metadata)
 519                                                  .map(|dep| {
 520             debug!("resolving dep crate {} hash: `{}`", dep.name, dep.hash);
 521             if dep.kind == DepKind::UnexportedMacrosOnly {
 522                 return krate;
 523             }
 524             let dep_kind = match dep_kind {
 525                 DepKind::MacrosOnly => DepKind::MacrosOnly,
 526                 _ => dep.kind,
 527             };
 528             let (local_cnum, ..) = self.resolve_crate(
 529                 root, dep.name, dep.name, Some(&dep.hash), span, PathKind::Dependency, dep_kind,
 530             );
 531             local_cnum
 532         })).collect()
 533     }
 534
 535     fn read_extension_crate(&mut self, span: Span, info: &ExternCrateInfo) -> ExtensionCrate {
 536         info!("read extension crate {} `extern crate {} as {}` dep_kind={:?}",
 537               info.id, info.name, info.ident, info.dep_kind);
 538         let target_triple = &self.sess.opts.target_triple[..];
 539         let is_cross = target_triple != config::host_triple();
 540         let mut target_only = false;
 541         let mut locate_ctxt = locator::Context {
 542             sess: self.sess,
 543             span: span,
 544             ident: info.ident,
 545             crate_name: info.name,
 546             hash: None,
 547             filesearch: self.sess.host_filesearch(PathKind::Crate),
 548             target: &self.sess.host,
 549             triple: config::host_triple(),
 550             root: &None,
 551             rejected_via_hash: vec![],
 552             rejected_via_triple: vec![],
 553             rejected_via_kind: vec![],
 554             rejected_via_version: vec![],
 555             rejected_via_filename: vec![],
 556             should_match_name: true,
 557             is_proc_macro: None,
 558             metadata_loader: &*self.cstore.metadata_loader,
 559         };
 560         let library = self.load(&mut locate_ctxt).or_else(|| {
 561             if !is_cross {
 562                 return None
 563             }
 564             // Try loading from target crates. This will abort later if we
 565             // try to load a plugin registrar function,
 566             target_only = true;
 567
 568             locate_ctxt.target = &self.sess.target.target;
 569             locate_ctxt.triple = target_triple;
 570             locate_ctxt.filesearch = self.sess.target_filesearch(PathKind::Crate);
 571
 572             self.load(&mut locate_ctxt)
 573         });
 574         let library = match library {
 575             Some(l) => l,
 576             None => locate_ctxt.report_errs(),
 577         };
 578
 579         let (dylib, metadata) = match library {
 580             LoadResult::Previous(cnum) => {
 581                 let data = self.cstore.get_crate_data(cnum);
 582                 (data.source.dylib.clone(), PMDSource::Registered(data))
 583             }
 584             LoadResult::Loaded(library) => {
 585                 let dylib = library.dylib.clone();
 586                 let metadata = PMDSource::Owned(library);
 587                 (dylib, metadata)
 588             }
 589         };
 590
 591         ExtensionCrate {
 592             metadata: metadata,
 593             dylib: dylib.map(|p| p.0),
 594             target_only: target_only,
 595         }
 596     }
 597
 598     /// Load custom derive macros.
 599     ///
 600     /// Note that this is intentionally similar to how we load plugins today,
 601     /// but also intentionally separate. Plugins are likely always going to be
 602     /// implemented as dynamic libraries, but we have a possible future where
 603     /// custom derive (and other macro-1.1 style features) are implemented via
 604     /// executables and custom IPC.
 605     fn load_derive_macros(&mut self, root: &CrateRoot, dylib: Option<PathBuf>, span: Span)
 606                           -> Vec<(ast::Name, Rc<SyntaxExtension>)> {
 607         use std::{env, mem};
 608         use proc_macro::TokenStream;
 609         use proc_macro::__internal::Registry;
 610         use rustc_back::dynamic_lib::DynamicLibrary;
 611         use syntax_ext::deriving::custom::ProcMacroDerive;
 612         use syntax_ext::proc_macro_impl::{AttrProcMacro, BangProcMacro};
 613
 614         let path = match dylib {
 615             Some(dylib) => dylib,
 616             None => span_bug!(span, "proc-macro crate not dylib"),
 617         };
 618         // Make sure the path contains a / or the linker will search for it.
 619         let path = env::current_dir().unwrap().join(path);
 620         let lib = match DynamicLibrary::open(Some(&path)) {
 621             Ok(lib) => lib,
 622             Err(err) => self.sess.span_fatal(span, &err),
 623         };
 624
 625         let sym = self.sess.generate_derive_registrar_symbol(root.disambiguator,
 626                                                              root.macro_derive_registrar.unwrap());
 627         let registrar = unsafe {
 628             let sym = match lib.symbol(&sym) {
 629                 Ok(f) => f,
 630                 Err(err) => self.sess.span_fatal(span, &err),
 631             };
 632             mem::transmute::<*mut u8, fn(&mut Registry)>(sym)
 633         };
 634
 635         struct MyRegistrar(Vec<(ast::Name, Rc<SyntaxExtension>)>);
 636
 637         impl Registry for MyRegistrar {
 638             fn register_custom_derive(&mut self,
 639                                       trait_name: &str,
 640                                       expand: fn(TokenStream) -> TokenStream,
 641                                       attributes: &[&'static str]) {
 642                 let attrs = attributes.iter().cloned().map(Symbol::intern).collect::<Vec<_>>();
 643                 let derive = ProcMacroDerive::new(expand, attrs.clone());
 644                 let derive = SyntaxExtension::ProcMacroDerive(Box::new(derive), attrs);
 645                 self.0.push((Symbol::intern(trait_name), Rc::new(derive)));
 646             }
 647
 648             fn register_attr_proc_macro(&mut self,
 649                                         name: &str,
 650                                         expand: fn(TokenStream, TokenStream) -> TokenStream) {
 651                 let expand = SyntaxExtension::AttrProcMacro(
 652                     Box::new(AttrProcMacro { inner: expand })
 653                 );
 654                 self.0.push((Symbol::intern(name), Rc::new(expand)));
 655             }
 656
 657             fn register_bang_proc_macro(&mut self,
 658                                         name: &str,
 659                                         expand: fn(TokenStream) -> TokenStream) {
 660                 let expand = SyntaxExtension::ProcMacro(
 661                     Box::new(BangProcMacro { inner: expand })
 662                 );
 663                 self.0.push((Symbol::intern(name), Rc::new(expand)));
 664             }
 665         }
 666
 667         let mut my_registrar = MyRegistrar(Vec::new());
 668         registrar(&mut my_registrar);
 669
 670         // Intentionally leak the dynamic library. We can't ever unload it
 671         // since the library can make things that will live arbitrarily long.
 672         mem::forget(lib);
 673         my_registrar.0
 674     }
 675
 676     /// Look for a plugin registrar. Returns library path, crate
 677     /// SVH and DefIndex of the registrar function.
 678     pub fn find_plugin_registrar(&mut self,
 679                                  span: Span,
 680                                  name: &str)
 681                                  -> Option<(PathBuf, Symbol, DefIndex)> {
 682         let ekrate = self.read_extension_crate(span, &ExternCrateInfo {
 683              name: Symbol::intern(name),
 684              ident: Symbol::intern(name),
 685              id: ast::DUMMY_NODE_ID,
 686              dep_kind: DepKind::UnexportedMacrosOnly,
 687         });
 688
 689         if ekrate.target_only {
 690             // Need to abort before syntax expansion.
 691             let message = format!("plugin `{}` is not available for triple `{}` \
 692                                    (only found {})",
 693                                   name,
 694                                   config::host_triple(),
 695                                   self.sess.opts.target_triple);
 696             span_fatal!(self.sess, span, E0456, "{}", &message);
 697         }
 698
 699         let root = ekrate.metadata.get_root();
 700         match (ekrate.dylib.as_ref(), root.plugin_registrar_fn) {
 701             (Some(dylib), Some(reg)) => {
 702                 Some((dylib.to_path_buf(), root.disambiguator, reg))
 703             }
 704             (None, Some(_)) => {
 705                 span_err!(self.sess, span, E0457,
 706                           "plugin `{}` only found in rlib format, but must be available \
 707                            in dylib format",
 708                           name);
 709                 // No need to abort because the loading code will just ignore this
 710                 // empty dylib.
 711                 None
 712             }
 713             _ => None,
 714         }
 715     }
 716
 717     fn get_foreign_items_of_kind(&self, kind: cstore::NativeLibraryKind) -> Vec<DefIndex> {
 718         let mut items = vec![];
 719         let libs = self.cstore.get_used_libraries();
 720         for lib in libs.borrow().iter() {
 721             if relevant_lib(self.sess, lib) && lib.kind == kind {
 722                 items.extend(&lib.foreign_items);
 723             }
 724         }
 725         items
 726     }
 727
 728     fn register_statically_included_foreign_items(&mut self) {
 729         for id in self.get_foreign_items_of_kind(cstore::NativeStatic) {
 730             self.cstore.add_statically_included_foreign_item(id);
 731         }
 732         for id in self.get_foreign_items_of_kind(cstore::NativeStaticNobundle) {
 733             self.cstore.add_statically_included_foreign_item(id);
 734         }
 735     }
 736
 737     fn register_dllimport_foreign_items(&mut self) {
 738         let mut dllimports = self.cstore.dllimport_foreign_items.borrow_mut();
 739         for id in self.get_foreign_items_of_kind(cstore::NativeUnknown) {
 740             dllimports.insert(id);
 741         }
 742     }
 743
 744     fn inject_panic_runtime(&mut self, krate: &ast::Crate) {
 745         // If we're only compiling an rlib, then there's no need to select a
 746         // panic runtime, so we just skip this section entirely.
 747         let any_non_rlib = self.sess.crate_types.borrow().iter().any(|ct| {
 748             *ct != config::CrateTypeRlib
 749         });
 750         if !any_non_rlib {
 751             info!("panic runtime injection skipped, only generating rlib");
 752             return
 753         }
 754
 755         // If we need a panic runtime, we try to find an existing one here. At
 756         // the same time we perform some general validation of the DAG we've got
 757         // going such as ensuring everything has a compatible panic strategy.
 758         //
 759         // The logic for finding the panic runtime here is pretty much the same
 760         // as the allocator case with the only addition that the panic strategy
 761         // compilation mode also comes into play.
 762         let desired_strategy = self.sess.panic_strategy();
 763         let mut runtime_found = false;
 764         let mut needs_panic_runtime = attr::contains_name(&krate.attrs,
 765                                                           "needs_panic_runtime");
 766
 767         let dep_graph = &self.sess.dep_graph;
 768
 769         self.cstore.iter_crate_data(|cnum, data| {
 770             needs_panic_runtime = needs_panic_runtime ||
 771                                   data.needs_panic_runtime(dep_graph);
 772             if data.is_panic_runtime(dep_graph) {
 773                 // Inject a dependency from all #![needs_panic_runtime] to this
 774                 // #![panic_runtime] crate.
 775                 self.inject_dependency_if(cnum, "a panic runtime",
 776                                           &|data| data.needs_panic_runtime(dep_graph));
 777                 runtime_found = runtime_found || data.dep_kind.get() == DepKind::Explicit;
 778             }
 779         });
 780
 781         // If an explicitly linked and matching panic runtime was found, or if
 782         // we just don't need one at all, then we're done here and there's
 783         // nothing else to do.
 784         if !needs_panic_runtime || runtime_found {
 785             return
 786         }
 787
 788         // By this point we know that we (a) need a panic runtime and (b) no
 789         // panic runtime was explicitly linked. Here we just load an appropriate
 790         // default runtime for our panic strategy and then inject the
 791         // dependencies.
 792         //
 793         // We may resolve to an already loaded crate (as the crate may not have
 794         // been explicitly linked prior to this) and we may re-inject
 795         // dependencies again, but both of those situations are fine.
 796         //
 797         // Also note that we have yet to perform validation of the crate graph
 798         // in terms of everyone has a compatible panic runtime format, that's
 799         // performed later as part of the `dependency_format` module.
 800         let name = match desired_strategy {
 801             PanicStrategy::Unwind => Symbol::intern("panic_unwind"),
 802             PanicStrategy::Abort => Symbol::intern("panic_abort"),
 803         };
 804         info!("panic runtime not found -- loading {}", name);
 805
 806         let dep_kind = DepKind::Implicit;
 807         let (cnum, data) =
 808             self.resolve_crate(&None, name, name, None, DUMMY_SP, PathKind::Crate, dep_kind);
 809
 810         // Sanity check the loaded crate to ensure it is indeed a panic runtime
 811         // and the panic strategy is indeed what we thought it was.
 812         if !data.is_panic_runtime(dep_graph) {
 813             self.sess.err(&format!("the crate `{}` is not a panic runtime",
 814                                    name));
 815         }
 816         if data.panic_strategy(dep_graph) != desired_strategy {
 817             self.sess.err(&format!("the crate `{}` does not have the panic \
 818                                     strategy `{}`",
 819                                    name, desired_strategy.desc()));
 820         }
 821
 822         self.sess.injected_panic_runtime.set(Some(cnum));
 823         self.inject_dependency_if(cnum, "a panic runtime",
 824                                   &|data| data.needs_panic_runtime(dep_graph));
 825     }
 826
 827     fn inject_sanitizer_runtime(&mut self) {
 828         if let Some(ref sanitizer) = self.sess.opts.debugging_opts.sanitizer {
 829             // Sanitizers can only be used on some tested platforms with
 830             // executables linked to `std`
 831             const ASAN_SUPPORTED_TARGETS: &[&str] = &["x86_64-unknown-linux-gnu",
 832                                                       "x86_64-apple-darwin"];
 833             const TSAN_SUPPORTED_TARGETS: &[&str] = &["x86_64-unknown-linux-gnu",
 834                                                       "x86_64-apple-darwin"];
 835             const LSAN_SUPPORTED_TARGETS: &[&str] = &["x86_64-unknown-linux-gnu"];
 836             const MSAN_SUPPORTED_TARGETS: &[&str] = &["x86_64-unknown-linux-gnu"];
 837
 838             let supported_targets = match *sanitizer {
 839                 Sanitizer::Address => ASAN_SUPPORTED_TARGETS,
 840                 Sanitizer::Thread => TSAN_SUPPORTED_TARGETS,
 841                 Sanitizer::Leak => LSAN_SUPPORTED_TARGETS,
 842                 Sanitizer::Memory => MSAN_SUPPORTED_TARGETS,
 843             };
 844             if !supported_targets.contains(&&*self.sess.target.target.llvm_target) {
 845                 self.sess.err(&format!("{:?}Sanitizer only works with the `{}` target",
 846                     sanitizer,
 847                     supported_targets.join("` or `")
 848                 ));
 849                 return
 850             }
 851
 852             if !self.sess.crate_types.borrow().iter().all(|ct| {
 853                 match *ct {
 854                     // Link the runtime
 855                     config::CrateTypeExecutable => true,
 856                     // This crate will be compiled with the required
 857                     // instrumentation pass
 858                     config::CrateTypeRlib => false,
 859                     _ => {
 860                         self.sess.err(&format!("Only executables and rlibs can be \
 861                                                 compiled with `-Z sanitizer`"));
 862                         false
 863                     }
 864                 }
 865             }) {
 866                 return
 867             }
 868
 869             let mut uses_std = false;
 870             self.cstore.iter_crate_data(|_, data| {
 871                 if data.name == "std" {
 872                     uses_std = true;
 873                 }
 874             });
 875
 876             if uses_std {
 877                 let name = match *sanitizer {
 878                     Sanitizer::Address => "rustc_asan",
 879                     Sanitizer::Leak => "rustc_lsan",
 880                     Sanitizer::Memory => "rustc_msan",
 881                     Sanitizer::Thread => "rustc_tsan",
 882                 };
 883                 info!("loading sanitizer: {}", name);
 884
 885                 let symbol = Symbol::intern(name);
 886                 let dep_kind = DepKind::Implicit;
 887                 let (_, data) =
 888                     self.resolve_crate(&None, symbol, symbol, None, DUMMY_SP,
 889                                        PathKind::Crate, dep_kind);
 890
 891                 // Sanity check the loaded crate to ensure it is indeed a sanitizer runtime
 892                 if !data.is_sanitizer_runtime(&self.sess.dep_graph) {
 893                     self.sess.err(&format!("the crate `{}` is not a sanitizer runtime",
 894                                            name));
 895                 }
 896             }
 897         }
 898     }
 899
 900     fn inject_allocator_crate(&mut self) {
 901         // Make sure that we actually need an allocator, if none of our
 902         // dependencies need one then we definitely don't!
 903         //
 904         // Also, if one of our dependencies has an explicit allocator, then we
 905         // also bail out as we don't need to implicitly inject one.
 906         let mut needs_allocator = false;
 907         let mut found_required_allocator = false;
 908         let dep_graph = &self.sess.dep_graph;
 909         self.cstore.iter_crate_data(|cnum, data| {
 910             needs_allocator = needs_allocator || data.needs_allocator(dep_graph);
 911             if data.is_allocator(dep_graph) {
 912                 info!("{} required by rlib and is an allocator", data.name());
 913                 self.inject_dependency_if(cnum, "an allocator",
 914                                           &|data| data.needs_allocator(dep_graph));
 915                 found_required_allocator = found_required_allocator ||
 916                     data.dep_kind.get() == DepKind::Explicit;
 917             }
 918         });
 919         if !needs_allocator || found_required_allocator { return }
 920
 921         // At this point we've determined that we need an allocator and no
 922         // previous allocator has been activated. We look through our outputs of
 923         // crate types to see what kind of allocator types we may need.
 924         //
 925         // The main special output type here is that rlibs do **not** need an
 926         // allocator linked in (they're just object files), only final products
 927         // (exes, dylibs, staticlibs) need allocators.
 928         let mut need_lib_alloc = false;
 929         let mut need_exe_alloc = false;
 930         for ct in self.sess.crate_types.borrow().iter() {
 931             match *ct {
 932                 config::CrateTypeExecutable => need_exe_alloc = true,
 933                 config::CrateTypeDylib |
 934                 config::CrateTypeProcMacro |
 935                 config::CrateTypeCdylib |
 936                 config::CrateTypeStaticlib => need_lib_alloc = true,
 937                 config::CrateTypeRlib => {}
 938             }
 939         }
 940         if !need_lib_alloc && !need_exe_alloc { return }
 941
 942         // The default allocator crate comes from the custom target spec, and we
 943         // choose between the standard library allocator or exe allocator. This
 944         // distinction exists because the default allocator for binaries (where
 945         // the world is Rust) is different than library (where the world is
 946         // likely *not* Rust).
 947         //
 948         // If a library is being produced, but we're also flagged with `-C
 949         // prefer-dynamic`, then we interpret this as a *Rust* dynamic library
 950         // is being produced so we use the exe allocator instead.
 951         //
 952         // What this boils down to is:
 953         //
 954         // * Binaries use jemalloc
 955         // * Staticlibs and Rust dylibs use system malloc
 956         // * Rust dylibs used as dependencies to rust use jemalloc
 957         let name = if need_lib_alloc && !self.sess.opts.cg.prefer_dynamic {
 958             Symbol::intern(&self.sess.target.target.options.lib_allocation_crate)
 959         } else {
 960             Symbol::intern(&self.sess.target.target.options.exe_allocation_crate)
 961         };
 962         let dep_kind = DepKind::Implicit;
 963         let (cnum, data) =
 964             self.resolve_crate(&None, name, name, None, DUMMY_SP, PathKind::Crate, dep_kind);
 965
 966         // Sanity check the crate we loaded to ensure that it is indeed an
 967         // allocator.
 968         if !data.is_allocator(dep_graph) {
 969             self.sess.err(&format!("the allocator crate `{}` is not tagged \
 970                                     with #![allocator]", data.name()));
 971         }
 972
 973         self.sess.injected_allocator.set(Some(cnum));
 974         self.inject_dependency_if(cnum, "an allocator",
 975                                   &|data| data.needs_allocator(dep_graph));
 976     }
 977
 978     fn inject_dependency_if(&self,
 979                             krate: CrateNum,
 980                             what: &str,
 981                             needs_dep: &Fn(&cstore::CrateMetadata) -> bool) {
 982         // don't perform this validation if the session has errors, as one of
 983         // those errors may indicate a circular dependency which could cause
 984         // this to stack overflow.
 985         if self.sess.has_errors() {
 986             return
 987         }
 988
 989         // Before we inject any dependencies, make sure we don't inject a
 990         // circular dependency by validating that this crate doesn't
 991         // transitively depend on any crates satisfying `needs_dep`.
 992         for dep in self.cstore.crate_dependencies_in_rpo(krate) {
 993             let data = self.cstore.get_crate_data(dep);
 994             if needs_dep(&data) {
 995                 self.sess.err(&format!("the crate `{}` cannot depend \
 996                                         on a crate that needs {}, but \
 997                                         it depends on `{}`",
 998                                        self.cstore.get_crate_data(krate).name(),
 999                                        what,
1000                                        data.name()));
1001             }
1002         }
1003
1004         // All crates satisfying `needs_dep` do not explicitly depend on the
1005         // crate provided for this compile, but in order for this compilation to
1006         // be successfully linked we need to inject a dependency (to order the
1007         // crates on the command line correctly).
1008         self.cstore.iter_crate_data(|cnum, data| {
1009             if !needs_dep(data) {
1010                 return
1011             }
1012
1013             info!("injecting a dep from {} to {}", cnum, krate);
1014             data.cnum_map.borrow_mut().push(krate);
1015         });
1016     }
1017 }
1018
1019 impl<'a> CrateLoader<'a> {
1020     pub fn preprocess(&mut self, krate: &ast::Crate) {
1021         for attr in &krate.attrs {
1022             if attr.path == "link_args" {
1023                 if let Some(linkarg) = attr.value_str() {
1024                     self.cstore.add_used_link_args(&linkarg.as_str());
1025                 }
1026             }
1027         }
1028     }
1029
1030     fn process_foreign_mod(&mut self, i: &ast::Item, fm: &ast::ForeignMod,
1031                            definitions: &Definitions) {
1032         if fm.abi == Abi::Rust || fm.abi == Abi::RustIntrinsic || fm.abi == Abi::PlatformIntrinsic {
1033             return;
1034         }
1035
1036         // First, add all of the custom #[link_args] attributes
1037         for m in i.attrs.iter().filter(|a| a.check_name("link_args")) {
1038             if let Some(linkarg) = m.value_str() {
1039                 self.cstore.add_used_link_args(&linkarg.as_str());
1040             }
1041         }
1042
1043         // Next, process all of the #[link(..)]-style arguments
1044         for m in i.attrs.iter().filter(|a| a.check_name("link")) {
1045             let items = match m.meta_item_list() {
1046                 Some(item) => item,
1047                 None => continue,
1048             };
1049             let kind = items.iter().find(|k| {
1050                 k.check_name("kind")
1051             }).and_then(|a| a.value_str()).map(Symbol::as_str);
1052             let kind = match kind.as_ref().map(|s| &s[..]) {
1053                 Some("static") => cstore::NativeStatic,
1054                 Some("static-nobundle") => cstore::NativeStaticNobundle,
1055                 Some("dylib") => cstore::NativeUnknown,
1056                 Some("framework") => cstore::NativeFramework,
1057                 Some(k) => {
1058                     struct_span_err!(self.sess, m.span, E0458,
1059                               "unknown kind: `{}`", k)
1060                         .span_label(m.span, "unknown kind").emit();
1061                     cstore::NativeUnknown
1062                 }
1063                 None => cstore::NativeUnknown
1064             };
1065             let n = items.iter().find(|n| {
1066                 n.check_name("name")
1067             }).and_then(|a| a.value_str());
1068             let n = match n {
1069                 Some(n) => n,
1070                 None => {
1071                     struct_span_err!(self.sess, m.span, E0459,
1072                                      "#[link(...)] specified without `name = \"foo\"`")
1073                         .span_label(m.span, "missing `name` argument").emit();
1074                     Symbol::intern("foo")
1075                 }
1076             };
1077             let cfg = items.iter().find(|k| {
1078                 k.check_name("cfg")
1079             }).and_then(|a| a.meta_item_list());
1080             let cfg = cfg.map(|list| {
1081                 list[0].meta_item().unwrap().clone()
1082             });
1083             let foreign_items = fm.items.iter()
1084                 .map(|it| definitions.opt_def_index(it.id).unwrap())
1085                 .collect();
1086             let lib = NativeLibrary {
1087                 name: n,
1088                 kind: kind,
1089                 cfg: cfg,
1090                 foreign_items: foreign_items,
1091             };
1092             register_native_lib(self.sess, self.cstore, Some(m.span), lib);
1093         }
1094     }
1095 }
1096
1097 impl<'a> middle::cstore::CrateLoader for CrateLoader<'a> {
1098     fn postprocess(&mut self, krate: &ast::Crate) {
1099         // inject the sanitizer runtime before the allocator runtime because all
1100         // sanitizers force the use of the `alloc_system` allocator
1101         self.inject_sanitizer_runtime();
1102         self.inject_allocator_crate();
1103         self.inject_panic_runtime(krate);
1104
1105         if log_enabled!(log::LogLevel::Info) {
1106             dump_crates(&self.cstore);
1107         }
1108
1109         // Process libs passed on the command line
1110         // First, check for errors
1111         let mut renames = FxHashSet();
1112         for &(ref name, ref new_name, _) in &self.sess.opts.libs {
1113             if let &Some(ref new_name) = new_name {
1114                 if new_name.is_empty() {
1115                     self.sess.err(
1116                         &format!("an empty renaming target was specified for library `{}`",name));
1117                 } else if !self.cstore.get_used_libraries().borrow().iter()
1118                                                            .any(|lib| lib.name == name as &str) {
1119                     self.sess.err(&format!("renaming of the library `{}` was specified, \
1120                                             however this crate contains no #[link(...)] \
1121                                             attributes referencing this library.", name));
1122                 } else if renames.contains(name) {
1123                     self.sess.err(&format!("multiple renamings were specified for library `{}` .",
1124                                             name));
1125                 } else {
1126                     renames.insert(name);
1127                 }
1128             }
1129         }
1130         // Update kind and, optionally, the name of all native libaries
1131         // (there may be more than one) with the specified name.
1132         for &(ref name, ref new_name, kind) in &self.sess.opts.libs {
1133             let mut found = false;
1134             for lib in self.cstore.get_used_libraries().borrow_mut().iter_mut() {
1135                 if lib.name == name as &str {
1136                     let mut changed = false;
1137                     if let Some(k) = kind {
1138                         lib.kind = k;
1139                         changed = true;
1140                     }
1141                     if let &Some(ref new_name) = new_name {
1142                         lib.name = Symbol::intern(new_name);
1143                         changed = true;
1144                     }
1145                     if !changed {
1146                         self.sess.warn(&format!("redundant linker flag specified for library `{}`",
1147                                                 name));
1148                     }
1149
1150                     found = true;
1151                 }
1152             }
1153             if !found {
1154                 // Add if not found
1155                 let new_name = new_name.as_ref().map(|s| &**s); // &Option<String> -> Option<&str>
1156                 let lib = NativeLibrary {
1157                     name: Symbol::intern(new_name.unwrap_or(name)),
1158                     kind: if let Some(k) = kind { k } else { cstore::NativeUnknown },
1159                     cfg: None,
1160                     foreign_items: Vec::new(),
1161                 };
1162                 register_native_lib(self.sess, self.cstore, None, lib);
1163             }
1164         }
1165         self.register_statically_included_foreign_items();
1166         self.register_dllimport_foreign_items();
1167     }
1168
1169     fn process_item(&mut self, item: &ast::Item, definitions: &Definitions) {
1170         match item.node {
1171             ast::ItemKind::ForeignMod(ref fm) => {
1172                 self.process_foreign_mod(item, fm, definitions)
1173             },
1174             ast::ItemKind::ExternCrate(_) => {
1175                 let info = self.extract_crate_info(item).unwrap();
1176                 let (cnum, ..) = self.resolve_crate(
1177                     &None, info.ident, info.name, None, item.span, PathKind::Crate, info.dep_kind,
1178                 );
1179
1180                 let def_id = definitions.opt_local_def_id(item.id).unwrap();
1181                 let len = definitions.def_path(def_id.index).data.len();
1182
1183                 let extern_crate =
1184                     ExternCrate { def_id: def_id, span: item.span, direct: true, path_len: len };
1185                 self.update_extern_crate(cnum, extern_crate, &mut FxHashSet());
1186                 self.cstore.add_extern_mod_stmt_cnum(info.id, cnum);
1187             }
1188             _ => {}
1189         }
1190     }
1191 }