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;
  16
  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;
  24 use rustc::middle;
  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;
  30
  31 use std::cell::{RefCell, Cell};
  32 use std::ops::Deref;
  33 use std::path::PathBuf;
  34 use std::rc::Rc;
  35 use std::{cmp, fs};
  36
  37 use syntax::ast;
  38 use syntax::abi::Abi;
  39 use syntax::attr;
  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};
  44 use log;
  45
  46 pub struct Library {
  47     pub dylib: Option<(PathBuf, PathKind)>,
  48     pub rlib: Option<(PathBuf, PathKind)>,
  49     pub rmeta: Option<(PathBuf, PathKind)>,
  50     pub metadata: MetadataBlob,
  51 }
  52
  53 pub struct CrateLoader<'a> {
  54     pub sess: &'a Session,
  55     cstore: &'a CStore,
  56     next_crate_num: CrateNum,
  57     local_crate_name: Symbol,
  58 }
  59
  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()));
  71     });
  72 }
  73
  74 #[derive(Debug)]
  75 struct ExternCrateInfo {
  76     ident: Symbol,
  77     name: Symbol,
  78     id: ast::NodeId,
  79     dep_kind: DepKind,
  80 }
  81
  82 fn register_native_lib(sess: &Session,
  83                        cstore: &CStore,
  84                        span: Option<Span>,
  85                        lib: NativeLibrary) {
  86     if lib.name.as_str().is_empty() {
  87         match span {
  88             Some(span) => {
  89                 struct_span_err!(sess, span, E0454,
  90                                  "#[link(name = \"\")] given with empty name")
  91                     .span_label(span, &format!("empty name given"))
  92                     .emit();
  93             }
  94             None => {
  95                 sess.err("empty library name given via `-l`");
  96             }
  97         }
  98         return
  99     }
 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 macOS targets";
 103         match span {
 104             Some(span) => span_err!(sess, span, E0455, "{}", msg),
 105             None => sess.err(msg),
 106         }
 107     }
 108     if lib.cfg.is_some() && !sess.features.borrow().link_cfg {
 109         feature_gate::emit_feature_err(&sess.parse_sess,
 110                                        "link_cfg",
 111                                        span.unwrap(),
 112                                        GateIssue::Language,
 113                                        "is feature gated");
 114     }
 115     if lib.kind == cstore::NativeStaticNobundle && !sess.features.borrow().static_nobundle {
 116         feature_gate::emit_feature_err(&sess.parse_sess,
 117                                        "static_nobundle",
 118                                        span.unwrap(),
 119                                        GateIssue::Language,
 120                                        "kind=\"static-nobundle\" is feature gated");
 121     }
 122     cstore.add_used_library(lib);
 123 }
 124
 125 fn relevant_lib(sess: &Session, lib: &NativeLibrary) -> bool {
 126     match lib.cfg {
 127         Some(ref cfg) => attr::cfg_matches(cfg, &sess.parse_sess, None),
 128         None => true,
 129     }
 130 }
 131
 132 // Extra info about a crate loaded for plugins or exported macros.
 133 struct ExtensionCrate {
 134     metadata: PMDSource,
 135     dylib: Option<PathBuf>,
 136     target_only: bool,
 137 }
 138
 139 enum PMDSource {
 140     Registered(Rc<cstore::CrateMetadata>),
 141     Owned(Library),
 142 }
 143
 144 impl Deref for PMDSource {
 145     type Target = MetadataBlob;
 146
 147     fn deref(&self) -> &MetadataBlob {
 148         match *self {
 149             PMDSource::Registered(ref cmd) => &cmd.blob,
 150             PMDSource::Owned(ref lib) => &lib.metadata
 151         }
 152     }
 153 }
 154
 155 enum LoadResult {
 156     Previous(CrateNum),
 157     Loaded(Library),
 158 }
 159
 160 impl<'a> CrateLoader<'a> {
 161     pub fn new(sess: &'a Session, cstore: &'a CStore, local_crate_name: &str) -> Self {
 162         CrateLoader {
 163             sess: sess,
 164             cstore: cstore,
 165             next_crate_num: cstore.next_crate_num(),
 166             local_crate_name: Symbol::intern(local_crate_name),
 167         }
 168     }
 169
 170     fn extract_crate_info(&self, i: &ast::Item) -> Option<ExternCrateInfo> {
 171         match i.node {
 172             ast::ItemKind::ExternCrate(ref path_opt) => {
 173                 debug!("resolving extern crate stmt. ident: {} path_opt: {:?}",
 174                        i.ident, path_opt);
 175                 let name = match *path_opt {
 176                     Some(name) => {
 177                         validate_crate_name(Some(self.sess), &name.as_str(),
 178                                             Some(i.span));
 179                         name
 180                     }
 181                     None => i.ident.name,
 182                 };
 183                 Some(ExternCrateInfo {
 184                     ident: i.ident.name,
 185                     name: name,
 186                     id: i.id,
 187                     dep_kind: if attr::contains_name(&i.attrs, "no_link") {
 188                         DepKind::UnexportedMacrosOnly
 189                     } else {
 190                         DepKind::Explicit
 191                     },
 192                 })
 193             }
 194             _ => None
 195         }
 196     }
 197
 198     fn existing_match(&self, name: Symbol, hash: Option<&Svh>, kind: PathKind)
 199                       -> Option<CrateNum> {
 200         let mut ret = None;
 201         self.cstore.iter_crate_data(|cnum, data| {
 202             if data.name != name { return }
 203
 204             match hash {
 205                 Some(hash) if *hash == data.hash() => { ret = Some(cnum); return }
 206                 Some(..) => return,
 207                 None => {}
 208             }
 209
 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.
 215             //
 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()
 225                 });
 226                 if found {
 227                     ret = Some(cnum);
 228                 }
 229                 return
 230             }
 231
 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())
 239                                   .unwrap().1;
 240             if ret.is_none() && (prev_kind == kind || prev_kind == PathKind::All) {
 241                 ret = Some(cnum);
 242             }
 243         });
 244         return ret;
 245     }
 246
 247     fn verify_no_symbol_conflicts(&self,
 248                                   span: Span,
 249                                   root: &CrateRoot) {
 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.",
 258                         root.name)
 259         }
 260
 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.",
 270                         root.name)
 271             }
 272         });
 273     }
 274
 275     fn register_crate(&mut self,
 276                       root: &Option<CratePaths>,
 277                       ident: Symbol,
 278                       name: Symbol,
 279                       span: Span,
 280                       lib: Library,
 281                       dep_kind: DepKind)
 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);
 286
 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);
 290
 291         // Stash paths for top-most crate locally if necessary.
 292         let crate_paths = if root.is_none() {
 293             Some(CratePaths {
 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),
 298             })
 299         } else {
 300             None
 301         };
 302         // Maintain a reference to the top most crate.
 303         let root = if root.is_some() { root } else { &crate_paths };
 304
 305         let Library { dylib, rlib, rmeta, metadata } = lib;
 306
 307         let cnum_map = self.resolve_crate_deps(root, &crate_root, &metadata, cnum, span, dep_kind);
 308
 309         let def_path_table = record_time(&self.sess.perf_stats.decode_def_path_tables_time, || {
 310             crate_root.def_path_table.decode(&metadata)
 311         });
 312
 313         let exported_symbols = crate_root.exported_symbols.decode(&metadata).collect();
 314
 315         let mut cmeta = cstore::CrateMetadata {
 316             name: name,
 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)
 322             }),
 323             root: crate_root,
 324             blob: metadata,
 325             cnum_map: RefCell::new(cnum_map),
 326             cnum: cnum,
 327             codemap_import_info: RefCell::new(vec![]),
 328             dep_kind: Cell::new(dep_kind),
 329             source: cstore::CrateSource {
 330                 dylib: dylib,
 331                 rlib: rlib,
 332                 rmeta: rmeta,
 333             },
 334             dllimport_foreign_items: FxHashSet(),
 335         };
 336
 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)
 341                             .map(|id| *id)
 342                             .collect();
 343         cmeta.dllimport_foreign_items.extend(dllimports);
 344
 345         let cmeta = Rc::new(cmeta);
 346         self.cstore.set_crate_data(cnum, cmeta.clone());
 347         (cnum, cmeta)
 348     }
 349
 350     fn resolve_crate(&mut self,
 351                      root: &Option<CratePaths>,
 352                      ident: Symbol,
 353                      name: Symbol,
 354                      hash: Option<&Svh>,
 355                      span: Span,
 356                      path_kind: PathKind,
 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)
 362         } else {
 363             info!("falling back to a load");
 364             let mut locate_ctxt = locator::Context {
 365                 sess: self.sess,
 366                 span: span,
 367                 ident: ident,
 368                 crate_name: name,
 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,
 373                 root: root,
 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),
 381             };
 382
 383             self.load(&mut locate_ctxt).or_else(|| {
 384                 dep_kind = DepKind::UnexportedMacrosOnly;
 385
 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),
 396                     ..locate_ctxt
 397                 };
 398
 399                 self.load(&mut proc_macro_locator)
 400             }).unwrap_or_else(|| locate_ctxt.report_errs())
 401         };
 402
 403         match result {
 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;
 408                 }
 409                 data.dep_kind.set(cmp::max(data.dep_kind.get(), dep_kind));
 410                 (cnum, data)
 411             }
 412             LoadResult::Loaded(library) => {
 413                 self.register_crate(root, ident, name, span, library, dep_kind)
 414             }
 415         }
 416     }
 417
 418     fn load(&mut self, locate_ctxt: &mut locator::Context) -> Option<LoadResult> {
 419         let library = match locate_ctxt.maybe_load_library_crate() {
 420             Some(lib) => lib,
 421             None => return None,
 422         };
 423
 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.
 428         //
 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
 431         // already loaded.
 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);
 440                 }
 441             });
 442             Some(result)
 443         } else {
 444             Some(LoadResult::Loaded(library))
 445         }
 446     }
 447
 448     fn update_extern_crate(&mut self,
 449                            cnum: CrateNum,
 450                            mut extern_crate: ExternCrate,
 451                            visited: &mut FxHashSet<(CrateNum, bool)>)
 452     {
 453         if !visited.insert((cnum, extern_crate.direct)) { return }
 454
 455         let cmeta = self.cstore.get_crate_data(cnum);
 456         let old_extern_crate = cmeta.extern_crate.get();
 457
 458         // Prefer:
 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),
 466         };
 467
 468         if old_rank >= new_rank {
 469             return; // no change needed
 470         }
 471
 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);
 477         }
 478     }
 479
 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,
 485                           krate: CrateNum,
 486                           span: Span,
 487                           dep_kind: DepKind)
 488                           -> cstore::CrateNumMap {
 489         debug!("resolving deps of external crate");
 490         if crate_root.macro_derive_registrar.is_some() {
 491             return cstore::CrateNumMap::new();
 492         }
 493
 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 {
 500                 return krate;
 501             }
 502             let dep_kind = match dep_kind {
 503                 DepKind::MacrosOnly => DepKind::MacrosOnly,
 504                 _ => dep.kind,
 505             };
 506             let (local_cnum, ..) = self.resolve_crate(
 507                 root, dep.name, dep.name, Some(&dep.hash), span, PathKind::Dependency, dep_kind,
 508             );
 509             local_cnum
 510         })).collect()
 511     }
 512
 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 {
 520             sess: self.sess,
 521             span: span,
 522             ident: info.ident,
 523             crate_name: info.name,
 524             hash: None,
 525             filesearch: self.sess.host_filesearch(PathKind::Crate),
 526             target: &self.sess.host,
 527             triple: config::host_triple(),
 528             root: &None,
 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,
 535             is_proc_macro: None,
 536         };
 537         let library = self.load(&mut locate_ctxt).or_else(|| {
 538             if !is_cross {
 539                 return None
 540             }
 541             // Try loading from target crates. This will abort later if we
 542             // try to load a plugin registrar function,
 543             target_only = true;
 544
 545             locate_ctxt.target = &self.sess.target.target;
 546             locate_ctxt.triple = target_triple;
 547             locate_ctxt.filesearch = self.sess.target_filesearch(PathKind::Crate);
 548
 549             self.load(&mut locate_ctxt)
 550         });
 551         let library = match library {
 552             Some(l) => l,
 553             None => locate_ctxt.report_errs(),
 554         };
 555
 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))
 560             }
 561             LoadResult::Loaded(library) => {
 562                 let dylib = library.dylib.clone();
 563                 let metadata = PMDSource::Owned(library);
 564                 (dylib, metadata)
 565             }
 566         };
 567
 568         ExtensionCrate {
 569             metadata: metadata,
 570             dylib: dylib.map(|p| p.0),
 571             target_only: target_only,
 572         }
 573     }
 574
 575     /// Load custom derive macros.
 576     ///
 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>)> {
 584         use std::{env, mem};
 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, BangProcMacro};
 590
 591         let path = match dylib {
 592             Some(dylib) => dylib,
 593             None => span_bug!(span, "proc-macro crate not dylib"),
 594         };
 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)) {
 598             Ok(lib) => lib,
 599             Err(err) => self.sess.span_fatal(span, &err),
 600         };
 601
 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) {
 606                 Ok(f) => f,
 607                 Err(err) => self.sess.span_fatal(span, &err),
 608             };
 609             mem::transmute::<*mut u8, fn(&mut Registry)>(sym)
 610         };
 611
 612         struct MyRegistrar(Vec<(ast::Name, Rc<SyntaxExtension>)>);
 613
 614         impl Registry for MyRegistrar {
 615             fn register_custom_derive(&mut self,
 616                                       trait_name: &str,
 617                                       expand: fn(TokenStream) -> TokenStream,
 618                                       attributes: &[&'static str]) {
 619                 let attrs = attributes.iter().cloned().map(Symbol::intern).collect::<Vec<_>>();
 620                 let derive = ProcMacroDerive::new(expand, attrs.clone());
 621                 let derive = SyntaxExtension::ProcMacroDerive(Box::new(derive), attrs);
 622                 self.0.push((Symbol::intern(trait_name), Rc::new(derive)));
 623             }
 624
 625             fn register_attr_proc_macro(&mut self,
 626                                         name: &str,
 627                                         expand: fn(TokenStream, TokenStream) -> TokenStream) {
 628                 let expand = SyntaxExtension::AttrProcMacro(
 629                     Box::new(AttrProcMacro { inner: expand })
 630                 );
 631                 self.0.push((Symbol::intern(name), Rc::new(expand)));
 632             }
 633
 634             fn register_bang_proc_macro(&mut self,
 635                                         name: &str,
 636                                         expand: fn(TokenStream) -> TokenStream) {
 637                 let expand = SyntaxExtension::ProcMacro(
 638                     Box::new(BangProcMacro { inner: expand })
 639                 );
 640                 self.0.push((Symbol::intern(name), Rc::new(expand)));
 641             }
 642         }
 643
 644         let mut my_registrar = MyRegistrar(Vec::new());
 645         registrar(&mut my_registrar);
 646
 647         // Intentionally leak the dynamic library. We can't ever unload it
 648         // since the library can make things that will live arbitrarily long.
 649         mem::forget(lib);
 650         my_registrar.0
 651     }
 652
 653     /// Look for a plugin registrar. Returns library path, crate
 654     /// SVH and DefIndex of the registrar function.
 655     pub fn find_plugin_registrar(&mut self, span: Span, name: &str)
 656                                  -> Option<(PathBuf, Svh, DefIndex)> {
 657         let ekrate = self.read_extension_crate(span, &ExternCrateInfo {
 658              name: Symbol::intern(name),
 659              ident: Symbol::intern(name),
 660              id: ast::DUMMY_NODE_ID,
 661              dep_kind: DepKind::UnexportedMacrosOnly,
 662         });
 663
 664         if ekrate.target_only {
 665             // Need to abort before syntax expansion.
 666             let message = format!("plugin `{}` is not available for triple `{}` \
 667                                    (only found {})",
 668                                   name,
 669                                   config::host_triple(),
 670                                   self.sess.opts.target_triple);
 671             span_fatal!(self.sess, span, E0456, "{}", &message[..]);
 672         }
 673
 674         let root = ekrate.metadata.get_root();
 675         match (ekrate.dylib.as_ref(), root.plugin_registrar_fn) {
 676             (Some(dylib), Some(reg)) => {
 677                 Some((dylib.to_path_buf(), root.hash, reg))
 678             }
 679             (None, Some(_)) => {
 680                 span_err!(self.sess, span, E0457,
 681                           "plugin `{}` only found in rlib format, but must be available \
 682                            in dylib format",
 683                           name);
 684                 // No need to abort because the loading code will just ignore this
 685                 // empty dylib.
 686                 None
 687             }
 688             _ => None,
 689         }
 690     }
 691
 692     fn get_foreign_items_of_kind(&self, kind: cstore::NativeLibraryKind) -> Vec<DefIndex> {
 693         let mut items = vec![];
 694         let libs = self.cstore.get_used_libraries();
 695         for lib in libs.borrow().iter() {
 696             if relevant_lib(self.sess, lib) && lib.kind == kind {
 697                 items.extend(&lib.foreign_items);
 698             }
 699         }
 700         items
 701     }
 702
 703     fn register_statically_included_foreign_items(&mut self) {
 704         for id in self.get_foreign_items_of_kind(cstore::NativeStatic) {
 705             self.cstore.add_statically_included_foreign_item(id);
 706         }
 707         for id in self.get_foreign_items_of_kind(cstore::NativeStaticNobundle) {
 708             self.cstore.add_statically_included_foreign_item(id);
 709         }
 710     }
 711
 712     fn register_dllimport_foreign_items(&mut self) {
 713         let mut dllimports = self.cstore.dllimport_foreign_items.borrow_mut();
 714         for id in self.get_foreign_items_of_kind(cstore::NativeUnknown) {
 715             dllimports.insert(id);
 716         }
 717     }
 718
 719     fn inject_panic_runtime(&mut self, krate: &ast::Crate) {
 720         // If we're only compiling an rlib, then there's no need to select a
 721         // panic runtime, so we just skip this section entirely.
 722         let any_non_rlib = self.sess.crate_types.borrow().iter().any(|ct| {
 723             *ct != config::CrateTypeRlib
 724         });
 725         if !any_non_rlib {
 726             info!("panic runtime injection skipped, only generating rlib");
 727             return
 728         }
 729
 730         // If we need a panic runtime, we try to find an existing one here. At
 731         // the same time we perform some general validation of the DAG we've got
 732         // going such as ensuring everything has a compatible panic strategy.
 733         //
 734         // The logic for finding the panic runtime here is pretty much the same
 735         // as the allocator case with the only addition that the panic strategy
 736         // compilation mode also comes into play.
 737         let desired_strategy = self.sess.panic_strategy();
 738         let mut runtime_found = false;
 739         let mut needs_panic_runtime = attr::contains_name(&krate.attrs,
 740                                                           "needs_panic_runtime");
 741         self.cstore.iter_crate_data(|cnum, data| {
 742             needs_panic_runtime = needs_panic_runtime || data.needs_panic_runtime();
 743             if data.is_panic_runtime() {
 744                 // Inject a dependency from all #![needs_panic_runtime] to this
 745                 // #![panic_runtime] crate.
 746                 self.inject_dependency_if(cnum, "a panic runtime",
 747                                           &|data| data.needs_panic_runtime());
 748                 runtime_found = runtime_found || data.dep_kind.get() == DepKind::Explicit;
 749             }
 750         });
 751
 752         // If an explicitly linked and matching panic runtime was found, or if
 753         // we just don't need one at all, then we're done here and there's
 754         // nothing else to do.
 755         if !needs_panic_runtime || runtime_found {
 756             return
 757         }
 758
 759         // By this point we know that we (a) need a panic runtime and (b) no
 760         // panic runtime was explicitly linked. Here we just load an appropriate
 761         // default runtime for our panic strategy and then inject the
 762         // dependencies.
 763         //
 764         // We may resolve to an already loaded crate (as the crate may not have
 765         // been explicitly linked prior to this) and we may re-inject
 766         // dependencies again, but both of those situations are fine.
 767         //
 768         // Also note that we have yet to perform validation of the crate graph
 769         // in terms of everyone has a compatible panic runtime format, that's
 770         // performed later as part of the `dependency_format` module.
 771         let name = match desired_strategy {
 772             PanicStrategy::Unwind => Symbol::intern("panic_unwind"),
 773             PanicStrategy::Abort => Symbol::intern("panic_abort"),
 774         };
 775         info!("panic runtime not found -- loading {}", name);
 776
 777         let dep_kind = DepKind::Implicit;
 778         let (cnum, data) =
 779             self.resolve_crate(&None, name, name, None, DUMMY_SP, PathKind::Crate, dep_kind);
 780
 781         // Sanity check the loaded crate to ensure it is indeed a panic runtime
 782         // and the panic strategy is indeed what we thought it was.
 783         if !data.is_panic_runtime() {
 784             self.sess.err(&format!("the crate `{}` is not a panic runtime",
 785                                    name));
 786         }
 787         if data.panic_strategy() != desired_strategy {
 788             self.sess.err(&format!("the crate `{}` does not have the panic \
 789                                     strategy `{}`",
 790                                    name, desired_strategy.desc()));
 791         }
 792
 793         self.sess.injected_panic_runtime.set(Some(cnum));
 794         self.inject_dependency_if(cnum, "a panic runtime",
 795                                   &|data| data.needs_panic_runtime());
 796     }
 797
 798     fn inject_sanitizer_runtime(&mut self) {
 799         if let Some(ref sanitizer) = self.sess.opts.debugging_opts.sanitizer {
 800             // Sanitizers can only be used with x86_64 Linux executables linked
 801             // to `std`
 802             if self.sess.target.target.llvm_target != "x86_64-unknown-linux-gnu" {
 803                 self.sess.err(&format!("Sanitizers only work with the \
 804                                         `x86_64-unknown-linux-gnu` target."));
 805                 return
 806             }
 807
 808             if !self.sess.crate_types.borrow().iter().all(|ct| {
 809                 match *ct {
 810                     // Link the runtime
 811                     config::CrateTypeExecutable => true,
 812                     // This crate will be compiled with the required
 813                     // instrumentation pass
 814                     config::CrateTypeRlib => false,
 815                     _ => {
 816                         self.sess.err(&format!("Only executables and rlibs can be \
 817                                                 compiled with `-Z sanitizer`"));
 818                         false
 819                     }
 820                 }
 821             }) {
 822                 return
 823             }
 824
 825             let mut uses_std = false;
 826             self.cstore.iter_crate_data(|_, data| {
 827                 if data.name == "std" {
 828                     uses_std = true;
 829                 }
 830             });
 831
 832             if uses_std {
 833                 let name = match *sanitizer {
 834                     Sanitizer::Address => "rustc_asan",
 835                     Sanitizer::Leak => "rustc_lsan",
 836                     Sanitizer::Memory => "rustc_msan",
 837                     Sanitizer::Thread => "rustc_tsan",
 838                 };
 839                 info!("loading sanitizer: {}", name);
 840
 841                 let symbol = Symbol::intern(name);
 842                 let dep_kind = DepKind::Implicit;
 843                 let (_, data) =
 844                     self.resolve_crate(&None, symbol, symbol, None, DUMMY_SP,
 845                                        PathKind::Crate, dep_kind);
 846
 847                 // Sanity check the loaded crate to ensure it is indeed a sanitizer runtime
 848                 if !data.is_sanitizer_runtime() {
 849                     self.sess.err(&format!("the crate `{}` is not a sanitizer runtime",
 850                                            name));
 851                 }
 852             }
 853         }
 854     }
 855
 856     fn inject_allocator_crate(&mut self) {
 857         // Make sure that we actually need an allocator, if none of our
 858         // dependencies need one then we definitely don't!
 859         //
 860         // Also, if one of our dependencies has an explicit allocator, then we
 861         // also bail out as we don't need to implicitly inject one.
 862         let mut needs_allocator = false;
 863         let mut found_required_allocator = false;
 864         self.cstore.iter_crate_data(|cnum, data| {
 865             needs_allocator = needs_allocator || data.needs_allocator();
 866             if data.is_allocator() {
 867                 info!("{} required by rlib and is an allocator", data.name());
 868                 self.inject_dependency_if(cnum, "an allocator",
 869                                           &|data| data.needs_allocator());
 870                 found_required_allocator = found_required_allocator ||
 871                     data.dep_kind.get() == DepKind::Explicit;
 872             }
 873         });
 874         if !needs_allocator || found_required_allocator { return }
 875
 876         // At this point we've determined that we need an allocator and no
 877         // previous allocator has been activated. We look through our outputs of
 878         // crate types to see what kind of allocator types we may need.
 879         //
 880         // The main special output type here is that rlibs do **not** need an
 881         // allocator linked in (they're just object files), only final products
 882         // (exes, dylibs, staticlibs) need allocators.
 883         let mut need_lib_alloc = false;
 884         let mut need_exe_alloc = false;
 885         for ct in self.sess.crate_types.borrow().iter() {
 886             match *ct {
 887                 config::CrateTypeExecutable => need_exe_alloc = true,
 888                 config::CrateTypeDylib |
 889                 config::CrateTypeProcMacro |
 890                 config::CrateTypeCdylib |
 891                 config::CrateTypeStaticlib => need_lib_alloc = true,
 892                 config::CrateTypeRlib => {}
 893             }
 894         }
 895         if !need_lib_alloc && !need_exe_alloc { return }
 896
 897         // The default allocator crate comes from the custom target spec, and we
 898         // choose between the standard library allocator or exe allocator. This
 899         // distinction exists because the default allocator for binaries (where
 900         // the world is Rust) is different than library (where the world is
 901         // likely *not* Rust).
 902         //
 903         // If a library is being produced, but we're also flagged with `-C
 904         // prefer-dynamic`, then we interpret this as a *Rust* dynamic library
 905         // is being produced so we use the exe allocator instead.
 906         //
 907         // What this boils down to is:
 908         //
 909         // * Binaries use jemalloc
 910         // * Staticlibs and Rust dylibs use system malloc
 911         // * Rust dylibs used as dependencies to rust use jemalloc
 912         let name = if need_lib_alloc && !self.sess.opts.cg.prefer_dynamic {
 913             Symbol::intern(&self.sess.target.target.options.lib_allocation_crate)
 914         } else {
 915             Symbol::intern(&self.sess.target.target.options.exe_allocation_crate)
 916         };
 917         let dep_kind = DepKind::Implicit;
 918         let (cnum, data) =
 919             self.resolve_crate(&None, name, name, None, DUMMY_SP, PathKind::Crate, dep_kind);
 920
 921         // Sanity check the crate we loaded to ensure that it is indeed an
 922         // allocator.
 923         if !data.is_allocator() {
 924             self.sess.err(&format!("the allocator crate `{}` is not tagged \
 925                                     with #![allocator]", data.name()));
 926         }
 927
 928         self.sess.injected_allocator.set(Some(cnum));
 929         self.inject_dependency_if(cnum, "an allocator",
 930                                   &|data| data.needs_allocator());
 931     }
 932
 933     fn inject_dependency_if(&self,
 934                             krate: CrateNum,
 935                             what: &str,
 936                             needs_dep: &Fn(&cstore::CrateMetadata) -> bool) {
 937         // don't perform this validation if the session has errors, as one of
 938         // those errors may indicate a circular dependency which could cause
 939         // this to stack overflow.
 940         if self.sess.has_errors() {
 941             return
 942         }
 943
 944         // Before we inject any dependencies, make sure we don't inject a
 945         // circular dependency by validating that this crate doesn't
 946         // transitively depend on any crates satisfying `needs_dep`.
 947         for dep in self.cstore.crate_dependencies_in_rpo(krate) {
 948             let data = self.cstore.get_crate_data(dep);
 949             if needs_dep(&data) {
 950                 self.sess.err(&format!("the crate `{}` cannot depend \
 951                                         on a crate that needs {}, but \
 952                                         it depends on `{}`",
 953                                        self.cstore.get_crate_data(krate).name(),
 954                                        what,
 955                                        data.name()));
 956             }
 957         }
 958
 959         // All crates satisfying `needs_dep` do not explicitly depend on the
 960         // crate provided for this compile, but in order for this compilation to
 961         // be successfully linked we need to inject a dependency (to order the
 962         // crates on the command line correctly).
 963         self.cstore.iter_crate_data(|cnum, data| {
 964             if !needs_dep(data) {
 965                 return
 966             }
 967
 968             info!("injecting a dep from {} to {}", cnum, krate);
 969             data.cnum_map.borrow_mut().push(krate);
 970         });
 971     }
 972 }
 973
 974 impl<'a> CrateLoader<'a> {
 975     pub fn preprocess(&mut self, krate: &ast::Crate) {
 976         for attr in &krate.attrs {
 977             if attr.path == "link_args" {
 978                 if let Some(linkarg) = attr.value_str() {
 979                     self.cstore.add_used_link_args(&linkarg.as_str());
 980                 }
 981             }
 982         }
 983     }
 984
 985     fn process_foreign_mod(&mut self, i: &ast::Item, fm: &ast::ForeignMod,
 986                            definitions: &Definitions) {
 987         if fm.abi == Abi::Rust || fm.abi == Abi::RustIntrinsic || fm.abi == Abi::PlatformIntrinsic {
 988             return;
 989         }
 990
 991         // First, add all of the custom #[link_args] attributes
 992         for m in i.attrs.iter().filter(|a| a.check_name("link_args")) {
 993             if let Some(linkarg) = m.value_str() {
 994                 self.cstore.add_used_link_args(&linkarg.as_str());
 995             }
 996         }
 997
 998         // Next, process all of the #[link(..)]-style arguments
 999         for m in i.attrs.iter().filter(|a| a.check_name("link")) {
1000             let items = match m.meta_item_list() {
1001                 Some(item) => item,
1002                 None => continue,
1003             };
1004             let kind = items.iter().find(|k| {
1005                 k.check_name("kind")
1006             }).and_then(|a| a.value_str()).map(Symbol::as_str);
1007             let kind = match kind.as_ref().map(|s| &s[..]) {
1008                 Some("static") => cstore::NativeStatic,
1009                 Some("static-nobundle") => cstore::NativeStaticNobundle,
1010                 Some("dylib") => cstore::NativeUnknown,
1011                 Some("framework") => cstore::NativeFramework,
1012                 Some(k) => {
1013                     struct_span_err!(self.sess, m.span, E0458,
1014                               "unknown kind: `{}`", k)
1015                         .span_label(m.span, &format!("unknown kind")).emit();
1016                     cstore::NativeUnknown
1017                 }
1018                 None => cstore::NativeUnknown
1019             };
1020             let n = items.iter().find(|n| {
1021                 n.check_name("name")
1022             }).and_then(|a| a.value_str());
1023             let n = match n {
1024                 Some(n) => n,
1025                 None => {
1026                     struct_span_err!(self.sess, m.span, E0459,
1027                                      "#[link(...)] specified without `name = \"foo\"`")
1028                         .span_label(m.span, &format!("missing `name` argument")).emit();
1029                     Symbol::intern("foo")
1030                 }
1031             };
1032             let cfg = items.iter().find(|k| {
1033                 k.check_name("cfg")
1034             }).and_then(|a| a.meta_item_list());
1035             let cfg = cfg.map(|list| {
1036                 list[0].meta_item().unwrap().clone()
1037             });
1038             let foreign_items = fm.items.iter()
1039                 .map(|it| definitions.opt_def_index(it.id).unwrap())
1040                 .collect();
1041             let lib = NativeLibrary {
1042                 name: n,
1043                 kind: kind,
1044                 cfg: cfg,
1045                 foreign_items: foreign_items,
1046             };
1047             register_native_lib(self.sess, self.cstore, Some(m.span), lib);
1048         }
1049     }
1050 }
1051
1052 impl<'a> middle::cstore::CrateLoader for CrateLoader<'a> {
1053     fn postprocess(&mut self, krate: &ast::Crate) {
1054         // inject the sanitizer runtime before the allocator runtime because all
1055         // sanitizers force the use of the `alloc_system` allocator
1056         self.inject_sanitizer_runtime();
1057         self.inject_allocator_crate();
1058         self.inject_panic_runtime(krate);
1059
1060         if log_enabled!(log::INFO) {
1061             dump_crates(&self.cstore);
1062         }
1063
1064         // Process libs passed on the command line
1065         // First, check for errors
1066         let mut renames = FxHashSet();
1067         for &(ref name, ref new_name, _) in &self.sess.opts.libs {
1068             if let &Some(ref new_name) = new_name {
1069                 if new_name.is_empty() {
1070                     self.sess.err(
1071                         &format!("an empty renaming target was specified for library `{}`",name));
1072                 } else if !self.cstore.get_used_libraries().borrow().iter()
1073                                                            .any(|lib| lib.name == name as &str) {
1074                     self.sess.err(&format!("renaming of the library `{}` was specified, \
1075                                             however this crate contains no #[link(...)] \
1076                                             attributes referencing this library.", name));
1077                 } else if renames.contains(name) {
1078                     self.sess.err(&format!("multiple renamings were specified for library `{}` .",
1079                                             name));
1080                 } else {
1081                     renames.insert(name);
1082                 }
1083             }
1084         }
1085         // Update kind and, optionally, the name of all native libaries
1086         // (there may be more than one) with the specified name.
1087         for &(ref name, ref new_name, kind) in &self.sess.opts.libs {
1088             let mut found = false;
1089             for lib in self.cstore.get_used_libraries().borrow_mut().iter_mut() {
1090                 if lib.name == name as &str {
1091                     let mut changed = false;
1092                     if let Some(k) = kind {
1093                         lib.kind = k;
1094                         changed = true;
1095                     }
1096                     if let &Some(ref new_name) = new_name {
1097                         lib.name = Symbol::intern(new_name);
1098                         changed = true;
1099                     }
1100                     if !changed {
1101                         self.sess.warn(&format!("redundant linker flag specified for library `{}`",
1102                                                 name));
1103                     }
1104
1105                     found = true;
1106                 }
1107             }
1108             if !found {
1109                 // Add if not found
1110                 let new_name = new_name.as_ref().map(|s| &**s); // &Option<String> -> Option<&str>
1111                 let lib = NativeLibrary {
1112                     name: Symbol::intern(new_name.unwrap_or(name)),
1113                     kind: if let Some(k) = kind { k } else { cstore::NativeUnknown },
1114                     cfg: None,
1115                     foreign_items: Vec::new(),
1116                 };
1117                 register_native_lib(self.sess, self.cstore, None, lib);
1118             }
1119         }
1120         self.register_statically_included_foreign_items();
1121         self.register_dllimport_foreign_items();
1122     }
1123
1124     fn process_item(&mut self, item: &ast::Item, definitions: &Definitions) {
1125         match item.node {
1126             ast::ItemKind::ForeignMod(ref fm) => {
1127                 self.process_foreign_mod(item, fm, definitions)
1128             },
1129             ast::ItemKind::ExternCrate(_) => {
1130                 let info = self.extract_crate_info(item).unwrap();
1131                 let (cnum, ..) = self.resolve_crate(
1132                     &None, info.ident, info.name, None, item.span, PathKind::Crate, info.dep_kind,
1133                 );
1134
1135                 let def_id = definitions.opt_local_def_id(item.id).unwrap();
1136                 let len = definitions.def_path(def_id.index).data.len();
1137
1138                 let extern_crate =
1139                     ExternCrate { def_id: def_id, span: item.span, direct: true, path_len: len };
1140                 self.update_extern_crate(cnum, extern_crate, &mut FxHashSet());
1141                 self.cstore.add_extern_mod_stmt_cnum(info.id, cnum);
1142             }
1143             _ => {}
1144         }
1145     }
1146 }