src/librustc/session/config.rs

   1 //! Contains infrastructure for configuring the compiler, including parsing
   2 //! command line options.
   3
   4 use std::str::FromStr;
   5
   6 use crate::session::{early_error, early_warn, Session};
   7 use crate::session::search_paths::SearchPath;
   8
   9 use rustc_target::spec::{LinkerFlavor, MergeFunctions, PanicStrategy, RelroLevel};
  10 use rustc_target::spec::{Target, TargetTriple};
  11 use crate::lint;
  12 use crate::middle::cstore;
  13
  14 use syntax::ast::{self, IntTy, UintTy, MetaItemKind};
  15 use syntax::source_map::{FileName, FilePathMapping};
  16 use syntax::edition::{Edition, EDITION_NAME_LIST, DEFAULT_EDITION};
  17 use syntax::parse::token;
  18 use syntax::parse;
  19 use syntax::symbol::Symbol;
  20 use syntax::feature_gate::UnstableFeatures;
  21
  22 use errors::{ColorConfig, FatalError, Handler};
  23
  24 use getopts;
  25 use std::collections::{BTreeMap, BTreeSet};
  26 use std::collections::btree_map::Iter as BTreeMapIter;
  27 use std::collections::btree_map::Keys as BTreeMapKeysIter;
  28 use std::collections::btree_map::Values as BTreeMapValuesIter;
  29
  30 use rustc_data_structures::fx::FxHashSet;
  31 use std::{fmt, str};
  32 use std::hash::Hasher;
  33 use std::collections::hash_map::DefaultHasher;
  34 use std::iter::FromIterator;
  35 use std::path::{Path, PathBuf};
  36
  37 pub struct Config {
  38     pub target: Target,
  39     pub isize_ty: IntTy,
  40     pub usize_ty: UintTy,
  41 }
  42
  43 #[derive(Clone, Hash, Debug)]
  44 pub enum Sanitizer {
  45     Address,
  46     Leak,
  47     Memory,
  48     Thread,
  49 }
  50
  51 #[derive(Clone, Copy, Debug, PartialEq, Hash)]
  52 pub enum OptLevel {
  53     No,         // -O0
  54     Less,       // -O1
  55     Default,    // -O2
  56     Aggressive, // -O3
  57     Size,       // -Os
  58     SizeMin,    // -Oz
  59 }
  60
  61 impl_stable_hash_via_hash!(OptLevel);
  62
  63 /// This is what the `LtoCli` values get mapped to after resolving defaults and
  64 /// and taking other command line options into account.
  65 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
  66 pub enum Lto {
  67     /// Don't do any LTO whatsoever
  68     No,
  69
  70     /// Do a full crate graph LTO with ThinLTO
  71     Thin,
  72
  73     /// Do a local graph LTO with ThinLTO (only relevant for multiple codegen
  74     /// units).
  75     ThinLocal,
  76
  77     /// Do a full crate graph LTO with "fat" LTO
  78     Fat,
  79 }
  80
  81 /// The different settings that the `-C lto` flag can have.
  82 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
  83 pub enum LtoCli {
  84     /// `-C lto=no`
  85     No,
  86     /// `-C lto=yes`
  87     Yes,
  88     /// `-C lto`
  89     NoParam,
  90     /// `-C lto=thin`
  91     Thin,
  92     /// `-C lto=fat`
  93     Fat,
  94     /// No `-C lto` flag passed
  95     Unspecified,
  96 }
  97
  98 #[derive(Clone, PartialEq, Hash)]
  99 pub enum LinkerPluginLto {
 100     LinkerPlugin(PathBuf),
 101     LinkerPluginAuto,
 102     Disabled
 103 }
 104
 105 impl LinkerPluginLto {
 106     pub fn enabled(&self) -> bool {
 107         match *self {
 108             LinkerPluginLto::LinkerPlugin(_) |
 109             LinkerPluginLto::LinkerPluginAuto => true,
 110             LinkerPluginLto::Disabled => false,
 111         }
 112     }
 113 }
 114
 115 #[derive(Clone, Copy, PartialEq, Hash)]
 116 pub enum DebugInfo {
 117     None,
 118     Limited,
 119     Full,
 120 }
 121
 122 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, PartialOrd, Ord, RustcEncodable, RustcDecodable)]
 123 pub enum OutputType {
 124     Bitcode,
 125     Assembly,
 126     LlvmAssembly,
 127     Mir,
 128     Metadata,
 129     Object,
 130     Exe,
 131     DepInfo,
 132 }
 133
 134 impl_stable_hash_via_hash!(OutputType);
 135
 136 impl OutputType {
 137     fn is_compatible_with_codegen_units_and_single_output_file(&self) -> bool {
 138         match *self {
 139             OutputType::Exe | OutputType::DepInfo => true,
 140             OutputType::Bitcode
 141             | OutputType::Assembly
 142             | OutputType::LlvmAssembly
 143             | OutputType::Mir
 144             | OutputType::Object
 145             | OutputType::Metadata => false,
 146         }
 147     }
 148
 149     fn shorthand(&self) -> &'static str {
 150         match *self {
 151             OutputType::Bitcode => "llvm-bc",
 152             OutputType::Assembly => "asm",
 153             OutputType::LlvmAssembly => "llvm-ir",
 154             OutputType::Mir => "mir",
 155             OutputType::Object => "obj",
 156             OutputType::Metadata => "metadata",
 157             OutputType::Exe => "link",
 158             OutputType::DepInfo => "dep-info",
 159         }
 160     }
 161
 162     fn from_shorthand(shorthand: &str) -> Option<Self> {
 163         Some(match shorthand {
 164             "asm" => OutputType::Assembly,
 165             "llvm-ir" => OutputType::LlvmAssembly,
 166             "mir" => OutputType::Mir,
 167             "llvm-bc" => OutputType::Bitcode,
 168             "obj" => OutputType::Object,
 169             "metadata" => OutputType::Metadata,
 170             "link" => OutputType::Exe,
 171             "dep-info" => OutputType::DepInfo,
 172             _ => return None,
 173         })
 174     }
 175
 176     fn shorthands_display() -> String {
 177         format!(
 178             "`{}`, `{}`, `{}`, `{}`, `{}`, `{}`, `{}`, `{}`",
 179             OutputType::Bitcode.shorthand(),
 180             OutputType::Assembly.shorthand(),
 181             OutputType::LlvmAssembly.shorthand(),
 182             OutputType::Mir.shorthand(),
 183             OutputType::Object.shorthand(),
 184             OutputType::Metadata.shorthand(),
 185             OutputType::Exe.shorthand(),
 186             OutputType::DepInfo.shorthand(),
 187         )
 188     }
 189
 190     pub fn extension(&self) -> &'static str {
 191         match *self {
 192             OutputType::Bitcode => "bc",
 193             OutputType::Assembly => "s",
 194             OutputType::LlvmAssembly => "ll",
 195             OutputType::Mir => "mir",
 196             OutputType::Object => "o",
 197             OutputType::Metadata => "rmeta",
 198             OutputType::DepInfo => "d",
 199             OutputType::Exe => "",
 200         }
 201     }
 202 }
 203
 204 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 205 pub enum ErrorOutputType {
 206     HumanReadable(ColorConfig),
 207     Json(bool),
 208     Short(ColorConfig),
 209 }
 210
 211 impl Default for ErrorOutputType {
 212     fn default() -> ErrorOutputType {
 213         ErrorOutputType::HumanReadable(ColorConfig::Auto)
 214     }
 215 }
 216
 217 // Use tree-based collections to cheaply get a deterministic Hash implementation.
 218 // DO NOT switch BTreeMap out for an unsorted container type! That would break
 219 // dependency tracking for command-line arguments.
 220 #[derive(Clone, Hash)]
 221 pub struct OutputTypes(BTreeMap<OutputType, Option<PathBuf>>);
 222
 223 impl_stable_hash_via_hash!(OutputTypes);
 224
 225 impl OutputTypes {
 226     pub fn new(entries: &[(OutputType, Option<PathBuf>)]) -> OutputTypes {
 227         OutputTypes(BTreeMap::from_iter(
 228             entries.iter().map(|&(k, ref v)| (k, v.clone())),
 229         ))
 230     }
 231
 232     pub fn get(&self, key: &OutputType) -> Option<&Option<PathBuf>> {
 233         self.0.get(key)
 234     }
 235
 236     pub fn contains_key(&self, key: &OutputType) -> bool {
 237         self.0.contains_key(key)
 238     }
 239
 240     pub fn keys<'a>(&'a self) -> BTreeMapKeysIter<'a, OutputType, Option<PathBuf>> {
 241         self.0.keys()
 242     }
 243
 244     pub fn values<'a>(&'a self) -> BTreeMapValuesIter<'a, OutputType, Option<PathBuf>> {
 245         self.0.values()
 246     }
 247
 248     pub fn len(&self) -> usize {
 249         self.0.len()
 250     }
 251
 252     // True if any of the output types require codegen or linking.
 253     pub fn should_codegen(&self) -> bool {
 254         self.0.keys().any(|k| match *k {
 255             OutputType::Bitcode
 256             | OutputType::Assembly
 257             | OutputType::LlvmAssembly
 258             | OutputType::Mir
 259             | OutputType::Object
 260             | OutputType::Exe => true,
 261             OutputType::Metadata | OutputType::DepInfo => false,
 262         })
 263     }
 264 }
 265
 266 // Use tree-based collections to cheaply get a deterministic Hash implementation.
 267 // DO NOT switch BTreeMap or BTreeSet out for an unsorted container type! That
 268 // would break dependency tracking for command-line arguments.
 269 #[derive(Clone, Hash)]
 270 pub struct Externs(BTreeMap<String, BTreeSet<Option<String>>>);
 271
 272 impl Externs {
 273     pub fn new(data: BTreeMap<String, BTreeSet<Option<String>>>) -> Externs {
 274         Externs(data)
 275     }
 276
 277     pub fn get(&self, key: &str) -> Option<&BTreeSet<Option<String>>> {
 278         self.0.get(key)
 279     }
 280
 281     pub fn iter<'a>(&'a self) -> BTreeMapIter<'a, String, BTreeSet<Option<String>>> {
 282         self.0.iter()
 283     }
 284 }
 285
 286 macro_rules! hash_option {
 287     ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, [UNTRACKED]) => ({});
 288     ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, [TRACKED]) => ({
 289         if $sub_hashes.insert(stringify!($opt_name),
 290                               $opt_expr as &dyn dep_tracking::DepTrackingHash).is_some() {
 291             bug!("Duplicate key in CLI DepTrackingHash: {}", stringify!($opt_name))
 292         }
 293     });
 294     ($opt_name:ident,
 295      $opt_expr:expr,
 296      $sub_hashes:expr,
 297      [UNTRACKED_WITH_WARNING $warn_val:expr, $warn_text:expr, $error_format:expr]) => ({
 298         if *$opt_expr == $warn_val {
 299             early_warn($error_format, $warn_text)
 300         }
 301     });
 302 }
 303
 304 macro_rules! top_level_options {
 305     (pub struct Options { $(
 306         $opt:ident : $t:ty [$dep_tracking_marker:ident $($warn_val:expr, $warn_text:expr)*],
 307     )* } ) => (
 308         #[derive(Clone)]
 309         pub struct Options {
 310             $(pub $opt: $t),*
 311         }
 312
 313         impl Options {
 314             pub fn dep_tracking_hash(&self) -> u64 {
 315                 let mut sub_hashes = BTreeMap::new();
 316                 $({
 317                     hash_option!($opt,
 318                                  &self.$opt,
 319                                  &mut sub_hashes,
 320                                  [$dep_tracking_marker $($warn_val,
 321                                                          $warn_text,
 322                                                          self.error_format)*]);
 323                 })*
 324                 let mut hasher = DefaultHasher::new();
 325                 dep_tracking::stable_hash(sub_hashes,
 326                                           &mut hasher,
 327                                           self.error_format);
 328                 hasher.finish()
 329             }
 330         }
 331     );
 332 }
 333
 334 // The top-level command-line options struct
 335 //
 336 // For each option, one has to specify how it behaves with regard to the
 337 // dependency tracking system of incremental compilation. This is done via the
 338 // square-bracketed directive after the field type. The options are:
 339 //
 340 // [TRACKED]
 341 // A change in the given field will cause the compiler to completely clear the
 342 // incremental compilation cache before proceeding.
 343 //
 344 // [UNTRACKED]
 345 // Incremental compilation is not influenced by this option.
 346 //
 347 // [UNTRACKED_WITH_WARNING(val, warning)]
 348 // The option is incompatible with incremental compilation in some way. If it
 349 // has the value `val`, the string `warning` is emitted as a warning.
 350 //
 351 // If you add a new option to this struct or one of the sub-structs like
 352 // CodegenOptions, think about how it influences incremental compilation. If in
 353 // doubt, specify [TRACKED], which is always "correct" but might lead to
 354 // unnecessary re-compilation.
 355 top_level_options!(
 356     pub struct Options {
 357         // The crate config requested for the session, which may be combined
 358         // with additional crate configurations during the compile process
 359         crate_types: Vec<CrateType> [TRACKED],
 360         optimize: OptLevel [TRACKED],
 361         // Include the debug_assertions flag into dependency tracking, since it
 362         // can influence whether overflow checks are done or not.
 363         debug_assertions: bool [TRACKED],
 364         debuginfo: DebugInfo [TRACKED],
 365         lint_opts: Vec<(String, lint::Level)> [TRACKED],
 366         lint_cap: Option<lint::Level> [TRACKED],
 367         describe_lints: bool [UNTRACKED],
 368         output_types: OutputTypes [TRACKED],
 369         search_paths: Vec<SearchPath> [UNTRACKED],
 370         libs: Vec<(String, Option<String>, Option<cstore::NativeLibraryKind>)> [TRACKED],
 371         maybe_sysroot: Option<PathBuf> [TRACKED],
 372
 373         target_triple: TargetTriple [TRACKED],
 374
 375         test: bool [TRACKED],
 376         error_format: ErrorOutputType [UNTRACKED],
 377
 378         // if Some, enable incremental compilation, using the given
 379         // directory to store intermediate results
 380         incremental: Option<PathBuf> [UNTRACKED],
 381
 382         debugging_opts: DebuggingOptions [TRACKED],
 383         prints: Vec<PrintRequest> [UNTRACKED],
 384         // Determines which borrow checker(s) to run. This is the parsed, sanitized
 385         // version of `debugging_opts.borrowck`, which is just a plain string.
 386         borrowck_mode: BorrowckMode [UNTRACKED],
 387         cg: CodegenOptions [TRACKED],
 388         externs: Externs [UNTRACKED],
 389         crate_name: Option<String> [TRACKED],
 390         // An optional name to use as the crate for std during std injection,
 391         // written `extern crate name as std`. Defaults to `std`. Used by
 392         // out-of-tree drivers.
 393         alt_std_name: Option<String> [TRACKED],
 394         // Indicates how the compiler should treat unstable features
 395         unstable_features: UnstableFeatures [TRACKED],
 396
 397         // Indicates whether this run of the compiler is actually rustdoc. This
 398         // is currently just a hack and will be removed eventually, so please
 399         // try to not rely on this too much.
 400         actually_rustdoc: bool [TRACKED],
 401
 402         // Specifications of codegen units / ThinLTO which are forced as a
 403         // result of parsing command line options. These are not necessarily
 404         // what rustc was invoked with, but massaged a bit to agree with
 405         // commands like `--emit llvm-ir` which they're often incompatible with
 406         // if we otherwise use the defaults of rustc.
 407         cli_forced_codegen_units: Option<usize> [UNTRACKED],
 408         cli_forced_thinlto_off: bool [UNTRACKED],
 409
 410         // Remap source path prefixes in all output (messages, object files, debug, etc)
 411         remap_path_prefix: Vec<(PathBuf, PathBuf)> [UNTRACKED],
 412
 413         edition: Edition [TRACKED],
 414
 415         // The list of crates to consider private when
 416         // checking leaked private dependency types in public interfaces
 417         extern_private: Vec<String> [TRACKED],
 418     }
 419 );
 420
 421 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
 422 pub enum PrintRequest {
 423     FileNames,
 424     Sysroot,
 425     CrateName,
 426     Cfg,
 427     TargetList,
 428     TargetCPUs,
 429     TargetFeatures,
 430     RelocationModels,
 431     CodeModels,
 432     TlsModels,
 433     TargetSpec,
 434     NativeStaticLibs,
 435 }
 436
 437 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
 438 pub enum BorrowckMode {
 439     Ast,
 440     Mir,
 441     Compare,
 442     Migrate,
 443 }
 444
 445 impl BorrowckMode {
 446     /// Should we run the MIR-based borrow check, but also fall back
 447     /// on the AST borrow check if the MIR-based one errors.
 448     pub fn migrate(self) -> bool {
 449         match self {
 450             BorrowckMode::Ast => false,
 451             BorrowckMode::Compare => false,
 452             BorrowckMode::Mir => false,
 453             BorrowckMode::Migrate => true,
 454         }
 455     }
 456
 457     /// Should we emit the AST-based borrow checker errors?
 458     pub fn use_ast(self) -> bool {
 459         match self {
 460             BorrowckMode::Ast => true,
 461             BorrowckMode::Compare => true,
 462             BorrowckMode::Mir => false,
 463             BorrowckMode::Migrate => false,
 464         }
 465     }
 466     /// Should we emit the MIR-based borrow checker errors?
 467     pub fn use_mir(self) -> bool {
 468         match self {
 469             BorrowckMode::Ast => false,
 470             BorrowckMode::Compare => true,
 471             BorrowckMode::Mir => true,
 472             BorrowckMode::Migrate => true,
 473         }
 474     }
 475 }
 476
 477 pub enum Input {
 478     /// Loads source from file
 479     File(PathBuf),
 480     Str {
 481         /// String that is shown in place of a filename
 482         name: FileName,
 483         /// Anonymous source string
 484         input: String,
 485     },
 486 }
 487
 488 impl Input {
 489     pub fn filestem(&self) -> &str {
 490         match *self {
 491             Input::File(ref ifile) => ifile.file_stem().unwrap().to_str().unwrap(),
 492             Input::Str { .. } => "rust_out",
 493         }
 494     }
 495
 496     pub fn get_input(&mut self) -> Option<&mut String> {
 497         match *self {
 498             Input::File(_) => None,
 499             Input::Str { ref mut input, .. } => Some(input),
 500         }
 501     }
 502
 503     pub fn source_name(&self) -> FileName {
 504         match *self {
 505             Input::File(ref ifile) => ifile.clone().into(),
 506             Input::Str { ref name, .. } => name.clone(),
 507         }
 508     }
 509 }
 510
 511 #[derive(Clone, Hash)]
 512 pub struct OutputFilenames {
 513     pub out_directory: PathBuf,
 514     pub out_filestem: String,
 515     pub single_output_file: Option<PathBuf>,
 516     pub extra: String,
 517     pub outputs: OutputTypes,
 518 }
 519
 520 impl_stable_hash_via_hash!(OutputFilenames);
 521
 522 pub const RUST_CGU_EXT: &str = "rcgu";
 523
 524 impl OutputFilenames {
 525     pub fn path(&self, flavor: OutputType) -> PathBuf {
 526         self.outputs
 527             .get(&flavor)
 528             .and_then(|p| p.to_owned())
 529             .or_else(|| self.single_output_file.clone())
 530             .unwrap_or_else(|| self.temp_path(flavor, None))
 531     }
 532
 533     /// Gets the path where a compilation artifact of the given type for the
 534     /// given codegen unit should be placed on disk. If codegen_unit_name is
 535     /// None, a path distinct from those of any codegen unit will be generated.
 536     pub fn temp_path(&self, flavor: OutputType, codegen_unit_name: Option<&str>) -> PathBuf {
 537         let extension = flavor.extension();
 538         self.temp_path_ext(extension, codegen_unit_name)
 539     }
 540
 541     /// Like temp_path, but also supports things where there is no corresponding
 542     /// OutputType, like noopt-bitcode or lto-bitcode.
 543     pub fn temp_path_ext(&self, ext: &str, codegen_unit_name: Option<&str>) -> PathBuf {
 544         let base = self.out_directory.join(&self.filestem());
 545
 546         let mut extension = String::new();
 547
 548         if let Some(codegen_unit_name) = codegen_unit_name {
 549             extension.push_str(codegen_unit_name);
 550         }
 551
 552         if !ext.is_empty() {
 553             if !extension.is_empty() {
 554                 extension.push_str(".");
 555                 extension.push_str(RUST_CGU_EXT);
 556                 extension.push_str(".");
 557             }
 558
 559             extension.push_str(ext);
 560         }
 561
 562         let path = base.with_extension(&extension[..]);
 563         path
 564     }
 565
 566     pub fn with_extension(&self, extension: &str) -> PathBuf {
 567         self.out_directory
 568             .join(&self.filestem())
 569             .with_extension(extension)
 570     }
 571
 572     pub fn filestem(&self) -> String {
 573         format!("{}{}", self.out_filestem, self.extra)
 574     }
 575 }
 576
 577 pub fn host_triple() -> &'static str {
 578     // Get the host triple out of the build environment. This ensures that our
 579     // idea of the host triple is the same as for the set of libraries we've
 580     // actually built.  We can't just take LLVM's host triple because they
 581     // normalize all ix86 architectures to i386.
 582     //
 583     // Instead of grabbing the host triple (for the current host), we grab (at
 584     // compile time) the target triple that this rustc is built with and
 585     // calling that (at runtime) the host triple.
 586     (option_env!("CFG_COMPILER_HOST_TRIPLE")).expect("CFG_COMPILER_HOST_TRIPLE")
 587 }
 588
 589 impl Default for Options {
 590     fn default() -> Options {
 591         Options {
 592             crate_types: Vec::new(),
 593             optimize: OptLevel::No,
 594             debuginfo: DebugInfo::None,
 595             lint_opts: Vec::new(),
 596             lint_cap: None,
 597             describe_lints: false,
 598             output_types: OutputTypes(BTreeMap::new()),
 599             search_paths: vec![],
 600             maybe_sysroot: None,
 601             target_triple: TargetTriple::from_triple(host_triple()),
 602             test: false,
 603             incremental: None,
 604             debugging_opts: basic_debugging_options(),
 605             prints: Vec::new(),
 606             borrowck_mode: BorrowckMode::Ast,
 607             cg: basic_codegen_options(),
 608             error_format: ErrorOutputType::default(),
 609             externs: Externs(BTreeMap::new()),
 610             crate_name: None,
 611             alt_std_name: None,
 612             libs: Vec::new(),
 613             unstable_features: UnstableFeatures::Disallow,
 614             debug_assertions: true,
 615             actually_rustdoc: false,
 616             cli_forced_codegen_units: None,
 617             cli_forced_thinlto_off: false,
 618             remap_path_prefix: Vec::new(),
 619             edition: DEFAULT_EDITION,
 620             extern_private: Vec::new()
 621         }
 622     }
 623 }
 624
 625 impl Options {
 626     /// Returns `true` if there is a reason to build the dep graph.
 627     pub fn build_dep_graph(&self) -> bool {
 628         self.incremental.is_some() || self.debugging_opts.dump_dep_graph
 629             || self.debugging_opts.query_dep_graph
 630     }
 631
 632     #[inline(always)]
 633     pub fn enable_dep_node_debug_strs(&self) -> bool {
 634         cfg!(debug_assertions)
 635             && (self.debugging_opts.query_dep_graph || self.debugging_opts.incremental_info)
 636     }
 637
 638     pub fn file_path_mapping(&self) -> FilePathMapping {
 639         FilePathMapping::new(self.remap_path_prefix.clone())
 640     }
 641
 642     /// Returns `true` if there will be an output file generated
 643     pub fn will_create_output_file(&self) -> bool {
 644         !self.debugging_opts.parse_only && // The file is just being parsed
 645             !self.debugging_opts.ls // The file is just being queried
 646     }
 647
 648     #[inline]
 649     pub fn share_generics(&self) -> bool {
 650         match self.debugging_opts.share_generics {
 651             Some(setting) => setting,
 652             None => {
 653                 match self.optimize {
 654                     OptLevel::No   |
 655                     OptLevel::Less |
 656                     OptLevel::Size |
 657                     OptLevel::SizeMin => true,
 658                     OptLevel::Default    |
 659                     OptLevel::Aggressive => false,
 660                 }
 661             }
 662         }
 663     }
 664 }
 665
 666 // The type of entry function, so users can have their own entry functions
 667 #[derive(Copy, Clone, PartialEq, Hash, Debug)]
 668 pub enum EntryFnType {
 669     Main,
 670     Start,
 671 }
 672
 673 impl_stable_hash_via_hash!(EntryFnType);
 674
 675 #[derive(Copy, PartialEq, PartialOrd, Clone, Ord, Eq, Hash, Debug)]
 676 pub enum CrateType {
 677     Executable,
 678     Dylib,
 679     Rlib,
 680     Staticlib,
 681     Cdylib,
 682     ProcMacro,
 683 }
 684
 685 #[derive(Clone, Hash)]
 686 pub enum Passes {
 687     Some(Vec<String>),
 688     All,
 689 }
 690
 691 impl Passes {
 692     pub fn is_empty(&self) -> bool {
 693         match *self {
 694             Passes::Some(ref v) => v.is_empty(),
 695             Passes::All => false,
 696         }
 697     }
 698 }
 699
 700 /// Declare a macro that will define all CodegenOptions/DebuggingOptions fields and parsers all
 701 /// at once. The goal of this macro is to define an interface that can be
 702 /// programmatically used by the option parser in order to initialize the struct
 703 /// without hardcoding field names all over the place.
 704 ///
 705 /// The goal is to invoke this macro once with the correct fields, and then this
 706 /// macro generates all necessary code. The main gotcha of this macro is the
 707 /// cgsetters module which is a bunch of generated code to parse an option into
 708 /// its respective field in the struct. There are a few hand-written parsers for
 709 /// parsing specific types of values in this module.
 710 macro_rules! options {
 711     ($struct_name:ident, $setter_name:ident, $defaultfn:ident,
 712      $buildfn:ident, $prefix:expr, $outputname:expr,
 713      $stat:ident, $mod_desc:ident, $mod_set:ident,
 714      $($opt:ident : $t:ty = (
 715         $init:expr,
 716         $parse:ident,
 717         [$dep_tracking_marker:ident $(($dep_warn_val:expr, $dep_warn_text:expr))*],
 718         $desc:expr)
 719      ),* ,) =>
 720 (
 721     #[derive(Clone)]
 722     pub struct $struct_name { $(pub $opt: $t),* }
 723
 724     pub fn $defaultfn() -> $struct_name {
 725         $struct_name { $($opt: $init),* }
 726     }
 727
 728     pub fn $buildfn(matches: &getopts::Matches, error_format: ErrorOutputType) -> $struct_name
 729     {
 730         let mut op = $defaultfn();
 731         for option in matches.opt_strs($prefix) {
 732             let mut iter = option.splitn(2, '=');
 733             let key = iter.next().unwrap();
 734             let value = iter.next();
 735             let option_to_lookup = key.replace("-", "_");
 736             let mut found = false;
 737             for &(candidate, setter, opt_type_desc, _) in $stat {
 738                 if option_to_lookup != candidate { continue }
 739                 if !setter(&mut op, value) {
 740                     match (value, opt_type_desc) {
 741                         (Some(..), None) => {
 742                             early_error(error_format, &format!("{} option `{}` takes no \
 743                                                                 value", $outputname, key))
 744                         }
 745                         (None, Some(type_desc)) => {
 746                             early_error(error_format, &format!("{0} option `{1}` requires \
 747                                                                 {2} ({3} {1}=<value>)",
 748                                                                $outputname, key,
 749                                                                type_desc, $prefix))
 750                         }
 751                         (Some(value), Some(type_desc)) => {
 752                             early_error(error_format, &format!("incorrect value `{}` for {} \
 753                                                                 option `{}` - {} was expected",
 754                                                                value, $outputname,
 755                                                                key, type_desc))
 756                         }
 757                         (None, None) => bug!()
 758                     }
 759                 }
 760                 found = true;
 761                 break;
 762             }
 763             if !found {
 764                 early_error(error_format, &format!("unknown {} option: `{}`",
 765                                                    $outputname, key));
 766             }
 767         }
 768         return op;
 769     }
 770
 771     impl<'a> dep_tracking::DepTrackingHash for $struct_name {
 772         fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
 773             let mut sub_hashes = BTreeMap::new();
 774             $({
 775                 hash_option!($opt,
 776                              &self.$opt,
 777                              &mut sub_hashes,
 778                              [$dep_tracking_marker $($dep_warn_val,
 779                                                      $dep_warn_text,
 780                                                      error_format)*]);
 781             })*
 782             dep_tracking::stable_hash(sub_hashes, hasher, error_format);
 783         }
 784     }
 785
 786     pub type $setter_name = fn(&mut $struct_name, v: Option<&str>) -> bool;
 787     pub const $stat: &[(&str, $setter_name, Option<&str>, &str)] =
 788         &[ $( (stringify!($opt), $mod_set::$opt, $mod_desc::$parse, $desc) ),* ];
 789
 790     #[allow(non_upper_case_globals, dead_code)]
 791     mod $mod_desc {
 792         pub const parse_bool: Option<&str> = None;
 793         pub const parse_opt_bool: Option<&str> =
 794             Some("one of: `y`, `yes`, `on`, `n`, `no`, or `off`");
 795         pub const parse_string: Option<&str> = Some("a string");
 796         pub const parse_string_push: Option<&str> = Some("a string");
 797         pub const parse_pathbuf_push: Option<&str> = Some("a path");
 798         pub const parse_opt_string: Option<&str> = Some("a string");
 799         pub const parse_opt_pathbuf: Option<&str> = Some("a path");
 800         pub const parse_list: Option<&str> = Some("a space-separated list of strings");
 801         pub const parse_opt_list: Option<&str> = Some("a space-separated list of strings");
 802         pub const parse_uint: Option<&str> = Some("a number");
 803         pub const parse_passes: Option<&str> =
 804             Some("a space-separated list of passes, or `all`");
 805         pub const parse_opt_uint: Option<&str> =
 806             Some("a number");
 807         pub const parse_panic_strategy: Option<&str> =
 808             Some("either `unwind` or `abort`");
 809         pub const parse_relro_level: Option<&str> =
 810             Some("one of: `full`, `partial`, or `off`");
 811         pub const parse_sanitizer: Option<&str> =
 812             Some("one of: `address`, `leak`, `memory` or `thread`");
 813         pub const parse_linker_flavor: Option<&str> =
 814             Some(::rustc_target::spec::LinkerFlavor::one_of());
 815         pub const parse_optimization_fuel: Option<&str> =
 816             Some("crate=integer");
 817         pub const parse_unpretty: Option<&str> =
 818             Some("`string` or `string=string`");
 819         pub const parse_lto: Option<&str> =
 820             Some("either a boolean (`yes`, `no`, `on`, `off`, etc), `thin`, \
 821                   `fat`, or omitted");
 822         pub const parse_linker_plugin_lto: Option<&str> =
 823             Some("either a boolean (`yes`, `no`, `on`, `off`, etc), \
 824                   or the path to the linker plugin");
 825         pub const parse_merge_functions: Option<&str> =
 826             Some("one of: `disabled`, `trampolines`, or `aliases`");
 827     }
 828
 829     #[allow(dead_code)]
 830     mod $mod_set {
 831         use super::{$struct_name, Passes, Sanitizer, LtoCli, LinkerPluginLto};
 832         use rustc_target::spec::{LinkerFlavor, MergeFunctions, PanicStrategy, RelroLevel};
 833         use std::path::PathBuf;
 834         use std::str::FromStr;
 835
 836         $(
 837             pub fn $opt(cg: &mut $struct_name, v: Option<&str>) -> bool {
 838                 $parse(&mut cg.$opt, v)
 839             }
 840         )*
 841
 842         fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
 843             match v {
 844                 Some(..) => false,
 845                 None => { *slot = true; true }
 846             }
 847         }
 848
 849         fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
 850             match v {
 851                 Some(s) => {
 852                     match s {
 853                         "n" | "no" | "off" => {
 854                             *slot = Some(false);
 855                         }
 856                         "y" | "yes" | "on" => {
 857                             *slot = Some(true);
 858                         }
 859                         _ => { return false; }
 860                     }
 861
 862                     true
 863                 },
 864                 None => { *slot = Some(true); true }
 865             }
 866         }
 867
 868         fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
 869             match v {
 870                 Some(s) => { *slot = Some(s.to_string()); true },
 871                 None => false,
 872             }
 873         }
 874
 875         fn parse_opt_pathbuf(slot: &mut Option<PathBuf>, v: Option<&str>) -> bool {
 876             match v {
 877                 Some(s) => { *slot = Some(PathBuf::from(s)); true },
 878                 None => false,
 879             }
 880         }
 881
 882         fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
 883             match v {
 884                 Some(s) => { *slot = s.to_string(); true },
 885                 None => false,
 886             }
 887         }
 888
 889         fn parse_string_push(slot: &mut Vec<String>, v: Option<&str>) -> bool {
 890             match v {
 891                 Some(s) => { slot.push(s.to_string()); true },
 892                 None => false,
 893             }
 894         }
 895
 896         fn parse_pathbuf_push(slot: &mut Vec<PathBuf>, v: Option<&str>) -> bool {
 897             match v {
 898                 Some(s) => { slot.push(PathBuf::from(s)); true },
 899                 None => false,
 900             }
 901         }
 902
 903         fn parse_list(slot: &mut Vec<String>, v: Option<&str>)
 904                       -> bool {
 905             match v {
 906                 Some(s) => {
 907                     slot.extend(s.split_whitespace().map(|s| s.to_string()));
 908                     true
 909                 },
 910                 None => false,
 911             }
 912         }
 913
 914         fn parse_opt_list(slot: &mut Option<Vec<String>>, v: Option<&str>)
 915                       -> bool {
 916             match v {
 917                 Some(s) => {
 918                     let v = s.split_whitespace().map(|s| s.to_string()).collect();
 919                     *slot = Some(v);
 920                     true
 921                 },
 922                 None => false,
 923             }
 924         }
 925
 926         fn parse_uint(slot: &mut usize, v: Option<&str>) -> bool {
 927             match v.and_then(|s| s.parse().ok()) {
 928                 Some(i) => { *slot = i; true },
 929                 None => false
 930             }
 931         }
 932
 933         fn parse_opt_uint(slot: &mut Option<usize>, v: Option<&str>) -> bool {
 934             match v {
 935                 Some(s) => { *slot = s.parse().ok(); slot.is_some() }
 936                 None => { *slot = None; false }
 937             }
 938         }
 939
 940         fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
 941             match v {
 942                 Some("all") => {
 943                     *slot = Passes::All;
 944                     true
 945                 }
 946                 v => {
 947                     let mut passes = vec![];
 948                     if parse_list(&mut passes, v) {
 949                         *slot = Passes::Some(passes);
 950                         true
 951                     } else {
 952                         false
 953                     }
 954                 }
 955             }
 956         }
 957
 958         fn parse_panic_strategy(slot: &mut Option<PanicStrategy>, v: Option<&str>) -> bool {
 959             match v {
 960                 Some("unwind") => *slot = Some(PanicStrategy::Unwind),
 961                 Some("abort") => *slot = Some(PanicStrategy::Abort),
 962                 _ => return false
 963             }
 964             true
 965         }
 966
 967         fn parse_relro_level(slot: &mut Option<RelroLevel>, v: Option<&str>) -> bool {
 968             match v {
 969                 Some(s) => {
 970                     match s.parse::<RelroLevel>() {
 971                         Ok(level) => *slot = Some(level),
 972                         _ => return false
 973                     }
 974                 },
 975                 _ => return false
 976             }
 977             true
 978         }
 979
 980         fn parse_sanitizer(slote: &mut Option<Sanitizer>, v: Option<&str>) -> bool {
 981             match v {
 982                 Some("address") => *slote = Some(Sanitizer::Address),
 983                 Some("leak") => *slote = Some(Sanitizer::Leak),
 984                 Some("memory") => *slote = Some(Sanitizer::Memory),
 985                 Some("thread") => *slote = Some(Sanitizer::Thread),
 986                 _ => return false,
 987             }
 988             true
 989         }
 990
 991         fn parse_linker_flavor(slote: &mut Option<LinkerFlavor>, v: Option<&str>) -> bool {
 992             match v.and_then(LinkerFlavor::from_str) {
 993                 Some(lf) => *slote = Some(lf),
 994                 _ => return false,
 995             }
 996             true
 997         }
 998
 999         fn parse_optimization_fuel(slot: &mut Option<(String, u64)>, v: Option<&str>) -> bool {
1000             match v {
1001                 None => false,
1002                 Some(s) => {
1003                     let parts = s.split('=').collect::<Vec<_>>();
1004                     if parts.len() != 2 { return false; }
1005                     let crate_name = parts[0].to_string();
1006                     let fuel = parts[1].parse::<u64>();
1007                     if fuel.is_err() { return false; }
1008                     *slot = Some((crate_name, fuel.unwrap()));
1009                     true
1010                 }
1011             }
1012         }
1013
1014         fn parse_unpretty(slot: &mut Option<String>, v: Option<&str>) -> bool {
1015             match v {
1016                 None => false,
1017                 Some(s) if s.split('=').count() <= 2 => {
1018                     *slot = Some(s.to_string());
1019                     true
1020                 }
1021                 _ => false,
1022             }
1023         }
1024
1025         fn parse_lto(slot: &mut LtoCli, v: Option<&str>) -> bool {
1026             if v.is_some() {
1027                 let mut bool_arg = None;
1028                 if parse_opt_bool(&mut bool_arg, v) {
1029                     *slot = if bool_arg.unwrap() {
1030                         LtoCli::Yes
1031                     } else {
1032                         LtoCli::No
1033                     };
1034                     return true
1035                 }
1036             }
1037
1038             *slot = match v {
1039                 None => LtoCli::NoParam,
1040                 Some("thin") => LtoCli::Thin,
1041                 Some("fat") => LtoCli::Fat,
1042                 Some(_) => return false,
1043             };
1044             true
1045         }
1046
1047         fn parse_linker_plugin_lto(slot: &mut LinkerPluginLto, v: Option<&str>) -> bool {
1048             if v.is_some() {
1049                 let mut bool_arg = None;
1050                 if parse_opt_bool(&mut bool_arg, v) {
1051                     *slot = if bool_arg.unwrap() {
1052                         LinkerPluginLto::LinkerPluginAuto
1053                     } else {
1054                         LinkerPluginLto::Disabled
1055                     };
1056                     return true
1057                 }
1058             }
1059
1060             *slot = match v {
1061                 None => LinkerPluginLto::LinkerPluginAuto,
1062                 Some(path) => LinkerPluginLto::LinkerPlugin(PathBuf::from(path)),
1063             };
1064             true
1065         }
1066
1067         fn parse_merge_functions(slot: &mut Option<MergeFunctions>, v: Option<&str>) -> bool {
1068             match v.and_then(|s| MergeFunctions::from_str(s).ok()) {
1069                 Some(mergefunc) => *slot = Some(mergefunc),
1070                 _ => return false,
1071             }
1072             true
1073         }
1074     }
1075 ) }
1076
1077 options! {CodegenOptions, CodegenSetter, basic_codegen_options,
1078           build_codegen_options, "C", "codegen",
1079           CG_OPTIONS, cg_type_desc, cgsetters,
1080     ar: Option<String> = (None, parse_opt_string, [UNTRACKED],
1081         "this option is deprecated and does nothing"),
1082     linker: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1083         "system linker to link outputs with"),
1084     link_arg: Vec<String> = (vec![], parse_string_push, [UNTRACKED],
1085         "a single extra argument to append to the linker invocation (can be used several times)"),
1086     link_args: Option<Vec<String>> = (None, parse_opt_list, [UNTRACKED],
1087         "extra arguments to append to the linker invocation (space separated)"),
1088     link_dead_code: bool = (false, parse_bool, [UNTRACKED],
1089         "don't let linker strip dead code (turning it on can be used for code coverage)"),
1090     lto: LtoCli = (LtoCli::Unspecified, parse_lto, [TRACKED],
1091         "perform LLVM link-time optimizations"),
1092     target_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1093         "select target processor (rustc --print target-cpus for details)"),
1094     target_feature: String = (String::new(), parse_string, [TRACKED],
1095         "target specific attributes (rustc --print target-features for details)"),
1096     passes: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1097         "a list of extra LLVM passes to run (space separated)"),
1098     llvm_args: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1099         "a list of arguments to pass to llvm (space separated)"),
1100     save_temps: bool = (false, parse_bool, [UNTRACKED_WITH_WARNING(true,
1101         "`-C save-temps` might not produce all requested temporary products \
1102          when incremental compilation is enabled.")],
1103         "save all temporary output files during compilation"),
1104     rpath: bool = (false, parse_bool, [UNTRACKED],
1105         "set rpath values in libs/exes"),
1106     overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1107         "use overflow checks for integer arithmetic"),
1108     no_prepopulate_passes: bool = (false, parse_bool, [TRACKED],
1109         "don't pre-populate the pass manager with a list of passes"),
1110     no_vectorize_loops: bool = (false, parse_bool, [TRACKED],
1111         "don't run the loop vectorization optimization passes"),
1112     no_vectorize_slp: bool = (false, parse_bool, [TRACKED],
1113         "don't run LLVM's SLP vectorization pass"),
1114     soft_float: bool = (false, parse_bool, [TRACKED],
1115         "use soft float ABI (*eabihf targets only)"),
1116     prefer_dynamic: bool = (false, parse_bool, [TRACKED],
1117         "prefer dynamic linking to static linking"),
1118     no_integrated_as: bool = (false, parse_bool, [TRACKED],
1119         "use an external assembler rather than LLVM's integrated one"),
1120     no_redzone: Option<bool> = (None, parse_opt_bool, [TRACKED],
1121         "disable the use of the redzone"),
1122     relocation_model: Option<String> = (None, parse_opt_string, [TRACKED],
1123         "choose the relocation model to use (rustc --print relocation-models for details)"),
1124     code_model: Option<String> = (None, parse_opt_string, [TRACKED],
1125         "choose the code model to use (rustc --print code-models for details)"),
1126     metadata: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1127         "metadata to mangle symbol names with"),
1128     extra_filename: String = (String::new(), parse_string, [UNTRACKED],
1129         "extra data to put in each output filename"),
1130     codegen_units: Option<usize> = (None, parse_opt_uint, [UNTRACKED],
1131         "divide crate into N units to optimize in parallel"),
1132     remark: Passes = (Passes::Some(Vec::new()), parse_passes, [UNTRACKED],
1133         "print remarks for these optimization passes (space separated, or \"all\")"),
1134     no_stack_check: bool = (false, parse_bool, [UNTRACKED],
1135         "the --no-stack-check flag is deprecated and does nothing"),
1136     debuginfo: Option<usize> = (None, parse_opt_uint, [TRACKED],
1137         "debug info emission level, 0 = no debug info, 1 = line tables only, \
1138          2 = full debug info with variable and type information"),
1139     opt_level: Option<String> = (None, parse_opt_string, [TRACKED],
1140         "optimize with possible levels 0-3, s, or z"),
1141     force_frame_pointers: Option<bool> = (None, parse_opt_bool, [TRACKED],
1142         "force use of the frame pointers"),
1143     debug_assertions: Option<bool> = (None, parse_opt_bool, [TRACKED],
1144         "explicitly enable the cfg(debug_assertions) directive"),
1145     inline_threshold: Option<usize> = (None, parse_opt_uint, [TRACKED],
1146         "set the threshold for inlining a function (default: 225)"),
1147     panic: Option<PanicStrategy> = (None, parse_panic_strategy,
1148         [TRACKED], "panic strategy to compile crate with"),
1149     incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
1150         "enable incremental compilation"),
1151     default_linker_libraries: Option<bool> = (None, parse_opt_bool, [UNTRACKED],
1152         "allow the linker to link its default libraries"),
1153     linker_flavor: Option<LinkerFlavor> = (None, parse_linker_flavor, [UNTRACKED],
1154                                            "Linker flavor"),
1155     linker_plugin_lto: LinkerPluginLto = (LinkerPluginLto::Disabled,
1156         parse_linker_plugin_lto, [TRACKED],
1157         "generate build artifacts that are compatible with linker-based LTO."),
1158
1159 }
1160
1161 options! {DebuggingOptions, DebuggingSetter, basic_debugging_options,
1162           build_debugging_options, "Z", "debugging",
1163           DB_OPTIONS, db_type_desc, dbsetters,
1164     codegen_backend: Option<String> = (None, parse_opt_string, [TRACKED],
1165         "the backend to use"),
1166     verbose: bool = (false, parse_bool, [UNTRACKED],
1167         "in general, enable more debug printouts"),
1168     span_free_formats: bool = (false, parse_bool, [UNTRACKED],
1169         "when debug-printing compiler state, do not include spans"), // o/w tests have closure@path
1170     identify_regions: bool = (false, parse_bool, [UNTRACKED],
1171         "make unnamed regions display as '# (where # is some non-ident unique id)"),
1172     borrowck: Option<String> = (None, parse_opt_string, [UNTRACKED],
1173         "select which borrowck is used (`ast`, `mir`, `migrate`, or `compare`)"),
1174     two_phase_borrows: bool = (false, parse_bool, [UNTRACKED],
1175         "use two-phase reserved/active distinction for `&mut` borrows in MIR borrowck"),
1176     two_phase_beyond_autoref: bool = (false, parse_bool, [UNTRACKED],
1177         "when using two-phase-borrows, allow two phases even for non-autoref `&mut` borrows"),
1178     time_passes: bool = (false, parse_bool, [UNTRACKED],
1179         "measure time of each rustc pass"),
1180     count_llvm_insns: bool = (false, parse_bool,
1181         [UNTRACKED_WITH_WARNING(true,
1182         "The output generated by `-Z count_llvm_insns` might not be reliable \
1183          when used with incremental compilation")],
1184         "count where LLVM instrs originate"),
1185     time_llvm_passes: bool = (false, parse_bool, [UNTRACKED_WITH_WARNING(true,
1186         "The output of `-Z time-llvm-passes` will only reflect timings of \
1187          re-codegened modules when used with incremental compilation" )],
1188         "measure time of each LLVM pass"),
1189     input_stats: bool = (false, parse_bool, [UNTRACKED],
1190         "gather statistics about the input"),
1191     codegen_stats: bool = (false, parse_bool, [UNTRACKED_WITH_WARNING(true,
1192         "The output of `-Z codegen-stats` might not be accurate when incremental \
1193          compilation is enabled")],
1194         "gather codegen statistics"),
1195     asm_comments: bool = (false, parse_bool, [TRACKED],
1196         "generate comments into the assembly (may change behavior)"),
1197     verify_llvm_ir: bool = (false, parse_bool, [TRACKED],
1198         "verify LLVM IR"),
1199     borrowck_stats: bool = (false, parse_bool, [UNTRACKED],
1200         "gather borrowck statistics"),
1201     no_landing_pads: bool = (false, parse_bool, [TRACKED],
1202         "omit landing pads for unwinding"),
1203     fewer_names: bool = (false, parse_bool, [TRACKED],
1204         "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR)"),
1205     meta_stats: bool = (false, parse_bool, [UNTRACKED],
1206         "gather metadata statistics"),
1207     print_link_args: bool = (false, parse_bool, [UNTRACKED],
1208         "print the arguments passed to the linker"),
1209     print_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1210         "prints the llvm optimization passes being run"),
1211     ast_json: bool = (false, parse_bool, [UNTRACKED],
1212         "print the AST as JSON and halt"),
1213     threads: Option<usize> = (None, parse_opt_uint, [UNTRACKED],
1214         "use a thread pool with N threads"),
1215     ast_json_noexpand: bool = (false, parse_bool, [UNTRACKED],
1216         "print the pre-expansion AST as JSON and halt"),
1217     ls: bool = (false, parse_bool, [UNTRACKED],
1218         "list the symbols defined by a library crate"),
1219     save_analysis: bool = (false, parse_bool, [UNTRACKED],
1220         "write syntax and type analysis (in JSON format) information, in \
1221          addition to normal output"),
1222     flowgraph_print_loans: bool = (false, parse_bool, [UNTRACKED],
1223         "include loan analysis data in -Z unpretty flowgraph output"),
1224     flowgraph_print_moves: bool = (false, parse_bool, [UNTRACKED],
1225         "include move analysis data in -Z unpretty flowgraph output"),
1226     flowgraph_print_assigns: bool = (false, parse_bool, [UNTRACKED],
1227         "include assignment analysis data in -Z unpretty flowgraph output"),
1228     flowgraph_print_all: bool = (false, parse_bool, [UNTRACKED],
1229         "include all dataflow analysis data in -Z unpretty flowgraph output"),
1230     print_region_graph: bool = (false, parse_bool, [UNTRACKED],
1231         "prints region inference graph. \
1232          Use with RUST_REGION_GRAPH=help for more info"),
1233     parse_only: bool = (false, parse_bool, [UNTRACKED],
1234         "parse only; do not compile, assemble, or link"),
1235     no_codegen: bool = (false, parse_bool, [TRACKED],
1236         "run all passes except codegen; no output"),
1237     treat_err_as_bug: Option<usize> = (None, parse_opt_uint, [TRACKED],
1238         "treat all errors that occur as bugs"),
1239     report_delayed_bugs: bool = (false, parse_bool, [TRACKED],
1240         "immediately print bugs registered with `delay_span_bug`"),
1241     external_macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1242         "show macro backtraces even for non-local macros"),
1243     teach: bool = (false, parse_bool, [TRACKED],
1244         "show extended diagnostic help"),
1245     continue_parse_after_error: bool = (false, parse_bool, [TRACKED],
1246         "attempt to recover from parse errors (experimental)"),
1247     dep_tasks: bool = (false, parse_bool, [UNTRACKED],
1248         "print tasks that execute and the color their dep node gets (requires debug build)"),
1249     incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
1250         "enable incremental compilation (experimental)"),
1251     incremental_queries: bool = (true, parse_bool, [UNTRACKED],
1252         "enable incremental compilation support for queries (experimental)"),
1253     incremental_info: bool = (false, parse_bool, [UNTRACKED],
1254         "print high-level information about incremental reuse (or the lack thereof)"),
1255     incremental_dump_hash: bool = (false, parse_bool, [UNTRACKED],
1256         "dump hash information in textual format to stdout"),
1257     incremental_verify_ich: bool = (false, parse_bool, [UNTRACKED],
1258         "verify incr. comp. hashes of green query instances"),
1259     incremental_ignore_spans: bool = (false, parse_bool, [UNTRACKED],
1260         "ignore spans during ICH computation -- used for testing"),
1261     instrument_mcount: bool = (false, parse_bool, [TRACKED],
1262         "insert function instrument code for mcount-based tracing"),
1263     dump_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1264         "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv)"),
1265     query_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1266         "enable queries of the dependency graph for regression testing"),
1267     profile_queries: bool = (false, parse_bool, [UNTRACKED],
1268         "trace and profile the queries of the incremental compilation framework"),
1269     profile_queries_and_keys: bool = (false, parse_bool, [UNTRACKED],
1270         "trace and profile the queries and keys of the incremental compilation framework"),
1271     no_analysis: bool = (false, parse_bool, [UNTRACKED],
1272         "parse and expand the source, but run no analysis"),
1273     extra_plugins: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1274         "load extra plugins"),
1275     unstable_options: bool = (false, parse_bool, [UNTRACKED],
1276         "adds unstable command line options to rustc interface"),
1277     force_overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1278         "force overflow checks on or off"),
1279     trace_macros: bool = (false, parse_bool, [UNTRACKED],
1280         "for every macro invocation, print its name and arguments"),
1281     debug_macros: bool = (false, parse_bool, [TRACKED],
1282         "emit line numbers debug info inside macros"),
1283     keep_hygiene_data: bool = (false, parse_bool, [UNTRACKED],
1284         "don't clear the hygiene data after analysis"),
1285     keep_ast: bool = (false, parse_bool, [UNTRACKED],
1286         "keep the AST after lowering it to HIR"),
1287     show_span: Option<String> = (None, parse_opt_string, [TRACKED],
1288         "show spans for compiler debugging (expr|pat|ty)"),
1289     print_type_sizes: bool = (false, parse_bool, [UNTRACKED],
1290         "print layout information for each type encountered"),
1291     print_mono_items: Option<String> = (None, parse_opt_string, [UNTRACKED],
1292         "print the result of the monomorphization collection pass"),
1293     mir_opt_level: usize = (1, parse_uint, [TRACKED],
1294         "set the MIR optimization level (0-3, default: 1)"),
1295     mutable_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1296         "emit noalias metadata for mutable references (default: yes on LLVM >= 6)"),
1297     dump_mir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1298         "dump MIR state to file.
1299         `val` is used to select which passes and functions to dump. For example:
1300         `all` matches all passes and functions,
1301         `foo` matches all passes for functions whose name contains 'foo',
1302         `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
1303         `foo | bar` all passes for function names containing 'foo' or 'bar'."),
1304
1305     dump_mir_dir: String = (String::from("mir_dump"), parse_string, [UNTRACKED],
1306         "the directory the MIR is dumped into"),
1307     dump_mir_graphviz: bool = (false, parse_bool, [UNTRACKED],
1308         "in addition to `.mir` files, create graphviz `.dot` files"),
1309     dump_mir_exclude_pass_number: bool = (false, parse_bool, [UNTRACKED],
1310         "if set, exclude the pass number when dumping MIR (used in tests)"),
1311     mir_emit_retag: bool = (false, parse_bool, [TRACKED],
1312         "emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0"),
1313     perf_stats: bool = (false, parse_bool, [UNTRACKED],
1314         "print some performance-related statistics"),
1315     query_stats: bool = (false, parse_bool, [UNTRACKED],
1316         "print some statistics about the query system"),
1317     hir_stats: bool = (false, parse_bool, [UNTRACKED],
1318         "print some statistics about AST and HIR"),
1319     always_encode_mir: bool = (false, parse_bool, [TRACKED],
1320         "encode MIR of all functions into the crate metadata"),
1321     unleash_the_miri_inside_of_you: bool = (false, parse_bool, [TRACKED],
1322         "take the breaks off const evaluation. NOTE: this is unsound"),
1323     osx_rpath_install_name: bool = (false, parse_bool, [TRACKED],
1324         "pass `-install_name @rpath/...` to the macOS linker"),
1325     sanitizer: Option<Sanitizer> = (None, parse_sanitizer, [TRACKED],
1326                                     "Use a sanitizer"),
1327     fuel: Option<(String, u64)> = (None, parse_optimization_fuel, [TRACKED],
1328         "set the optimization fuel quota for a crate"),
1329     print_fuel: Option<String> = (None, parse_opt_string, [TRACKED],
1330         "make Rustc print the total optimization fuel used by a crate"),
1331     force_unstable_if_unmarked: bool = (false, parse_bool, [TRACKED],
1332         "force all crates to be `rustc_private` unstable"),
1333     pre_link_arg: Vec<String> = (vec![], parse_string_push, [UNTRACKED],
1334         "a single extra argument to prepend the linker invocation (can be used several times)"),
1335     pre_link_args: Option<Vec<String>> = (None, parse_opt_list, [UNTRACKED],
1336         "extra arguments to prepend to the linker invocation (space separated)"),
1337     profile: bool = (false, parse_bool, [TRACKED],
1338                      "insert profiling code"),
1339     pgo_gen: Option<String> = (None, parse_opt_string, [TRACKED],
1340         "Generate PGO profile data, to a given file, or to the default location if it's empty."),
1341     pgo_use: String = (String::new(), parse_string, [TRACKED],
1342         "Use PGO profile data from the given profile file."),
1343     disable_instrumentation_preinliner: bool = (false, parse_bool, [TRACKED],
1344         "Disable the instrumentation pre-inliner, useful for profiling / PGO."),
1345     relro_level: Option<RelroLevel> = (None, parse_relro_level, [TRACKED],
1346         "choose which RELRO level to use"),
1347     nll_facts: bool = (false, parse_bool, [UNTRACKED],
1348                        "dump facts from NLL analysis into side files"),
1349     nll_dont_emit_read_for_match: bool = (false, parse_bool, [UNTRACKED],
1350         "in match codegen, do not include FakeRead statements (used by mir-borrowck)"),
1351     dont_buffer_diagnostics: bool = (false, parse_bool, [UNTRACKED],
1352         "emit diagnostics rather than buffering (breaks NLL error downgrading, sorting)."),
1353     polonius: bool = (false, parse_bool, [UNTRACKED],
1354         "enable polonius-based borrow-checker"),
1355     codegen_time_graph: bool = (false, parse_bool, [UNTRACKED],
1356         "generate a graphical HTML report of time spent in codegen and LLVM"),
1357     thinlto: Option<bool> = (None, parse_opt_bool, [TRACKED],
1358         "enable ThinLTO when possible"),
1359     inline_in_all_cgus: Option<bool> = (None, parse_opt_bool, [TRACKED],
1360         "control whether #[inline] functions are in all cgus"),
1361     tls_model: Option<String> = (None, parse_opt_string, [TRACKED],
1362         "choose the TLS model to use (rustc --print tls-models for details)"),
1363     saturating_float_casts: bool = (false, parse_bool, [TRACKED],
1364         "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
1365          the max/min integer respectively, and NaN is mapped to 0"),
1366     lower_128bit_ops: Option<bool> = (None, parse_opt_bool, [TRACKED],
1367         "rewrite operators on i128 and u128 into lang item calls (typically provided \
1368          by compiler-builtins) so codegen doesn't need to support them,
1369          overriding the default for the current target"),
1370     human_readable_cgu_names: bool = (false, parse_bool, [TRACKED],
1371         "generate human-readable, predictable names for codegen units"),
1372     dep_info_omit_d_target: bool = (false, parse_bool, [TRACKED],
1373         "in dep-info output, omit targets for tracking dependencies of the dep-info files \
1374          themselves"),
1375     unpretty: Option<String> = (None, parse_unpretty, [UNTRACKED],
1376         "Present the input source, unstable (and less-pretty) variants;
1377         valid types are any of the types for `--pretty`, as well as:
1378         `expanded`, `expanded,identified`,
1379         `expanded,hygiene` (with internal representations),
1380         `flowgraph=<nodeid>` (graphviz formatted flowgraph for node),
1381         `flowgraph,unlabelled=<nodeid>` (unlabelled graphviz formatted flowgraph for node),
1382         `everybody_loops` (all function bodies replaced with `loop {}`),
1383         `hir` (the HIR), `hir,identified`,
1384         `hir,typed` (HIR with types for each node),
1385         `hir-tree` (dump the raw HIR),
1386         `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)"),
1387     run_dsymutil: Option<bool> = (None, parse_opt_bool, [TRACKED],
1388         "run `dsymutil` and delete intermediate object files"),
1389     ui_testing: bool = (false, parse_bool, [UNTRACKED],
1390         "format compiler diagnostics in a way that's better suitable for UI testing"),
1391     embed_bitcode: bool = (false, parse_bool, [TRACKED],
1392         "embed LLVM bitcode in object files"),
1393     strip_debuginfo_if_disabled: Option<bool> = (None, parse_opt_bool, [TRACKED],
1394         "tell the linker to strip debuginfo when building without debuginfo enabled."),
1395     share_generics: Option<bool> = (None, parse_opt_bool, [TRACKED],
1396         "make the current crate share its generic instantiations"),
1397     chalk: bool = (false, parse_bool, [TRACKED],
1398         "enable the experimental Chalk-based trait solving engine"),
1399     no_parallel_llvm: bool = (false, parse_bool, [UNTRACKED],
1400         "don't run LLVM in parallel (while keeping codegen-units and ThinLTO)"),
1401     no_leak_check: bool = (false, parse_bool, [UNTRACKED],
1402         "disables the 'leak check' for subtyping; unsound, but useful for tests"),
1403     no_interleave_lints: bool = (false, parse_bool, [UNTRACKED],
1404         "don't interleave execution of lints; allows benchmarking individual lints"),
1405     crate_attr: Vec<String> = (Vec::new(), parse_string_push, [TRACKED],
1406         "inject the given attribute in the crate"),
1407     self_profile: bool = (false, parse_bool, [UNTRACKED],
1408         "run the self profiler and output the raw event data"),
1409     emit_stack_sizes: bool = (false, parse_bool, [UNTRACKED],
1410         "emits a section containing stack size metadata"),
1411     plt: Option<bool> = (None, parse_opt_bool, [TRACKED],
1412           "whether to use the PLT when calling into shared libraries;
1413           only has effect for PIC code on systems with ELF binaries
1414           (default: PLT is disabled if full relro is enabled)"),
1415     merge_functions: Option<MergeFunctions> = (None, parse_merge_functions, [TRACKED],
1416         "control the operation of the MergeFunctions LLVM pass, taking
1417          the same values as the target option of the same name"),
1418 }
1419
1420 pub fn default_lib_output() -> CrateType {
1421     CrateType::Rlib
1422 }
1423
1424 pub fn default_configuration(sess: &Session) -> ast::CrateConfig {
1425     let end = &sess.target.target.target_endian;
1426     let arch = &sess.target.target.arch;
1427     let wordsz = &sess.target.target.target_pointer_width;
1428     let os = &sess.target.target.target_os;
1429     let env = &sess.target.target.target_env;
1430     let vendor = &sess.target.target.target_vendor;
1431     let min_atomic_width = sess.target.target.min_atomic_width();
1432     let max_atomic_width = sess.target.target.max_atomic_width();
1433     let atomic_cas = sess.target.target.options.atomic_cas;
1434
1435     let mut ret = FxHashSet::default();
1436     ret.reserve(6); // the minimum number of insertions
1437     // Target bindings.
1438     ret.insert((Symbol::intern("target_os"), Some(Symbol::intern(os))));
1439     if let Some(ref fam) = sess.target.target.options.target_family {
1440         ret.insert((Symbol::intern("target_family"), Some(Symbol::intern(fam))));
1441         if fam == "windows" || fam == "unix" {
1442             ret.insert((Symbol::intern(fam), None));
1443         }
1444     }
1445     ret.insert((Symbol::intern("target_arch"), Some(Symbol::intern(arch))));
1446     ret.insert((Symbol::intern("target_endian"), Some(Symbol::intern(end))));
1447     ret.insert((
1448         Symbol::intern("target_pointer_width"),
1449         Some(Symbol::intern(wordsz)),
1450     ));
1451     ret.insert((Symbol::intern("target_env"), Some(Symbol::intern(env))));
1452     ret.insert((
1453         Symbol::intern("target_vendor"),
1454         Some(Symbol::intern(vendor)),
1455     ));
1456     if sess.target.target.options.has_elf_tls {
1457         ret.insert((Symbol::intern("target_thread_local"), None));
1458     }
1459     for &i in &[8, 16, 32, 64, 128] {
1460         if i >= min_atomic_width && i <= max_atomic_width {
1461             let s = i.to_string();
1462             ret.insert((
1463                 Symbol::intern("target_has_atomic"),
1464                 Some(Symbol::intern(&s)),
1465             ));
1466             if &s == wordsz {
1467                 ret.insert((
1468                     Symbol::intern("target_has_atomic"),
1469                     Some(Symbol::intern("ptr")),
1470                 ));
1471             }
1472         }
1473     }
1474     if atomic_cas {
1475         ret.insert((Symbol::intern("target_has_atomic"), Some(Symbol::intern("cas"))));
1476     }
1477     if sess.opts.debug_assertions {
1478         ret.insert((Symbol::intern("debug_assertions"), None));
1479     }
1480     if sess.opts.crate_types.contains(&CrateType::ProcMacro) {
1481         ret.insert((Symbol::intern("proc_macro"), None));
1482     }
1483     ret
1484 }
1485
1486 pub fn build_configuration(sess: &Session, mut user_cfg: ast::CrateConfig) -> ast::CrateConfig {
1487     // Combine the configuration requested by the session (command line) with
1488     // some default and generated configuration items
1489     let default_cfg = default_configuration(sess);
1490     // If the user wants a test runner, then add the test cfg
1491     if sess.opts.test {
1492         user_cfg.insert((Symbol::intern("test"), None));
1493     }
1494     user_cfg.extend(default_cfg.iter().cloned());
1495     user_cfg
1496 }
1497
1498 pub fn build_target_config(opts: &Options, sp: &Handler) -> Config {
1499     let target = Target::search(&opts.target_triple).unwrap_or_else(|e| {
1500         sp.struct_fatal(&format!("Error loading target specification: {}", e))
1501           .help("Use `--print target-list` for a list of built-in targets")
1502           .emit();
1503         FatalError.raise();
1504     });
1505
1506     let (isize_ty, usize_ty) = match &target.target_pointer_width[..] {
1507         "16" => (ast::IntTy::I16, ast::UintTy::U16),
1508         "32" => (ast::IntTy::I32, ast::UintTy::U32),
1509         "64" => (ast::IntTy::I64, ast::UintTy::U64),
1510         w => sp.fatal(&format!(
1511             "target specification was invalid: \
1512              unrecognized target-pointer-width {}",
1513             w
1514         )).raise(),
1515     };
1516
1517     Config {
1518         target,
1519         isize_ty,
1520         usize_ty,
1521     }
1522 }
1523
1524 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
1525 pub enum OptionStability {
1526     Stable,
1527     Unstable,
1528 }
1529
1530 pub struct RustcOptGroup {
1531     pub apply: Box<dyn Fn(&mut getopts::Options) -> &mut getopts::Options>,
1532     pub name: &'static str,
1533     pub stability: OptionStability,
1534 }
1535
1536 impl RustcOptGroup {
1537     pub fn is_stable(&self) -> bool {
1538         self.stability == OptionStability::Stable
1539     }
1540
1541     pub fn stable<F>(name: &'static str, f: F) -> RustcOptGroup
1542     where
1543         F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1544     {
1545         RustcOptGroup {
1546             name,
1547             apply: Box::new(f),
1548             stability: OptionStability::Stable,
1549         }
1550     }
1551
1552     pub fn unstable<F>(name: &'static str, f: F) -> RustcOptGroup
1553     where
1554         F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1555     {
1556         RustcOptGroup {
1557             name,
1558             apply: Box::new(f),
1559             stability: OptionStability::Unstable,
1560         }
1561     }
1562 }
1563
1564 // The `opt` local module holds wrappers around the `getopts` API that
1565 // adds extra rustc-specific metadata to each option; such metadata
1566 // is exposed by .  The public
1567 // functions below ending with `_u` are the functions that return
1568 // *unstable* options, i.e., options that are only enabled when the
1569 // user also passes the `-Z unstable-options` debugging flag.
1570 mod opt {
1571     // The `fn opt_u` etc below are written so that we can use them
1572     // in the future; do not warn about them not being used right now.
1573     #![allow(dead_code)]
1574
1575     use getopts;
1576     use super::RustcOptGroup;
1577
1578     pub type R = RustcOptGroup;
1579     pub type S = &'static str;
1580
1581     fn stable<F>(name: S, f: F) -> R
1582     where
1583         F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1584     {
1585         RustcOptGroup::stable(name, f)
1586     }
1587
1588     fn unstable<F>(name: S, f: F) -> R
1589     where
1590         F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1591     {
1592         RustcOptGroup::unstable(name, f)
1593     }
1594
1595     fn longer(a: S, b: S) -> S {
1596         if a.len() > b.len() {
1597             a
1598         } else {
1599             b
1600         }
1601     }
1602
1603     pub fn opt_s(a: S, b: S, c: S, d: S) -> R {
1604         stable(longer(a, b), move |opts| opts.optopt(a, b, c, d))
1605     }
1606     pub fn multi_s(a: S, b: S, c: S, d: S) -> R {
1607         stable(longer(a, b), move |opts| opts.optmulti(a, b, c, d))
1608     }
1609     pub fn flag_s(a: S, b: S, c: S) -> R {
1610         stable(longer(a, b), move |opts| opts.optflag(a, b, c))
1611     }
1612     pub fn flagopt_s(a: S, b: S, c: S, d: S) -> R {
1613         stable(longer(a, b), move |opts| opts.optflagopt(a, b, c, d))
1614     }
1615     pub fn flagmulti_s(a: S, b: S, c: S) -> R {
1616         stable(longer(a, b), move |opts| opts.optflagmulti(a, b, c))
1617     }
1618
1619     pub fn opt(a: S, b: S, c: S, d: S) -> R {
1620         unstable(longer(a, b), move |opts| opts.optopt(a, b, c, d))
1621     }
1622     pub fn multi(a: S, b: S, c: S, d: S) -> R {
1623         unstable(longer(a, b), move |opts| opts.optmulti(a, b, c, d))
1624     }
1625     pub fn flag(a: S, b: S, c: S) -> R {
1626         unstable(longer(a, b), move |opts| opts.optflag(a, b, c))
1627     }
1628     pub fn flagopt(a: S, b: S, c: S, d: S) -> R {
1629         unstable(longer(a, b), move |opts| opts.optflagopt(a, b, c, d))
1630     }
1631     pub fn flagmulti(a: S, b: S, c: S) -> R {
1632         unstable(longer(a, b), move |opts| opts.optflagmulti(a, b, c))
1633     }
1634 }
1635
1636 /// Returns the "short" subset of the rustc command line options,
1637 /// including metadata for each option, such as whether the option is
1638 /// part of the stable long-term interface for rustc.
1639 pub fn rustc_short_optgroups() -> Vec<RustcOptGroup> {
1640     vec![
1641         opt::flag_s("h", "help", "Display this message"),
1642         opt::multi_s("", "cfg", "Configure the compilation environment", "SPEC"),
1643         opt::multi_s(
1644             "L",
1645             "",
1646             "Add a directory to the library search path. The
1647                              optional KIND can be one of dependency, crate, native,
1648                              framework or all (the default).",
1649             "[KIND=]PATH",
1650         ),
1651         opt::multi_s(
1652             "l",
1653             "",
1654             "Link the generated crate(s) to the specified native
1655                              library NAME. The optional KIND can be one of
1656                              static, dylib, or framework. If omitted, dylib is
1657                              assumed.",
1658             "[KIND=]NAME",
1659         ),
1660         opt::multi_s(
1661             "",
1662             "crate-type",
1663             "Comma separated list of types of crates
1664                                     for the compiler to emit",
1665             "[bin|lib|rlib|dylib|cdylib|staticlib|proc-macro]",
1666         ),
1667         opt::opt_s(
1668             "",
1669             "crate-name",
1670             "Specify the name of the crate being built",
1671             "NAME",
1672         ),
1673         opt::multi_s(
1674             "",
1675             "emit",
1676             "Comma separated list of types of output for \
1677              the compiler to emit",
1678             "[asm|llvm-bc|llvm-ir|obj|metadata|link|dep-info|mir]",
1679         ),
1680         opt::multi_s(
1681             "",
1682             "print",
1683             "Comma separated list of compiler information to \
1684              print on stdout",
1685             "[crate-name|file-names|sysroot|cfg|target-list|\
1686              target-cpus|target-features|relocation-models|\
1687              code-models|tls-models|target-spec-json|native-static-libs]",
1688         ),
1689         opt::flagmulti_s("g", "", "Equivalent to -C debuginfo=2"),
1690         opt::flagmulti_s("O", "", "Equivalent to -C opt-level=2"),
1691         opt::opt_s("o", "", "Write output to <filename>", "FILENAME"),
1692         opt::opt_s(
1693             "",
1694             "out-dir",
1695             "Write output to compiler-chosen filename \
1696              in <dir>",
1697             "DIR",
1698         ),
1699         opt::opt_s(
1700             "",
1701             "explain",
1702             "Provide a detailed explanation of an error \
1703              message",
1704             "OPT",
1705         ),
1706         opt::flag_s("", "test", "Build a test harness"),
1707         opt::opt_s(
1708             "",
1709             "target",
1710             "Target triple for which the code is compiled",
1711             "TARGET",
1712         ),
1713         opt::multi_s("W", "warn", "Set lint warnings", "OPT"),
1714         opt::multi_s("A", "allow", "Set lint allowed", "OPT"),
1715         opt::multi_s("D", "deny", "Set lint denied", "OPT"),
1716         opt::multi_s("F", "forbid", "Set lint forbidden", "OPT"),
1717         opt::multi_s(
1718             "",
1719             "cap-lints",
1720             "Set the most restrictive lint level. \
1721              More restrictive lints are capped at this \
1722              level",
1723             "LEVEL",
1724         ),
1725         opt::multi_s("C", "codegen", "Set a codegen option", "OPT[=VALUE]"),
1726         opt::flag_s("V", "version", "Print version info and exit"),
1727         opt::flag_s("v", "verbose", "Use verbose output"),
1728     ]
1729 }
1730
1731 /// Returns all rustc command line options, including metadata for
1732 /// each option, such as whether the option is part of the stable
1733 /// long-term interface for rustc.
1734 pub fn rustc_optgroups() -> Vec<RustcOptGroup> {
1735     let mut opts = rustc_short_optgroups();
1736     opts.extend(vec![
1737         opt::multi_s(
1738             "",
1739             "extern",
1740             "Specify where an external rust library is located",
1741             "NAME=PATH",
1742         ),
1743         opt::multi_s(
1744             "",
1745             "extern-private",
1746             "Specify where an extern rust library is located, marking it as a private dependency",
1747             "NAME=PATH",
1748         ),
1749         opt::opt_s("", "sysroot", "Override the system root", "PATH"),
1750         opt::multi("Z", "", "Set internal debugging options", "FLAG"),
1751         opt::opt_s(
1752             "",
1753             "error-format",
1754             "How errors and other messages are produced",
1755             "human|json|short",
1756         ),
1757         opt::opt_s(
1758             "",
1759             "color",
1760             "Configure coloring of output:
1761                                  auto   = colorize, if output goes to a tty (default);
1762                                  always = always colorize output;
1763                                  never  = never colorize output",
1764             "auto|always|never",
1765         ),
1766         opt::opt(
1767             "",
1768             "pretty",
1769             "Pretty-print the input instead of compiling;
1770                   valid types are: `normal` (un-annotated source),
1771                   `expanded` (crates expanded), or
1772                   `expanded,identified` (fully parenthesized, AST nodes with IDs).",
1773             "TYPE",
1774         ),
1775         opt::opt_s(
1776             "",
1777             "edition",
1778             "Specify which edition of the compiler to use when compiling code.",
1779             EDITION_NAME_LIST,
1780         ),
1781         opt::multi_s(
1782             "",
1783             "remap-path-prefix",
1784             "Remap source names in all output (compiler messages and output files)",
1785             "FROM=TO",
1786         ),
1787     ]);
1788     opts
1789 }
1790
1791 // Convert strings provided as --cfg [cfgspec] into a crate_cfg
1792 pub fn parse_cfgspecs(cfgspecs: Vec<String>) -> ast::CrateConfig {
1793     cfgspecs
1794         .into_iter()
1795         .map(|s| {
1796             let sess = parse::ParseSess::new(FilePathMapping::empty());
1797             let filename = FileName::cfg_spec_source_code(&s);
1798             let mut parser = parse::new_parser_from_source_str(&sess, filename, s.to_string());
1799
1800             macro_rules! error {($reason: expr) => {
1801                 early_error(ErrorOutputType::default(),
1802                             &format!(concat!("invalid `--cfg` argument: `{}` (", $reason, ")"), s));
1803             }}
1804
1805             match &mut parser.parse_meta_item() {
1806                 Ok(meta_item) if parser.token == token::Eof => {
1807                     if meta_item.ident.segments.len() != 1 {
1808                         error!("argument key must be an identifier");
1809                     }
1810                     match &meta_item.node {
1811                         MetaItemKind::List(..) => {
1812                             error!(r#"expected `key` or `key="value"`"#);
1813                         }
1814                         MetaItemKind::NameValue(lit) if !lit.node.is_str() => {
1815                             error!("argument value must be a string");
1816                         }
1817                         MetaItemKind::NameValue(..) | MetaItemKind::Word => {
1818                             return (meta_item.name(), meta_item.value_str());
1819                         }
1820                     }
1821                 }
1822                 Ok(..) => {}
1823                 Err(err) => err.cancel(),
1824             }
1825
1826             error!(r#"expected `key` or `key="value"`"#);
1827         })
1828         .collect::<ast::CrateConfig>()
1829 }
1830
1831 pub fn get_cmd_lint_options(matches: &getopts::Matches,
1832                             error_format: ErrorOutputType)
1833                             -> (Vec<(String, lint::Level)>, bool, Option<lint::Level>) {
1834     let mut lint_opts = vec![];
1835     let mut describe_lints = false;
1836
1837     for &level in &[lint::Allow, lint::Warn, lint::Deny, lint::Forbid] {
1838         for lint_name in matches.opt_strs(level.as_str()) {
1839             if lint_name == "help" {
1840                 describe_lints = true;
1841             } else {
1842                 lint_opts.push((lint_name.replace("-", "_"), level));
1843             }
1844         }
1845     }
1846
1847     let lint_cap = matches.opt_str("cap-lints").map(|cap| {
1848         lint::Level::from_str(&cap)
1849             .unwrap_or_else(|| early_error(error_format, &format!("unknown lint level: `{}`", cap)))
1850     });
1851     (lint_opts, describe_lints, lint_cap)
1852 }
1853
1854 pub fn build_session_options_and_crate_config(
1855     matches: &getopts::Matches,
1856 ) -> (Options, ast::CrateConfig) {
1857     let color = match matches.opt_str("color").as_ref().map(|s| &s[..]) {
1858         Some("auto") => ColorConfig::Auto,
1859         Some("always") => ColorConfig::Always,
1860         Some("never") => ColorConfig::Never,
1861
1862         None => ColorConfig::Auto,
1863
1864         Some(arg) => early_error(
1865             ErrorOutputType::default(),
1866             &format!(
1867                 "argument for --color must be auto, \
1868                  always or never (instead was `{}`)",
1869                 arg
1870             ),
1871         ),
1872     };
1873
1874     let edition = match matches.opt_str("edition") {
1875         Some(arg) => Edition::from_str(&arg).unwrap_or_else(|_|
1876             early_error(
1877                 ErrorOutputType::default(),
1878                 &format!(
1879                     "argument for --edition must be one of: \
1880                      {}. (instead was `{}`)",
1881                     EDITION_NAME_LIST,
1882                     arg
1883                 ),
1884             ),
1885         ),
1886         None => DEFAULT_EDITION,
1887     };
1888
1889     if !edition.is_stable() && !nightly_options::is_nightly_build() {
1890         early_error(
1891                 ErrorOutputType::default(),
1892                 &format!(
1893                     "Edition {} is unstable and only \
1894                      available for nightly builds of rustc.",
1895                     edition,
1896                 )
1897         )
1898     }
1899
1900
1901     // We need the opts_present check because the driver will send us Matches
1902     // with only stable options if no unstable options are used. Since error-format
1903     // is unstable, it will not be present. We have to use opts_present not
1904     // opt_present because the latter will panic.
1905     let error_format = if matches.opts_present(&["error-format".to_owned()]) {
1906         match matches.opt_str("error-format").as_ref().map(|s| &s[..]) {
1907             Some("human") => ErrorOutputType::HumanReadable(color),
1908             Some("json") => ErrorOutputType::Json(false),
1909             Some("pretty-json") => ErrorOutputType::Json(true),
1910             Some("short") => ErrorOutputType::Short(color),
1911             None => ErrorOutputType::HumanReadable(color),
1912
1913             Some(arg) => early_error(
1914                 ErrorOutputType::HumanReadable(color),
1915                 &format!(
1916                     "argument for --error-format must be `human`, `json` or \
1917                      `short` (instead was `{}`)",
1918                     arg
1919                 ),
1920             ),
1921         }
1922     } else {
1923         ErrorOutputType::HumanReadable(color)
1924     };
1925
1926     let unparsed_crate_types = matches.opt_strs("crate-type");
1927     let crate_types = parse_crate_types_from_list(unparsed_crate_types)
1928         .unwrap_or_else(|e| early_error(error_format, &e[..]));
1929
1930
1931     let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
1932
1933     let mut debugging_opts = build_debugging_options(matches, error_format);
1934
1935     if !debugging_opts.unstable_options && error_format == ErrorOutputType::Json(true) {
1936         early_error(
1937             ErrorOutputType::Json(false),
1938             "--error-format=pretty-json is unstable",
1939         );
1940     }
1941
1942     if debugging_opts.pgo_gen.is_some() && !debugging_opts.pgo_use.is_empty() {
1943         early_error(
1944             error_format,
1945             "options `-Z pgo-gen` and `-Z pgo-use` are exclusive",
1946         );
1947     }
1948
1949     let mut output_types = BTreeMap::new();
1950     if !debugging_opts.parse_only {
1951         for list in matches.opt_strs("emit") {
1952             for output_type in list.split(',') {
1953                 let mut parts = output_type.splitn(2, '=');
1954                 let shorthand = parts.next().unwrap();
1955                 let output_type = OutputType::from_shorthand(shorthand).unwrap_or_else(||
1956                     early_error(
1957                         error_format,
1958                         &format!(
1959                             "unknown emission type: `{}` - expected one of: {}",
1960                             shorthand,
1961                             OutputType::shorthands_display(),
1962                         ),
1963                     ),
1964                 );
1965                 let path = parts.next().map(PathBuf::from);
1966                 output_types.insert(output_type, path);
1967             }
1968         }
1969     };
1970     if output_types.is_empty() {
1971         output_types.insert(OutputType::Exe, None);
1972     }
1973
1974     let mut cg = build_codegen_options(matches, error_format);
1975     let mut codegen_units = cg.codegen_units;
1976     let mut disable_thinlto = false;
1977
1978     // Issue #30063: if user requests llvm-related output to one
1979     // particular path, disable codegen-units.
1980     let incompatible: Vec<_> = output_types
1981         .iter()
1982         .map(|ot_path| ot_path.0)
1983         .filter(|ot| !ot.is_compatible_with_codegen_units_and_single_output_file())
1984         .map(|ot| ot.shorthand())
1985         .collect();
1986     if !incompatible.is_empty() {
1987         match codegen_units {
1988             Some(n) if n > 1 => {
1989                 if matches.opt_present("o") {
1990                     for ot in &incompatible {
1991                         early_warn(
1992                             error_format,
1993                             &format!(
1994                                 "--emit={} with -o incompatible with \
1995                                  -C codegen-units=N for N > 1",
1996                                 ot
1997                             ),
1998                         );
1999                     }
2000                     early_warn(error_format, "resetting to default -C codegen-units=1");
2001                     codegen_units = Some(1);
2002                     disable_thinlto = true;
2003                 }
2004             }
2005             _ => {
2006                 codegen_units = Some(1);
2007                 disable_thinlto = true;
2008             }
2009         }
2010     }
2011
2012     if debugging_opts.threads == Some(0) {
2013         early_error(
2014             error_format,
2015             "Value for threads must be a positive nonzero integer",
2016         );
2017     }
2018
2019     if debugging_opts.threads.unwrap_or(1) > 1 && debugging_opts.fuel.is_some() {
2020         early_error(
2021             error_format,
2022             "Optimization fuel is incompatible with multiple threads",
2023         );
2024     }
2025
2026     if codegen_units == Some(0) {
2027         early_error(
2028             error_format,
2029             "Value for codegen units must be a positive nonzero integer",
2030         );
2031     }
2032
2033     let incremental = match (&debugging_opts.incremental, &cg.incremental) {
2034         (&Some(ref path1), &Some(ref path2)) => {
2035             if path1 != path2 {
2036                 early_error(
2037                     error_format,
2038                     &format!(
2039                         "conflicting paths for `-Z incremental` and \
2040                          `-C incremental` specified: {} versus {}",
2041                         path1, path2
2042                     ),
2043                 );
2044             } else {
2045                 Some(path1)
2046             }
2047         }
2048         (&Some(ref path), &None) => Some(path),
2049         (&None, &Some(ref path)) => Some(path),
2050         (&None, &None) => None,
2051     }.map(|m| PathBuf::from(m));
2052
2053     if debugging_opts.profile && incremental.is_some() {
2054         early_error(
2055             error_format,
2056             "can't instrument with gcov profiling when compiling incrementally",
2057         );
2058     }
2059
2060     let mut prints = Vec::<PrintRequest>::new();
2061     if cg.target_cpu.as_ref().map_or(false, |s| s == "help") {
2062         prints.push(PrintRequest::TargetCPUs);
2063         cg.target_cpu = None;
2064     };
2065     if cg.target_feature == "help" {
2066         prints.push(PrintRequest::TargetFeatures);
2067         cg.target_feature = String::new();
2068     }
2069     if cg.relocation_model.as_ref().map_or(false, |s| s == "help") {
2070         prints.push(PrintRequest::RelocationModels);
2071         cg.relocation_model = None;
2072     }
2073     if cg.code_model.as_ref().map_or(false, |s| s == "help") {
2074         prints.push(PrintRequest::CodeModels);
2075         cg.code_model = None;
2076     }
2077     if debugging_opts
2078         .tls_model
2079         .as_ref()
2080         .map_or(false, |s| s == "help")
2081     {
2082         prints.push(PrintRequest::TlsModels);
2083         debugging_opts.tls_model = None;
2084     }
2085
2086     let cg = cg;
2087
2088     let sysroot_opt = matches.opt_str("sysroot").map(|m| PathBuf::from(&m));
2089     let target_triple = if let Some(target) = matches.opt_str("target") {
2090         if target.ends_with(".json") {
2091             let path = Path::new(&target);
2092             TargetTriple::from_path(&path).unwrap_or_else(|_|
2093                 early_error(error_format, &format!("target file {:?} does not exist", path)))
2094         } else {
2095             TargetTriple::TargetTriple(target)
2096         }
2097     } else {
2098         TargetTriple::from_triple(host_triple())
2099     };
2100     let opt_level = {
2101         if matches.opt_present("O") {
2102             if cg.opt_level.is_some() {
2103                 early_error(error_format, "-O and -C opt-level both provided");
2104             }
2105             OptLevel::Default
2106         } else {
2107             match cg.opt_level.as_ref().map(String::as_ref) {
2108                 None => OptLevel::No,
2109                 Some("0") => OptLevel::No,
2110                 Some("1") => OptLevel::Less,
2111                 Some("2") => OptLevel::Default,
2112                 Some("3") => OptLevel::Aggressive,
2113                 Some("s") => OptLevel::Size,
2114                 Some("z") => OptLevel::SizeMin,
2115                 Some(arg) => {
2116                     early_error(
2117                         error_format,
2118                         &format!(
2119                             "optimization level needs to be \
2120                              between 0-3, s or z (instead was `{}`)",
2121                             arg
2122                         ),
2123                     );
2124                 }
2125             }
2126         }
2127     };
2128     let debug_assertions = cg.debug_assertions.unwrap_or(opt_level == OptLevel::No);
2129     let debuginfo = if matches.opt_present("g") {
2130         if cg.debuginfo.is_some() {
2131             early_error(error_format, "-g and -C debuginfo both provided");
2132         }
2133         DebugInfo::Full
2134     } else {
2135         match cg.debuginfo {
2136             None | Some(0) => DebugInfo::None,
2137             Some(1) => DebugInfo::Limited,
2138             Some(2) => DebugInfo::Full,
2139             Some(arg) => {
2140                 early_error(
2141                     error_format,
2142                     &format!(
2143                         "debug info level needs to be between \
2144                          0-2 (instead was `{}`)",
2145                         arg
2146                     ),
2147                 );
2148             }
2149         }
2150     };
2151
2152     let mut search_paths = vec![];
2153     for s in &matches.opt_strs("L") {
2154         search_paths.push(SearchPath::from_cli_opt(&s[..], error_format));
2155     }
2156
2157     let libs = matches
2158         .opt_strs("l")
2159         .into_iter()
2160         .map(|s| {
2161             // Parse string of the form "[KIND=]lib[:new_name]",
2162             // where KIND is one of "dylib", "framework", "static".
2163             let mut parts = s.splitn(2, '=');
2164             let kind = parts.next().unwrap();
2165             let (name, kind) = match (parts.next(), kind) {
2166                 (None, name) => (name, None),
2167                 (Some(name), "dylib") => (name, Some(cstore::NativeUnknown)),
2168                 (Some(name), "framework") => (name, Some(cstore::NativeFramework)),
2169                 (Some(name), "static") => (name, Some(cstore::NativeStatic)),
2170                 (Some(name), "static-nobundle") => (name, Some(cstore::NativeStaticNobundle)),
2171                 (_, s) => {
2172                     early_error(
2173                         error_format,
2174                         &format!(
2175                             "unknown library kind `{}`, expected \
2176                              one of dylib, framework, or static",
2177                             s
2178                         ),
2179                     );
2180                 }
2181             };
2182             if kind == Some(cstore::NativeStaticNobundle) && !nightly_options::is_nightly_build() {
2183                 early_error(
2184                     error_format,
2185                     &format!(
2186                         "the library kind 'static-nobundle' is only \
2187                          accepted on the nightly compiler"
2188                     ),
2189                 );
2190             }
2191             let mut name_parts = name.splitn(2, ':');
2192             let name = name_parts.next().unwrap();
2193             let new_name = name_parts.next();
2194             (name.to_owned(), new_name.map(|n| n.to_owned()), kind)
2195         })
2196         .collect();
2197
2198     let cfg = parse_cfgspecs(matches.opt_strs("cfg"));
2199     let test = matches.opt_present("test");
2200
2201     let is_unstable_enabled = nightly_options::is_unstable_enabled(matches);
2202
2203     prints.extend(matches.opt_strs("print").into_iter().map(|s| match &*s {
2204         "crate-name" => PrintRequest::CrateName,
2205         "file-names" => PrintRequest::FileNames,
2206         "sysroot" => PrintRequest::Sysroot,
2207         "cfg" => PrintRequest::Cfg,
2208         "target-list" => PrintRequest::TargetList,
2209         "target-cpus" => PrintRequest::TargetCPUs,
2210         "target-features" => PrintRequest::TargetFeatures,
2211         "relocation-models" => PrintRequest::RelocationModels,
2212         "code-models" => PrintRequest::CodeModels,
2213         "tls-models" => PrintRequest::TlsModels,
2214         "native-static-libs" => PrintRequest::NativeStaticLibs,
2215         "target-spec-json" => {
2216             if is_unstable_enabled {
2217                 PrintRequest::TargetSpec
2218             } else {
2219                 early_error(
2220                     error_format,
2221                     "the `-Z unstable-options` flag must also be passed to \
2222                      enable the target-spec-json print option",
2223                 );
2224             }
2225         }
2226         req => early_error(error_format, &format!("unknown print request `{}`", req)),
2227     }));
2228
2229     let borrowck_mode = match debugging_opts.borrowck.as_ref().map(|s| &s[..]) {
2230         None | Some("ast") => BorrowckMode::Ast,
2231         Some("mir") => BorrowckMode::Mir,
2232         Some("compare") => BorrowckMode::Compare,
2233         Some("migrate") => BorrowckMode::Migrate,
2234         Some(m) => early_error(error_format, &format!("unknown borrowck mode `{}`", m)),
2235     };
2236
2237     if !cg.remark.is_empty() && debuginfo == DebugInfo::None {
2238         early_warn(
2239             error_format,
2240             "-C remark requires \"-C debuginfo=n\" to show source locations",
2241         );
2242     }
2243
2244     if matches.opt_present("extern-private") && !debugging_opts.unstable_options {
2245         early_error(
2246             ErrorOutputType::default(),
2247             "'--extern-private' is unstable and only \
2248             available for nightly builds of rustc."
2249         )
2250     }
2251
2252     let extern_private = matches.opt_strs("extern-private");
2253
2254     let mut externs: BTreeMap<_, BTreeSet<_>> = BTreeMap::new();
2255     for arg in matches.opt_strs("extern").into_iter().chain(matches.opt_strs("extern-private")) {
2256         let mut parts = arg.splitn(2, '=');
2257         let name = parts.next().unwrap_or_else(||
2258             early_error(error_format, "--extern value must not be empty"));
2259         let location = parts.next().map(|s| s.to_string());
2260         if location.is_none() && !is_unstable_enabled {
2261             early_error(
2262                 error_format,
2263                 "the `-Z unstable-options` flag must also be passed to \
2264                  enable `--extern crate_name` without `=path`",
2265             );
2266         };
2267
2268         externs
2269             .entry(name.to_owned())
2270             .or_default()
2271             .insert(location);
2272     }
2273
2274     let crate_name = matches.opt_str("crate-name");
2275
2276     let remap_path_prefix = matches
2277         .opt_strs("remap-path-prefix")
2278         .into_iter()
2279         .map(|remap| {
2280             let mut parts = remap.rsplitn(2, '='); // reverse iterator
2281             let to = parts.next();
2282             let from = parts.next();
2283             match (from, to) {
2284                 (Some(from), Some(to)) => (PathBuf::from(from), PathBuf::from(to)),
2285                 _ => early_error(
2286                     error_format,
2287                     "--remap-path-prefix must contain '=' between FROM and TO",
2288                 ),
2289             }
2290         })
2291         .collect();
2292
2293     (
2294         Options {
2295             crate_types,
2296             optimize: opt_level,
2297             debuginfo,
2298             lint_opts,
2299             lint_cap,
2300             describe_lints,
2301             output_types: OutputTypes(output_types),
2302             search_paths,
2303             maybe_sysroot: sysroot_opt,
2304             target_triple,
2305             test,
2306             incremental,
2307             debugging_opts,
2308             prints,
2309             borrowck_mode,
2310             cg,
2311             error_format,
2312             externs: Externs(externs),
2313             crate_name,
2314             alt_std_name: None,
2315             libs,
2316             unstable_features: UnstableFeatures::from_environment(),
2317             debug_assertions,
2318             actually_rustdoc: false,
2319             cli_forced_codegen_units: codegen_units,
2320             cli_forced_thinlto_off: disable_thinlto,
2321             remap_path_prefix,
2322             edition,
2323             extern_private
2324         },
2325         cfg,
2326     )
2327 }
2328
2329 pub fn parse_crate_types_from_list(list_list: Vec<String>) -> Result<Vec<CrateType>, String> {
2330     let mut crate_types: Vec<CrateType> = Vec::new();
2331     for unparsed_crate_type in &list_list {
2332         for part in unparsed_crate_type.split(',') {
2333             let new_part = match part {
2334                 "lib" => default_lib_output(),
2335                 "rlib" => CrateType::Rlib,
2336                 "staticlib" => CrateType::Staticlib,
2337                 "dylib" => CrateType::Dylib,
2338                 "cdylib" => CrateType::Cdylib,
2339                 "bin" => CrateType::Executable,
2340                 "proc-macro" => CrateType::ProcMacro,
2341                 _ => return Err(format!("unknown crate type: `{}`", part))
2342             };
2343             if !crate_types.contains(&new_part) {
2344                 crate_types.push(new_part)
2345             }
2346         }
2347     }
2348
2349     Ok(crate_types)
2350 }
2351
2352 pub mod nightly_options {
2353     use getopts;
2354     use syntax::feature_gate::UnstableFeatures;
2355     use super::{ErrorOutputType, OptionStability, RustcOptGroup};
2356     use crate::session::early_error;
2357
2358     pub fn is_unstable_enabled(matches: &getopts::Matches) -> bool {
2359         is_nightly_build()
2360             && matches
2361                 .opt_strs("Z")
2362                 .iter()
2363                 .any(|x| *x == "unstable-options")
2364     }
2365
2366     pub fn is_nightly_build() -> bool {
2367         UnstableFeatures::from_environment().is_nightly_build()
2368     }
2369
2370     pub fn check_nightly_options(matches: &getopts::Matches, flags: &[RustcOptGroup]) {
2371         let has_z_unstable_option = matches
2372             .opt_strs("Z")
2373             .iter()
2374             .any(|x| *x == "unstable-options");
2375         let really_allows_unstable_options =
2376             UnstableFeatures::from_environment().is_nightly_build();
2377
2378         for opt in flags.iter() {
2379             if opt.stability == OptionStability::Stable {
2380                 continue;
2381             }
2382             if !matches.opt_present(opt.name) {
2383                 continue;
2384             }
2385             if opt.name != "Z" && !has_z_unstable_option {
2386                 early_error(
2387                     ErrorOutputType::default(),
2388                     &format!(
2389                         "the `-Z unstable-options` flag must also be passed to enable \
2390                          the flag `{}`",
2391                         opt.name
2392                     ),
2393                 );
2394             }
2395             if really_allows_unstable_options {
2396                 continue;
2397             }
2398             match opt.stability {
2399                 OptionStability::Unstable => {
2400                     let msg = format!(
2401                         "the option `{}` is only accepted on the \
2402                          nightly compiler",
2403                         opt.name
2404                     );
2405                     early_error(ErrorOutputType::default(), &msg);
2406                 }
2407                 OptionStability::Stable => {}
2408             }
2409         }
2410     }
2411 }
2412
2413 impl fmt::Display for CrateType {
2414     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2415         match *self {
2416             CrateType::Executable => "bin".fmt(f),
2417             CrateType::Dylib => "dylib".fmt(f),
2418             CrateType::Rlib => "rlib".fmt(f),
2419             CrateType::Staticlib => "staticlib".fmt(f),
2420             CrateType::Cdylib => "cdylib".fmt(f),
2421             CrateType::ProcMacro => "proc-macro".fmt(f),
2422         }
2423     }
2424 }
2425
2426 /// Command-line arguments passed to the compiler have to be incorporated with
2427 /// the dependency tracking system for incremental compilation. This module
2428 /// provides some utilities to make this more convenient.
2429 ///
2430 /// The values of all command-line arguments that are relevant for dependency
2431 /// tracking are hashed into a single value that determines whether the
2432 /// incremental compilation cache can be re-used or not. This hashing is done
2433 /// via the DepTrackingHash trait defined below, since the standard Hash
2434 /// implementation might not be suitable (e.g., arguments are stored in a Vec,
2435 /// the hash of which is order dependent, but we might not want the order of
2436 /// arguments to make a difference for the hash).
2437 ///
2438 /// However, since the value provided by Hash::hash often *is* suitable,
2439 /// especially for primitive types, there is the
2440 /// impl_dep_tracking_hash_via_hash!() macro that allows to simply reuse the
2441 /// Hash implementation for DepTrackingHash. It's important though that
2442 /// we have an opt-in scheme here, so one is hopefully forced to think about
2443 /// how the hash should be calculated when adding a new command-line argument.
2444 mod dep_tracking {
2445     use crate::lint;
2446     use crate::middle::cstore;
2447     use std::collections::BTreeMap;
2448     use std::hash::Hash;
2449     use std::path::PathBuf;
2450     use std::collections::hash_map::DefaultHasher;
2451     use super::{CrateType, DebugInfo, ErrorOutputType, OptLevel, OutputTypes,
2452                 Passes, Sanitizer, LtoCli, LinkerPluginLto};
2453     use syntax::feature_gate::UnstableFeatures;
2454     use rustc_target::spec::{MergeFunctions, PanicStrategy, RelroLevel, TargetTriple};
2455     use syntax::edition::Edition;
2456
2457     pub trait DepTrackingHash {
2458         fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType);
2459     }
2460
2461     macro_rules! impl_dep_tracking_hash_via_hash {
2462         ($t:ty) => (
2463             impl DepTrackingHash for $t {
2464                 fn hash(&self, hasher: &mut DefaultHasher, _: ErrorOutputType) {
2465                     Hash::hash(self, hasher);
2466                 }
2467             }
2468         )
2469     }
2470
2471     macro_rules! impl_dep_tracking_hash_for_sortable_vec_of {
2472         ($t:ty) => (
2473             impl DepTrackingHash for Vec<$t> {
2474                 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
2475                     let mut elems: Vec<&$t> = self.iter().collect();
2476                     elems.sort();
2477                     Hash::hash(&elems.len(), hasher);
2478                     for (index, elem) in elems.iter().enumerate() {
2479                         Hash::hash(&index, hasher);
2480                         DepTrackingHash::hash(*elem, hasher, error_format);
2481                     }
2482                 }
2483             }
2484         );
2485     }
2486
2487     impl_dep_tracking_hash_via_hash!(bool);
2488     impl_dep_tracking_hash_via_hash!(usize);
2489     impl_dep_tracking_hash_via_hash!(u64);
2490     impl_dep_tracking_hash_via_hash!(String);
2491     impl_dep_tracking_hash_via_hash!(PathBuf);
2492     impl_dep_tracking_hash_via_hash!(lint::Level);
2493     impl_dep_tracking_hash_via_hash!(Option<bool>);
2494     impl_dep_tracking_hash_via_hash!(Option<usize>);
2495     impl_dep_tracking_hash_via_hash!(Option<String>);
2496     impl_dep_tracking_hash_via_hash!(Option<(String, u64)>);
2497     impl_dep_tracking_hash_via_hash!(Option<Vec<String>>);
2498     impl_dep_tracking_hash_via_hash!(Option<MergeFunctions>);
2499     impl_dep_tracking_hash_via_hash!(Option<PanicStrategy>);
2500     impl_dep_tracking_hash_via_hash!(Option<RelroLevel>);
2501     impl_dep_tracking_hash_via_hash!(Option<lint::Level>);
2502     impl_dep_tracking_hash_via_hash!(Option<PathBuf>);
2503     impl_dep_tracking_hash_via_hash!(Option<cstore::NativeLibraryKind>);
2504     impl_dep_tracking_hash_via_hash!(CrateType);
2505     impl_dep_tracking_hash_via_hash!(MergeFunctions);
2506     impl_dep_tracking_hash_via_hash!(PanicStrategy);
2507     impl_dep_tracking_hash_via_hash!(RelroLevel);
2508     impl_dep_tracking_hash_via_hash!(Passes);
2509     impl_dep_tracking_hash_via_hash!(OptLevel);
2510     impl_dep_tracking_hash_via_hash!(LtoCli);
2511     impl_dep_tracking_hash_via_hash!(DebugInfo);
2512     impl_dep_tracking_hash_via_hash!(UnstableFeatures);
2513     impl_dep_tracking_hash_via_hash!(OutputTypes);
2514     impl_dep_tracking_hash_via_hash!(cstore::NativeLibraryKind);
2515     impl_dep_tracking_hash_via_hash!(Sanitizer);
2516     impl_dep_tracking_hash_via_hash!(Option<Sanitizer>);
2517     impl_dep_tracking_hash_via_hash!(TargetTriple);
2518     impl_dep_tracking_hash_via_hash!(Edition);
2519     impl_dep_tracking_hash_via_hash!(LinkerPluginLto);
2520
2521     impl_dep_tracking_hash_for_sortable_vec_of!(String);
2522     impl_dep_tracking_hash_for_sortable_vec_of!(PathBuf);
2523     impl_dep_tracking_hash_for_sortable_vec_of!(CrateType);
2524     impl_dep_tracking_hash_for_sortable_vec_of!((String, lint::Level));
2525     impl_dep_tracking_hash_for_sortable_vec_of!((
2526         String,
2527         Option<String>,
2528         Option<cstore::NativeLibraryKind>
2529     ));
2530     impl_dep_tracking_hash_for_sortable_vec_of!((String, u64));
2531
2532     impl<T1, T2> DepTrackingHash for (T1, T2)
2533     where
2534         T1: DepTrackingHash,
2535         T2: DepTrackingHash,
2536     {
2537         fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
2538             Hash::hash(&0, hasher);
2539             DepTrackingHash::hash(&self.0, hasher, error_format);
2540             Hash::hash(&1, hasher);
2541             DepTrackingHash::hash(&self.1, hasher, error_format);
2542         }
2543     }
2544
2545     impl<T1, T2, T3> DepTrackingHash for (T1, T2, T3)
2546     where
2547         T1: DepTrackingHash,
2548         T2: DepTrackingHash,
2549         T3: DepTrackingHash,
2550     {
2551         fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
2552             Hash::hash(&0, hasher);
2553             DepTrackingHash::hash(&self.0, hasher, error_format);
2554             Hash::hash(&1, hasher);
2555             DepTrackingHash::hash(&self.1, hasher, error_format);
2556             Hash::hash(&2, hasher);
2557             DepTrackingHash::hash(&self.2, hasher, error_format);
2558         }
2559     }
2560
2561     // This is a stable hash because BTreeMap is a sorted container
2562     pub fn stable_hash(
2563         sub_hashes: BTreeMap<&'static str, &dyn DepTrackingHash>,
2564         hasher: &mut DefaultHasher,
2565         error_format: ErrorOutputType,
2566     ) {
2567         for (key, sub_hash) in sub_hashes {
2568             // Using Hash::hash() instead of DepTrackingHash::hash() is fine for
2569             // the keys, as they are just plain strings
2570             Hash::hash(&key.len(), hasher);
2571             Hash::hash(key, hasher);
2572             sub_hash.hash(hasher, error_format);
2573         }
2574     }
2575 }
2576
2577 #[cfg(test)]
2578 mod tests {
2579     use getopts;
2580     use crate::lint;
2581     use crate::middle::cstore;
2582     use crate::session::config::{build_configuration, build_session_options_and_crate_config};
2583     use crate::session::config::{LtoCli, LinkerPluginLto};
2584     use crate::session::build_session;
2585     use crate::session::search_paths::SearchPath;
2586     use std::collections::{BTreeMap, BTreeSet};
2587     use std::iter::FromIterator;
2588     use std::path::PathBuf;
2589     use super::{Externs, OutputType, OutputTypes};
2590     use rustc_target::spec::{MergeFunctions, PanicStrategy, RelroLevel};
2591     use syntax::symbol::Symbol;
2592     use syntax::edition::{Edition, DEFAULT_EDITION};
2593     use syntax;
2594     use super::Options;
2595
2596     fn optgroups() -> getopts::Options {
2597         let mut opts = getopts::Options::new();
2598         for group in super::rustc_optgroups() {
2599             (group.apply)(&mut opts);
2600         }
2601         return opts;
2602     }
2603
2604     fn mk_map<K: Ord, V>(entries: Vec<(K, V)>) -> BTreeMap<K, V> {
2605         BTreeMap::from_iter(entries.into_iter())
2606     }
2607
2608     fn mk_set<V: Ord>(entries: Vec<V>) -> BTreeSet<V> {
2609         BTreeSet::from_iter(entries.into_iter())
2610     }
2611
2612     // When the user supplies --test we should implicitly supply --cfg test
2613     #[test]
2614     fn test_switch_implies_cfg_test() {
2615         syntax::with_globals(|| {
2616             let matches = &match optgroups().parse(&["--test".to_string()]) {
2617                 Ok(m) => m,
2618                 Err(f) => panic!("test_switch_implies_cfg_test: {}", f),
2619             };
2620             let registry = errors::registry::Registry::new(&[]);
2621             let (sessopts, cfg) = build_session_options_and_crate_config(matches);
2622             let sess = build_session(sessopts, None, registry);
2623             let cfg = build_configuration(&sess, cfg);
2624             assert!(cfg.contains(&(Symbol::intern("test"), None)));
2625         });
2626     }
2627
2628     // When the user supplies --test and --cfg test, don't implicitly add
2629     // another --cfg test
2630     #[test]
2631     fn test_switch_implies_cfg_test_unless_cfg_test() {
2632         syntax::with_globals(|| {
2633             let matches = &match optgroups().parse(&["--test".to_string(),
2634                                                      "--cfg=test".to_string()]) {
2635                 Ok(m) => m,
2636                 Err(f) => panic!("test_switch_implies_cfg_test_unless_cfg_test: {}", f),
2637             };
2638             let registry = errors::registry::Registry::new(&[]);
2639             let (sessopts, cfg) = build_session_options_and_crate_config(matches);
2640             let sess = build_session(sessopts, None, registry);
2641             let cfg = build_configuration(&sess, cfg);
2642             let mut test_items = cfg.iter().filter(|&&(name, _)| name == "test");
2643             assert!(test_items.next().is_some());
2644             assert!(test_items.next().is_none());
2645         });
2646     }
2647
2648     #[test]
2649     fn test_can_print_warnings() {
2650         syntax::with_globals(|| {
2651             let matches = optgroups().parse(&["-Awarnings".to_string()]).unwrap();
2652             let registry = errors::registry::Registry::new(&[]);
2653             let (sessopts, _) = build_session_options_and_crate_config(&matches);
2654             let sess = build_session(sessopts, None, registry);
2655             assert!(!sess.diagnostic().flags.can_emit_warnings);
2656         });
2657
2658         syntax::with_globals(|| {
2659             let matches = optgroups()
2660                 .parse(&["-Awarnings".to_string(), "-Dwarnings".to_string()])
2661                 .unwrap();
2662             let registry = errors::registry::Registry::new(&[]);
2663             let (sessopts, _) = build_session_options_and_crate_config(&matches);
2664             let sess = build_session(sessopts, None, registry);
2665             assert!(sess.diagnostic().flags.can_emit_warnings);
2666         });
2667
2668         syntax::with_globals(|| {
2669             let matches = optgroups().parse(&["-Adead_code".to_string()]).unwrap();
2670             let registry = errors::registry::Registry::new(&[]);
2671             let (sessopts, _) = build_session_options_and_crate_config(&matches);
2672             let sess = build_session(sessopts, None, registry);
2673             assert!(sess.diagnostic().flags.can_emit_warnings);
2674         });
2675     }
2676
2677     #[test]
2678     fn test_output_types_tracking_hash_different_paths() {
2679         let mut v1 = Options::default();
2680         let mut v2 = Options::default();
2681         let mut v3 = Options::default();
2682
2683         v1.output_types =
2684             OutputTypes::new(&[(OutputType::Exe, Some(PathBuf::from("./some/thing")))]);
2685         v2.output_types =
2686             OutputTypes::new(&[(OutputType::Exe, Some(PathBuf::from("/some/thing")))]);
2687         v3.output_types = OutputTypes::new(&[(OutputType::Exe, None)]);
2688
2689         assert!(v1.dep_tracking_hash() != v2.dep_tracking_hash());
2690         assert!(v1.dep_tracking_hash() != v3.dep_tracking_hash());
2691         assert!(v2.dep_tracking_hash() != v3.dep_tracking_hash());
2692
2693         // Check clone
2694         assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2695         assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2696         assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2697     }
2698
2699     #[test]
2700     fn test_output_types_tracking_hash_different_construction_order() {
2701         let mut v1 = Options::default();
2702         let mut v2 = Options::default();
2703
2704         v1.output_types = OutputTypes::new(&[
2705             (OutputType::Exe, Some(PathBuf::from("./some/thing"))),
2706             (OutputType::Bitcode, Some(PathBuf::from("./some/thing.bc"))),
2707         ]);
2708
2709         v2.output_types = OutputTypes::new(&[
2710             (OutputType::Bitcode, Some(PathBuf::from("./some/thing.bc"))),
2711             (OutputType::Exe, Some(PathBuf::from("./some/thing"))),
2712         ]);
2713
2714         assert_eq!(v1.dep_tracking_hash(), v2.dep_tracking_hash());
2715
2716         // Check clone
2717         assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2718     }
2719
2720     #[test]
2721     fn test_externs_tracking_hash_different_construction_order() {
2722         let mut v1 = Options::default();
2723         let mut v2 = Options::default();
2724         let mut v3 = Options::default();
2725
2726         v1.externs = Externs::new(mk_map(vec![
2727             (
2728                 String::from("a"),
2729                 mk_set(vec![Some(String::from("b")), Some(String::from("c"))]),
2730             ),
2731             (
2732                 String::from("d"),
2733                 mk_set(vec![Some(String::from("e")), Some(String::from("f"))]),
2734             ),
2735         ]));
2736
2737         v2.externs = Externs::new(mk_map(vec![
2738             (
2739                 String::from("d"),
2740                 mk_set(vec![Some(String::from("e")), Some(String::from("f"))]),
2741             ),
2742             (
2743                 String::from("a"),
2744                 mk_set(vec![Some(String::from("b")), Some(String::from("c"))]),
2745             ),
2746         ]));
2747
2748         v3.externs = Externs::new(mk_map(vec![
2749             (
2750                 String::from("a"),
2751                 mk_set(vec![Some(String::from("b")), Some(String::from("c"))]),
2752             ),
2753             (
2754                 String::from("d"),
2755                 mk_set(vec![Some(String::from("f")), Some(String::from("e"))]),
2756             ),
2757         ]));
2758
2759         assert_eq!(v1.dep_tracking_hash(), v2.dep_tracking_hash());
2760         assert_eq!(v1.dep_tracking_hash(), v3.dep_tracking_hash());
2761         assert_eq!(v2.dep_tracking_hash(), v3.dep_tracking_hash());
2762
2763         // Check clone
2764         assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2765         assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2766         assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2767     }
2768
2769     #[test]
2770     fn test_lints_tracking_hash_different_values() {
2771         let mut v1 = Options::default();
2772         let mut v2 = Options::default();
2773         let mut v3 = Options::default();
2774
2775         v1.lint_opts = vec![
2776             (String::from("a"), lint::Allow),
2777             (String::from("b"), lint::Warn),
2778             (String::from("c"), lint::Deny),
2779             (String::from("d"), lint::Forbid),
2780         ];
2781
2782         v2.lint_opts = vec![
2783             (String::from("a"), lint::Allow),
2784             (String::from("b"), lint::Warn),
2785             (String::from("X"), lint::Deny),
2786             (String::from("d"), lint::Forbid),
2787         ];
2788
2789         v3.lint_opts = vec![
2790             (String::from("a"), lint::Allow),
2791             (String::from("b"), lint::Warn),
2792             (String::from("c"), lint::Forbid),
2793             (String::from("d"), lint::Deny),
2794         ];
2795
2796         assert!(v1.dep_tracking_hash() != v2.dep_tracking_hash());
2797         assert!(v1.dep_tracking_hash() != v3.dep_tracking_hash());
2798         assert!(v2.dep_tracking_hash() != v3.dep_tracking_hash());
2799
2800         // Check clone
2801         assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2802         assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2803         assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2804     }
2805
2806     #[test]
2807     fn test_lints_tracking_hash_different_construction_order() {
2808         let mut v1 = Options::default();
2809         let mut v2 = Options::default();
2810
2811         v1.lint_opts = vec![
2812             (String::from("a"), lint::Allow),
2813             (String::from("b"), lint::Warn),
2814             (String::from("c"), lint::Deny),
2815             (String::from("d"), lint::Forbid),
2816         ];
2817
2818         v2.lint_opts = vec![
2819             (String::from("a"), lint::Allow),
2820             (String::from("c"), lint::Deny),
2821             (String::from("b"), lint::Warn),
2822             (String::from("d"), lint::Forbid),
2823         ];
2824
2825         assert_eq!(v1.dep_tracking_hash(), v2.dep_tracking_hash());
2826
2827         // Check clone
2828         assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2829         assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2830     }
2831
2832     #[test]
2833     fn test_search_paths_tracking_hash_different_order() {
2834         let mut v1 = Options::default();
2835         let mut v2 = Options::default();
2836         let mut v3 = Options::default();
2837         let mut v4 = Options::default();
2838
2839         // Reference
2840         v1.search_paths
2841             .push(SearchPath::from_cli_opt("native=abc", super::ErrorOutputType::Json(false)));
2842         v1.search_paths
2843             .push(SearchPath::from_cli_opt("crate=def", super::ErrorOutputType::Json(false)));
2844         v1.search_paths
2845             .push(SearchPath::from_cli_opt("dependency=ghi", super::ErrorOutputType::Json(false)));
2846         v1.search_paths
2847             .push(SearchPath::from_cli_opt("framework=jkl", super::ErrorOutputType::Json(false)));
2848         v1.search_paths
2849             .push(SearchPath::from_cli_opt("all=mno", super::ErrorOutputType::Json(false)));
2850
2851         v2.search_paths
2852             .push(SearchPath::from_cli_opt("native=abc", super::ErrorOutputType::Json(false)));
2853         v2.search_paths
2854             .push(SearchPath::from_cli_opt("dependency=ghi", super::ErrorOutputType::Json(false)));
2855         v2.search_paths
2856             .push(SearchPath::from_cli_opt("crate=def", super::ErrorOutputType::Json(false)));
2857         v2.search_paths
2858             .push(SearchPath::from_cli_opt("framework=jkl", super::ErrorOutputType::Json(false)));
2859         v2.search_paths
2860             .push(SearchPath::from_cli_opt("all=mno", super::ErrorOutputType::Json(false)));
2861
2862         v3.search_paths
2863             .push(SearchPath::from_cli_opt("crate=def", super::ErrorOutputType::Json(false)));
2864         v3.search_paths
2865             .push(SearchPath::from_cli_opt("framework=jkl", super::ErrorOutputType::Json(false)));
2866         v3.search_paths
2867             .push(SearchPath::from_cli_opt("native=abc", super::ErrorOutputType::Json(false)));
2868         v3.search_paths
2869             .push(SearchPath::from_cli_opt("dependency=ghi", super::ErrorOutputType::Json(false)));
2870         v3.search_paths
2871             .push(SearchPath::from_cli_opt("all=mno", super::ErrorOutputType::Json(false)));
2872
2873         v4.search_paths
2874             .push(SearchPath::from_cli_opt("all=mno", super::ErrorOutputType::Json(false)));
2875         v4.search_paths
2876             .push(SearchPath::from_cli_opt("native=abc", super::ErrorOutputType::Json(false)));
2877         v4.search_paths
2878             .push(SearchPath::from_cli_opt("crate=def", super::ErrorOutputType::Json(false)));
2879         v4.search_paths
2880             .push(SearchPath::from_cli_opt("dependency=ghi", super::ErrorOutputType::Json(false)));
2881         v4.search_paths
2882             .push(SearchPath::from_cli_opt("framework=jkl", super::ErrorOutputType::Json(false)));
2883
2884         assert!(v1.dep_tracking_hash() == v2.dep_tracking_hash());
2885         assert!(v1.dep_tracking_hash() == v3.dep_tracking_hash());
2886         assert!(v1.dep_tracking_hash() == v4.dep_tracking_hash());
2887
2888         // Check clone
2889         assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2890         assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2891         assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2892         assert_eq!(v4.dep_tracking_hash(), v4.clone().dep_tracking_hash());
2893     }
2894
2895     #[test]
2896     fn test_native_libs_tracking_hash_different_values() {
2897         let mut v1 = Options::default();
2898         let mut v2 = Options::default();
2899         let mut v3 = Options::default();
2900         let mut v4 = Options::default();
2901
2902         // Reference
2903         v1.libs = vec![
2904             (String::from("a"), None, Some(cstore::NativeStatic)),
2905             (String::from("b"), None, Some(cstore::NativeFramework)),
2906             (String::from("c"), None, Some(cstore::NativeUnknown)),
2907         ];
2908
2909         // Change label
2910         v2.libs = vec![
2911             (String::from("a"), None, Some(cstore::NativeStatic)),
2912             (String::from("X"), None, Some(cstore::NativeFramework)),
2913             (String::from("c"), None, Some(cstore::NativeUnknown)),
2914         ];
2915
2916         // Change kind
2917         v3.libs = vec![
2918             (String::from("a"), None, Some(cstore::NativeStatic)),
2919             (String::from("b"), None, Some(cstore::NativeStatic)),
2920             (String::from("c"), None, Some(cstore::NativeUnknown)),
2921         ];
2922
2923         // Change new-name
2924         v4.libs = vec![
2925             (String::from("a"), None, Some(cstore::NativeStatic)),
2926             (
2927                 String::from("b"),
2928                 Some(String::from("X")),
2929                 Some(cstore::NativeFramework),
2930             ),
2931             (String::from("c"), None, Some(cstore::NativeUnknown)),
2932         ];
2933
2934         assert!(v1.dep_tracking_hash() != v2.dep_tracking_hash());
2935         assert!(v1.dep_tracking_hash() != v3.dep_tracking_hash());
2936         assert!(v1.dep_tracking_hash() != v4.dep_tracking_hash());
2937
2938         // Check clone
2939         assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2940         assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2941         assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2942         assert_eq!(v4.dep_tracking_hash(), v4.clone().dep_tracking_hash());
2943     }
2944
2945     #[test]
2946     fn test_native_libs_tracking_hash_different_order() {
2947         let mut v1 = Options::default();
2948         let mut v2 = Options::default();
2949         let mut v3 = Options::default();
2950
2951         // Reference
2952         v1.libs = vec![
2953             (String::from("a"), None, Some(cstore::NativeStatic)),
2954             (String::from("b"), None, Some(cstore::NativeFramework)),
2955             (String::from("c"), None, Some(cstore::NativeUnknown)),
2956         ];
2957
2958         v2.libs = vec![
2959             (String::from("b"), None, Some(cstore::NativeFramework)),
2960             (String::from("a"), None, Some(cstore::NativeStatic)),
2961             (String::from("c"), None, Some(cstore::NativeUnknown)),
2962         ];
2963
2964         v3.libs = vec![
2965             (String::from("c"), None, Some(cstore::NativeUnknown)),
2966             (String::from("a"), None, Some(cstore::NativeStatic)),
2967             (String::from("b"), None, Some(cstore::NativeFramework)),
2968         ];
2969
2970         assert!(v1.dep_tracking_hash() == v2.dep_tracking_hash());
2971         assert!(v1.dep_tracking_hash() == v3.dep_tracking_hash());
2972         assert!(v2.dep_tracking_hash() == v3.dep_tracking_hash());
2973
2974         // Check clone
2975         assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2976         assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2977         assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2978     }
2979
2980     #[test]
2981     fn test_codegen_options_tracking_hash() {
2982         let reference = Options::default();
2983         let mut opts = Options::default();
2984
2985         // Make sure the changing an [UNTRACKED] option leaves the hash unchanged
2986         opts.cg.ar = Some(String::from("abc"));
2987         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2988
2989         opts.cg.linker = Some(PathBuf::from("linker"));
2990         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2991
2992         opts.cg.link_args = Some(vec![String::from("abc"), String::from("def")]);
2993         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2994
2995         opts.cg.link_dead_code = true;
2996         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2997
2998         opts.cg.rpath = true;
2999         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3000
3001         opts.cg.extra_filename = String::from("extra-filename");
3002         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3003
3004         opts.cg.codegen_units = Some(42);
3005         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3006
3007         opts.cg.remark = super::Passes::Some(vec![String::from("pass1"), String::from("pass2")]);
3008         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3009
3010         opts.cg.save_temps = true;
3011         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3012
3013         opts.cg.incremental = Some(String::from("abc"));
3014         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3015
3016         // Make sure changing a [TRACKED] option changes the hash
3017         opts = reference.clone();
3018         opts.cg.lto = LtoCli::Fat;
3019         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3020
3021         opts = reference.clone();
3022         opts.cg.target_cpu = Some(String::from("abc"));
3023         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3024
3025         opts = reference.clone();
3026         opts.cg.target_feature = String::from("all the features, all of them");
3027         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3028
3029         opts = reference.clone();
3030         opts.cg.passes = vec![String::from("1"), String::from("2")];
3031         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3032
3033         opts = reference.clone();
3034         opts.cg.llvm_args = vec![String::from("1"), String::from("2")];
3035         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3036
3037         opts = reference.clone();
3038         opts.cg.overflow_checks = Some(true);
3039         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3040
3041         opts = reference.clone();
3042         opts.cg.no_prepopulate_passes = true;
3043         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3044
3045         opts = reference.clone();
3046         opts.cg.no_vectorize_loops = true;
3047         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3048
3049         opts = reference.clone();
3050         opts.cg.no_vectorize_slp = true;
3051         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3052
3053         opts = reference.clone();
3054         opts.cg.soft_float = true;
3055         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3056
3057         opts = reference.clone();
3058         opts.cg.prefer_dynamic = true;
3059         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3060
3061         opts = reference.clone();
3062         opts.cg.no_integrated_as = true;
3063         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3064
3065         opts = reference.clone();
3066         opts.cg.no_redzone = Some(true);
3067         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3068
3069         opts = reference.clone();
3070         opts.cg.relocation_model = Some(String::from("relocation model"));
3071         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3072
3073         opts = reference.clone();
3074         opts.cg.code_model = Some(String::from("code model"));
3075         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3076
3077         opts = reference.clone();
3078         opts.debugging_opts.tls_model = Some(String::from("tls model"));
3079         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3080
3081         opts = reference.clone();
3082         opts.debugging_opts.pgo_gen = Some(String::from("abc"));
3083         assert_ne!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3084
3085         opts = reference.clone();
3086         opts.debugging_opts.pgo_use = String::from("abc");
3087         assert_ne!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3088
3089         opts = reference.clone();
3090         opts.cg.metadata = vec![String::from("A"), String::from("B")];
3091         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3092
3093         opts = reference.clone();
3094         opts.cg.debuginfo = Some(0xdeadbeef);
3095         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3096
3097         opts = reference.clone();
3098         opts.cg.debuginfo = Some(0xba5eba11);
3099         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3100
3101         opts = reference.clone();
3102         opts.cg.force_frame_pointers = Some(false);
3103         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3104
3105         opts = reference.clone();
3106         opts.cg.debug_assertions = Some(true);
3107         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3108
3109         opts = reference.clone();
3110         opts.cg.inline_threshold = Some(0xf007ba11);
3111         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3112
3113         opts = reference.clone();
3114         opts.cg.panic = Some(PanicStrategy::Abort);
3115         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3116
3117         opts = reference.clone();
3118         opts.cg.linker_plugin_lto = LinkerPluginLto::LinkerPluginAuto;
3119         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3120     }
3121
3122     #[test]
3123     fn test_debugging_options_tracking_hash() {
3124         let reference = Options::default();
3125         let mut opts = Options::default();
3126
3127         // Make sure the changing an [UNTRACKED] option leaves the hash unchanged
3128         opts.debugging_opts.verbose = true;
3129         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3130         opts.debugging_opts.time_passes = true;
3131         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3132         opts.debugging_opts.count_llvm_insns = true;
3133         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3134         opts.debugging_opts.time_llvm_passes = true;
3135         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3136         opts.debugging_opts.input_stats = true;
3137         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3138         opts.debugging_opts.codegen_stats = true;
3139         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3140         opts.debugging_opts.borrowck_stats = true;
3141         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3142         opts.debugging_opts.meta_stats = true;
3143         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3144         opts.debugging_opts.print_link_args = true;
3145         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3146         opts.debugging_opts.print_llvm_passes = true;
3147         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3148         opts.debugging_opts.ast_json = true;
3149         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3150         opts.debugging_opts.ast_json_noexpand = true;
3151         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3152         opts.debugging_opts.ls = true;
3153         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3154         opts.debugging_opts.save_analysis = true;
3155         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3156         opts.debugging_opts.flowgraph_print_loans = true;
3157         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3158         opts.debugging_opts.flowgraph_print_moves = true;
3159         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3160         opts.debugging_opts.flowgraph_print_assigns = true;
3161         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3162         opts.debugging_opts.flowgraph_print_all = true;
3163         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3164         opts.debugging_opts.print_region_graph = true;
3165         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3166         opts.debugging_opts.parse_only = true;
3167         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3168         opts.debugging_opts.incremental = Some(String::from("abc"));
3169         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3170         opts.debugging_opts.dump_dep_graph = true;
3171         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3172         opts.debugging_opts.query_dep_graph = true;
3173         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3174         opts.debugging_opts.no_analysis = true;
3175         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3176         opts.debugging_opts.unstable_options = true;
3177         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3178         opts.debugging_opts.trace_macros = true;
3179         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3180         opts.debugging_opts.keep_hygiene_data = true;
3181         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3182         opts.debugging_opts.keep_ast = true;
3183         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3184         opts.debugging_opts.print_mono_items = Some(String::from("abc"));
3185         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3186         opts.debugging_opts.dump_mir = Some(String::from("abc"));
3187         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3188         opts.debugging_opts.dump_mir_dir = String::from("abc");
3189         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3190         opts.debugging_opts.dump_mir_graphviz = true;
3191         assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3192
3193         // Make sure changing a [TRACKED] option changes the hash
3194         opts = reference.clone();
3195         opts.debugging_opts.asm_comments = true;
3196         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3197
3198         opts = reference.clone();
3199         opts.debugging_opts.verify_llvm_ir = true;
3200         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3201
3202         opts = reference.clone();
3203         opts.debugging_opts.no_landing_pads = true;
3204         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3205
3206         opts = reference.clone();
3207         opts.debugging_opts.fewer_names = true;
3208         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3209
3210         opts = reference.clone();
3211         opts.debugging_opts.no_codegen = true;
3212         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3213
3214         opts = reference.clone();
3215         opts.debugging_opts.treat_err_as_bug = Some(1);
3216         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3217
3218         opts = reference.clone();
3219         opts.debugging_opts.report_delayed_bugs = true;
3220         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3221
3222         opts = reference.clone();
3223         opts.debugging_opts.continue_parse_after_error = true;
3224         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3225
3226         opts = reference.clone();
3227         opts.debugging_opts.extra_plugins = vec![String::from("plugin1"), String::from("plugin2")];
3228         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3229
3230         opts = reference.clone();
3231         opts.debugging_opts.force_overflow_checks = Some(true);
3232         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3233
3234         opts = reference.clone();
3235         opts.debugging_opts.show_span = Some(String::from("abc"));
3236         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3237
3238         opts = reference.clone();
3239         opts.debugging_opts.mir_opt_level = 3;
3240         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3241
3242         opts = reference.clone();
3243         opts.debugging_opts.relro_level = Some(RelroLevel::Full);
3244         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3245
3246         opts = reference.clone();
3247         opts.debugging_opts.merge_functions = Some(MergeFunctions::Disabled);
3248         assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3249     }
3250
3251     #[test]
3252     fn test_edition_parsing() {
3253         // test default edition
3254         let options = Options::default();
3255         assert!(options.edition == DEFAULT_EDITION);
3256
3257         let matches = optgroups()
3258             .parse(&["--edition=2018".to_string()])
3259             .unwrap();
3260         let (sessopts, _) = build_session_options_and_crate_config(&matches);
3261         assert!(sessopts.edition == Edition::Edition2018)
3262     }
3263 }