src/driver.rs

   1 #![feature(rustc_private)]
   2 #![feature(once_cell)]
   3 #![cfg_attr(feature = "deny-warnings", deny(warnings))]
   4 // warn on lints, that are included in `rust-lang/rust`s bootstrap
   5 #![warn(rust_2018_idioms, unused_lifetimes)]
   6 // warn on rustc internal lints
   7 #![warn(rustc::internal)]
   8
   9 // FIXME: switch to something more ergonomic here, once available.
  10 // (Currently there is no way to opt into sysroot crates without `extern crate`.)
  11 extern crate rustc_driver;
  12 extern crate rustc_errors;
  13 extern crate rustc_interface;
  14 extern crate rustc_session;
  15 extern crate rustc_span;
  16
  17 use rustc_interface::interface;
  18 use rustc_session::parse::ParseSess;
  19 use rustc_span::symbol::Symbol;
  20 use rustc_tools_util::VersionInfo;
  21
  22 use std::borrow::Cow;
  23 use std::env;
  24 use std::ops::Deref;
  25 use std::panic;
  26 use std::path::{Path, PathBuf};
  27 use std::process::{exit, Command};
  28 use std::sync::LazyLock;
  29
  30 /// If a command-line option matches `find_arg`, then apply the predicate `pred` on its value. If
  31 /// true, then return it. The parameter is assumed to be either `--arg=value` or `--arg value`.
  32 fn arg_value<'a, T: Deref<Target = str>>(
  33     args: &'a [T],
  34     find_arg: &str,
  35     pred: impl Fn(&str) -> bool,
  36 ) -> Option<&'a str> {
  37     let mut args = args.iter().map(Deref::deref);
  38     while let Some(arg) = args.next() {
  39         let mut arg = arg.splitn(2, '=');
  40         if arg.next() != Some(find_arg) {
  41             continue;
  42         }
  43
  44         match arg.next().or_else(|| args.next()) {
  45             Some(v) if pred(v) => return Some(v),
  46             _ => {},
  47         }
  48     }
  49     None
  50 }
  51
  52 #[test]
  53 fn test_arg_value() {
  54     let args = &["--bar=bar", "--foobar", "123", "--foo"];
  55
  56     assert_eq!(arg_value(&[] as &[&str], "--foobar", |_| true), None);
  57     assert_eq!(arg_value(args, "--bar", |_| false), None);
  58     assert_eq!(arg_value(args, "--bar", |_| true), Some("bar"));
  59     assert_eq!(arg_value(args, "--bar", |p| p == "bar"), Some("bar"));
  60     assert_eq!(arg_value(args, "--bar", |p| p == "foo"), None);
  61     assert_eq!(arg_value(args, "--foobar", |p| p == "foo"), None);
  62     assert_eq!(arg_value(args, "--foobar", |p| p == "123"), Some("123"));
  63     assert_eq!(arg_value(args, "--foobar", |p| p.contains("12")), Some("123"));
  64     assert_eq!(arg_value(args, "--foo", |_| true), None);
  65 }
  66
  67 fn track_clippy_args(parse_sess: &mut ParseSess, args_env_var: &Option<String>) {
  68     parse_sess.env_depinfo.get_mut().insert((
  69         Symbol::intern("CLIPPY_ARGS"),
  70         args_env_var.as_deref().map(Symbol::intern),
  71     ));
  72 }
  73
  74 struct DefaultCallbacks;
  75 impl rustc_driver::Callbacks for DefaultCallbacks {}
  76
  77 /// This is different from `DefaultCallbacks` that it will inform Cargo to track the value of
  78 /// `CLIPPY_ARGS` environment variable.
  79 struct RustcCallbacks {
  80     clippy_args_var: Option<String>,
  81 }
  82
  83 impl rustc_driver::Callbacks for RustcCallbacks {
  84     fn config(&mut self, config: &mut interface::Config) {
  85         let clippy_args_var = self.clippy_args_var.take();
  86         config.parse_sess_created = Some(Box::new(move |parse_sess| {
  87             track_clippy_args(parse_sess, &clippy_args_var);
  88         }));
  89     }
  90 }
  91
  92 struct ClippyCallbacks {
  93     clippy_args_var: Option<String>,
  94 }
  95
  96 impl rustc_driver::Callbacks for ClippyCallbacks {
  97     fn config(&mut self, config: &mut interface::Config) {
  98         let previous = config.register_lints.take();
  99         let clippy_args_var = self.clippy_args_var.take();
 100         config.parse_sess_created = Some(Box::new(move |parse_sess| {
 101             track_clippy_args(parse_sess, &clippy_args_var);
 102         }));
 103         config.register_lints = Some(Box::new(move |sess, lint_store| {
 104             // technically we're ~guaranteed that this is none but might as well call anything that
 105             // is there already. Certainly it can't hurt.
 106             if let Some(previous) = &previous {
 107                 (previous)(sess, lint_store);
 108             }
 109
 110             let conf = clippy_lints::read_conf(sess);
 111             clippy_lints::register_plugins(lint_store, sess, &conf);
 112             clippy_lints::register_pre_expansion_lints(lint_store, sess, &conf);
 113             clippy_lints::register_renamed(lint_store);
 114         }));
 115
 116         // FIXME: #4825; This is required, because Clippy lints that are based on MIR have to be
 117         // run on the unoptimized MIR. On the other hand this results in some false negatives. If
 118         // MIR passes can be enabled / disabled separately, we should figure out, what passes to
 119         // use for Clippy.
 120         config.opts.debugging_opts.mir_opt_level = Some(0);
 121     }
 122 }
 123
 124 fn display_help() {
 125     println!(
 126         "\
 127 Checks a package to catch common mistakes and improve your Rust code.
 128
 129 Usage:
 130     cargo clippy [options] [--] [<opts>...]
 131
 132 Common options:
 133     -h, --help               Print this message
 134         --rustc              Pass all args to rustc
 135     -V, --version            Print version info and exit
 136
 137 Other options are the same as `cargo check`.
 138
 139 To allow or deny a lint from the command line you can use `cargo clippy --`
 140 with:
 141
 142     -W --warn OPT       Set lint warnings
 143     -A --allow OPT      Set lint allowed
 144     -D --deny OPT       Set lint denied
 145     -F --forbid OPT     Set lint forbidden
 146
 147 You can use tool lints to allow or deny lints from your code, eg.:
 148
 149     #[allow(clippy::needless_lifetimes)]
 150 "
 151     );
 152 }
 153
 154 const BUG_REPORT_URL: &str = "https://github.com/rust-lang/rust-clippy/issues/new";
 155
 156 type PanicCallback = dyn Fn(&panic::PanicInfo<'_>) + Sync + Send + 'static;
 157 static ICE_HOOK: LazyLock<Box<PanicCallback>> = LazyLock::new(|| {
 158     let hook = panic::take_hook();
 159     panic::set_hook(Box::new(|info| report_clippy_ice(info, BUG_REPORT_URL)));
 160     hook
 161 });
 162
 163 fn report_clippy_ice(info: &panic::PanicInfo<'_>, bug_report_url: &str) {
 164     // Invoke our ICE handler, which prints the actual panic message and optionally a backtrace
 165     (*ICE_HOOK)(info);
 166
 167     // Separate the output with an empty line
 168     eprintln!();
 169
 170     let fallback_bundle = rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
 171     let emitter = Box::new(rustc_errors::emitter::EmitterWriter::stderr(
 172         rustc_errors::ColorConfig::Auto,
 173         None,
 174         None,
 175         fallback_bundle,
 176         false,
 177         false,
 178         None,
 179         false,
 180     ));
 181     let handler = rustc_errors::Handler::with_emitter(true, None, emitter);
 182
 183     // a .span_bug or .bug call has already printed what
 184     // it wants to print.
 185     if !info.payload().is::<rustc_errors::ExplicitBug>() {
 186         let mut d = rustc_errors::Diagnostic::new(rustc_errors::Level::Bug, "unexpected panic");
 187         handler.emit_diagnostic(&mut d);
 188     }
 189
 190     let version_info = rustc_tools_util::get_version_info!();
 191
 192     let xs: Vec<Cow<'static, str>> = vec![
 193         "the compiler unexpectedly panicked. this is a bug.".into(),
 194         format!("we would appreciate a bug report: {}", bug_report_url).into(),
 195         format!("Clippy version: {}", version_info).into(),
 196     ];
 197
 198     for note in &xs {
 199         handler.note_without_error(note.as_ref());
 200     }
 201
 202     // If backtraces are enabled, also print the query stack
 203     let backtrace = env::var_os("RUST_BACKTRACE").map_or(false, |x| &x != "0");
 204
 205     let num_frames = if backtrace { None } else { Some(2) };
 206
 207     interface::try_print_query_stack(&handler, num_frames);
 208 }
 209
 210 fn toolchain_path(home: Option<String>, toolchain: Option<String>) -> Option<PathBuf> {
 211     home.and_then(|home| {
 212         toolchain.map(|toolchain| {
 213             let mut path = PathBuf::from(home);
 214             path.push("toolchains");
 215             path.push(toolchain);
 216             path
 217         })
 218     })
 219 }
 220
 221 #[allow(clippy::too_many_lines)]
 222 pub fn main() {
 223     rustc_driver::init_rustc_env_logger();
 224     LazyLock::force(&ICE_HOOK);
 225     exit(rustc_driver::catch_with_exit_code(move || {
 226         let mut orig_args: Vec<String> = env::args().collect();
 227
 228         // Get the sysroot, looking from most specific to this invocation to the least:
 229         // - command line
 230         // - runtime environment
 231         //    - SYSROOT
 232         //    - RUSTUP_HOME, MULTIRUST_HOME, RUSTUP_TOOLCHAIN, MULTIRUST_TOOLCHAIN
 233         // - sysroot from rustc in the path
 234         // - compile-time environment
 235         //    - SYSROOT
 236         //    - RUSTUP_HOME, MULTIRUST_HOME, RUSTUP_TOOLCHAIN, MULTIRUST_TOOLCHAIN
 237         let sys_root_arg = arg_value(&orig_args, "--sysroot", |_| true);
 238         let have_sys_root_arg = sys_root_arg.is_some();
 239         let sys_root = sys_root_arg
 240             .map(PathBuf::from)
 241             .or_else(|| std::env::var("SYSROOT").ok().map(PathBuf::from))
 242             .or_else(|| {
 243                 let home = std::env::var("RUSTUP_HOME")
 244                     .or_else(|_| std::env::var("MULTIRUST_HOME"))
 245                     .ok();
 246                 let toolchain = std::env::var("RUSTUP_TOOLCHAIN")
 247                     .or_else(|_| std::env::var("MULTIRUST_TOOLCHAIN"))
 248                     .ok();
 249                 toolchain_path(home, toolchain)
 250             })
 251             .or_else(|| {
 252                 Command::new("rustc")
 253                     .arg("--print")
 254                     .arg("sysroot")
 255                     .output()
 256                     .ok()
 257                     .and_then(|out| String::from_utf8(out.stdout).ok())
 258                     .map(|s| PathBuf::from(s.trim()))
 259             })
 260             .or_else(|| option_env!("SYSROOT").map(PathBuf::from))
 261             .or_else(|| {
 262                 let home = option_env!("RUSTUP_HOME")
 263                     .or(option_env!("MULTIRUST_HOME"))
 264                     .map(ToString::to_string);
 265                 let toolchain = option_env!("RUSTUP_TOOLCHAIN")
 266                     .or(option_env!("MULTIRUST_TOOLCHAIN"))
 267                     .map(ToString::to_string);
 268                 toolchain_path(home, toolchain)
 269             })
 270             .map(|pb| pb.to_string_lossy().to_string())
 271             .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust");
 272
 273         // make "clippy-driver --rustc" work like a subcommand that passes further args to "rustc"
 274         // for example `clippy-driver --rustc --version` will print the rustc version that clippy-driver
 275         // uses
 276         if let Some(pos) = orig_args.iter().position(|arg| arg == "--rustc") {
 277             orig_args.remove(pos);
 278             orig_args[0] = "rustc".to_string();
 279
 280             // if we call "rustc", we need to pass --sysroot here as well
 281             let mut args: Vec<String> = orig_args.clone();
 282             if !have_sys_root_arg {
 283                 args.extend(vec!["--sysroot".into(), sys_root]);
 284             };
 285
 286             return rustc_driver::RunCompiler::new(&args, &mut DefaultCallbacks).run();
 287         }
 288
 289         if orig_args.iter().any(|a| a == "--version" || a == "-V") {
 290             let version_info = rustc_tools_util::get_version_info!();
 291             println!("{}", version_info);
 292             exit(0);
 293         }
 294
 295         // Setting RUSTC_WRAPPER causes Cargo to pass 'rustc' as the first argument.
 296         // We're invoking the compiler programmatically, so we ignore this/
 297         let wrapper_mode = orig_args.get(1).map(Path::new).and_then(Path::file_stem) == Some("rustc".as_ref());
 298
 299         if wrapper_mode {
 300             // we still want to be able to invoke it normally though
 301             orig_args.remove(1);
 302         }
 303
 304         if !wrapper_mode && (orig_args.iter().any(|a| a == "--help" || a == "-h") || orig_args.len() == 1) {
 305             display_help();
 306             exit(0);
 307         }
 308
 309         // this conditional check for the --sysroot flag is there so users can call
 310         // `clippy_driver` directly
 311         // without having to pass --sysroot or anything
 312         let mut args: Vec<String> = orig_args.clone();
 313         if !have_sys_root_arg {
 314             args.extend(vec!["--sysroot".into(), sys_root]);
 315         };
 316
 317         let mut no_deps = false;
 318         let clippy_args_var = env::var("CLIPPY_ARGS").ok();
 319         let clippy_args = clippy_args_var
 320             .as_deref()
 321             .unwrap_or_default()
 322             .split("__CLIPPY_HACKERY__")
 323             .filter_map(|s| match s {
 324                 "" => None,
 325                 "--no-deps" => {
 326                     no_deps = true;
 327                     None
 328                 },
 329                 _ => Some(s.to_string()),
 330             })
 331             .chain(vec!["--cfg".into(), r#"feature="cargo-clippy""#.into()])
 332             .collect::<Vec<String>>();
 333
 334         // We enable Clippy if one of the following conditions is met
 335         // - IF Clippy is run on its test suite OR
 336         // - IF Clippy is run on the main crate, not on deps (`!cap_lints_allow`) THEN
 337         //    - IF `--no-deps` is not set (`!no_deps`) OR
 338         //    - IF `--no-deps` is set and Clippy is run on the specified primary package
 339         let cap_lints_allow = arg_value(&orig_args, "--cap-lints", |val| val == "allow").is_some()
 340             && arg_value(&orig_args, "--force-warn", |val| val.contains("clippy::")).is_none();
 341         let in_primary_package = env::var("CARGO_PRIMARY_PACKAGE").is_ok();
 342
 343         let clippy_enabled = !cap_lints_allow && (!no_deps || in_primary_package);
 344         if clippy_enabled {
 345             args.extend(clippy_args);
 346             rustc_driver::RunCompiler::new(&args, &mut ClippyCallbacks { clippy_args_var }).run()
 347         } else {
 348             rustc_driver::RunCompiler::new(&args, &mut RustcCallbacks { clippy_args_var }).run()
 349         }
 350     }))
 351 }