src/librustc_plugin_impl/load.rs

   1 //! Used by `rustc` when loading a plugin.
   2
   3 use crate::Registry;
   4 use rustc_ast::ast::Crate;
   5 use rustc_errors::struct_span_err;
   6 use rustc_metadata::locator;
   7 use rustc_middle::middle::cstore::MetadataLoader;
   8 use rustc_session::Session;
   9 use rustc_span::symbol::{sym, Ident};
  10 use rustc_span::Span;
  11
  12 use std::borrow::ToOwned;
  13 use std::env;
  14 use std::mem;
  15 use std::path::PathBuf;
  16
  17 /// Pointer to a registrar function.
  18 type PluginRegistrarFn = fn(&mut Registry<'_>);
  19
  20 fn call_malformed_plugin_attribute(sess: &Session, span: Span) {
  21     struct_span_err!(sess, span, E0498, "malformed `plugin` attribute")
  22         .span_label(span, "malformed attribute")
  23         .emit();
  24 }
  25
  26 /// Read plugin metadata and dynamically load registrar functions.
  27 pub fn load_plugins(
  28     sess: &Session,
  29     metadata_loader: &dyn MetadataLoader,
  30     krate: &Crate,
  31 ) -> Vec<PluginRegistrarFn> {
  32     let mut plugins = Vec::new();
  33
  34     for attr in &krate.attrs {
  35         if !attr.check_name(sym::plugin) {
  36             continue;
  37         }
  38
  39         for plugin in attr.meta_item_list().unwrap_or_default() {
  40             match plugin.ident() {
  41                 Some(ident) if plugin.is_word() => {
  42                     load_plugin(&mut plugins, sess, metadata_loader, ident)
  43                 }
  44                 _ => call_malformed_plugin_attribute(sess, plugin.span()),
  45             }
  46         }
  47     }
  48
  49     plugins
  50 }
  51
  52 fn load_plugin(
  53     plugins: &mut Vec<PluginRegistrarFn>,
  54     sess: &Session,
  55     metadata_loader: &dyn MetadataLoader,
  56     ident: Ident,
  57 ) {
  58     let registrar = locator::find_plugin_registrar(sess, metadata_loader, ident.span, ident.name);
  59
  60     if let Some((lib, disambiguator)) = registrar {
  61         let symbol = sess.generate_plugin_registrar_symbol(disambiguator);
  62         let fun = dylink_registrar(sess, ident.span, lib, symbol);
  63         plugins.push(fun);
  64     }
  65 }
  66
  67 // Dynamically link a registrar function into the compiler process.
  68 fn dylink_registrar(
  69     sess: &Session,
  70     span: Span,
  71     path: PathBuf,
  72     symbol: String,
  73 ) -> PluginRegistrarFn {
  74     use rustc_metadata::dynamic_lib::DynamicLibrary;
  75
  76     // Make sure the path contains a / or the linker will search for it.
  77     let path = env::current_dir().unwrap().join(&path);
  78
  79     let lib = match DynamicLibrary::open(&path) {
  80         Ok(lib) => lib,
  81         // this is fatal: there are almost certainly macros we need
  82         // inside this crate, so continue would spew "macro undefined"
  83         // errors
  84         Err(err) => sess.span_fatal(span, &err),
  85     };
  86
  87     unsafe {
  88         let registrar = match lib.symbol(&symbol) {
  89             Ok(registrar) => mem::transmute::<*mut u8, PluginRegistrarFn>(registrar),
  90             // again fatal if we can't register macros
  91             Err(err) => sess.span_fatal(span, &err),
  92         };
  93
  94         // Intentionally leak the dynamic library. We can't ever unload it
  95         // since the library can make things that will live arbitrarily long
  96         // (e.g., an @-box cycle or a thread).
  97         mem::forget(lib);
  98
  99         registrar
 100     }
 101 }