src/librustc/session/config.rs

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