1 pub use crate::passes::BoxedResolver;
5 use rustc_ast::{self as ast, 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::{ErrorReported, Handler};
12 use rustc_lint::LintStore;
14 use rustc_parse::new_parser_from_source_str;
15 use rustc_query_impl::QueryCtxt;
16 use rustc_session::config::{self, ErrorOutputType, Input, OutputFilenames};
17 use rustc_session::early_error;
18 use rustc_session::lint;
19 use rustc_session::parse::{CrateConfig, ParseSess};
20 use rustc_session::{DiagnosticOutput, Session};
21 use rustc_span::source_map::{FileLoader, FileName};
22 use std::path::PathBuf;
24 use std::sync::{Arc, Mutex};
26 pub type Result<T> = result::Result<T, ErrorReported>;
28 /// Represents a compiler session.
30 /// Can be used to run `rustc_interface` queries.
31 /// Created by passing [`Config`] to [`run_compiler`].
33 pub(crate) sess: Lrc<Session>,
34 codegen_backend: Lrc<Box<dyn CodegenBackend>>,
35 pub(crate) input: Input,
36 pub(crate) input_path: Option<PathBuf>,
37 pub(crate) output_dir: Option<PathBuf>,
38 pub(crate) output_file: Option<PathBuf>,
39 pub(crate) temps_dir: Option<PathBuf>,
40 pub(crate) register_lints: Option<Box<dyn Fn(&Session, &mut LintStore) + Send + Sync>>,
41 pub(crate) override_queries:
42 Option<fn(&Session, &mut ty::query::Providers, &mut ty::query::ExternProviders)>,
46 pub fn session(&self) -> &Lrc<Session> {
49 pub fn codegen_backend(&self) -> &Lrc<Box<dyn CodegenBackend>> {
52 pub fn input(&self) -> &Input {
55 pub fn output_dir(&self) -> &Option<PathBuf> {
58 pub fn output_file(&self) -> &Option<PathBuf> {
61 pub fn temps_dir(&self) -> &Option<PathBuf> {
64 pub fn register_lints(&self) -> &Option<Box<dyn Fn(&Session, &mut LintStore) + Send + Sync>> {
67 pub fn build_output_filenames(
70 attrs: &[ast::Attribute],
71 ) -> OutputFilenames {
72 util::build_output_filenames(
83 /// Converts strings provided as `--cfg [cfgspec]` into a `crate_cfg`.
84 pub fn parse_cfgspecs(cfgspecs: Vec<String>) -> FxHashSet<(String, Option<String>)> {
85 rustc_span::create_default_session_if_not_set_then(move |_| {
89 let sess = ParseSess::with_silent_emitter(Some(format!(
90 "this error occurred on the command line: `--cfg={}`",
93 let filename = FileName::cfg_spec_source_code(&s);
94 let mut parser = new_parser_from_source_str(&sess, filename, s.to_string());
99 ErrorOutputType::default(),
100 &format!(concat!("invalid `--cfg` argument: `{}` (", $reason, ")"), s),
105 match &mut parser.parse_meta_item() {
106 Ok(meta_item) if parser.token == token::Eof => {
107 if meta_item.path.segments.len() != 1 {
108 error!("argument key must be an identifier");
110 match &meta_item.kind {
111 MetaItemKind::List(..) => {
112 error!(r#"expected `key` or `key="value"`"#);
114 MetaItemKind::NameValue(lit) if !lit.kind.is_str() => {
115 error!("argument value must be a string");
117 MetaItemKind::NameValue(..) | MetaItemKind::Word => {
118 let ident = meta_item.ident().expect("multi-segment cfg key");
119 return (ident.name, meta_item.value_str());
124 Err(err) => err.cancel(),
127 error!(r#"expected `key` or `key="value"`"#);
129 .collect::<CrateConfig>();
130 cfg.into_iter().map(|(a, b)| (a.to_string(), b.map(|b| b.to_string()))).collect()
134 /// The compiler configuration
136 /// Command line options
137 pub opts: config::Options,
139 /// cfg! configuration in addition to the default ones
140 pub crate_cfg: FxHashSet<(String, Option<String>)>,
143 pub input_path: Option<PathBuf>,
144 pub output_dir: Option<PathBuf>,
145 pub output_file: Option<PathBuf>,
146 pub file_loader: Option<Box<dyn FileLoader + Send + Sync>>,
147 pub diagnostic_output: DiagnosticOutput,
149 /// Set to capture stderr output during compiler execution
150 pub stderr: Option<Arc<Mutex<Vec<u8>>>>,
152 pub lint_caps: FxHashMap<lint::LintId, lint::Level>,
154 /// This is a callback from the driver that is called when [`ParseSess`] is created.
155 pub parse_sess_created: Option<Box<dyn FnOnce(&mut ParseSess) + Send>>,
157 /// This is a callback from the driver that is called when we're registering lints;
158 /// it is called during plugin registration when we have the LintStore in a non-shared state.
160 /// Note that if you find a Some here you probably want to call that function in the new
161 /// function being registered.
162 pub register_lints: Option<Box<dyn Fn(&Session, &mut LintStore) + Send + Sync>>,
164 /// This is a callback from the driver that is called just after we have populated
165 /// the list of queries.
167 /// The second parameter is local providers and the third parameter is external providers.
168 pub override_queries:
169 Option<fn(&Session, &mut ty::query::Providers, &mut ty::query::ExternProviders)>,
171 /// This is a callback from the driver that is called to create a codegen backend.
172 pub make_codegen_backend:
173 Option<Box<dyn FnOnce(&config::Options) -> Box<dyn CodegenBackend> + Send>>,
175 /// Registry of diagnostics codes.
176 pub registry: Registry,
179 pub fn create_compiler_and_run<R>(config: Config, f: impl FnOnce(&Compiler) -> R) -> R {
180 let registry = &config.registry;
181 let (mut sess, codegen_backend) = util::create_session(
184 config.diagnostic_output,
186 config.input_path.clone(),
188 config.make_codegen_backend,
192 if let Some(parse_sess_created) = config.parse_sess_created {
194 &mut Lrc::get_mut(&mut sess)
195 .expect("create_session() should never share the returned session")
200 let temps_dir = sess.opts.debugging_opts.temps_dir.as_ref().map(|o| PathBuf::from(&o));
202 let compiler = Compiler {
206 input_path: config.input_path,
207 output_dir: config.output_dir,
208 output_file: config.output_file,
210 register_lints: config.register_lints,
211 override_queries: config.override_queries,
214 rustc_span::with_source_map(compiler.sess.parse_sess.clone_source_map(), move || {
216 let _sess_abort_error = OnDrop(|| {
217 compiler.sess.finish_diagnostics(registry);
223 let prof = compiler.sess.prof.clone();
224 prof.generic_activity("drop_compiler").run(move || drop(compiler));
229 pub fn run_compiler<R: Send>(mut config: Config, f: impl FnOnce(&Compiler) -> R + Send) -> R {
230 tracing::trace!("run_compiler");
231 let stderr = config.stderr.take();
232 util::setup_callbacks_and_run_in_thread_pool_with_globals(
234 config.opts.debugging_opts.threads,
236 || create_compiler_and_run(config, f),
240 pub fn try_print_query_stack(handler: &Handler, num_frames: Option<usize>) {
241 eprintln!("query stack during panic:");
243 // Be careful relying on global state here: this code is called from
244 // a panic hook, which means that the global `Handler` may be in a weird
245 // state if it was responsible for triggering the panic.
246 let i = ty::tls::with_context_opt(|icx| {
247 if let Some(icx) = icx {
248 QueryCtxt::from_tcx(icx.tcx).try_print_query_stack(icx.query, handler, num_frames)
254 if num_frames == None || num_frames >= Some(i) {
255 eprintln!("end of query stack");
257 eprintln!("we're just showing a limited slice of the query stack");