src/driver.rs

   1 #![cfg_attr(feature = "deny-warnings", deny(warnings))]
   2 #![feature(rustc_private)]
   3
   4 // FIXME: switch to something more ergonomic here, once available.
   5 // (Currently there is no way to opt into sysroot crates without `extern crate`.)
   6 #[allow(unused_extern_crates)]
   7 extern crate rustc_driver;
   8 #[allow(unused_extern_crates)]
   9 extern crate rustc_errors;
  10 #[allow(unused_extern_crates)]
  11 extern crate rustc_interface;
  12 #[allow(unused_extern_crates)]
  13 extern crate rustc_middle;
  14
  15 use rustc_interface::interface;
  16 use rustc_middle::ty::TyCtxt;
  17 use rustc_tools_util::VersionInfo;
  18
  19 use lazy_static::lazy_static;
  20 use std::borrow::Cow;
  21 use std::env;
  22 use std::ops::Deref;
  23 use std::panic;
  24 use std::path::{Path, PathBuf};
  25 use std::process::{exit, Command};
  26
  27 mod lintlist;
  28
  29 /// If a command-line option matches `find_arg`, then apply the predicate `pred` on its value. If
  30 /// true, then return it. The parameter is assumed to be either `--arg=value` or `--arg value`.
  31 fn arg_value<'a, T: Deref<Target = str>>(
  32     args: &'a [T],
  33     find_arg: &str,
  34     pred: impl Fn(&str) -> bool,
  35 ) -> Option<&'a str> {
  36     let mut args = args.iter().map(Deref::deref);
  37     while let Some(arg) = args.next() {
  38         let mut arg = arg.splitn(2, '=');
  39         if arg.next() != Some(find_arg) {
  40             continue;
  41         }
  42
  43         match arg.next().or_else(|| args.next()) {
  44             Some(v) if pred(v) => return Some(v),
  45             _ => {},
  46         }
  47     }
  48     None
  49 }
  50
  51 #[test]
  52 fn test_arg_value() {
  53     let args = &["--bar=bar", "--foobar", "123", "--foo"];
  54
  55     assert_eq!(arg_value(&[] as &[&str], "--foobar", |_| true), None);
  56     assert_eq!(arg_value(args, "--bar", |_| false), None);
  57     assert_eq!(arg_value(args, "--bar", |_| true), Some("bar"));
  58     assert_eq!(arg_value(args, "--bar", |p| p == "bar"), Some("bar"));
  59     assert_eq!(arg_value(args, "--bar", |p| p == "foo"), None);
  60     assert_eq!(arg_value(args, "--foobar", |p| p == "foo"), None);
  61     assert_eq!(arg_value(args, "--foobar", |p| p == "123"), Some("123"));
  62     assert_eq!(arg_value(args, "--foo", |_| true), None);
  63 }
  64
  65 struct DefaultCallbacks;
  66 impl rustc_driver::Callbacks for DefaultCallbacks {}
  67
  68 struct ClippyCallbacks;
  69 impl rustc_driver::Callbacks for ClippyCallbacks {
  70     fn config(&mut self, config: &mut interface::Config) {
  71         let previous = config.register_lints.take();
  72         config.register_lints = Some(Box::new(move |sess, mut lint_store| {
  73             // technically we're ~guaranteed that this is none but might as well call anything that
  74             // is there already. Certainly it can't hurt.
  75             if let Some(previous) = &previous {
  76                 (previous)(sess, lint_store);
  77             }
  78
  79             let conf = clippy_lints::read_conf(&[], &sess);
  80             clippy_lints::register_plugins(&mut lint_store, &sess, &conf);
  81             clippy_lints::register_pre_expansion_lints(&mut lint_store);
  82             clippy_lints::register_renamed(&mut lint_store);
  83         }));
  84
  85         // FIXME: #4825; This is required, because Clippy lints that are based on MIR have to be
  86         // run on the unoptimized MIR. On the other hand this results in some false negatives. If
  87         // MIR passes can be enabled / disabled separately, we should figure out, what passes to
  88         // use for Clippy.
  89         config.opts.debugging_opts.mir_opt_level = 0;
  90     }
  91 }
  92
  93 #[allow(clippy::find_map, clippy::filter_map)]
  94 fn describe_lints() {
  95     use lintlist::{Level, Lint, ALL_LINTS, LINT_LEVELS};
  96     use std::collections::HashSet;
  97
  98     println!(
  99         "
 100 Available lint options:
 101     -W <foo>           Warn about <foo>
 102     -A <foo>           Allow <foo>
 103     -D <foo>           Deny <foo>
 104     -F <foo>           Forbid <foo> (deny <foo> and all attempts to override)
 105
 106 "
 107     );
 108
 109     let lint_level = |lint: &Lint| {
 110         LINT_LEVELS
 111             .iter()
 112             .find(|level_mapping| level_mapping.0 == lint.group)
 113             .map(|(_, level)| match level {
 114                 Level::Allow => "allow",
 115                 Level::Warn => "warn",
 116                 Level::Deny => "deny",
 117             })
 118             .unwrap()
 119     };
 120
 121     let mut lints: Vec<_> = ALL_LINTS.iter().collect();
 122     // The sort doesn't case-fold but it's doubtful we care.
 123     lints.sort_by_cached_key(|x: &&Lint| (lint_level(x), x.name));
 124
 125     let max_lint_name_len = lints
 126         .iter()
 127         .map(|lint| lint.name.len())
 128         .map(|len| len + "clippy::".len())
 129         .max()
 130         .unwrap_or(0);
 131
 132     let padded = |x: &str| {
 133         let mut s = " ".repeat(max_lint_name_len - x.chars().count());
 134         s.push_str(x);
 135         s
 136     };
 137
 138     let scoped = |x: &str| format!("clippy::{}", x);
 139
 140     let lint_groups: HashSet<_> = lints.iter().map(|lint| lint.group).collect();
 141
 142     println!("Lint checks provided by clippy:\n");
 143     println!("    {}  {:7.7}  meaning", padded("name"), "default");
 144     println!("    {}  {:7.7}  -------", padded("----"), "-------");
 145
 146     let print_lints = |lints: &[&Lint]| {
 147         for lint in lints {
 148             let name = lint.name.replace("_", "-");
 149             println!(
 150                 "    {}  {:7.7}  {}",
 151                 padded(&scoped(&name)),
 152                 lint_level(lint),
 153                 lint.desc
 154             );
 155         }
 156         println!("\n");
 157     };
 158
 159     print_lints(&lints);
 160
 161     let max_group_name_len = std::cmp::max(
 162         "clippy::all".len(),
 163         lint_groups
 164             .iter()
 165             .map(|group| group.len())
 166             .map(|len| len + "clippy::".len())
 167             .max()
 168             .unwrap_or(0),
 169     );
 170
 171     let padded_group = |x: &str| {
 172         let mut s = " ".repeat(max_group_name_len - x.chars().count());
 173         s.push_str(x);
 174         s
 175     };
 176
 177     println!("Lint groups provided by clippy:\n");
 178     println!("    {}  sub-lints", padded_group("name"));
 179     println!("    {}  ---------", padded_group("----"));
 180     println!("    {}  the set of all clippy lints", padded_group("clippy::all"));
 181
 182     let print_lint_groups = || {
 183         for group in lint_groups {
 184             let name = group.to_lowercase().replace("_", "-");
 185             let desc = lints
 186                 .iter()
 187                 .filter(|&lint| lint.group == group)
 188                 .map(|lint| lint.name)
 189                 .map(|name| name.replace("_", "-"))
 190                 .collect::<Vec<String>>()
 191                 .join(", ");
 192             println!("    {}  {}", padded_group(&scoped(&name)), desc);
 193         }
 194         println!("\n");
 195     };
 196
 197     print_lint_groups();
 198 }
 199
 200 fn display_help() {
 201     println!(
 202         "\
 203 Checks a package to catch common mistakes and improve your Rust code.
 204
 205 Usage:
 206     cargo clippy [options] [--] [<opts>...]
 207
 208 Common options:
 209     -h, --help               Print this message
 210         --rustc              Pass all args to rustc
 211     -V, --version            Print version info and exit
 212
 213 Other options are the same as `cargo check`.
 214
 215 To allow or deny a lint from the command line you can use `cargo clippy --`
 216 with:
 217
 218     -W --warn OPT       Set lint warnings
 219     -A --allow OPT      Set lint allowed
 220     -D --deny OPT       Set lint denied
 221     -F --forbid OPT     Set lint forbidden
 222
 223 You can use tool lints to allow or deny lints from your code, eg.:
 224
 225     #[allow(clippy::needless_lifetimes)]
 226 "
 227     );
 228 }
 229
 230 const BUG_REPORT_URL: &str = "https://github.com/rust-lang/rust-clippy/issues/new";
 231
 232 lazy_static! {
 233     static ref ICE_HOOK: Box<dyn Fn(&panic::PanicInfo<'_>) + Sync + Send + 'static> = {
 234         let hook = panic::take_hook();
 235         panic::set_hook(Box::new(|info| report_clippy_ice(info, BUG_REPORT_URL)));
 236         hook
 237     };
 238 }
 239
 240 fn report_clippy_ice(info: &panic::PanicInfo<'_>, bug_report_url: &str) {
 241     // Invoke our ICE handler, which prints the actual panic message and optionally a backtrace
 242     (*ICE_HOOK)(info);
 243
 244     // Separate the output with an empty line
 245     eprintln!();
 246
 247     let emitter = Box::new(rustc_errors::emitter::EmitterWriter::stderr(
 248         rustc_errors::ColorConfig::Auto,
 249         None,
 250         false,
 251         false,
 252         None,
 253         false,
 254     ));
 255     let handler = rustc_errors::Handler::with_emitter(true, None, emitter);
 256
 257     // a .span_bug or .bug call has already printed what
 258     // it wants to print.
 259     if !info.payload().is::<rustc_errors::ExplicitBug>() {
 260         let d = rustc_errors::Diagnostic::new(rustc_errors::Level::Bug, "unexpected panic");
 261         handler.emit_diagnostic(&d);
 262     }
 263
 264     let version_info = rustc_tools_util::get_version_info!();
 265
 266     let xs: Vec<Cow<'static, str>> = vec![
 267         "the compiler unexpectedly panicked. this is a bug.".into(),
 268         format!("we would appreciate a bug report: {}", bug_report_url).into(),
 269         format!("Clippy version: {}", version_info).into(),
 270     ];
 271
 272     for note in &xs {
 273         handler.note_without_error(&note);
 274     }
 275
 276     // If backtraces are enabled, also print the query stack
 277     let backtrace = env::var_os("RUST_BACKTRACE").map_or(false, |x| &x != "0");
 278
 279     if backtrace {
 280         TyCtxt::try_print_query_stack(&handler);
 281     }
 282 }
 283
 284 fn toolchain_path(home: Option<String>, toolchain: Option<String>) -> Option<PathBuf> {
 285     home.and_then(|home| {
 286         toolchain.map(|toolchain| {
 287             let mut path = PathBuf::from(home);
 288             path.push("toolchains");
 289             path.push(toolchain);
 290             path
 291         })
 292     })
 293 }
 294
 295 pub fn main() {
 296     rustc_driver::init_rustc_env_logger();
 297     lazy_static::initialize(&ICE_HOOK);
 298     exit(rustc_driver::catch_with_exit_code(move || {
 299         let mut orig_args: Vec<String> = env::args().collect();
 300
 301         // Get the sysroot, looking from most specific to this invocation to the least:
 302         // - command line
 303         // - runtime environment
 304         //    - SYSROOT
 305         //    - RUSTUP_HOME, MULTIRUST_HOME, RUSTUP_TOOLCHAIN, MULTIRUST_TOOLCHAIN
 306         // - sysroot from rustc in the path
 307         // - compile-time environment
 308         //    - SYSROOT
 309         //    - RUSTUP_HOME, MULTIRUST_HOME, RUSTUP_TOOLCHAIN, MULTIRUST_TOOLCHAIN
 310         let sys_root_arg = arg_value(&orig_args, "--sysroot", |_| true);
 311         let have_sys_root_arg = sys_root_arg.is_some();
 312         let sys_root = sys_root_arg
 313             .map(PathBuf::from)
 314             .or_else(|| std::env::var("SYSROOT").ok().map(PathBuf::from))
 315             .or_else(|| {
 316                 let home = std::env::var("RUSTUP_HOME")
 317                     .or_else(|_| std::env::var("MULTIRUST_HOME"))
 318                     .ok();
 319                 let toolchain = std::env::var("RUSTUP_TOOLCHAIN")
 320                     .or_else(|_| std::env::var("MULTIRUST_TOOLCHAIN"))
 321                     .ok();
 322                 toolchain_path(home, toolchain)
 323             })
 324             .or_else(|| {
 325                 Command::new("rustc")
 326                     .arg("--print")
 327                     .arg("sysroot")
 328                     .output()
 329                     .ok()
 330                     .and_then(|out| String::from_utf8(out.stdout).ok())
 331                     .map(|s| PathBuf::from(s.trim()))
 332             })
 333             .or_else(|| option_env!("SYSROOT").map(PathBuf::from))
 334             .or_else(|| {
 335                 let home = option_env!("RUSTUP_HOME")
 336                     .or(option_env!("MULTIRUST_HOME"))
 337                     .map(ToString::to_string);
 338                 let toolchain = option_env!("RUSTUP_TOOLCHAIN")
 339                     .or(option_env!("MULTIRUST_TOOLCHAIN"))
 340                     .map(ToString::to_string);
 341                 toolchain_path(home, toolchain)
 342             })
 343             .map(|pb| pb.to_string_lossy().to_string())
 344             .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust");
 345
 346         // make "clippy-driver --rustc" work like a subcommand that passes further args to "rustc"
 347         // for example `clippy-driver --rustc --version` will print the rustc version that clippy-driver
 348         // uses
 349         if let Some(pos) = orig_args.iter().position(|arg| arg == "--rustc") {
 350             orig_args.remove(pos);
 351             orig_args[0] = "rustc".to_string();
 352
 353             // if we call "rustc", we need to pass --sysroot here as well
 354             let mut args: Vec<String> = orig_args.clone();
 355             if !have_sys_root_arg {
 356                 args.extend(vec!["--sysroot".into(), sys_root]);
 357             };
 358
 359             return rustc_driver::run_compiler(&args, &mut DefaultCallbacks, None, None);
 360         }
 361
 362         if orig_args.iter().any(|a| a == "--version" || a == "-V") {
 363             let version_info = rustc_tools_util::get_version_info!();
 364             println!("{}", version_info);
 365             exit(0);
 366         }
 367
 368         // Setting RUSTC_WRAPPER causes Cargo to pass 'rustc' as the first argument.
 369         // We're invoking the compiler programmatically, so we ignore this/
 370         let wrapper_mode = orig_args.get(1).map(Path::new).and_then(Path::file_stem) == Some("rustc".as_ref());
 371
 372         if wrapper_mode {
 373             // we still want to be able to invoke it normally though
 374             orig_args.remove(1);
 375         }
 376
 377         if !wrapper_mode && (orig_args.iter().any(|a| a == "--help" || a == "-h") || orig_args.len() == 1) {
 378             display_help();
 379             exit(0);
 380         }
 381
 382         let should_describe_lints = || {
 383             let args: Vec<_> = env::args().collect();
 384             args.windows(2).any(|args| {
 385                 args[1] == "help"
 386                     && match args[0].as_str() {
 387                         "-W" | "-A" | "-D" | "-F" => true,
 388                         _ => false,
 389                     }
 390             })
 391         };
 392
 393         if !wrapper_mode && should_describe_lints() {
 394             describe_lints();
 395             exit(0);
 396         }
 397
 398         // this conditional check for the --sysroot flag is there so users can call
 399         // `clippy_driver` directly
 400         // without having to pass --sysroot or anything
 401         let mut args: Vec<String> = orig_args.clone();
 402         if !have_sys_root_arg {
 403             args.extend(vec!["--sysroot".into(), sys_root]);
 404         };
 405
 406         // this check ensures that dependencies are built but not linted and the final
 407         // crate is linted but not built
 408         let clippy_enabled = env::var("CLIPPY_TESTS").map_or(false, |val| val == "true")
 409             || arg_value(&orig_args, "--cap-lints", |val| val == "allow").is_none();
 410
 411         if clippy_enabled {
 412             args.extend(vec!["--cfg".into(), r#"feature="cargo-clippy""#.into()]);
 413             if let Ok(extra_args) = env::var("CLIPPY_ARGS") {
 414                 args.extend(extra_args.split("__CLIPPY_HACKERY__").filter_map(|s| {
 415                     if s.is_empty() {
 416                         None
 417                     } else {
 418                         Some(s.to_string())
 419                     }
 420                 }));
 421             }
 422         }
 423         let mut clippy = ClippyCallbacks;
 424         let mut default = DefaultCallbacks;
 425         let callbacks: &mut (dyn rustc_driver::Callbacks + Send) =
 426             if clippy_enabled { &mut clippy } else { &mut default };
 427         rustc_driver::run_compiler(&args, callbacks, None, None)
 428     }))
 429 }