5 //! This API is completely unstable and subject to change.
7 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
8 #![feature(is_terminal)]
10 #![feature(decl_macro)]
11 #![recursion_limit = "256"]
12 #![allow(rustc::potential_query_instability)]
13 #![deny(rustc::untranslatable_diagnostic)]
14 #![deny(rustc::diagnostic_outside_of_impl)]
19 pub extern crate rustc_plugin_impl as plugin;
22 use rustc_codegen_ssa::{traits::CodegenBackend, CodegenErrors, CodegenResults};
23 use rustc_data_structures::profiling::{get_resident_set_size, print_time_passes_entry};
24 use rustc_data_structures::sync::SeqCst;
25 use rustc_errors::registry::{InvalidErrorCode, Registry};
26 use rustc_errors::{ErrorGuaranteed, PResult};
27 use rustc_feature::find_gated_cfg;
28 use rustc_hir::def_id::LOCAL_CRATE;
29 use rustc_interface::util::{self, collect_crate_types, get_codegen_backend};
30 use rustc_interface::{interface, Queries};
31 use rustc_lint::LintStore;
32 use rustc_metadata::locator;
33 use rustc_save_analysis as save;
34 use rustc_save_analysis::DumpHandler;
35 use rustc_session::config::{nightly_options, CG_OPTIONS, Z_OPTIONS};
36 use rustc_session::config::{ErrorOutputType, Input, OutputType, PrintRequest, TrimmedDefPaths};
37 use rustc_session::cstore::MetadataLoader;
38 use rustc_session::getopts;
39 use rustc_session::lint::{Lint, LintId};
40 use rustc_session::{config, Session};
41 use rustc_session::{early_error, early_error_no_abort, early_warn};
42 use rustc_span::source_map::{FileLoader, FileName};
43 use rustc_span::symbol::sym;
44 use rustc_target::json::ToJson;
49 use std::ffi::OsString;
51 use std::io::{self, IsTerminal, Read, Write};
52 use std::panic::{self, catch_unwind};
53 use std::path::PathBuf;
54 use std::process::{self, Command, Stdio};
56 use std::sync::LazyLock;
57 use std::time::Instant;
61 mod session_diagnostics;
63 use crate::session_diagnostics::{
64 RLinkEmptyVersionNumber, RLinkEncodingVersionMismatch, RLinkRustcVersionMismatch,
65 RLinkWrongFileType, RlinkNotAFile, RlinkUnableToRead,
68 /// Exit status code used for successful compilation and help output.
69 pub const EXIT_SUCCESS: i32 = 0;
71 /// Exit status code used for compilation failures and invalid flags.
72 pub const EXIT_FAILURE: i32 = 1;
74 const BUG_REPORT_URL: &str = "https://github.com/rust-lang/rust/issues/new\
75 ?labels=C-bug%2C+I-ICE%2C+T-compiler&template=ice.md";
77 const ICE_REPORT_COMPILER_FLAGS: &[&str] = &["-Z", "-C", "--crate-type"];
79 const ICE_REPORT_COMPILER_FLAGS_EXCLUDE: &[&str] = &["metadata", "extra-filename"];
81 const ICE_REPORT_COMPILER_FLAGS_STRIP_VALUE: &[&str] = &["incremental"];
83 pub fn abort_on_err<T>(result: Result<T, ErrorGuaranteed>, sess: &Session) -> T {
86 sess.abort_if_errors();
87 panic!("error reported but abort_if_errors didn't abort???");
94 /// Called before creating the compiler instance
95 fn config(&mut self, _config: &mut interface::Config) {}
96 /// Called after parsing. Return value instructs the compiler whether to
97 /// continue the compilation afterwards (defaults to `Compilation::Continue`)
98 fn after_parsing<'tcx>(
100 _compiler: &interface::Compiler,
101 _queries: &'tcx Queries<'tcx>,
103 Compilation::Continue
105 /// Called after expansion. Return value instructs the compiler whether to
106 /// continue the compilation afterwards (defaults to `Compilation::Continue`)
107 fn after_expansion<'tcx>(
109 _compiler: &interface::Compiler,
110 _queries: &'tcx Queries<'tcx>,
112 Compilation::Continue
114 /// Called after analysis. Return value instructs the compiler whether to
115 /// continue the compilation afterwards (defaults to `Compilation::Continue`)
116 fn after_analysis<'tcx>(
118 _compiler: &interface::Compiler,
119 _queries: &'tcx Queries<'tcx>,
121 Compilation::Continue
126 pub struct TimePassesCallbacks {
130 impl Callbacks for TimePassesCallbacks {
131 // JUSTIFICATION: the session doesn't exist at this point.
132 #[allow(rustc::bad_opt_access)]
133 fn config(&mut self, config: &mut interface::Config) {
134 // If a --print=... option has been given, we don't print the "total"
135 // time because it will mess up the --print output. See #64339.
137 self.time_passes = config.opts.prints.is_empty() && config.opts.unstable_opts.time_passes;
138 config.opts.trimmed_def_paths = TrimmedDefPaths::GoodPath;
142 pub fn diagnostics_registry() -> Registry {
143 Registry::new(rustc_error_codes::DIAGNOSTICS)
146 /// This is the primary entry point for rustc.
147 pub struct RunCompiler<'a, 'b> {
148 at_args: &'a [String],
149 callbacks: &'b mut (dyn Callbacks + Send),
150 file_loader: Option<Box<dyn FileLoader + Send + Sync>>,
151 make_codegen_backend:
152 Option<Box<dyn FnOnce(&config::Options) -> Box<dyn CodegenBackend> + Send>>,
155 impl<'a, 'b> RunCompiler<'a, 'b> {
156 pub fn new(at_args: &'a [String], callbacks: &'b mut (dyn Callbacks + Send)) -> Self {
157 Self { at_args, callbacks, file_loader: None, make_codegen_backend: None }
160 /// Set a custom codegen backend.
162 /// Has no uses within this repository, but is used by bjorn3 for "the
163 /// hotswapping branch of cg_clif" for "setting the codegen backend from a
164 /// custom driver where the custom codegen backend has arbitrary data."
166 pub fn set_make_codegen_backend(
168 make_codegen_backend: Option<
169 Box<dyn FnOnce(&config::Options) -> Box<dyn CodegenBackend> + Send>,
172 self.make_codegen_backend = make_codegen_backend;
176 /// Load files from sources other than the file system.
178 /// Has no uses within this repository, but may be used in the future by
179 /// bjorn3 for "hooking rust-analyzer's VFS into rustc at some point for
180 /// running rustc without having to save". (See #102759.)
181 pub fn set_file_loader(
183 file_loader: Option<Box<dyn FileLoader + Send + Sync>>,
185 self.file_loader = file_loader;
189 /// Parse args and run the compiler.
190 pub fn run(self) -> interface::Result<()> {
191 run_compiler(self.at_args, self.callbacks, self.file_loader, self.make_codegen_backend)
197 callbacks: &mut (dyn Callbacks + Send),
198 file_loader: Option<Box<dyn FileLoader + Send + Sync>>,
199 make_codegen_backend: Option<
200 Box<dyn FnOnce(&config::Options) -> Box<dyn CodegenBackend> + Send>,
202 ) -> interface::Result<()> {
203 let args = args::arg_expand_all(at_args);
205 let Some(matches) = handle_options(&args) else { return Ok(()) };
207 let sopts = config::build_session_options(&matches);
209 if let Some(ref code) = matches.opt_str("explain") {
210 handle_explain(diagnostics_registry(), code, sopts.error_format);
214 let cfg = interface::parse_cfgspecs(matches.opt_strs("cfg"));
215 let check_cfg = interface::parse_check_cfg(matches.opt_strs("check-cfg"));
216 let (odir, ofile) = make_output(&matches);
217 let mut config = interface::Config {
220 crate_check_cfg: check_cfg,
221 input: Input::File(PathBuf::new()),
226 lint_caps: Default::default(),
227 parse_sess_created: None,
228 register_lints: None,
229 override_queries: None,
230 make_codegen_backend,
231 registry: diagnostics_registry(),
234 if !tracing::dispatcher::has_been_set() {
235 init_rustc_env_logger_with_backtrace_option(&config.opts.unstable_opts.log_backtrace);
238 match make_input(config.opts.error_format, &matches.free) {
239 Err(reported) => return Err(reported),
240 Ok(Some((input, input_file_path))) => {
241 config.input = input;
242 config.input_path = input_file_path;
244 callbacks.config(&mut config);
246 Ok(None) => match matches.free.len() {
248 callbacks.config(&mut config);
249 interface::run_compiler(config, |compiler| {
250 let sopts = &compiler.session().opts;
251 if sopts.describe_lints {
253 rustc_lint::new_lint_store(compiler.session().enable_internal_lints());
254 let registered_lints =
255 if let Some(register_lints) = compiler.register_lints() {
256 register_lints(compiler.session(), &mut lint_store);
261 describe_lints(compiler.session(), &lint_store, registered_lints);
264 let should_stop = print_crate_info(
265 &***compiler.codegen_backend(),
268 compiler.output_dir(),
269 compiler.output_file(),
270 compiler.temps_dir(),
273 if should_stop == Compilation::Stop {
276 early_error(sopts.error_format, "no input filename given")
280 1 => panic!("make_input should have provided valid inputs"),
282 config.opts.error_format,
284 "multiple input filenames provided (first two filenames are `{}` and `{}`)",
285 matches.free[0], matches.free[1],
291 interface::run_compiler(config, |compiler| {
292 let sess = compiler.session();
293 let should_stop = print_crate_info(
294 &***compiler.codegen_backend(),
296 Some(compiler.input()),
297 compiler.output_dir(),
298 compiler.output_file(),
299 compiler.temps_dir(),
302 list_metadata(sess, &*compiler.codegen_backend().metadata_loader(), compiler.input())
304 .and_then(|| try_process_rlink(sess, compiler));
306 if should_stop == Compilation::Stop {
307 return sess.compile_status();
310 let linker = compiler.enter(|queries| {
311 let early_exit = || sess.compile_status().map(|_| None);
314 if let Some(ppm) = &sess.opts.pretty {
315 if ppm.needs_ast_map() {
316 let expanded_crate = queries.expansion()?.borrow().0.clone();
317 queries.global_ctxt()?.enter(|tcx| {
318 pretty::print_after_hir_lowering(
323 compiler.output_file().as_deref(),
328 let krate = queries.parse()?.steal();
329 pretty::print_after_parsing(
334 compiler.output_file().as_deref(),
337 trace!("finished pretty-printing");
341 if callbacks.after_parsing(compiler, queries) == Compilation::Stop {
345 if sess.opts.unstable_opts.parse_only || sess.opts.unstable_opts.show_span.is_some() {
350 let plugins = queries.register_plugins()?;
351 let (_, lint_store) = &*plugins.borrow();
353 // Lint plugins are registered; now we can process command line flags.
354 if sess.opts.describe_lints {
355 describe_lints(sess, lint_store, true);
360 queries.expansion()?;
361 if callbacks.after_expansion(compiler, queries) == Compilation::Stop {
365 queries.prepare_outputs()?;
367 if sess.opts.output_types.contains_key(&OutputType::DepInfo)
368 && sess.opts.output_types.len() == 1
373 queries.global_ctxt()?;
375 if sess.opts.unstable_opts.no_analysis {
379 queries.global_ctxt()?.enter(|tcx| {
380 let result = tcx.analysis(());
381 if sess.opts.unstable_opts.save_analysis {
382 let crate_name = tcx.crate_name(LOCAL_CRATE);
383 sess.time("save_analysis", || {
389 DumpHandler::new(compiler.output_dir().as_deref(), crate_name),
396 if callbacks.after_analysis(compiler, queries) == Compilation::Stop {
400 queries.ongoing_codegen()?;
402 if sess.opts.unstable_opts.print_type_sizes {
403 sess.code_stats.print_type_sizes();
406 let linker = queries.linker()?;
410 if let Some(linker) = linker {
411 let _timer = sess.timer("link");
415 if sess.opts.unstable_opts.perf_stats {
416 sess.print_perf_stats();
419 if sess.opts.unstable_opts.print_fuel.is_some() {
421 "Fuel used by {}: {}",
422 sess.opts.unstable_opts.print_fuel.as_ref().unwrap(),
423 sess.print_fuel.load(SeqCst)
431 // Extract output directory and file from matches.
432 fn make_output(matches: &getopts::Matches) -> (Option<PathBuf>, Option<PathBuf>) {
433 let odir = matches.opt_str("out-dir").map(|o| PathBuf::from(&o));
434 let ofile = matches.opt_str("o").map(|o| PathBuf::from(&o));
438 // Extract input (string or file and optional path) from matches.
440 error_format: ErrorOutputType,
441 free_matches: &[String],
442 ) -> Result<Option<(Input, Option<PathBuf>)>, ErrorGuaranteed> {
443 if free_matches.len() == 1 {
444 let ifile = &free_matches[0];
446 let mut src = String::new();
447 if io::stdin().read_to_string(&mut src).is_err() {
448 // Immediately stop compilation if there was an issue reading
449 // the input (for example if the input stream is not UTF-8).
450 let reported = early_error_no_abort(
452 "couldn't read from stdin, as it did not contain valid UTF-8",
454 return Err(reported);
456 if let Ok(path) = env::var("UNSTABLE_RUSTDOC_TEST_PATH") {
457 let line = env::var("UNSTABLE_RUSTDOC_TEST_LINE").expect(
458 "when UNSTABLE_RUSTDOC_TEST_PATH is set \
459 UNSTABLE_RUSTDOC_TEST_LINE also needs to be set",
461 let line = isize::from_str_radix(&line, 10)
462 .expect("UNSTABLE_RUSTDOC_TEST_LINE needs to be an number");
463 let file_name = FileName::doc_test_source_code(PathBuf::from(path), line);
464 Ok(Some((Input::Str { name: file_name, input: src }, None)))
466 Ok(Some((Input::Str { name: FileName::anon_source_code(&src), input: src }, None)))
469 Ok(Some((Input::File(PathBuf::from(ifile)), Some(PathBuf::from(ifile)))))
476 /// Whether to stop or continue compilation.
477 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
478 pub enum Compilation {
484 pub fn and_then<F: FnOnce() -> Compilation>(self, next: F) -> Compilation {
486 Compilation::Stop => Compilation::Stop,
487 Compilation::Continue => next(),
492 fn handle_explain(registry: Registry, code: &str, output: ErrorOutputType) {
493 let upper_cased_code = code.to_ascii_uppercase();
495 if upper_cased_code.starts_with('E') { upper_cased_code } else { format!("E{code:0>4}") };
496 match registry.try_find_description(&normalised) {
497 Ok(Some(description)) => {
498 let mut is_in_code_block = false;
499 let mut text = String::new();
500 // Slice off the leading newline and print.
501 for line in description.lines() {
503 line.find(|c: char| !c.is_whitespace()).unwrap_or_else(|| line.len());
504 let dedented_line = &line[indent_level..];
505 if dedented_line.starts_with("```") {
506 is_in_code_block = !is_in_code_block;
507 text.push_str(&line[..(indent_level + 3)]);
508 } else if is_in_code_block && dedented_line.starts_with("# ") {
515 if io::stdout().is_terminal() {
516 show_content_with_pager(&text);
522 early_error(output, &format!("no extended information for {code}"));
524 Err(InvalidErrorCode) => {
525 early_error(output, &format!("{code} is not a valid error code"));
530 fn show_content_with_pager(content: &str) {
531 let pager_name = env::var_os("PAGER").unwrap_or_else(|| {
532 if cfg!(windows) { OsString::from("more.com") } else { OsString::from("less") }
535 let mut fallback_to_println = false;
537 match Command::new(pager_name).stdin(Stdio::piped()).spawn() {
539 if let Some(pipe) = pager.stdin.as_mut() {
540 if pipe.write_all(content.as_bytes()).is_err() {
541 fallback_to_println = true;
545 if pager.wait().is_err() {
546 fallback_to_println = true;
550 fallback_to_println = true;
554 // If pager fails for whatever reason, we should still print the content
555 // to standard output
556 if fallback_to_println {
561 pub fn try_process_rlink(sess: &Session, compiler: &interface::Compiler) -> Compilation {
562 if sess.opts.unstable_opts.link_only {
563 if let Input::File(file) = compiler.input() {
564 // FIXME: #![crate_type] and #![crate_name] support not implemented yet
565 sess.init_crate_types(collect_crate_types(sess, &[]));
566 let outputs = compiler.build_output_filenames(sess, &[]);
567 let rlink_data = fs::read(file).unwrap_or_else(|err| {
568 sess.emit_fatal(RlinkUnableToRead { err });
570 let codegen_results = match CodegenResults::deserialize_rlink(rlink_data) {
571 Ok(codegen) => codegen,
574 CodegenErrors::WrongFileType => sess.emit_fatal(RLinkWrongFileType),
575 CodegenErrors::EmptyVersionNumber => {
576 sess.emit_fatal(RLinkEmptyVersionNumber)
578 CodegenErrors::EncodingVersionMismatch { version_array, rlink_version } => {
579 sess.emit_fatal(RLinkEncodingVersionMismatch {
584 CodegenErrors::RustcVersionMismatch { rustc_version, current_version } => {
585 sess.emit_fatal(RLinkRustcVersionMismatch {
593 let result = compiler.codegen_backend().link(sess, codegen_results, &outputs);
594 abort_on_err(result, sess);
596 sess.emit_fatal(RlinkNotAFile {})
600 Compilation::Continue
604 pub fn list_metadata(
606 metadata_loader: &dyn MetadataLoader,
609 if sess.opts.unstable_opts.ls {
611 Input::File(ref ifile) => {
612 let path = &(*ifile);
613 let mut v = Vec::new();
614 locator::list_file_metadata(&sess.target, path, metadata_loader, &mut v).unwrap();
615 println!("{}", String::from_utf8(v).unwrap());
617 Input::Str { .. } => {
618 early_error(ErrorOutputType::default(), "cannot list metadata for stdin");
621 return Compilation::Stop;
624 Compilation::Continue
628 codegen_backend: &dyn CodegenBackend,
630 input: Option<&Input>,
631 odir: &Option<PathBuf>,
632 ofile: &Option<PathBuf>,
633 temps_dir: &Option<PathBuf>,
635 use rustc_session::config::PrintRequest::*;
636 // NativeStaticLibs and LinkArgs are special - printed during linking
637 // (empty iterator returns true)
638 if sess.opts.prints.iter().all(|&p| p == NativeStaticLibs || p == LinkArgs) {
639 return Compilation::Continue;
642 let attrs = match input {
645 let result = parse_crate_attrs(sess, input);
647 Ok(attrs) => Some(attrs),
648 Err(mut parse_error) => {
650 return Compilation::Stop;
655 for req in &sess.opts.prints {
658 let mut targets = rustc_target::spec::TARGETS.to_vec();
659 targets.sort_unstable();
660 println!("{}", targets.join("\n"));
662 Sysroot => println!("{}", sess.sysroot.display()),
663 TargetLibdir => println!("{}", sess.target_tlib_path.dir.display()),
665 println!("{}", serde_json::to_string_pretty(&sess.target.to_json()).unwrap());
667 FileNames | CrateName => {
668 let input = input.unwrap_or_else(|| {
669 early_error(ErrorOutputType::default(), "no input file provided")
671 let attrs = attrs.as_ref().unwrap();
672 let t_outputs = rustc_interface::util::build_output_filenames(
673 input, odir, ofile, temps_dir, attrs, sess,
675 let id = rustc_session::output::find_crate_name(sess, attrs, input);
676 if *req == PrintRequest::CrateName {
680 let crate_types = collect_crate_types(sess, attrs);
681 for &style in &crate_types {
683 rustc_session::output::filename_for_input(sess, style, id, &t_outputs);
684 println!("{}", fname.file_name().unwrap().to_string_lossy());
692 .filter_map(|&(name, value)| {
693 // Note that crt-static is a specially recognized cfg
694 // directive that's printed out here as part of
695 // rust-lang/rust#37406, but in general the
696 // `target_feature` cfg is gated under
697 // rust-lang/rust#29717. For now this is just
698 // specifically allowing the crt-static cfg and that's
699 // it, this is intended to get into Cargo and then go
700 // through to build scripts.
701 if (name != sym::target_feature || value != Some(sym::crt_dash_static))
702 && !sess.is_nightly_build()
703 && find_gated_cfg(|cfg_sym| cfg_sym == name).is_some()
708 if let Some(value) = value {
709 Some(format!("{name}=\"{value}\""))
711 Some(name.to_string())
714 .collect::<Vec<String>>();
721 CallingConventions => {
722 let mut calling_conventions = rustc_target::spec::abi::all_names();
723 calling_conventions.sort_unstable();
724 println!("{}", calling_conventions.join("\n"));
730 | StackProtectorStrategies
731 | TargetFeatures => {
732 codegen_backend.print(*req, sess);
734 // Any output here interferes with Cargo's parsing of other printed output
735 NativeStaticLibs => {}
738 use rustc_target::spec::SplitDebuginfo::{Off, Packed, Unpacked};
740 for split in &[Off, Packed, Unpacked] {
741 let stable = sess.target.options.supported_split_debuginfo.contains(split);
742 let unstable_ok = sess.unstable_options();
743 if stable || unstable_ok {
753 /// Prints version information
755 /// NOTE: this is a macro to support drivers built at a different time than the main `rustc_driver` crate.
756 pub macro version($binary: literal, $matches: expr) {
757 fn unw(x: Option<&str>) -> &str {
758 x.unwrap_or("unknown")
760 $crate::version_at_macro_invocation(
763 unw(option_env!("CFG_VERSION")),
764 unw(option_env!("CFG_VER_HASH")),
765 unw(option_env!("CFG_VER_DATE")),
766 unw(option_env!("CFG_RELEASE")),
770 #[doc(hidden)] // use the macro instead
771 pub fn version_at_macro_invocation(
773 matches: &getopts::Matches,
779 let verbose = matches.opt_present("verbose");
781 println!("{binary} {version}");
784 println!("binary: {binary}");
785 println!("commit-hash: {commit_hash}");
786 println!("commit-date: {commit_date}");
787 println!("host: {}", config::host_triple());
788 println!("release: {release}");
790 let debug_flags = matches.opt_strs("Z");
791 let backend_name = debug_flags.iter().find_map(|x| x.strip_prefix("codegen-backend="));
792 get_codegen_backend(&None, backend_name).print_version();
796 fn usage(verbose: bool, include_unstable_options: bool, nightly_build: bool) {
797 let groups = if verbose { config::rustc_optgroups() } else { config::rustc_short_optgroups() };
798 let mut options = getopts::Options::new();
799 for option in groups.iter().filter(|x| include_unstable_options || x.is_stable()) {
800 (option.apply)(&mut options);
802 let message = "Usage: rustc [OPTIONS] INPUT";
803 let nightly_help = if nightly_build {
804 "\n -Z help Print unstable compiler options"
808 let verbose_help = if verbose {
811 "\n --help -v Print the full set of options rustc accepts"
813 let at_path = if verbose {
814 " @path Read newline separated options from `path`\n"
819 "{options}{at_path}\nAdditional help:
820 -C help Print codegen options
822 Print 'lint' options and default settings{nightly}{verbose}\n",
823 options = options.usage(message),
825 nightly = nightly_help,
826 verbose = verbose_help
830 fn print_wall_help() {
833 The flag `-Wall` does not exist in `rustc`. Most useful lints are enabled by
834 default. Use `rustc -W help` to see all available lints. It's more common to put
835 warning settings in the crate root using `#![warn(LINT_NAME)]` instead of using
836 the command line flag directly.
841 /// Write to stdout lint command options, together with a list of all available lints
842 pub fn describe_lints(sess: &Session, lint_store: &LintStore, loaded_plugins: bool) {
845 Available lint options:
846 -W <foo> Warn about <foo>
850 -F <foo> Forbid <foo> \
851 (deny <foo> and all attempts to override)
856 fn sort_lints(sess: &Session, mut lints: Vec<&'static Lint>) -> Vec<&'static Lint> {
857 // The sort doesn't case-fold but it's doubtful we care.
858 lints.sort_by_cached_key(|x: &&Lint| (x.default_level(sess.edition()), x.name));
863 lints: Vec<(&'static str, Vec<LintId>, bool)>,
864 ) -> Vec<(&'static str, Vec<LintId>)> {
865 let mut lints: Vec<_> = lints.into_iter().map(|(x, y, _)| (x, y)).collect();
866 lints.sort_by_key(|l| l.0);
870 let (plugin, builtin): (Vec<_>, _) =
871 lint_store.get_lints().iter().cloned().partition(|&lint| lint.is_plugin);
872 let plugin = sort_lints(sess, plugin);
873 let builtin = sort_lints(sess, builtin);
875 let (plugin_groups, builtin_groups): (Vec<_>, _) =
876 lint_store.get_lint_groups().partition(|&(.., p)| p);
877 let plugin_groups = sort_lint_groups(plugin_groups);
878 let builtin_groups = sort_lint_groups(builtin_groups);
881 plugin.iter().chain(&builtin).map(|&s| s.name.chars().count()).max().unwrap_or(0);
882 let padded = |x: &str| {
883 let mut s = " ".repeat(max_name_len - x.chars().count());
888 println!("Lint checks provided by rustc:\n");
890 let print_lints = |lints: Vec<&Lint>| {
891 println!(" {} {:7.7} {}", padded("name"), "default", "meaning");
892 println!(" {} {:7.7} {}", padded("----"), "-------", "-------");
894 let name = lint.name_lower().replace('_', "-");
898 lint.default_level(sess.edition()).as_str(),
905 print_lints(builtin);
907 let max_name_len = max(
911 .chain(&builtin_groups)
912 .map(|&(s, _)| s.chars().count())
917 let padded = |x: &str| {
918 let mut s = " ".repeat(max_name_len - x.chars().count());
923 println!("Lint groups provided by rustc:\n");
925 let print_lint_groups = |lints: Vec<(&'static str, Vec<LintId>)>, all_warnings| {
926 println!(" {} sub-lints", padded("name"));
927 println!(" {} ---------", padded("----"));
930 println!(" {} all lints that are set to issue warnings", padded("warnings"));
933 for (name, to) in lints {
934 let name = name.to_lowercase().replace('_', "-");
937 .map(|x| x.to_string().replace('_', "-"))
938 .collect::<Vec<String>>()
940 println!(" {} {}", padded(&name), desc);
945 print_lint_groups(builtin_groups, true);
947 match (loaded_plugins, plugin.len(), plugin_groups.len()) {
948 (false, 0, _) | (false, _, 0) => {
949 println!("Lint tools like Clippy can provide additional lints and lint groups.");
951 (false, ..) => panic!("didn't load lint plugins but got them anyway!"),
952 (true, 0, 0) => println!("This crate does not load any lint plugins or lint groups."),
955 println!("Lint checks provided by plugins loaded by this crate:\n");
959 println!("Lint groups provided by plugins loaded by this crate:\n");
960 print_lint_groups(plugin_groups, false);
966 fn describe_debug_flags() {
967 println!("\nAvailable options:\n");
968 print_flag_list("-Z", config::Z_OPTIONS);
971 fn describe_codegen_flags() {
972 println!("\nAvailable codegen options:\n");
973 print_flag_list("-C", config::CG_OPTIONS);
976 pub fn print_flag_list<T>(
978 flag_list: &[(&'static str, T, &'static str, &'static str)],
980 let max_len = flag_list.iter().map(|&(name, _, _, _)| name.chars().count()).max().unwrap_or(0);
982 for &(name, _, _, desc) in flag_list {
984 " {} {:>width$}=val -- {}",
986 name.replace('_', "-"),
993 /// Process command line options. Emits messages as appropriate. If compilation
994 /// should continue, returns a getopts::Matches object parsed from args,
995 /// otherwise returns `None`.
997 /// The compiler's handling of options is a little complicated as it ties into
998 /// our stability story. The current intention of each compiler option is to
999 /// have one of two modes:
1001 /// 1. An option is stable and can be used everywhere.
1002 /// 2. An option is unstable, and can only be used on nightly.
1004 /// Like unstable library and language features, however, unstable options have
1005 /// always required a form of "opt in" to indicate that you're using them. This
1006 /// provides the easy ability to scan a code base to check to see if anything
1007 /// unstable is being used. Currently, this "opt in" is the `-Z` "zed" flag.
1009 /// All options behind `-Z` are considered unstable by default. Other top-level
1010 /// options can also be considered unstable, and they were unlocked through the
1011 /// `-Z unstable-options` flag. Note that `-Z` remains to be the root of
1012 /// instability in both cases, though.
1014 /// So with all that in mind, the comments below have some more detail about the
1015 /// contortions done here to get things to work out correctly.
1016 pub fn handle_options(args: &[String]) -> Option<getopts::Matches> {
1017 // Throw away the first argument, the name of the binary
1018 let args = &args[1..];
1020 if args.is_empty() {
1021 // user did not write `-v` nor `-Z unstable-options`, so do not
1022 // include that extra information.
1024 rustc_feature::UnstableFeatures::from_environment(None).is_nightly_build();
1025 usage(false, false, nightly_build);
1029 // Parse with *all* options defined in the compiler, we don't worry about
1030 // option stability here we just want to parse as much as possible.
1031 let mut options = getopts::Options::new();
1032 for option in config::rustc_optgroups() {
1033 (option.apply)(&mut options);
1035 let matches = options.parse(args).unwrap_or_else(|e| {
1037 getopts::Fail::UnrecognizedOption(ref opt) => CG_OPTIONS
1039 .map(|&(name, ..)| ('C', name))
1040 .chain(Z_OPTIONS.iter().map(|&(name, ..)| ('Z', name)))
1041 .find(|&(_, name)| *opt == name.replace('_', "-"))
1042 .map(|(flag, _)| format!("{e}. Did you mean `-{flag} {opt}`?")),
1045 early_error(ErrorOutputType::default(), &msg.unwrap_or_else(|| e.to_string()));
1048 // For all options we just parsed, we check a few aspects:
1050 // * If the option is stable, we're all good
1051 // * If the option wasn't passed, we're all good
1052 // * If `-Z unstable-options` wasn't passed (and we're not a -Z option
1053 // ourselves), then we require the `-Z unstable-options` flag to unlock
1054 // this option that was passed.
1055 // * If we're a nightly compiler, then unstable options are now unlocked, so
1056 // we're good to go.
1057 // * Otherwise, if we're an unstable option then we generate an error
1058 // (unstable option being used on stable)
1059 nightly_options::check_nightly_options(&matches, &config::rustc_optgroups());
1061 if matches.opt_present("h") || matches.opt_present("help") {
1062 // Only show unstable options in --help if we accept unstable options.
1063 let unstable_enabled = nightly_options::is_unstable_enabled(&matches);
1064 let nightly_build = nightly_options::match_is_nightly_build(&matches);
1065 usage(matches.opt_present("verbose"), unstable_enabled, nightly_build);
1069 // Handle the special case of -Wall.
1070 let wall = matches.opt_strs("W");
1071 if wall.iter().any(|x| *x == "all") {
1073 rustc_errors::FatalError.raise();
1076 // Don't handle -W help here, because we might first load plugins.
1077 let debug_flags = matches.opt_strs("Z");
1078 if debug_flags.iter().any(|x| *x == "help") {
1079 describe_debug_flags();
1083 let cg_flags = matches.opt_strs("C");
1085 if cg_flags.iter().any(|x| *x == "help") {
1086 describe_codegen_flags();
1090 if cg_flags.iter().any(|x| *x == "no-stack-check") {
1092 ErrorOutputType::default(),
1093 "the --no-stack-check flag is deprecated and does nothing",
1097 if cg_flags.iter().any(|x| *x == "passes=list") {
1098 let backend_name = debug_flags.iter().find_map(|x| x.strip_prefix("codegen-backend="));
1099 get_codegen_backend(&None, backend_name).print_passes();
1103 if matches.opt_present("version") {
1104 version!("rustc", &matches);
1111 fn parse_crate_attrs<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::AttrVec> {
1113 Input::File(ifile) => rustc_parse::parse_crate_attrs_from_file(ifile, &sess.parse_sess),
1114 Input::Str { name, input } => rustc_parse::parse_crate_attrs_from_source_str(
1122 /// Gets a list of extra command-line flags provided by the user, as strings.
1124 /// This function is used during ICEs to show more information useful for
1125 /// debugging, since some ICEs only happens with non-default compiler flags
1126 /// (and the users don't always report them).
1127 fn extra_compiler_flags() -> Option<(Vec<String>, bool)> {
1128 let mut args = env::args_os().map(|arg| arg.to_string_lossy().to_string()).peekable();
1130 let mut result = Vec::new();
1131 let mut excluded_cargo_defaults = false;
1132 while let Some(arg) = args.next() {
1133 if let Some(a) = ICE_REPORT_COMPILER_FLAGS.iter().find(|a| arg.starts_with(*a)) {
1134 let content = if arg.len() == a.len() {
1135 // A space-separated option, like `-C incremental=foo` or `--crate-type rlib`
1137 Some(arg) => arg.to_string(),
1140 } else if arg.get(a.len()..a.len() + 1) == Some("=") {
1141 // An equals option, like `--crate-type=rlib`
1142 arg[a.len() + 1..].to_string()
1144 // A non-space option, like `-Cincremental=foo`
1145 arg[a.len()..].to_string()
1147 let option = content.split_once('=').map(|s| s.0).unwrap_or(&content);
1148 if ICE_REPORT_COMPILER_FLAGS_EXCLUDE.iter().any(|exc| option == *exc) {
1149 excluded_cargo_defaults = true;
1151 result.push(a.to_string());
1152 match ICE_REPORT_COMPILER_FLAGS_STRIP_VALUE.iter().find(|s| option == **s) {
1153 Some(s) => result.push(format!("{s}=[REDACTED]")),
1154 None => result.push(content),
1160 if !result.is_empty() { Some((result, excluded_cargo_defaults)) } else { None }
1163 /// Runs a closure and catches unwinds triggered by fatal errors.
1165 /// The compiler currently unwinds with a special sentinel value to abort
1166 /// compilation on fatal errors. This function catches that sentinel and turns
1167 /// the panic into a `Result` instead.
1168 pub fn catch_fatal_errors<F: FnOnce() -> R, R>(f: F) -> Result<R, ErrorGuaranteed> {
1169 catch_unwind(panic::AssertUnwindSafe(f)).map_err(|value| {
1170 if value.is::<rustc_errors::FatalErrorMarker>() {
1171 ErrorGuaranteed::unchecked_claim_error_was_emitted()
1173 panic::resume_unwind(value);
1178 /// Variant of `catch_fatal_errors` for the `interface::Result` return type
1179 /// that also computes the exit code.
1180 pub fn catch_with_exit_code(f: impl FnOnce() -> interface::Result<()>) -> i32 {
1181 let result = catch_fatal_errors(f).and_then(|result| result);
1183 Ok(()) => EXIT_SUCCESS,
1184 Err(_) => EXIT_FAILURE,
1188 static DEFAULT_HOOK: LazyLock<Box<dyn Fn(&panic::PanicInfo<'_>) + Sync + Send + 'static>> =
1190 let hook = panic::take_hook();
1191 panic::set_hook(Box::new(|info| {
1192 // If the error was caused by a broken pipe then this is not a bug.
1193 // Write the error and return immediately. See #98700.
1195 if let Some(msg) = info.payload().downcast_ref::<String>() {
1196 if msg.starts_with("failed printing to stdout: ") && msg.ends_with("(os error 232)")
1198 early_error_no_abort(ErrorOutputType::default(), &msg);
1203 // Invoke the default handler, which prints the actual panic message and optionally a backtrace
1204 // Don't do this for delayed bugs, which already emit their own more useful backtrace.
1205 if !info.payload().is::<rustc_errors::DelayedBugPanic>() {
1206 (*DEFAULT_HOOK)(info);
1208 // Separate the output with an empty line
1212 // Print the ICE message
1213 report_ice(info, BUG_REPORT_URL);
1218 /// Prints the ICE message, including query stack, but without backtrace.
1220 /// The message will point the user at `bug_report_url` to report the ICE.
1222 /// When `install_ice_hook` is called, this function will be called as the panic
1224 pub fn report_ice(info: &panic::PanicInfo<'_>, bug_report_url: &str) {
1225 let fallback_bundle =
1226 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
1227 let emitter = Box::new(rustc_errors::emitter::EmitterWriter::stderr(
1228 rustc_errors::ColorConfig::Auto,
1238 let handler = rustc_errors::Handler::with_emitter(true, None, emitter);
1240 // a .span_bug or .bug call has already printed what
1241 // it wants to print.
1242 if !info.payload().is::<rustc_errors::ExplicitBug>()
1243 && !info.payload().is::<rustc_errors::DelayedBugPanic>()
1245 let mut d = rustc_errors::Diagnostic::new(rustc_errors::Level::Bug, "unexpected panic");
1246 handler.emit_diagnostic(&mut d);
1249 let mut xs: Vec<Cow<'static, str>> = vec![
1250 "the compiler unexpectedly panicked. this is a bug.".into(),
1251 format!("we would appreciate a bug report: {bug_report_url}").into(),
1253 "rustc {} running on {}",
1254 util::version_str!().unwrap_or("unknown_version"),
1255 config::host_triple()
1260 if let Some((flags, excluded_cargo_defaults)) = extra_compiler_flags() {
1261 xs.push(format!("compiler flags: {}", flags.join(" ")).into());
1263 if excluded_cargo_defaults {
1264 xs.push("some of the compiler flags provided by cargo are hidden".into());
1269 handler.note_without_error(note.as_ref());
1272 // If backtraces are enabled, also print the query stack
1273 let backtrace = env::var_os("RUST_BACKTRACE").map_or(false, |x| &x != "0");
1275 let num_frames = if backtrace { None } else { Some(2) };
1277 interface::try_print_query_stack(&handler, num_frames);
1281 if env::var("RUSTC_BREAK_ON_ICE").is_ok() {
1282 // Trigger a debugger if we crashed during bootstrap
1283 winapi::um::debugapi::DebugBreak();
1288 /// Installs a panic hook that will print the ICE message on unexpected panics.
1290 /// A custom rustc driver can skip calling this to set up a custom ICE hook.
1291 pub fn install_ice_hook() {
1292 // If the user has not explicitly overridden "RUST_BACKTRACE", then produce
1293 // full backtraces. When a compiler ICE happens, we want to gather
1294 // as much information as possible to present in the issue opened
1295 // by the user. Compiler developers and other rustc users can
1296 // opt in to less-verbose backtraces by manually setting "RUST_BACKTRACE"
1297 // (e.g. `RUST_BACKTRACE=1`)
1298 if std::env::var("RUST_BACKTRACE").is_err() {
1299 std::env::set_var("RUST_BACKTRACE", "full");
1301 LazyLock::force(&DEFAULT_HOOK);
1304 /// This allows tools to enable rust logging without having to magically match rustc's
1305 /// tracing crate version.
1306 pub fn init_rustc_env_logger() {
1307 init_rustc_env_logger_with_backtrace_option(&None);
1310 /// This allows tools to enable rust logging without having to magically match rustc's
1311 /// tracing crate version. In contrast to `init_rustc_env_logger` it allows you to
1312 /// choose a target module you wish to show backtraces along with its logging.
1313 pub fn init_rustc_env_logger_with_backtrace_option(backtrace_target: &Option<String>) {
1314 if let Err(error) = rustc_log::init_rustc_env_logger_with_backtrace_option(backtrace_target) {
1315 early_error(ErrorOutputType::default(), &error.to_string());
1319 /// This allows tools to enable rust logging without having to magically match rustc's
1320 /// tracing crate version. In contrast to `init_rustc_env_logger` it allows you to choose an env var
1321 /// other than `RUSTC_LOG`.
1322 pub fn init_env_logger(env: &str) {
1323 if let Err(error) = rustc_log::init_env_logger(env) {
1324 early_error(ErrorOutputType::default(), &error.to_string());
1328 #[cfg(all(unix, any(target_env = "gnu", target_os = "macos")))]
1329 mod signal_handler {
1331 fn backtrace_symbols_fd(
1332 buffer: *const *mut libc::c_void,
1338 extern "C" fn print_stack_trace(_: libc::c_int) {
1339 const MAX_FRAMES: usize = 256;
1340 static mut STACK_TRACE: [*mut libc::c_void; MAX_FRAMES] =
1341 [std::ptr::null_mut(); MAX_FRAMES];
1343 let depth = libc::backtrace(STACK_TRACE.as_mut_ptr(), MAX_FRAMES as i32);
1347 backtrace_symbols_fd(STACK_TRACE.as_ptr(), depth, 2);
1351 /// When an error signal (such as SIGABRT or SIGSEGV) is delivered to the
1352 /// process, print a stack trace and then exit.
1353 pub(super) fn install() {
1355 const ALT_STACK_SIZE: usize = libc::MINSIGSTKSZ + 64 * 1024;
1356 let mut alt_stack: libc::stack_t = std::mem::zeroed();
1358 std::alloc::alloc(std::alloc::Layout::from_size_align(ALT_STACK_SIZE, 1).unwrap())
1359 as *mut libc::c_void;
1360 alt_stack.ss_size = ALT_STACK_SIZE;
1361 libc::sigaltstack(&alt_stack, std::ptr::null_mut());
1363 let mut sa: libc::sigaction = std::mem::zeroed();
1364 sa.sa_sigaction = print_stack_trace as libc::sighandler_t;
1365 sa.sa_flags = libc::SA_NODEFER | libc::SA_RESETHAND | libc::SA_ONSTACK;
1366 libc::sigemptyset(&mut sa.sa_mask);
1367 libc::sigaction(libc::SIGSEGV, &sa, std::ptr::null_mut());
1372 #[cfg(not(all(unix, any(target_env = "gnu", target_os = "macos"))))]
1373 mod signal_handler {
1374 pub(super) fn install() {}
1377 pub fn main() -> ! {
1378 let start_time = Instant::now();
1379 let start_rss = get_resident_set_size();
1380 signal_handler::install();
1381 let mut callbacks = TimePassesCallbacks::default();
1383 let exit_code = catch_with_exit_code(|| {
1384 let args = env::args_os()
1387 arg.into_string().unwrap_or_else(|arg| {
1389 ErrorOutputType::default(),
1390 &format!("argument {i} is not valid Unicode: {arg:?}"),
1394 .collect::<Vec<_>>();
1395 RunCompiler::new(&args, &mut callbacks).run()
1398 if callbacks.time_passes {
1399 let end_rss = get_resident_set_size();
1400 print_time_passes_entry("total", start_time.elapsed(), start_rss, end_rss);
1403 process::exit(exit_code)