compiler/rustc_session/src/options.rs

   1 use crate::config::*;
   2
   3 use crate::early_error;
   4 use crate::lint;
   5 use crate::search_paths::SearchPath;
   6 use crate::utils::NativeLib;
   7 use rustc_errors::LanguageIdentifier;
   8 use rustc_target::spec::{CodeModel, LinkerFlavorCli, MergeFunctions, PanicStrategy, SanitizerSet};
   9 use rustc_target::spec::{
  10     RelocModel, RelroLevel, SplitDebuginfo, StackProtector, TargetTriple, TlsModel,
  11 };
  12
  13 use rustc_feature::UnstableFeatures;
  14 use rustc_span::edition::Edition;
  15 use rustc_span::RealFileName;
  16 use rustc_span::SourceFileHashAlgorithm;
  17
  18 use std::collections::BTreeMap;
  19
  20 use std::collections::hash_map::DefaultHasher;
  21 use std::hash::Hasher;
  22 use std::num::NonZeroUsize;
  23 use std::path::PathBuf;
  24 use std::str;
  25
  26 macro_rules! insert {
  27     ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr) => {
  28         if $sub_hashes
  29             .insert(stringify!($opt_name), $opt_expr as &dyn dep_tracking::DepTrackingHash)
  30             .is_some()
  31         {
  32             panic!("duplicate key in CLI DepTrackingHash: {}", stringify!($opt_name))
  33         }
  34     };
  35 }
  36
  37 macro_rules! hash_opt {
  38     ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, $_for_crate_hash: ident, [UNTRACKED]) => {{}};
  39     ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, $_for_crate_hash: ident, [TRACKED]) => {{ insert!($opt_name, $opt_expr, $sub_hashes) }};
  40     ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, $for_crate_hash: ident, [TRACKED_NO_CRATE_HASH]) => {{
  41         if !$for_crate_hash {
  42             insert!($opt_name, $opt_expr, $sub_hashes)
  43         }
  44     }};
  45     ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, $_for_crate_hash: ident, [SUBSTRUCT]) => {{}};
  46 }
  47
  48 macro_rules! hash_substruct {
  49     ($opt_name:ident, $opt_expr:expr, $error_format:expr, $for_crate_hash:expr, $hasher:expr, [UNTRACKED]) => {{}};
  50     ($opt_name:ident, $opt_expr:expr, $error_format:expr, $for_crate_hash:expr, $hasher:expr, [TRACKED]) => {{}};
  51     ($opt_name:ident, $opt_expr:expr, $error_format:expr, $for_crate_hash:expr, $hasher:expr, [TRACKED_NO_CRATE_HASH]) => {{}};
  52     ($opt_name:ident, $opt_expr:expr, $error_format:expr, $for_crate_hash:expr, $hasher:expr, [SUBSTRUCT]) => {
  53         use crate::config::dep_tracking::DepTrackingHash;
  54         $opt_expr.dep_tracking_hash($for_crate_hash, $error_format).hash(
  55             $hasher,
  56             $error_format,
  57             $for_crate_hash,
  58         );
  59     };
  60 }
  61
  62 macro_rules! top_level_options {
  63     ( $( #[$top_level_attr:meta] )* pub struct Options { $(
  64         $( #[$attr:meta] )*
  65         $opt:ident : $t:ty [$dep_tracking_marker:ident],
  66     )* } ) => (
  67         #[derive(Clone)]
  68         $( #[$top_level_attr] )*
  69         pub struct Options {
  70             $(
  71                 $( #[$attr] )*
  72                 pub $opt: $t
  73             ),*
  74         }
  75
  76         impl Options {
  77             pub fn dep_tracking_hash(&self, for_crate_hash: bool) -> u64 {
  78                 let mut sub_hashes = BTreeMap::new();
  79                 $({
  80                     hash_opt!($opt,
  81                                 &self.$opt,
  82                                 &mut sub_hashes,
  83                                 for_crate_hash,
  84                                 [$dep_tracking_marker]);
  85                 })*
  86                 let mut hasher = DefaultHasher::new();
  87                 dep_tracking::stable_hash(sub_hashes,
  88                                           &mut hasher,
  89                                           self.error_format,
  90                                           for_crate_hash);
  91                 $({
  92                     hash_substruct!($opt,
  93                         &self.$opt,
  94                         self.error_format,
  95                         for_crate_hash,
  96                         &mut hasher,
  97                         [$dep_tracking_marker]);
  98                 })*
  99                 hasher.finish()
 100             }
 101         }
 102     );
 103 }
 104
 105 top_level_options!(
 106     /// The top-level command-line options struct.
 107     ///
 108     /// For each option, one has to specify how it behaves with regard to the
 109     /// dependency tracking system of incremental compilation. This is done via the
 110     /// square-bracketed directive after the field type. The options are:
 111     ///
 112     /// - `[TRACKED]`
 113     /// A change in the given field will cause the compiler to completely clear the
 114     /// incremental compilation cache before proceeding.
 115     ///
 116     /// - `[TRACKED_NO_CRATE_HASH]`
 117     /// Same as `[TRACKED]`, but will not affect the crate hash. This is useful for options that only
 118     /// affect the incremental cache.
 119     ///
 120     /// - `[UNTRACKED]`
 121     /// Incremental compilation is not influenced by this option.
 122     ///
 123     /// - `[SUBSTRUCT]`
 124     /// Second-level sub-structs containing more options.
 125     ///
 126     /// If you add a new option to this struct or one of the sub-structs like
 127     /// `CodegenOptions`, think about how it influences incremental compilation. If in
 128     /// doubt, specify `[TRACKED]`, which is always "correct" but might lead to
 129     /// unnecessary re-compilation.
 130     #[rustc_lint_opt_ty]
 131     pub struct Options {
 132         /// The crate config requested for the session, which may be combined
 133         /// with additional crate configurations during the compile process.
 134         #[rustc_lint_opt_deny_field_access("use `Session::crate_types` instead of this field")]
 135         crate_types: Vec<CrateType> [TRACKED],
 136         optimize: OptLevel [TRACKED],
 137         /// Include the `debug_assertions` flag in dependency tracking, since it
 138         /// can influence whether overflow checks are done or not.
 139         debug_assertions: bool [TRACKED],
 140         debuginfo: DebugInfo [TRACKED],
 141         lint_opts: Vec<(String, lint::Level)> [TRACKED_NO_CRATE_HASH],
 142         lint_cap: Option<lint::Level> [TRACKED_NO_CRATE_HASH],
 143         describe_lints: bool [UNTRACKED],
 144         output_types: OutputTypes [TRACKED],
 145         search_paths: Vec<SearchPath> [UNTRACKED],
 146         libs: Vec<NativeLib> [TRACKED],
 147         maybe_sysroot: Option<PathBuf> [UNTRACKED],
 148
 149         target_triple: TargetTriple [TRACKED],
 150
 151         test: bool [TRACKED],
 152         error_format: ErrorOutputType [UNTRACKED],
 153         diagnostic_width: Option<usize> [UNTRACKED],
 154
 155         /// If `Some`, enable incremental compilation, using the given
 156         /// directory to store intermediate results.
 157         incremental: Option<PathBuf> [UNTRACKED],
 158         assert_incr_state: Option<IncrementalStateAssertion> [UNTRACKED],
 159
 160         unstable_opts: UnstableOptions [SUBSTRUCT],
 161         prints: Vec<PrintRequest> [UNTRACKED],
 162         cg: CodegenOptions [SUBSTRUCT],
 163         externs: Externs [UNTRACKED],
 164         crate_name: Option<String> [TRACKED],
 165         /// Indicates how the compiler should treat unstable features.
 166         unstable_features: UnstableFeatures [TRACKED],
 167
 168         /// Indicates whether this run of the compiler is actually rustdoc. This
 169         /// is currently just a hack and will be removed eventually, so please
 170         /// try to not rely on this too much.
 171         actually_rustdoc: bool [TRACKED],
 172
 173         /// Control path trimming.
 174         trimmed_def_paths: TrimmedDefPaths [TRACKED],
 175
 176         /// Specifications of codegen units / ThinLTO which are forced as a
 177         /// result of parsing command line options. These are not necessarily
 178         /// what rustc was invoked with, but massaged a bit to agree with
 179         /// commands like `--emit llvm-ir` which they're often incompatible with
 180         /// if we otherwise use the defaults of rustc.
 181         #[rustc_lint_opt_deny_field_access("use `Session::codegen_units` instead of this field")]
 182         cli_forced_codegen_units: Option<usize> [UNTRACKED],
 183         #[rustc_lint_opt_deny_field_access("use `Session::lto` instead of this field")]
 184         cli_forced_local_thinlto_off: bool [UNTRACKED],
 185
 186         /// Remap source path prefixes in all output (messages, object files, debug, etc.).
 187         remap_path_prefix: Vec<(PathBuf, PathBuf)> [TRACKED_NO_CRATE_HASH],
 188         /// Base directory containing the `src/` for the Rust standard library, and
 189         /// potentially `rustc` as well, if we can find it. Right now it's always
 190         /// `$sysroot/lib/rustlib/src/rust` (i.e. the `rustup` `rust-src` component).
 191         ///
 192         /// This directory is what the virtual `/rustc/$hash` is translated back to,
 193         /// if Rust was built with path remapping to `/rustc/$hash` enabled
 194         /// (the `rust.remap-debuginfo` option in `config.toml`).
 195         real_rust_source_base_dir: Option<PathBuf> [TRACKED_NO_CRATE_HASH],
 196
 197         edition: Edition [TRACKED],
 198
 199         /// `true` if we're emitting JSON blobs about each artifact produced
 200         /// by the compiler.
 201         json_artifact_notifications: bool [TRACKED],
 202
 203         /// `true` if we're emitting a JSON blob containing the unused externs
 204         json_unused_externs: JsonUnusedExterns [UNTRACKED],
 205
 206         /// `true` if we're emitting a JSON job containing a future-incompat report for lints
 207         json_future_incompat: bool [TRACKED],
 208
 209         pretty: Option<PpMode> [UNTRACKED],
 210
 211         /// The (potentially remapped) working directory
 212         working_dir: RealFileName [TRACKED],
 213     }
 214 );
 215
 216 /// Defines all `CodegenOptions`/`DebuggingOptions` fields and parsers all at once. The goal of this
 217 /// macro is to define an interface that can be programmatically used by the option parser
 218 /// to initialize the struct without hardcoding field names all over the place.
 219 ///
 220 /// The goal is to invoke this macro once with the correct fields, and then this macro generates all
 221 /// necessary code. The main gotcha of this macro is the `cgsetters` module which is a bunch of
 222 /// generated code to parse an option into its respective field in the struct. There are a few
 223 /// hand-written parsers for parsing specific types of values in this module.
 224 macro_rules! options {
 225     ($struct_name:ident, $stat:ident, $optmod:ident, $prefix:expr, $outputname:expr,
 226      $($( #[$attr:meta] )* $opt:ident : $t:ty = (
 227         $init:expr,
 228         $parse:ident,
 229         [$dep_tracking_marker:ident],
 230         $desc:expr)
 231      ),* ,) =>
 232 (
 233     #[derive(Clone)]
 234     #[rustc_lint_opt_ty]
 235     pub struct $struct_name { $( $( #[$attr] )* pub $opt: $t),* }
 236
 237     impl Default for $struct_name {
 238         fn default() -> $struct_name {
 239             $struct_name { $($opt: $init),* }
 240         }
 241     }
 242
 243     impl $struct_name {
 244         pub fn build(
 245             matches: &getopts::Matches,
 246             error_format: ErrorOutputType,
 247         ) -> $struct_name {
 248             build_options(matches, $stat, $prefix, $outputname, error_format)
 249         }
 250
 251         fn dep_tracking_hash(&self, for_crate_hash: bool, error_format: ErrorOutputType) -> u64 {
 252             let mut sub_hashes = BTreeMap::new();
 253             $({
 254                 hash_opt!($opt,
 255                             &self.$opt,
 256                             &mut sub_hashes,
 257                             for_crate_hash,
 258                             [$dep_tracking_marker]);
 259             })*
 260             let mut hasher = DefaultHasher::new();
 261             dep_tracking::stable_hash(sub_hashes,
 262                                         &mut hasher,
 263                                         error_format,
 264                                         for_crate_hash
 265                                         );
 266             hasher.finish()
 267         }
 268     }
 269
 270     pub const $stat: OptionDescrs<$struct_name> =
 271         &[ $( (stringify!($opt), $optmod::$opt, desc::$parse, $desc) ),* ];
 272
 273     mod $optmod {
 274     $(
 275         pub(super) fn $opt(cg: &mut super::$struct_name, v: Option<&str>) -> bool {
 276             super::parse::$parse(&mut redirect_field!(cg.$opt), v)
 277         }
 278     )*
 279     }
 280
 281 ) }
 282
 283 impl CodegenOptions {
 284     // JUSTIFICATION: defn of the suggested wrapper fn
 285     #[allow(rustc::bad_opt_access)]
 286     pub fn instrument_coverage(&self) -> InstrumentCoverage {
 287         self.instrument_coverage.unwrap_or(InstrumentCoverage::Off)
 288     }
 289 }
 290
 291 // Sometimes different options need to build a common structure.
 292 // That structure can be kept in one of the options' fields, the others become dummy.
 293 macro_rules! redirect_field {
 294     ($cg:ident.link_arg) => {
 295         $cg.link_args
 296     };
 297     ($cg:ident.pre_link_arg) => {
 298         $cg.pre_link_args
 299     };
 300     ($cg:ident.$field:ident) => {
 301         $cg.$field
 302     };
 303 }
 304
 305 type OptionSetter<O> = fn(&mut O, v: Option<&str>) -> bool;
 306 type OptionDescrs<O> = &'static [(&'static str, OptionSetter<O>, &'static str, &'static str)];
 307
 308 fn build_options<O: Default>(
 309     matches: &getopts::Matches,
 310     descrs: OptionDescrs<O>,
 311     prefix: &str,
 312     outputname: &str,
 313     error_format: ErrorOutputType,
 314 ) -> O {
 315     let mut op = O::default();
 316     for option in matches.opt_strs(prefix) {
 317         let (key, value) = match option.split_once('=') {
 318             None => (option, None),
 319             Some((k, v)) => (k.to_string(), Some(v)),
 320         };
 321
 322         let option_to_lookup = key.replace('-', "_");
 323         match descrs.iter().find(|(name, ..)| *name == option_to_lookup) {
 324             Some((_, setter, type_desc, _)) => {
 325                 if !setter(&mut op, value) {
 326                     match value {
 327                         None => early_error(
 328                             error_format,
 329                             &format!(
 330                                 "{0} option `{1}` requires {2} ({3} {1}=<value>)",
 331                                 outputname, key, type_desc, prefix
 332                             ),
 333                         ),
 334                         Some(value) => early_error(
 335                             error_format,
 336                             &format!(
 337                                 "incorrect value `{value}` for {outputname} option `{key}` - {type_desc} was expected"
 338                             ),
 339                         ),
 340                     }
 341                 }
 342             }
 343             None => early_error(error_format, &format!("unknown {outputname} option: `{key}`")),
 344         }
 345     }
 346     return op;
 347 }
 348
 349 #[allow(non_upper_case_globals)]
 350 mod desc {
 351     pub const parse_no_flag: &str = "no value";
 352     pub const parse_bool: &str = "one of: `y`, `yes`, `on`, `n`, `no`, or `off`";
 353     pub const parse_opt_bool: &str = parse_bool;
 354     pub const parse_string: &str = "a string";
 355     pub const parse_opt_string: &str = parse_string;
 356     pub const parse_string_push: &str = parse_string;
 357     pub const parse_opt_langid: &str = "a language identifier";
 358     pub const parse_opt_pathbuf: &str = "a path";
 359     pub const parse_list: &str = "a space-separated list of strings";
 360     pub const parse_list_with_polarity: &str =
 361         "a comma-separated list of strings, with elements beginning with + or -";
 362     pub const parse_opt_comma_list: &str = "a comma-separated list of strings";
 363     pub const parse_number: &str = "a number";
 364     pub const parse_opt_number: &str = parse_number;
 365     pub const parse_threads: &str = parse_number;
 366     pub const parse_passes: &str = "a space-separated list of passes, or `all`";
 367     pub const parse_panic_strategy: &str = "either `unwind` or `abort`";
 368     pub const parse_opt_panic_strategy: &str = parse_panic_strategy;
 369     pub const parse_oom_strategy: &str = "either `panic` or `abort`";
 370     pub const parse_relro_level: &str = "one of: `full`, `partial`, or `off`";
 371     pub const parse_sanitizers: &str = "comma separated list of sanitizers: `address`, `cfi`, `hwaddress`, `kcfi`, `leak`, `memory`, `memtag`, `shadow-call-stack`, or `thread`";
 372     pub const parse_sanitizer_memory_track_origins: &str = "0, 1, or 2";
 373     pub const parse_cfguard: &str =
 374         "either a boolean (`yes`, `no`, `on`, `off`, etc), `checks`, or `nochecks`";
 375     pub const parse_cfprotection: &str = "`none`|`no`|`n` (default), `branch`, `return`, or `full`|`yes`|`y` (equivalent to `branch` and `return`)";
 376     pub const parse_strip: &str = "either `none`, `debuginfo`, or `symbols`";
 377     pub const parse_linker_flavor: &str = ::rustc_target::spec::LinkerFlavorCli::one_of();
 378     pub const parse_optimization_fuel: &str = "crate=integer";
 379     pub const parse_mir_spanview: &str = "`statement` (default), `terminator`, or `block`";
 380     pub const parse_instrument_coverage: &str =
 381         "`all` (default), `except-unused-generics`, `except-unused-functions`, or `off`";
 382     pub const parse_unpretty: &str = "`string` or `string=string`";
 383     pub const parse_treat_err_as_bug: &str = "either no value or a number bigger than 0";
 384     pub const parse_lto: &str =
 385         "either a boolean (`yes`, `no`, `on`, `off`, etc), `thin`, `fat`, or omitted";
 386     pub const parse_linker_plugin_lto: &str =
 387         "either a boolean (`yes`, `no`, `on`, `off`, etc), or the path to the linker plugin";
 388     pub const parse_location_detail: &str = "either `none`, or a comma separated list of location details to track: `file`, `line`, or `column`";
 389     pub const parse_switch_with_opt_path: &str =
 390         "an optional path to the profiling data output directory";
 391     pub const parse_merge_functions: &str = "one of: `disabled`, `trampolines`, or `aliases`";
 392     pub const parse_symbol_mangling_version: &str = "either `legacy` or `v0` (RFC 2603)";
 393     pub const parse_src_file_hash: &str = "either `md5` or `sha1`";
 394     pub const parse_relocation_model: &str =
 395         "one of supported relocation models (`rustc --print relocation-models`)";
 396     pub const parse_code_model: &str = "one of supported code models (`rustc --print code-models`)";
 397     pub const parse_tls_model: &str = "one of supported TLS models (`rustc --print tls-models`)";
 398     pub const parse_target_feature: &str = parse_string;
 399     pub const parse_wasi_exec_model: &str = "either `command` or `reactor`";
 400     pub const parse_split_debuginfo: &str =
 401         "one of supported split-debuginfo modes (`off`, `packed`, or `unpacked`)";
 402     pub const parse_split_dwarf_kind: &str =
 403         "one of supported split dwarf modes (`split` or `single`)";
 404     pub const parse_gcc_ld: &str = "one of: no value, `lld`";
 405     pub const parse_stack_protector: &str =
 406         "one of (`none` (default), `basic`, `strong`, or `all`)";
 407     pub const parse_branch_protection: &str =
 408         "a `,` separated combination of `bti`, `b-key`, `pac-ret`, or `leaf`";
 409     pub const parse_proc_macro_execution_strategy: &str =
 410         "one of supported execution strategies (`same-thread`, or `cross-thread`)";
 411 }
 412
 413 mod parse {
 414     pub(crate) use super::*;
 415     use std::str::FromStr;
 416
 417     /// This is for boolean options that don't take a value and start with
 418     /// `no-`. This style of option is deprecated.
 419     pub(crate) fn parse_no_flag(slot: &mut bool, v: Option<&str>) -> bool {
 420         match v {
 421             None => {
 422                 *slot = true;
 423                 true
 424             }
 425             Some(_) => false,
 426         }
 427     }
 428
 429     /// Use this for any boolean option that has a static default.
 430     pub(crate) fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
 431         match v {
 432             Some("y") | Some("yes") | Some("on") | None => {
 433                 *slot = true;
 434                 true
 435             }
 436             Some("n") | Some("no") | Some("off") => {
 437                 *slot = false;
 438                 true
 439             }
 440             _ => false,
 441         }
 442     }
 443
 444     /// Use this for any boolean option that lacks a static default. (The
 445     /// actions taken when such an option is not specified will depend on
 446     /// other factors, such as other options, or target options.)
 447     pub(crate) fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
 448         match v {
 449             Some("y") | Some("yes") | Some("on") | None => {
 450                 *slot = Some(true);
 451                 true
 452             }
 453             Some("n") | Some("no") | Some("off") => {
 454                 *slot = Some(false);
 455                 true
 456             }
 457             _ => false,
 458         }
 459     }
 460
 461     /// Use this for any string option that has a static default.
 462     pub(crate) fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
 463         match v {
 464             Some(s) => {
 465                 *slot = s.to_string();
 466                 true
 467             }
 468             None => false,
 469         }
 470     }
 471
 472     /// Use this for any string option that lacks a static default.
 473     pub(crate) fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
 474         match v {
 475             Some(s) => {
 476                 *slot = Some(s.to_string());
 477                 true
 478             }
 479             None => false,
 480         }
 481     }
 482
 483     /// Parse an optional language identifier, e.g. `en-US` or `zh-CN`.
 484     pub(crate) fn parse_opt_langid(slot: &mut Option<LanguageIdentifier>, v: Option<&str>) -> bool {
 485         match v {
 486             Some(s) => {
 487                 *slot = rustc_errors::LanguageIdentifier::from_str(s).ok();
 488                 true
 489             }
 490             None => false,
 491         }
 492     }
 493
 494     pub(crate) fn parse_opt_pathbuf(slot: &mut Option<PathBuf>, v: Option<&str>) -> bool {
 495         match v {
 496             Some(s) => {
 497                 *slot = Some(PathBuf::from(s));
 498                 true
 499             }
 500             None => false,
 501         }
 502     }
 503
 504     pub(crate) fn parse_string_push(slot: &mut Vec<String>, v: Option<&str>) -> bool {
 505         match v {
 506             Some(s) => {
 507                 slot.push(s.to_string());
 508                 true
 509             }
 510             None => false,
 511         }
 512     }
 513
 514     pub(crate) fn parse_list(slot: &mut Vec<String>, v: Option<&str>) -> bool {
 515         match v {
 516             Some(s) => {
 517                 slot.extend(s.split_whitespace().map(|s| s.to_string()));
 518                 true
 519             }
 520             None => false,
 521         }
 522     }
 523
 524     pub(crate) fn parse_list_with_polarity(
 525         slot: &mut Vec<(String, bool)>,
 526         v: Option<&str>,
 527     ) -> bool {
 528         match v {
 529             Some(s) => {
 530                 for s in s.split(',') {
 531                     let Some(pass_name) = s.strip_prefix(&['+', '-'][..]) else { return false };
 532                     slot.push((pass_name.to_string(), &s[..1] == "+"));
 533                 }
 534                 true
 535             }
 536             None => false,
 537         }
 538     }
 539
 540     pub(crate) fn parse_location_detail(ld: &mut LocationDetail, v: Option<&str>) -> bool {
 541         if let Some(v) = v {
 542             ld.line = false;
 543             ld.file = false;
 544             ld.column = false;
 545             if v == "none" {
 546                 return true;
 547             }
 548             for s in v.split(',') {
 549                 match s {
 550                     "file" => ld.file = true,
 551                     "line" => ld.line = true,
 552                     "column" => ld.column = true,
 553                     _ => return false,
 554                 }
 555             }
 556             true
 557         } else {
 558             false
 559         }
 560     }
 561
 562     pub(crate) fn parse_opt_comma_list(slot: &mut Option<Vec<String>>, v: Option<&str>) -> bool {
 563         match v {
 564             Some(s) => {
 565                 let mut v: Vec<_> = s.split(',').map(|s| s.to_string()).collect();
 566                 v.sort_unstable();
 567                 *slot = Some(v);
 568                 true
 569             }
 570             None => false,
 571         }
 572     }
 573
 574     pub(crate) fn parse_threads(slot: &mut usize, v: Option<&str>) -> bool {
 575         match v.and_then(|s| s.parse().ok()) {
 576             Some(0) => {
 577                 *slot = std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get);
 578                 true
 579             }
 580             Some(i) => {
 581                 *slot = i;
 582                 true
 583             }
 584             None => false,
 585         }
 586     }
 587
 588     /// Use this for any numeric option that has a static default.
 589     pub(crate) fn parse_number<T: Copy + FromStr>(slot: &mut T, v: Option<&str>) -> bool {
 590         match v.and_then(|s| s.parse().ok()) {
 591             Some(i) => {
 592                 *slot = i;
 593                 true
 594             }
 595             None => false,
 596         }
 597     }
 598
 599     /// Use this for any numeric option that lacks a static default.
 600     pub(crate) fn parse_opt_number<T: Copy + FromStr>(
 601         slot: &mut Option<T>,
 602         v: Option<&str>,
 603     ) -> bool {
 604         match v {
 605             Some(s) => {
 606                 *slot = s.parse().ok();
 607                 slot.is_some()
 608             }
 609             None => false,
 610         }
 611     }
 612
 613     pub(crate) fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
 614         match v {
 615             Some("all") => {
 616                 *slot = Passes::All;
 617                 true
 618             }
 619             v => {
 620                 let mut passes = vec![];
 621                 if parse_list(&mut passes, v) {
 622                     slot.extend(passes);
 623                     true
 624                 } else {
 625                     false
 626                 }
 627             }
 628         }
 629     }
 630
 631     pub(crate) fn parse_opt_panic_strategy(
 632         slot: &mut Option<PanicStrategy>,
 633         v: Option<&str>,
 634     ) -> bool {
 635         match v {
 636             Some("unwind") => *slot = Some(PanicStrategy::Unwind),
 637             Some("abort") => *slot = Some(PanicStrategy::Abort),
 638             _ => return false,
 639         }
 640         true
 641     }
 642
 643     pub(crate) fn parse_panic_strategy(slot: &mut PanicStrategy, v: Option<&str>) -> bool {
 644         match v {
 645             Some("unwind") => *slot = PanicStrategy::Unwind,
 646             Some("abort") => *slot = PanicStrategy::Abort,
 647             _ => return false,
 648         }
 649         true
 650     }
 651
 652     pub(crate) fn parse_oom_strategy(slot: &mut OomStrategy, v: Option<&str>) -> bool {
 653         match v {
 654             Some("panic") => *slot = OomStrategy::Panic,
 655             Some("abort") => *slot = OomStrategy::Abort,
 656             _ => return false,
 657         }
 658         true
 659     }
 660
 661     pub(crate) fn parse_relro_level(slot: &mut Option<RelroLevel>, v: Option<&str>) -> bool {
 662         match v {
 663             Some(s) => match s.parse::<RelroLevel>() {
 664                 Ok(level) => *slot = Some(level),
 665                 _ => return false,
 666             },
 667             _ => return false,
 668         }
 669         true
 670     }
 671
 672     pub(crate) fn parse_sanitizers(slot: &mut SanitizerSet, v: Option<&str>) -> bool {
 673         if let Some(v) = v {
 674             for s in v.split(',') {
 675                 *slot |= match s {
 676                     "address" => SanitizerSet::ADDRESS,
 677                     "cfi" => SanitizerSet::CFI,
 678                     "kcfi" => SanitizerSet::KCFI,
 679                     "leak" => SanitizerSet::LEAK,
 680                     "memory" => SanitizerSet::MEMORY,
 681                     "memtag" => SanitizerSet::MEMTAG,
 682                     "shadow-call-stack" => SanitizerSet::SHADOWCALLSTACK,
 683                     "thread" => SanitizerSet::THREAD,
 684                     "hwaddress" => SanitizerSet::HWADDRESS,
 685                     _ => return false,
 686                 }
 687             }
 688             true
 689         } else {
 690             false
 691         }
 692     }
 693
 694     pub(crate) fn parse_sanitizer_memory_track_origins(slot: &mut usize, v: Option<&str>) -> bool {
 695         match v {
 696             Some("2") | None => {
 697                 *slot = 2;
 698                 true
 699             }
 700             Some("1") => {
 701                 *slot = 1;
 702                 true
 703             }
 704             Some("0") => {
 705                 *slot = 0;
 706                 true
 707             }
 708             Some(_) => false,
 709         }
 710     }
 711
 712     pub(crate) fn parse_strip(slot: &mut Strip, v: Option<&str>) -> bool {
 713         match v {
 714             Some("none") => *slot = Strip::None,
 715             Some("debuginfo") => *slot = Strip::Debuginfo,
 716             Some("symbols") => *slot = Strip::Symbols,
 717             _ => return false,
 718         }
 719         true
 720     }
 721
 722     pub(crate) fn parse_cfguard(slot: &mut CFGuard, v: Option<&str>) -> bool {
 723         if v.is_some() {
 724             let mut bool_arg = None;
 725             if parse_opt_bool(&mut bool_arg, v) {
 726                 *slot = if bool_arg.unwrap() { CFGuard::Checks } else { CFGuard::Disabled };
 727                 return true;
 728             }
 729         }
 730
 731         *slot = match v {
 732             None => CFGuard::Checks,
 733             Some("checks") => CFGuard::Checks,
 734             Some("nochecks") => CFGuard::NoChecks,
 735             Some(_) => return false,
 736         };
 737         true
 738     }
 739
 740     pub(crate) fn parse_cfprotection(slot: &mut CFProtection, v: Option<&str>) -> bool {
 741         if v.is_some() {
 742             let mut bool_arg = None;
 743             if parse_opt_bool(&mut bool_arg, v) {
 744                 *slot = if bool_arg.unwrap() { CFProtection::Full } else { CFProtection::None };
 745                 return true;
 746             }
 747         }
 748
 749         *slot = match v {
 750             None | Some("none") => CFProtection::None,
 751             Some("branch") => CFProtection::Branch,
 752             Some("return") => CFProtection::Return,
 753             Some("full") => CFProtection::Full,
 754             Some(_) => return false,
 755         };
 756         true
 757     }
 758
 759     pub(crate) fn parse_linker_flavor(slot: &mut Option<LinkerFlavorCli>, v: Option<&str>) -> bool {
 760         match v.and_then(LinkerFlavorCli::from_str) {
 761             Some(lf) => *slot = Some(lf),
 762             _ => return false,
 763         }
 764         true
 765     }
 766
 767     pub(crate) fn parse_optimization_fuel(
 768         slot: &mut Option<(String, u64)>,
 769         v: Option<&str>,
 770     ) -> bool {
 771         match v {
 772             None => false,
 773             Some(s) => {
 774                 let parts = s.split('=').collect::<Vec<_>>();
 775                 if parts.len() != 2 {
 776                     return false;
 777                 }
 778                 let crate_name = parts[0].to_string();
 779                 let fuel = parts[1].parse::<u64>();
 780                 if fuel.is_err() {
 781                     return false;
 782                 }
 783                 *slot = Some((crate_name, fuel.unwrap()));
 784                 true
 785             }
 786         }
 787     }
 788
 789     pub(crate) fn parse_unpretty(slot: &mut Option<String>, v: Option<&str>) -> bool {
 790         match v {
 791             None => false,
 792             Some(s) if s.split('=').count() <= 2 => {
 793                 *slot = Some(s.to_string());
 794                 true
 795             }
 796             _ => false,
 797         }
 798     }
 799
 800     pub(crate) fn parse_mir_spanview(slot: &mut Option<MirSpanview>, v: Option<&str>) -> bool {
 801         if v.is_some() {
 802             let mut bool_arg = None;
 803             if parse_opt_bool(&mut bool_arg, v) {
 804                 *slot = if bool_arg.unwrap() { Some(MirSpanview::Statement) } else { None };
 805                 return true;
 806             }
 807         }
 808
 809         let Some(v) = v else {
 810             *slot = Some(MirSpanview::Statement);
 811             return true;
 812         };
 813
 814         *slot = Some(match v.trim_end_matches('s') {
 815             "statement" | "stmt" => MirSpanview::Statement,
 816             "terminator" | "term" => MirSpanview::Terminator,
 817             "block" | "basicblock" => MirSpanview::Block,
 818             _ => return false,
 819         });
 820         true
 821     }
 822
 823     pub(crate) fn parse_instrument_coverage(
 824         slot: &mut Option<InstrumentCoverage>,
 825         v: Option<&str>,
 826     ) -> bool {
 827         if v.is_some() {
 828             let mut bool_arg = None;
 829             if parse_opt_bool(&mut bool_arg, v) {
 830                 *slot = if bool_arg.unwrap() { Some(InstrumentCoverage::All) } else { None };
 831                 return true;
 832             }
 833         }
 834
 835         let Some(v) = v else {
 836             *slot = Some(InstrumentCoverage::All);
 837             return true;
 838         };
 839
 840         *slot = Some(match v {
 841             "all" => InstrumentCoverage::All,
 842             "except-unused-generics" | "except_unused_generics" => {
 843                 InstrumentCoverage::ExceptUnusedGenerics
 844             }
 845             "except-unused-functions" | "except_unused_functions" => {
 846                 InstrumentCoverage::ExceptUnusedFunctions
 847             }
 848             "off" | "no" | "n" | "false" | "0" => InstrumentCoverage::Off,
 849             _ => return false,
 850         });
 851         true
 852     }
 853
 854     pub(crate) fn parse_treat_err_as_bug(slot: &mut Option<NonZeroUsize>, v: Option<&str>) -> bool {
 855         match v {
 856             Some(s) => {
 857                 *slot = s.parse().ok();
 858                 slot.is_some()
 859             }
 860             None => {
 861                 *slot = NonZeroUsize::new(1);
 862                 true
 863             }
 864         }
 865     }
 866
 867     pub(crate) fn parse_lto(slot: &mut LtoCli, v: Option<&str>) -> bool {
 868         if v.is_some() {
 869             let mut bool_arg = None;
 870             if parse_opt_bool(&mut bool_arg, v) {
 871                 *slot = if bool_arg.unwrap() { LtoCli::Yes } else { LtoCli::No };
 872                 return true;
 873             }
 874         }
 875
 876         *slot = match v {
 877             None => LtoCli::NoParam,
 878             Some("thin") => LtoCli::Thin,
 879             Some("fat") => LtoCli::Fat,
 880             Some(_) => return false,
 881         };
 882         true
 883     }
 884
 885     pub(crate) fn parse_linker_plugin_lto(slot: &mut LinkerPluginLto, v: Option<&str>) -> bool {
 886         if v.is_some() {
 887             let mut bool_arg = None;
 888             if parse_opt_bool(&mut bool_arg, v) {
 889                 *slot = if bool_arg.unwrap() {
 890                     LinkerPluginLto::LinkerPluginAuto
 891                 } else {
 892                     LinkerPluginLto::Disabled
 893                 };
 894                 return true;
 895             }
 896         }
 897
 898         *slot = match v {
 899             None => LinkerPluginLto::LinkerPluginAuto,
 900             Some(path) => LinkerPluginLto::LinkerPlugin(PathBuf::from(path)),
 901         };
 902         true
 903     }
 904
 905     pub(crate) fn parse_switch_with_opt_path(
 906         slot: &mut SwitchWithOptPath,
 907         v: Option<&str>,
 908     ) -> bool {
 909         *slot = match v {
 910             None => SwitchWithOptPath::Enabled(None),
 911             Some(path) => SwitchWithOptPath::Enabled(Some(PathBuf::from(path))),
 912         };
 913         true
 914     }
 915
 916     pub(crate) fn parse_merge_functions(
 917         slot: &mut Option<MergeFunctions>,
 918         v: Option<&str>,
 919     ) -> bool {
 920         match v.and_then(|s| MergeFunctions::from_str(s).ok()) {
 921             Some(mergefunc) => *slot = Some(mergefunc),
 922             _ => return false,
 923         }
 924         true
 925     }
 926
 927     pub(crate) fn parse_relocation_model(slot: &mut Option<RelocModel>, v: Option<&str>) -> bool {
 928         match v.and_then(|s| RelocModel::from_str(s).ok()) {
 929             Some(relocation_model) => *slot = Some(relocation_model),
 930             None if v == Some("default") => *slot = None,
 931             _ => return false,
 932         }
 933         true
 934     }
 935
 936     pub(crate) fn parse_code_model(slot: &mut Option<CodeModel>, v: Option<&str>) -> bool {
 937         match v.and_then(|s| CodeModel::from_str(s).ok()) {
 938             Some(code_model) => *slot = Some(code_model),
 939             _ => return false,
 940         }
 941         true
 942     }
 943
 944     pub(crate) fn parse_tls_model(slot: &mut Option<TlsModel>, v: Option<&str>) -> bool {
 945         match v.and_then(|s| TlsModel::from_str(s).ok()) {
 946             Some(tls_model) => *slot = Some(tls_model),
 947             _ => return false,
 948         }
 949         true
 950     }
 951
 952     pub(crate) fn parse_symbol_mangling_version(
 953         slot: &mut Option<SymbolManglingVersion>,
 954         v: Option<&str>,
 955     ) -> bool {
 956         *slot = match v {
 957             Some("legacy") => Some(SymbolManglingVersion::Legacy),
 958             Some("v0") => Some(SymbolManglingVersion::V0),
 959             _ => return false,
 960         };
 961         true
 962     }
 963
 964     pub(crate) fn parse_src_file_hash(
 965         slot: &mut Option<SourceFileHashAlgorithm>,
 966         v: Option<&str>,
 967     ) -> bool {
 968         match v.and_then(|s| SourceFileHashAlgorithm::from_str(s).ok()) {
 969             Some(hash_kind) => *slot = Some(hash_kind),
 970             _ => return false,
 971         }
 972         true
 973     }
 974
 975     pub(crate) fn parse_target_feature(slot: &mut String, v: Option<&str>) -> bool {
 976         match v {
 977             Some(s) => {
 978                 if !slot.is_empty() {
 979                     slot.push(',');
 980                 }
 981                 slot.push_str(s);
 982                 true
 983             }
 984             None => false,
 985         }
 986     }
 987
 988     pub(crate) fn parse_wasi_exec_model(slot: &mut Option<WasiExecModel>, v: Option<&str>) -> bool {
 989         match v {
 990             Some("command") => *slot = Some(WasiExecModel::Command),
 991             Some("reactor") => *slot = Some(WasiExecModel::Reactor),
 992             _ => return false,
 993         }
 994         true
 995     }
 996
 997     pub(crate) fn parse_split_debuginfo(
 998         slot: &mut Option<SplitDebuginfo>,
 999         v: Option<&str>,
1000     ) -> bool {
1001         match v.and_then(|s| SplitDebuginfo::from_str(s).ok()) {
1002             Some(e) => *slot = Some(e),
1003             _ => return false,
1004         }
1005         true
1006     }
1007
1008     pub(crate) fn parse_split_dwarf_kind(slot: &mut SplitDwarfKind, v: Option<&str>) -> bool {
1009         match v.and_then(|s| SplitDwarfKind::from_str(s).ok()) {
1010             Some(e) => *slot = e,
1011             _ => return false,
1012         }
1013         true
1014     }
1015
1016     pub(crate) fn parse_gcc_ld(slot: &mut Option<LdImpl>, v: Option<&str>) -> bool {
1017         match v {
1018             None => *slot = None,
1019             Some("lld") => *slot = Some(LdImpl::Lld),
1020             _ => return false,
1021         }
1022         true
1023     }
1024
1025     pub(crate) fn parse_stack_protector(slot: &mut StackProtector, v: Option<&str>) -> bool {
1026         match v.and_then(|s| StackProtector::from_str(s).ok()) {
1027             Some(ssp) => *slot = ssp,
1028             _ => return false,
1029         }
1030         true
1031     }
1032
1033     pub(crate) fn parse_branch_protection(
1034         slot: &mut Option<BranchProtection>,
1035         v: Option<&str>,
1036     ) -> bool {
1037         match v {
1038             Some(s) => {
1039                 let slot = slot.get_or_insert_default();
1040                 for opt in s.split(',') {
1041                     match opt {
1042                         "bti" => slot.bti = true,
1043                         "pac-ret" if slot.pac_ret.is_none() => {
1044                             slot.pac_ret = Some(PacRet { leaf: false, key: PAuthKey::A })
1045                         }
1046                         "leaf" => match slot.pac_ret.as_mut() {
1047                             Some(pac) => pac.leaf = true,
1048                             _ => return false,
1049                         },
1050                         "b-key" => match slot.pac_ret.as_mut() {
1051                             Some(pac) => pac.key = PAuthKey::B,
1052                             _ => return false,
1053                         },
1054                         _ => return false,
1055                     };
1056                 }
1057             }
1058             _ => return false,
1059         }
1060         true
1061     }
1062
1063     pub(crate) fn parse_proc_macro_execution_strategy(
1064         slot: &mut ProcMacroExecutionStrategy,
1065         v: Option<&str>,
1066     ) -> bool {
1067         *slot = match v {
1068             Some("same-thread") => ProcMacroExecutionStrategy::SameThread,
1069             Some("cross-thread") => ProcMacroExecutionStrategy::CrossThread,
1070             _ => return false,
1071         };
1072         true
1073     }
1074 }
1075
1076 options! {
1077     CodegenOptions, CG_OPTIONS, cgopts, "C", "codegen",
1078
1079     // If you add a new option, please update:
1080     // - compiler/rustc_interface/src/tests.rs
1081     // - src/doc/rustc/src/codegen-options/index.md
1082
1083     // tidy-alphabetical-start
1084     ar: String = (String::new(), parse_string, [UNTRACKED],
1085         "this option is deprecated and does nothing"),
1086     #[rustc_lint_opt_deny_field_access("use `Session::code_model` instead of this field")]
1087     code_model: Option<CodeModel> = (None, parse_code_model, [TRACKED],
1088         "choose the code model to use (`rustc --print code-models` for details)"),
1089     codegen_units: Option<usize> = (None, parse_opt_number, [UNTRACKED],
1090         "divide crate into N units to optimize in parallel"),
1091     control_flow_guard: CFGuard = (CFGuard::Disabled, parse_cfguard, [TRACKED],
1092         "use Windows Control Flow Guard (default: no)"),
1093     debug_assertions: Option<bool> = (None, parse_opt_bool, [TRACKED],
1094         "explicitly enable the `cfg(debug_assertions)` directive"),
1095     debuginfo: usize = (0, parse_number, [TRACKED],
1096         "debug info emission level (0 = no debug info, 1 = line tables only, \
1097         2 = full debug info with variable and type information; default: 0)"),
1098     default_linker_libraries: bool = (false, parse_bool, [UNTRACKED],
1099         "allow the linker to link its default libraries (default: no)"),
1100     embed_bitcode: bool = (true, parse_bool, [TRACKED],
1101         "emit bitcode in rlibs (default: yes)"),
1102     extra_filename: String = (String::new(), parse_string, [UNTRACKED],
1103         "extra data to put in each output filename"),
1104     force_frame_pointers: Option<bool> = (None, parse_opt_bool, [TRACKED],
1105         "force use of the frame pointers"),
1106     #[rustc_lint_opt_deny_field_access("use `Session::must_emit_unwind_tables` instead of this field")]
1107     force_unwind_tables: Option<bool> = (None, parse_opt_bool, [TRACKED],
1108         "force use of unwind tables"),
1109     incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
1110         "enable incremental compilation"),
1111     inline_threshold: Option<u32> = (None, parse_opt_number, [TRACKED],
1112         "set the threshold for inlining a function"),
1113     #[rustc_lint_opt_deny_field_access("use `Session::instrument_coverage` instead of this field")]
1114     instrument_coverage: Option<InstrumentCoverage> = (None, parse_instrument_coverage, [TRACKED],
1115         "instrument the generated code to support LLVM source-based code coverage \
1116         reports (note, the compiler build config must include `profiler = true`); \
1117         implies `-C symbol-mangling-version=v0`. Optional values are:
1118         `=all` (implicit value)
1119         `=except-unused-generics`
1120         `=except-unused-functions`
1121         `=off` (default)"),
1122     link_arg: (/* redirected to link_args */) = ((), parse_string_push, [UNTRACKED],
1123         "a single extra argument to append to the linker invocation (can be used several times)"),
1124     link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
1125         "extra arguments to append to the linker invocation (space separated)"),
1126     #[rustc_lint_opt_deny_field_access("use `Session::link_dead_code` instead of this field")]
1127     link_dead_code: Option<bool> = (None, parse_opt_bool, [TRACKED],
1128         "keep dead code at link time (useful for code coverage) (default: no)"),
1129     link_self_contained: Option<bool> = (None, parse_opt_bool, [UNTRACKED],
1130         "control whether to link Rust provided C objects/libraries or rely
1131         on C toolchain installed in the system"),
1132     linker: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1133         "system linker to link outputs with"),
1134     linker_flavor: Option<LinkerFlavorCli> = (None, parse_linker_flavor, [UNTRACKED],
1135         "linker flavor"),
1136     linker_plugin_lto: LinkerPluginLto = (LinkerPluginLto::Disabled,
1137         parse_linker_plugin_lto, [TRACKED],
1138         "generate build artifacts that are compatible with linker-based LTO"),
1139     llvm_args: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1140         "a list of arguments to pass to LLVM (space separated)"),
1141     #[rustc_lint_opt_deny_field_access("use `Session::lto` instead of this field")]
1142     lto: LtoCli = (LtoCli::Unspecified, parse_lto, [TRACKED],
1143         "perform LLVM link-time optimizations"),
1144     metadata: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1145         "metadata to mangle symbol names with"),
1146     no_prepopulate_passes: bool = (false, parse_no_flag, [TRACKED],
1147         "give an empty list of passes to the pass manager"),
1148     no_redzone: Option<bool> = (None, parse_opt_bool, [TRACKED],
1149         "disable the use of the redzone"),
1150     no_stack_check: bool = (false, parse_no_flag, [UNTRACKED],
1151         "this option is deprecated and does nothing"),
1152     no_vectorize_loops: bool = (false, parse_no_flag, [TRACKED],
1153         "disable loop vectorization optimization passes"),
1154     no_vectorize_slp: bool = (false, parse_no_flag, [TRACKED],
1155         "disable LLVM's SLP vectorization pass"),
1156     opt_level: String = ("0".to_string(), parse_string, [TRACKED],
1157         "optimization level (0-3, s, or z; default: 0)"),
1158     #[rustc_lint_opt_deny_field_access("use `Session::overflow_checks` instead of this field")]
1159     overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1160         "use overflow checks for integer arithmetic"),
1161     #[rustc_lint_opt_deny_field_access("use `Session::panic_strategy` instead of this field")]
1162     panic: Option<PanicStrategy> = (None, parse_opt_panic_strategy, [TRACKED],
1163         "panic strategy to compile crate with"),
1164     passes: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1165         "a list of extra LLVM passes to run (space separated)"),
1166     prefer_dynamic: bool = (false, parse_bool, [TRACKED],
1167         "prefer dynamic linking to static linking (default: no)"),
1168     profile_generate: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1169         parse_switch_with_opt_path, [TRACKED],
1170         "compile the program with profiling instrumentation"),
1171     profile_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1172         "use the given `.profdata` file for profile-guided optimization"),
1173     #[rustc_lint_opt_deny_field_access("use `Session::relocation_model` instead of this field")]
1174     relocation_model: Option<RelocModel> = (None, parse_relocation_model, [TRACKED],
1175         "control generation of position-independent code (PIC) \
1176         (`rustc --print relocation-models` for details)"),
1177     remark: Passes = (Passes::Some(Vec::new()), parse_passes, [UNTRACKED],
1178         "print remarks for these optimization passes (space separated, or \"all\")"),
1179     rpath: bool = (false, parse_bool, [UNTRACKED],
1180         "set rpath values in libs/exes (default: no)"),
1181     save_temps: bool = (false, parse_bool, [UNTRACKED],
1182         "save all temporary output files during compilation (default: no)"),
1183     soft_float: bool = (false, parse_bool, [TRACKED],
1184         "use soft float ABI (*eabihf targets only) (default: no)"),
1185     #[rustc_lint_opt_deny_field_access("use `Session::split_debuginfo` instead of this field")]
1186     split_debuginfo: Option<SplitDebuginfo> = (None, parse_split_debuginfo, [TRACKED],
1187         "how to handle split-debuginfo, a platform-specific option"),
1188     strip: Strip = (Strip::None, parse_strip, [UNTRACKED],
1189         "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1190     symbol_mangling_version: Option<SymbolManglingVersion> = (None,
1191         parse_symbol_mangling_version, [TRACKED],
1192         "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1193     target_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1194         "select target processor (`rustc --print target-cpus` for details)"),
1195     target_feature: String = (String::new(), parse_target_feature, [TRACKED],
1196         "target specific attributes. (`rustc --print target-features` for details). \
1197         This feature is unsafe."),
1198     // tidy-alphabetical-end
1199
1200     // If you add a new option, please update:
1201     // - compiler/rustc_interface/src/tests.rs
1202     // - src/doc/rustc/src/codegen-options/index.md
1203 }
1204
1205 options! {
1206     UnstableOptions, Z_OPTIONS, dbopts, "Z", "unstable",
1207
1208     // If you add a new option, please update:
1209     // - compiler/rustc_interface/src/tests.rs
1210     // - src/doc/unstable-book/src/compiler-flags
1211
1212     // tidy-alphabetical-start
1213     allow_features: Option<Vec<String>> = (None, parse_opt_comma_list, [TRACKED],
1214         "only allow the listed language features to be enabled in code (space separated)"),
1215     always_encode_mir: bool = (false, parse_bool, [TRACKED],
1216         "encode MIR of all functions into the crate metadata (default: no)"),
1217     asm_comments: bool = (false, parse_bool, [TRACKED],
1218         "generate comments into the assembly (may change behavior) (default: no)"),
1219     assert_incr_state: Option<String> = (None, parse_opt_string, [UNTRACKED],
1220         "assert that the incremental cache is in given state: \
1221          either `loaded` or `not-loaded`."),
1222     assume_incomplete_release: bool = (false, parse_bool, [TRACKED],
1223         "make cfg(version) treat the current version as incomplete (default: no)"),
1224     #[rustc_lint_opt_deny_field_access("use `Session::binary_dep_depinfo` instead of this field")]
1225     binary_dep_depinfo: bool = (false, parse_bool, [TRACKED],
1226         "include artifacts (sysroot, crate dependencies) used during compilation in dep-info \
1227         (default: no)"),
1228     box_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1229         "emit noalias metadata for box (default: yes)"),
1230     branch_protection: Option<BranchProtection> = (None, parse_branch_protection, [TRACKED],
1231         "set options for branch target identification and pointer authentication on AArch64"),
1232     cf_protection: CFProtection = (CFProtection::None, parse_cfprotection, [TRACKED],
1233         "instrument control-flow architecture protection"),
1234     cgu_partitioning_strategy: Option<String> = (None, parse_opt_string, [TRACKED],
1235         "the codegen unit partitioning strategy to use"),
1236     chalk: bool = (false, parse_bool, [TRACKED],
1237         "enable the experimental Chalk-based trait solving engine"),
1238     codegen_backend: Option<String> = (None, parse_opt_string, [TRACKED],
1239         "the backend to use"),
1240     combine_cgu: bool = (false, parse_bool, [TRACKED],
1241         "combine CGUs into a single one"),
1242     crate_attr: Vec<String> = (Vec::new(), parse_string_push, [TRACKED],
1243         "inject the given attribute in the crate"),
1244     debug_info_for_profiling: bool = (false, parse_bool, [TRACKED],
1245         "emit discriminators and other data necessary for AutoFDO"),
1246     debug_macros: bool = (false, parse_bool, [TRACKED],
1247         "emit line numbers debug info inside macros (default: no)"),
1248     deduplicate_diagnostics: bool = (true, parse_bool, [UNTRACKED],
1249         "deduplicate identical diagnostics (default: yes)"),
1250     dep_info_omit_d_target: bool = (false, parse_bool, [TRACKED],
1251         "in dep-info output, omit targets for tracking dependencies of the dep-info files \
1252         themselves (default: no)"),
1253     dep_tasks: bool = (false, parse_bool, [UNTRACKED],
1254         "print tasks that execute and the color their dep node gets (requires debug build) \
1255         (default: no)"),
1256     diagnostic_width: Option<usize> = (None, parse_opt_number, [UNTRACKED],
1257         "set the current output width for diagnostic truncation"),
1258     dlltool: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1259         "import library generation tool (windows-gnu only)"),
1260     dont_buffer_diagnostics: bool = (false, parse_bool, [UNTRACKED],
1261         "emit diagnostics rather than buffering (breaks NLL error downgrading, sorting) \
1262         (default: no)"),
1263     drop_tracking: bool = (false, parse_bool, [TRACKED],
1264         "enables drop tracking in generators (default: no)"),
1265     dual_proc_macros: bool = (false, parse_bool, [TRACKED],
1266         "load proc macros for both target and host, but only link to the target (default: no)"),
1267     dump_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1268         "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv) \
1269         (default: no)"),
1270     dump_drop_tracking_cfg: Option<String> = (None, parse_opt_string, [UNTRACKED],
1271         "dump drop-tracking control-flow graph as a `.dot` file (default: no)"),
1272     dump_mir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1273         "dump MIR state to file.
1274         `val` is used to select which passes and functions to dump. For example:
1275         `all` matches all passes and functions,
1276         `foo` matches all passes for functions whose name contains 'foo',
1277         `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
1278         `foo | bar` all passes for function names containing 'foo' or 'bar'."),
1279     dump_mir_dataflow: bool = (false, parse_bool, [UNTRACKED],
1280         "in addition to `.mir` files, create graphviz `.dot` files with dataflow results \
1281         (default: no)"),
1282     dump_mir_dir: String = ("mir_dump".to_string(), parse_string, [UNTRACKED],
1283         "the directory the MIR is dumped into (default: `mir_dump`)"),
1284     dump_mir_exclude_pass_number: bool = (false, parse_bool, [UNTRACKED],
1285         "exclude the pass number when dumping MIR (used in tests) (default: no)"),
1286     dump_mir_graphviz: bool = (false, parse_bool, [UNTRACKED],
1287         "in addition to `.mir` files, create graphviz `.dot` files (and with \
1288         `-Z instrument-coverage`, also create a `.dot` file for the MIR-derived \
1289         coverage graph) (default: no)"),
1290     dump_mir_spanview: Option<MirSpanview> = (None, parse_mir_spanview, [UNTRACKED],
1291         "in addition to `.mir` files, create `.html` files to view spans for \
1292         all `statement`s (including terminators), only `terminator` spans, or \
1293         computed `block` spans (one span encompassing a block's terminator and \
1294         all statements). If `-Z instrument-coverage` is also enabled, create \
1295         an additional `.html` file showing the computed coverage spans."),
1296     dump_mono_stats: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1297         parse_switch_with_opt_path, [UNTRACKED],
1298         "output statistics about monomorphization collection (format: markdown)"),
1299     dwarf_version: Option<u32> = (None, parse_opt_number, [TRACKED],
1300         "version of DWARF debug information to emit (default: 2 or 4, depending on platform)"),
1301     dylib_lto: bool = (false, parse_bool, [UNTRACKED],
1302         "enables LTO for dylib crate type"),
1303     emit_stack_sizes: bool = (false, parse_bool, [UNTRACKED],
1304         "emit a section containing stack size metadata (default: no)"),
1305     emit_thin_lto: bool = (true, parse_bool, [TRACKED],
1306         "emit the bc module with thin LTO info (default: yes)"),
1307     export_executable_symbols: bool = (false, parse_bool, [TRACKED],
1308         "export symbols from executables, as if they were dynamic libraries"),
1309     extra_const_ub_checks: bool = (false, parse_bool, [TRACKED],
1310         "turns on more checks to detect const UB, which can be slow (default: no)"),
1311     #[rustc_lint_opt_deny_field_access("use `Session::fewer_names` instead of this field")]
1312     fewer_names: Option<bool> = (None, parse_opt_bool, [TRACKED],
1313         "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR) \
1314         (default: no)"),
1315     force_unstable_if_unmarked: bool = (false, parse_bool, [TRACKED],
1316         "force all crates to be `rustc_private` unstable (default: no)"),
1317     fuel: Option<(String, u64)> = (None, parse_optimization_fuel, [TRACKED],
1318         "set the optimization fuel quota for a crate"),
1319     function_sections: Option<bool> = (None, parse_opt_bool, [TRACKED],
1320         "whether each function should go in its own section"),
1321     future_incompat_test: bool = (false, parse_bool, [UNTRACKED],
1322         "forces all lints to be future incompatible, used for internal testing (default: no)"),
1323     gcc_ld: Option<LdImpl> = (None, parse_gcc_ld, [TRACKED], "implementation of ld used by cc"),
1324     graphviz_dark_mode: bool = (false, parse_bool, [UNTRACKED],
1325         "use dark-themed colors in graphviz output (default: no)"),
1326     graphviz_font: String = ("Courier, monospace".to_string(), parse_string, [UNTRACKED],
1327         "use the given `fontname` in graphviz output; can be overridden by setting \
1328         environment variable `RUSTC_GRAPHVIZ_FONT` (default: `Courier, monospace`)"),
1329     hir_stats: bool = (false, parse_bool, [UNTRACKED],
1330         "print some statistics about AST and HIR (default: no)"),
1331     human_readable_cgu_names: bool = (false, parse_bool, [TRACKED],
1332         "generate human-readable, predictable names for codegen units (default: no)"),
1333     identify_regions: bool = (false, parse_bool, [UNTRACKED],
1334         "display unnamed regions as `'<id>`, using a non-ident unique id (default: no)"),
1335     incremental_ignore_spans: bool = (false, parse_bool, [UNTRACKED],
1336         "ignore spans during ICH computation -- used for testing (default: no)"),
1337     incremental_info: bool = (false, parse_bool, [UNTRACKED],
1338         "print high-level information about incremental reuse (or the lack thereof) \
1339         (default: no)"),
1340     incremental_relative_spans: bool = (false, parse_bool, [TRACKED],
1341         "hash spans relative to their parent item for incr. comp. (default: no)"),
1342     incremental_verify_ich: bool = (false, parse_bool, [UNTRACKED],
1343         "verify incr. comp. hashes of green query instances (default: no)"),
1344     inline_in_all_cgus: Option<bool> = (None, parse_opt_bool, [TRACKED],
1345         "control whether `#[inline]` functions are in all CGUs"),
1346     inline_llvm: bool = (true, parse_bool, [TRACKED],
1347         "enable LLVM inlining (default: yes)"),
1348     inline_mir: Option<bool> = (None, parse_opt_bool, [TRACKED],
1349         "enable MIR inlining (default: no)"),
1350     inline_mir_hint_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1351         "inlining threshold for functions with inline hint (default: 100)"),
1352     inline_mir_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1353         "a default MIR inlining threshold (default: 50)"),
1354     input_stats: bool = (false, parse_bool, [UNTRACKED],
1355         "gather statistics about the input (default: no)"),
1356     #[rustc_lint_opt_deny_field_access("use `Session::instrument_coverage` instead of this field")]
1357     instrument_coverage: Option<InstrumentCoverage> = (None, parse_instrument_coverage, [TRACKED],
1358         "instrument the generated code to support LLVM source-based code coverage \
1359         reports (note, the compiler build config must include `profiler = true`); \
1360         implies `-C symbol-mangling-version=v0`. Optional values are:
1361         `=all` (implicit value)
1362         `=except-unused-generics`
1363         `=except-unused-functions`
1364         `=off` (default)"),
1365     instrument_mcount: bool = (false, parse_bool, [TRACKED],
1366         "insert function instrument code for mcount-based tracing (default: no)"),
1367     keep_hygiene_data: bool = (false, parse_bool, [UNTRACKED],
1368         "keep hygiene data after analysis (default: no)"),
1369     layout_seed: Option<u64> = (None, parse_opt_number, [TRACKED],
1370         "seed layout randomization"),
1371     link_native_libraries: bool = (true, parse_bool, [UNTRACKED],
1372         "link native libraries in the linker invocation (default: yes)"),
1373     link_only: bool = (false, parse_bool, [TRACKED],
1374         "link the `.rlink` file generated by `-Z no-link` (default: no)"),
1375     llvm_plugins: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1376         "a list LLVM plugins to enable (space separated)"),
1377     llvm_time_trace: bool = (false, parse_bool, [UNTRACKED],
1378         "generate JSON tracing data file from LLVM data (default: no)"),
1379     location_detail: LocationDetail = (LocationDetail::all(), parse_location_detail, [TRACKED],
1380         "what location details should be tracked when using caller_location, either \
1381         `none`, or a comma separated list of location details, for which \
1382         valid options are `file`, `line`, and `column` (default: `file,line,column`)"),
1383     ls: bool = (false, parse_bool, [UNTRACKED],
1384         "list the symbols defined by a library crate (default: no)"),
1385     macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1386         "show macro backtraces (default: no)"),
1387     maximal_hir_to_mir_coverage: bool = (false, parse_bool, [TRACKED],
1388         "save as much information as possible about the correspondence between MIR and HIR \
1389         as source scopes (default: no)"),
1390     merge_functions: Option<MergeFunctions> = (None, parse_merge_functions, [TRACKED],
1391         "control the operation of the MergeFunctions LLVM pass, taking \
1392         the same values as the target option of the same name"),
1393     meta_stats: bool = (false, parse_bool, [UNTRACKED],
1394         "gather metadata statistics (default: no)"),
1395     mir_emit_retag: bool = (false, parse_bool, [TRACKED],
1396         "emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0 \
1397         (default: no)"),
1398     mir_enable_passes: Vec<(String, bool)> = (Vec::new(), parse_list_with_polarity, [TRACKED],
1399         "use like `-Zmir-enable-passes=+DestProp,-InstCombine`. Forces the specified passes to be \
1400         enabled, overriding all other checks. Passes that are not specified are enabled or \
1401         disabled by other flags as usual."),
1402     #[rustc_lint_opt_deny_field_access("use `Session::mir_opt_level` instead of this field")]
1403     mir_opt_level: Option<usize> = (None, parse_opt_number, [TRACKED],
1404         "MIR optimization level (0-4; default: 1 in non optimized builds and 2 in optimized builds)"),
1405     mir_pretty_relative_line_numbers: bool = (false, parse_bool, [UNTRACKED],
1406         "use line numbers relative to the function in mir pretty printing"),
1407     move_size_limit: Option<usize> = (None, parse_opt_number, [TRACKED],
1408         "the size at which the `large_assignments` lint starts to be emitted"),
1409     mutable_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1410         "emit noalias metadata for mutable references (default: yes)"),
1411     nll_facts: bool = (false, parse_bool, [UNTRACKED],
1412         "dump facts from NLL analysis into side files (default: no)"),
1413     nll_facts_dir: String = ("nll-facts".to_string(), parse_string, [UNTRACKED],
1414         "the directory the NLL facts are dumped into (default: `nll-facts`)"),
1415     no_analysis: bool = (false, parse_no_flag, [UNTRACKED],
1416         "parse and expand the source, but run no analysis"),
1417     no_codegen: bool = (false, parse_no_flag, [TRACKED_NO_CRATE_HASH],
1418         "run all passes except codegen; no output"),
1419     no_generate_arange_section: bool = (false, parse_no_flag, [TRACKED],
1420         "omit DWARF address ranges that give faster lookups"),
1421     no_jump_tables: bool = (false, parse_no_flag, [TRACKED],
1422         "disable the jump tables and lookup tables that can be generated from a switch case lowering"),
1423     no_leak_check: bool = (false, parse_no_flag, [UNTRACKED],
1424         "disable the 'leak check' for subtyping; unsound, but useful for tests"),
1425     no_link: bool = (false, parse_no_flag, [TRACKED],
1426         "compile without linking"),
1427     no_parallel_llvm: bool = (false, parse_no_flag, [UNTRACKED],
1428         "run LLVM in non-parallel mode (while keeping codegen-units and ThinLTO)"),
1429     no_profiler_runtime: bool = (false, parse_no_flag, [TRACKED],
1430         "prevent automatic injection of the profiler_builtins crate"),
1431     no_unique_section_names: bool = (false, parse_bool, [TRACKED],
1432         "do not use unique names for text and data sections when -Z function-sections is used"),
1433     normalize_docs: bool = (false, parse_bool, [TRACKED],
1434         "normalize associated items in rustdoc when generating documentation"),
1435     oom: OomStrategy = (OomStrategy::Abort, parse_oom_strategy, [TRACKED],
1436         "panic strategy for out-of-memory handling"),
1437     osx_rpath_install_name: bool = (false, parse_bool, [TRACKED],
1438         "pass `-install_name @rpath/...` to the macOS linker (default: no)"),
1439     packed_bundled_libs: bool = (false, parse_bool, [TRACKED],
1440         "change rlib format to store native libraries as archives"),
1441     panic_abort_tests: bool = (false, parse_bool, [TRACKED],
1442         "support compiling tests with panic=abort (default: no)"),
1443     panic_in_drop: PanicStrategy = (PanicStrategy::Unwind, parse_panic_strategy, [TRACKED],
1444         "panic strategy for panics in drops"),
1445     parse_only: bool = (false, parse_bool, [UNTRACKED],
1446         "parse only; do not compile, assemble, or link (default: no)"),
1447     perf_stats: bool = (false, parse_bool, [UNTRACKED],
1448         "print some performance-related statistics (default: no)"),
1449     pick_stable_methods_before_any_unstable: bool = (true, parse_bool, [TRACKED],
1450         "try to pick stable methods first before picking any unstable methods (default: yes)"),
1451     plt: Option<bool> = (None, parse_opt_bool, [TRACKED],
1452         "whether to use the PLT when calling into shared libraries;
1453         only has effect for PIC code on systems with ELF binaries
1454         (default: PLT is disabled if full relro is enabled)"),
1455     polonius: bool = (false, parse_bool, [TRACKED],
1456         "enable polonius-based borrow-checker (default: no)"),
1457     polymorphize: bool = (false, parse_bool, [TRACKED],
1458           "perform polymorphization analysis"),
1459     pre_link_arg: (/* redirected to pre_link_args */) = ((), parse_string_push, [UNTRACKED],
1460         "a single extra argument to prepend the linker invocation (can be used several times)"),
1461     pre_link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
1462         "extra arguments to prepend to the linker invocation (space separated)"),
1463     precise_enum_drop_elaboration: bool = (true, parse_bool, [TRACKED],
1464         "use a more precise version of drop elaboration for matches on enums (default: yes). \
1465         This results in better codegen, but has caused miscompilations on some tier 2 platforms. \
1466         See #77382 and #74551."),
1467     print_fuel: Option<String> = (None, parse_opt_string, [TRACKED],
1468         "make rustc print the total optimization fuel used by a crate"),
1469     print_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1470         "print the LLVM optimization passes being run (default: no)"),
1471     print_mono_items: Option<String> = (None, parse_opt_string, [UNTRACKED],
1472         "print the result of the monomorphization collection pass"),
1473     print_type_sizes: bool = (false, parse_bool, [UNTRACKED],
1474         "print layout information for each type encountered (default: no)"),
1475     proc_macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1476          "show backtraces for panics during proc-macro execution (default: no)"),
1477     proc_macro_execution_strategy: ProcMacroExecutionStrategy = (ProcMacroExecutionStrategy::SameThread,
1478         parse_proc_macro_execution_strategy, [UNTRACKED],
1479         "how to run proc-macro code (default: same-thread)"),
1480     profile: bool = (false, parse_bool, [TRACKED],
1481         "insert profiling code (default: no)"),
1482     profile_closures: bool = (false, parse_no_flag, [UNTRACKED],
1483         "profile size of closures"),
1484     profile_emit: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1485         "file path to emit profiling data at runtime when using 'profile' \
1486         (default based on relative source path)"),
1487     profile_sample_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1488         "use the given `.prof` file for sampled profile-guided optimization (also known as AutoFDO)"),
1489     profiler_runtime: String = (String::from("profiler_builtins"), parse_string, [TRACKED],
1490         "name of the profiler runtime crate to automatically inject (default: `profiler_builtins`)"),
1491     query_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1492         "enable queries of the dependency graph for regression testing (default: no)"),
1493     randomize_layout: bool = (false, parse_bool, [TRACKED],
1494         "randomize the layout of types (default: no)"),
1495     relax_elf_relocations: Option<bool> = (None, parse_opt_bool, [TRACKED],
1496         "whether ELF relocations can be relaxed"),
1497     relro_level: Option<RelroLevel> = (None, parse_relro_level, [TRACKED],
1498         "choose which RELRO level to use"),
1499     remap_cwd_prefix: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1500         "remap paths under the current working directory to this path prefix"),
1501     report_delayed_bugs: bool = (false, parse_bool, [TRACKED],
1502         "immediately print bugs registered with `delay_span_bug` (default: no)"),
1503     sanitizer: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
1504         "use a sanitizer"),
1505     sanitizer_memory_track_origins: usize = (0, parse_sanitizer_memory_track_origins, [TRACKED],
1506         "enable origins tracking in MemorySanitizer"),
1507     sanitizer_recover: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
1508         "enable recovery for selected sanitizers"),
1509     saturating_float_casts: Option<bool> = (None, parse_opt_bool, [TRACKED],
1510         "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
1511         the max/min integer respectively, and NaN is mapped to 0 (default: yes)"),
1512     save_analysis: bool = (false, parse_bool, [UNTRACKED],
1513         "write syntax and type analysis (in JSON format) information, in \
1514         addition to normal output (default: no)"),
1515     self_profile: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1516         parse_switch_with_opt_path, [UNTRACKED],
1517         "run the self profiler and output the raw event data"),
1518     self_profile_counter: String = ("wall-time".to_string(), parse_string, [UNTRACKED],
1519         "counter used by the self profiler (default: `wall-time`), one of:
1520         `wall-time` (monotonic clock, i.e. `std::time::Instant`)
1521         `instructions:u` (retired instructions, userspace-only)
1522         `instructions-minus-irqs:u` (subtracting hardware interrupt counts for extra accuracy)"
1523     ),
1524     /// keep this in sync with the event filter names in librustc_data_structures/profiling.rs
1525     self_profile_events: Option<Vec<String>> = (None, parse_opt_comma_list, [UNTRACKED],
1526         "specify the events recorded by the self profiler;
1527         for example: `-Z self-profile-events=default,query-keys`
1528         all options: none, all, default, generic-activity, query-provider, query-cache-hit
1529                      query-blocked, incr-cache-load, incr-result-hashing, query-keys, function-args, args, llvm, artifact-sizes"),
1530     share_generics: Option<bool> = (None, parse_opt_bool, [TRACKED],
1531         "make the current crate share its generic instantiations"),
1532     show_span: Option<String> = (None, parse_opt_string, [TRACKED],
1533         "show spans for compiler debugging (expr|pat|ty)"),
1534     simulate_remapped_rust_src_base: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1535         "simulate the effect of remap-debuginfo = true at bootstrapping by remapping path \
1536         to rust's source base directory. only meant for testing purposes"),
1537     span_debug: bool = (false, parse_bool, [UNTRACKED],
1538         "forward proc_macro::Span's `Debug` impl to `Span`"),
1539     /// o/w tests have closure@path
1540     span_free_formats: bool = (false, parse_bool, [UNTRACKED],
1541         "exclude spans when debug-printing compiler state (default: no)"),
1542     split_dwarf_inlining: bool = (true, parse_bool, [TRACKED],
1543         "provide minimal debug info in the object/executable to facilitate online \
1544          symbolication/stack traces in the absence of .dwo/.dwp files when using Split DWARF"),
1545     split_dwarf_kind: SplitDwarfKind = (SplitDwarfKind::Split, parse_split_dwarf_kind, [TRACKED],
1546         "split dwarf variant (only if -Csplit-debuginfo is enabled and on relevant platform)
1547         (default: `split`)
1548
1549         `split`: sections which do not require relocation are written into a DWARF object (`.dwo`)
1550                  file which is ignored by the linker
1551         `single`: sections which do not require relocation are written into object file but ignored
1552                   by the linker"),
1553     src_hash_algorithm: Option<SourceFileHashAlgorithm> = (None, parse_src_file_hash, [TRACKED],
1554         "hash algorithm of source files in debug info (`md5`, `sha1`, or `sha256`)"),
1555     #[rustc_lint_opt_deny_field_access("use `Session::stack_protector` instead of this field")]
1556     stack_protector: StackProtector = (StackProtector::None, parse_stack_protector, [TRACKED],
1557         "control stack smash protection strategy (`rustc --print stack-protector-strategies` for details)"),
1558     strict_init_checks: bool = (false, parse_bool, [TRACKED],
1559         "control if mem::uninitialized and mem::zeroed panic on more UB"),
1560     strip: Strip = (Strip::None, parse_strip, [UNTRACKED],
1561         "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1562     symbol_mangling_version: Option<SymbolManglingVersion> = (None,
1563         parse_symbol_mangling_version, [TRACKED],
1564         "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1565     #[rustc_lint_opt_deny_field_access("use `Session::teach` instead of this field")]
1566     teach: bool = (false, parse_bool, [TRACKED],
1567         "show extended diagnostic help (default: no)"),
1568     temps_dir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1569         "the directory the intermediate files are written to"),
1570     #[rustc_lint_opt_deny_field_access("use `Session::lto` instead of this field")]
1571     thinlto: Option<bool> = (None, parse_opt_bool, [TRACKED],
1572         "enable ThinLTO when possible"),
1573     thir_unsafeck: bool = (false, parse_bool, [TRACKED],
1574         "use the THIR unsafety checker (default: no)"),
1575     /// We default to 1 here since we want to behave like
1576     /// a sequential compiler for now. This'll likely be adjusted
1577     /// in the future. Note that -Zthreads=0 is the way to get
1578     /// the num_cpus behavior.
1579     #[rustc_lint_opt_deny_field_access("use `Session::threads` instead of this field")]
1580     threads: usize = (1, parse_threads, [UNTRACKED],
1581         "use a thread pool with N threads"),
1582     time_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1583         "measure time of each LLVM pass (default: no)"),
1584     time_passes: bool = (false, parse_bool, [UNTRACKED],
1585         "measure time of each rustc pass (default: no)"),
1586     #[rustc_lint_opt_deny_field_access("use `Session::tls_model` instead of this field")]
1587     tls_model: Option<TlsModel> = (None, parse_tls_model, [TRACKED],
1588         "choose the TLS model to use (`rustc --print tls-models` for details)"),
1589     trace_macros: bool = (false, parse_bool, [UNTRACKED],
1590         "for every macro invocation, print its name and arguments (default: no)"),
1591     track_diagnostics: bool = (false, parse_bool, [UNTRACKED],
1592         "tracks where in rustc a diagnostic was emitted"),
1593     // Diagnostics are considered side-effects of a query (see `QuerySideEffects`) and are saved
1594     // alongside query results and changes to translation options can affect diagnostics - so
1595     // translation options should be tracked.
1596     translate_additional_ftl: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1597         "additional fluent translation to preferentially use (for testing translation)"),
1598     translate_directionality_markers: bool = (false, parse_bool, [TRACKED],
1599         "emit directionality isolation markers in translated diagnostics"),
1600     translate_lang: Option<LanguageIdentifier> = (None, parse_opt_langid, [TRACKED],
1601         "language identifier for diagnostic output"),
1602     translate_remapped_path_to_local_path: bool = (true, parse_bool, [TRACKED],
1603         "translate remapped paths into local paths when possible (default: yes)"),
1604     trap_unreachable: Option<bool> = (None, parse_opt_bool, [TRACKED],
1605         "generate trap instructions for unreachable intrinsics (default: use target setting, usually yes)"),
1606     treat_err_as_bug: Option<NonZeroUsize> = (None, parse_treat_err_as_bug, [TRACKED],
1607         "treat error number `val` that occurs as bug"),
1608     trim_diagnostic_paths: bool = (true, parse_bool, [UNTRACKED],
1609         "in diagnostics, use heuristics to shorten paths referring to items"),
1610     tune_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1611         "select processor to schedule for (`rustc --print target-cpus` for details)"),
1612     ui_testing: bool = (false, parse_bool, [UNTRACKED],
1613         "emit compiler diagnostics in a form suitable for UI testing (default: no)"),
1614     uninit_const_chunk_threshold: usize = (16, parse_number, [TRACKED],
1615         "allow generating const initializers with mixed init/uninit chunks, \
1616         and set the maximum number of chunks for which this is allowed (default: 16)"),
1617     unleash_the_miri_inside_of_you: bool = (false, parse_bool, [TRACKED],
1618         "take the brakes off const evaluation. NOTE: this is unsound (default: no)"),
1619     unpretty: Option<String> = (None, parse_unpretty, [UNTRACKED],
1620         "present the input source, unstable (and less-pretty) variants;
1621         `normal`, `identified`,
1622         `expanded`, `expanded,identified`,
1623         `expanded,hygiene` (with internal representations),
1624         `ast-tree` (raw AST before expansion),
1625         `ast-tree,expanded` (raw AST after expansion),
1626         `hir` (the HIR), `hir,identified`,
1627         `hir,typed` (HIR with types for each node),
1628         `hir-tree` (dump the raw HIR),
1629         `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)"),
1630     unsound_mir_opts: bool = (false, parse_bool, [TRACKED],
1631         "enable unsound and buggy MIR optimizations (default: no)"),
1632     /// This name is kind of confusing: Most unstable options enable something themselves, while
1633     /// this just allows "normal" options to be feature-gated.
1634     #[rustc_lint_opt_deny_field_access("use `Session::unstable_options` instead of this field")]
1635     unstable_options: bool = (false, parse_bool, [UNTRACKED],
1636         "adds unstable command line options to rustc interface (default: no)"),
1637     use_ctors_section: Option<bool> = (None, parse_opt_bool, [TRACKED],
1638         "use legacy .ctors section for initializers rather than .init_array"),
1639     validate_mir: bool = (false, parse_bool, [UNTRACKED],
1640         "validate MIR after each transformation"),
1641     #[rustc_lint_opt_deny_field_access("use `Session::verbose` instead of this field")]
1642     verbose: bool = (false, parse_bool, [UNTRACKED],
1643         "in general, enable more debug printouts (default: no)"),
1644     #[rustc_lint_opt_deny_field_access("use `Session::verify_llvm_ir` instead of this field")]
1645     verify_llvm_ir: bool = (false, parse_bool, [TRACKED],
1646         "verify LLVM IR (default: no)"),
1647     virtual_function_elimination: bool = (false, parse_bool, [TRACKED],
1648         "enables dead virtual function elimination optimization. \
1649         Requires `-Clto[=[fat,yes]]`"),
1650     wasi_exec_model: Option<WasiExecModel> = (None, parse_wasi_exec_model, [TRACKED],
1651         "whether to build a wasi command or reactor"),
1652     // tidy-alphabetical-end
1653
1654     // If you add a new option, please update:
1655     // - compiler/rustc_interface/src/tests.rs
1656 }
1657
1658 #[derive(Clone, Hash, PartialEq, Eq, Debug)]
1659 pub enum WasiExecModel {
1660     Command,
1661     Reactor,
1662 }
1663
1664 #[derive(Clone, Copy, Hash)]
1665 pub enum LdImpl {
1666     Lld,
1667 }