compiler/rustc_interface/src/interface.rs

   1 pub use crate::passes::BoxedResolver;
   2 use crate::util;
   3
   4 use rustc_ast::token;
   5 use rustc_ast::{self as ast, LitKind, MetaItemKind};
   6 use rustc_codegen_ssa::traits::CodegenBackend;
   7 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
   8 use rustc_data_structures::sync::Lrc;
   9 use rustc_data_structures::OnDrop;
  10 use rustc_errors::registry::Registry;
  11 use rustc_errors::{ErrorGuaranteed, Handler};
  12 use rustc_lint::LintStore;
  13 use rustc_middle::ty;
  14 use rustc_parse::maybe_new_parser_from_source_str;
  15 use rustc_query_impl::QueryCtxt;
  16 use rustc_session::config::{self, CheckCfg, ErrorOutputType, Input, OutputFilenames};
  17 use rustc_session::lint;
  18 use rustc_session::parse::{CrateConfig, ParseSess};
  19 use rustc_session::Session;
  20 use rustc_session::{early_error, CompilerIO};
  21 use rustc_span::source_map::{FileLoader, FileName};
  22 use rustc_span::symbol::sym;
  23 use std::path::PathBuf;
  24 use std::result;
  25
  26 pub type Result<T> = result::Result<T, ErrorGuaranteed>;
  27
  28 /// Represents a compiler session. Note that every `Compiler` contains a
  29 /// `Session`, but `Compiler` also contains some things that cannot be in
  30 /// `Session`, due to `Session` being in a crate that has many fewer
  31 /// dependencies than this crate.
  32 ///
  33 /// Can be used to run `rustc_interface` queries.
  34 /// Created by passing [`Config`] to [`run_compiler`].
  35 pub struct Compiler {
  36     pub(crate) sess: Lrc<Session>,
  37     codegen_backend: Lrc<Box<dyn CodegenBackend>>,
  38     pub(crate) register_lints: Option<Box<dyn Fn(&Session, &mut LintStore) + Send + Sync>>,
  39     pub(crate) override_queries:
  40         Option<fn(&Session, &mut ty::query::Providers, &mut ty::query::ExternProviders)>,
  41 }
  42
  43 impl Compiler {
  44     pub fn session(&self) -> &Lrc<Session> {
  45         &self.sess
  46     }
  47     pub fn codegen_backend(&self) -> &Lrc<Box<dyn CodegenBackend>> {
  48         &self.codegen_backend
  49     }
  50     pub fn register_lints(&self) -> &Option<Box<dyn Fn(&Session, &mut LintStore) + Send + Sync>> {
  51         &self.register_lints
  52     }
  53     pub fn build_output_filenames(
  54         &self,
  55         sess: &Session,
  56         attrs: &[ast::Attribute],
  57     ) -> OutputFilenames {
  58         util::build_output_filenames(attrs, sess)
  59     }
  60 }
  61
  62 /// Converts strings provided as `--cfg [cfgspec]` into a `crate_cfg`.
  63 pub fn parse_cfgspecs(cfgspecs: Vec<String>) -> FxHashSet<(String, Option<String>)> {
  64     rustc_span::create_default_session_if_not_set_then(move |_| {
  65         let cfg = cfgspecs
  66             .into_iter()
  67             .map(|s| {
  68                 let sess = ParseSess::with_silent_emitter(Some(format!(
  69                     "this error occurred on the command line: `--cfg={s}`"
  70                 )));
  71                 let filename = FileName::cfg_spec_source_code(&s);
  72
  73                 macro_rules! error {
  74                     ($reason: expr) => {
  75                         early_error(
  76                             ErrorOutputType::default(),
  77                             &format!(concat!("invalid `--cfg` argument: `{}` (", $reason, ")"), s),
  78                         );
  79                     };
  80                 }
  81
  82                 match maybe_new_parser_from_source_str(&sess, filename, s.to_string()) {
  83                     Ok(mut parser) => match parser.parse_meta_item() {
  84                         Ok(meta_item) if parser.token == token::Eof => {
  85                             if meta_item.path.segments.len() != 1 {
  86                                 error!("argument key must be an identifier");
  87                             }
  88                             match &meta_item.kind {
  89                                 MetaItemKind::List(..) => {}
  90                                 MetaItemKind::NameValue(lit) if !lit.kind.is_str() => {
  91                                     error!("argument value must be a string");
  92                                 }
  93                                 MetaItemKind::NameValue(..) | MetaItemKind::Word => {
  94                                     let ident = meta_item.ident().expect("multi-segment cfg key");
  95                                     return (ident.name, meta_item.value_str());
  96                                 }
  97                             }
  98                         }
  99                         Ok(..) => {}
 100                         Err(err) => err.cancel(),
 101                     },
 102                     Err(errs) => drop(errs),
 103                 }
 104
 105                 // If the user tried to use a key="value" flag, but is missing the quotes, provide
 106                 // a hint about how to resolve this.
 107                 if s.contains('=') && !s.contains("=\"") && !s.ends_with('"') {
 108                     error!(concat!(
 109                         r#"expected `key` or `key="value"`, ensure escaping is appropriate"#,
 110                         r#" for your shell, try 'key="value"' or key=\"value\""#
 111                     ));
 112                 } else {
 113                     error!(r#"expected `key` or `key="value"`"#);
 114                 }
 115             })
 116             .collect::<CrateConfig>();
 117         cfg.into_iter().map(|(a, b)| (a.to_string(), b.map(|b| b.to_string()))).collect()
 118     })
 119 }
 120
 121 /// Converts strings provided as `--check-cfg [specs]` into a `CheckCfg`.
 122 pub fn parse_check_cfg(specs: Vec<String>) -> CheckCfg {
 123     rustc_span::create_default_session_if_not_set_then(move |_| {
 124         let mut cfg = CheckCfg::default();
 125
 126         'specs: for s in specs {
 127             let sess = ParseSess::with_silent_emitter(Some(format!(
 128                 "this error occurred on the command line: `--check-cfg={s}`"
 129             )));
 130             let filename = FileName::cfg_spec_source_code(&s);
 131
 132             macro_rules! error {
 133                 ($reason: expr) => {
 134                     early_error(
 135                         ErrorOutputType::default(),
 136                         &format!(
 137                             concat!("invalid `--check-cfg` argument: `{}` (", $reason, ")"),
 138                             s
 139                         ),
 140                     );
 141                 };
 142             }
 143
 144             match maybe_new_parser_from_source_str(&sess, filename, s.to_string()) {
 145                 Ok(mut parser) => match parser.parse_meta_item() {
 146                     Ok(meta_item) if parser.token == token::Eof => {
 147                         if let Some(args) = meta_item.meta_item_list() {
 148                             if meta_item.has_name(sym::names) {
 149                                 let names_valid =
 150                                     cfg.names_valid.get_or_insert_with(|| FxHashSet::default());
 151                                 for arg in args {
 152                                     if arg.is_word() && arg.ident().is_some() {
 153                                         let ident = arg.ident().expect("multi-segment cfg key");
 154                                         names_valid.insert(ident.name.to_string());
 155                                     } else {
 156                                         error!("`names()` arguments must be simple identifiers");
 157                                     }
 158                                 }
 159                                 continue 'specs;
 160                             } else if meta_item.has_name(sym::values) {
 161                                 if let Some((name, values)) = args.split_first() {
 162                                     if name.is_word() && name.ident().is_some() {
 163                                         let ident = name.ident().expect("multi-segment cfg key");
 164                                         let ident_values = cfg
 165                                             .values_valid
 166                                             .entry(ident.name.to_string())
 167                                             .or_insert_with(|| FxHashSet::default());
 168
 169                                         for val in values {
 170                                             if let Some(LitKind::Str(s, _)) =
 171                                                 val.lit().map(|lit| &lit.kind)
 172                                             {
 173                                                 ident_values.insert(s.to_string());
 174                                             } else {
 175                                                 error!(
 176                                                     "`values()` arguments must be string literals"
 177                                                 );
 178                                             }
 179                                         }
 180
 181                                         continue 'specs;
 182                                     } else {
 183                                         error!(
 184                                             "`values()` first argument must be a simple identifier"
 185                                         );
 186                                     }
 187                                 } else if args.is_empty() {
 188                                     cfg.well_known_values = true;
 189                                     continue 'specs;
 190                                 }
 191                             }
 192                         }
 193                     }
 194                     Ok(..) => {}
 195                     Err(err) => err.cancel(),
 196                 },
 197                 Err(errs) => drop(errs),
 198             }
 199
 200             error!(
 201                 "expected `names(name1, name2, ... nameN)` or \
 202                 `values(name, \"value1\", \"value2\", ... \"valueN\")`"
 203             );
 204         }
 205
 206         if let Some(names_valid) = &mut cfg.names_valid {
 207             names_valid.extend(cfg.values_valid.keys().cloned());
 208         }
 209         cfg
 210     })
 211 }
 212
 213 /// The compiler configuration
 214 pub struct Config {
 215     /// Command line options
 216     pub opts: config::Options,
 217
 218     /// cfg! configuration in addition to the default ones
 219     pub crate_cfg: FxHashSet<(String, Option<String>)>,
 220     pub crate_check_cfg: CheckCfg,
 221
 222     pub input: Input,
 223     pub output_dir: Option<PathBuf>,
 224     pub output_file: Option<PathBuf>,
 225     pub file_loader: Option<Box<dyn FileLoader + Send + Sync>>,
 226
 227     pub lint_caps: FxHashMap<lint::LintId, lint::Level>,
 228
 229     /// This is a callback from the driver that is called when [`ParseSess`] is created.
 230     pub parse_sess_created: Option<Box<dyn FnOnce(&mut ParseSess) + Send>>,
 231
 232     /// This is a callback from the driver that is called when we're registering lints;
 233     /// it is called during plugin registration when we have the LintStore in a non-shared state.
 234     ///
 235     /// Note that if you find a Some here you probably want to call that function in the new
 236     /// function being registered.
 237     pub register_lints: Option<Box<dyn Fn(&Session, &mut LintStore) + Send + Sync>>,
 238
 239     /// This is a callback from the driver that is called just after we have populated
 240     /// the list of queries.
 241     ///
 242     /// The second parameter is local providers and the third parameter is external providers.
 243     pub override_queries:
 244         Option<fn(&Session, &mut ty::query::Providers, &mut ty::query::ExternProviders)>,
 245
 246     /// This is a callback from the driver that is called to create a codegen backend.
 247     pub make_codegen_backend:
 248         Option<Box<dyn FnOnce(&config::Options) -> Box<dyn CodegenBackend> + Send>>,
 249
 250     /// Registry of diagnostics codes.
 251     pub registry: Registry,
 252 }
 253
 254 // JUSTIFICATION: before session exists, only config
 255 #[allow(rustc::bad_opt_access)]
 256 pub fn run_compiler<R: Send>(config: Config, f: impl FnOnce(&Compiler) -> R + Send) -> R {
 257     trace!("run_compiler");
 258     util::run_in_thread_pool_with_globals(
 259         config.opts.edition,
 260         config.opts.unstable_opts.threads,
 261         || {
 262             crate::callbacks::setup_callbacks();
 263
 264             let registry = &config.registry;
 265
 266             let temps_dir = config.opts.unstable_opts.temps_dir.as_deref().map(PathBuf::from);
 267             let (mut sess, codegen_backend) = util::create_session(
 268                 config.opts,
 269                 config.crate_cfg,
 270                 config.crate_check_cfg,
 271                 config.file_loader,
 272                 CompilerIO {
 273                     input: config.input,
 274                     output_dir: config.output_dir,
 275                     output_file: config.output_file,
 276                     temps_dir,
 277                 },
 278                 config.lint_caps,
 279                 config.make_codegen_backend,
 280                 registry.clone(),
 281             );
 282
 283             if let Some(parse_sess_created) = config.parse_sess_created {
 284                 parse_sess_created(&mut sess.parse_sess);
 285             }
 286
 287             let compiler = Compiler {
 288                 sess: Lrc::new(sess),
 289                 codegen_backend: Lrc::new(codegen_backend),
 290                 register_lints: config.register_lints,
 291                 override_queries: config.override_queries,
 292             };
 293
 294             rustc_span::with_source_map(compiler.sess.parse_sess.clone_source_map(), move || {
 295                 let r = {
 296                     let _sess_abort_error = OnDrop(|| {
 297                         compiler.sess.finish_diagnostics(registry);
 298                     });
 299
 300                     f(&compiler)
 301                 };
 302
 303                 let prof = compiler.sess.prof.clone();
 304                 prof.generic_activity("drop_compiler").run(move || drop(compiler));
 305                 r
 306             })
 307         },
 308     )
 309 }
 310
 311 pub fn try_print_query_stack(handler: &Handler, num_frames: Option<usize>) {
 312     eprintln!("query stack during panic:");
 313
 314     // Be careful relying on global state here: this code is called from
 315     // a panic hook, which means that the global `Handler` may be in a weird
 316     // state if it was responsible for triggering the panic.
 317     let i = ty::tls::with_context_opt(|icx| {
 318         if let Some(icx) = icx {
 319             QueryCtxt::from_tcx(icx.tcx).try_print_query_stack(icx.query, handler, num_frames)
 320         } else {
 321             0
 322         }
 323     });
 324
 325     if num_frames == None || num_frames >= Some(i) {
 326         eprintln!("end of query stack");
 327     } else {
 328         eprintln!("we're just showing a limited slice of the query stack");
 329     }
 330 }