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