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