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