src/librustc/session/config.rs

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