3 use crate::early_error
;
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
,
13 use rustc_feature
::UnstableFeatures
;
14 use rustc_span
::edition
::Edition
;
15 use rustc_span
::RealFileName
;
16 use rustc_span
::SourceFileHashAlgorithm
;
18 use std
::collections
::BTreeMap
;
20 use std
::collections
::hash_map
::DefaultHasher
;
21 use std
::hash
::Hasher
;
22 use std
::num
::NonZeroUsize
;
23 use std
::path
::PathBuf
;
27 ($opt_name
:ident
, $opt_expr
:expr
, $sub_hashes
:expr
) => {
29 .insert(stringify
!($opt_name
), $opt_expr
as &dyn dep_tracking
::DepTrackingHash
)
32 panic
!("duplicate key in CLI DepTrackingHash: {}", stringify
!($opt_name
))
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
]) => {{
42 insert
!($opt_name
, $opt_expr
, $sub_hashes
)
45 ($opt_name
:ident
, $opt_expr
:expr
, $sub_hashes
:expr
, $_for_crate_hash
: ident
, [SUBSTRUCT
]) => {{}
};
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(
62 macro_rules
! top_level_options
{
63 ( $
( #[$top_level_attr:meta] )* pub struct Options { $(
65 $opt
:ident
: $t
:ty
[$dep_tracking_marker
:ident
],
68 $
( #[$top_level_attr] )*
77 pub fn dep_tracking_hash(&self, for_crate_hash
: bool
) -> u64 {
78 let mut sub_hashes
= BTreeMap
::new();
84 [$dep_tracking_marker
]);
86 let mut hasher
= DefaultHasher
::new();
87 dep_tracking
::stable_hash(sub_hashes
,
97 [$dep_tracking_marker
]);
106 pub fn mir_opt_level(&self) -> usize {
109 .unwrap_or_else(|| if self.optimize
!= OptLevel
::No { 2 }
else { 1 }
)
112 pub fn instrument_coverage(&self) -> bool
{
113 self.cg
.instrument_coverage
.unwrap_or(InstrumentCoverage
::Off
) != InstrumentCoverage
::Off
116 pub fn instrument_coverage_except_unused_generics(&self) -> bool
{
117 self.cg
.instrument_coverage
.unwrap_or(InstrumentCoverage
::Off
)
118 == InstrumentCoverage
::ExceptUnusedGenerics
121 pub fn instrument_coverage_except_unused_functions(&self) -> bool
{
122 self.cg
.instrument_coverage
.unwrap_or(InstrumentCoverage
::Off
)
123 == InstrumentCoverage
::ExceptUnusedFunctions
128 /// The top-level command-line options struct.
130 /// For each option, one has to specify how it behaves with regard to the
131 /// dependency tracking system of incremental compilation. This is done via the
132 /// square-bracketed directive after the field type. The options are:
135 /// A change in the given field will cause the compiler to completely clear the
136 /// incremental compilation cache before proceeding.
138 /// - `[TRACKED_NO_CRATE_HASH]`
139 /// Same as `[TRACKED]`, but will not affect the crate hash. This is useful for options that only
140 /// affect the incremental cache.
143 /// Incremental compilation is not influenced by this option.
146 /// Second-level sub-structs containing more options.
148 /// If you add a new option to this struct or one of the sub-structs like
149 /// `CodegenOptions`, think about how it influences incremental compilation. If in
150 /// doubt, specify `[TRACKED]`, which is always "correct" but might lead to
151 /// unnecessary re-compilation.
153 /// The crate config requested for the session, which may be combined
154 /// with additional crate configurations during the compile process.
155 crate_types
: Vec
<CrateType
> [TRACKED
],
156 optimize
: OptLevel
[TRACKED
],
157 /// Include the `debug_assertions` flag in dependency tracking, since it
158 /// can influence whether overflow checks are done or not.
159 debug_assertions
: bool
[TRACKED
],
160 debuginfo
: DebugInfo
[TRACKED
],
161 lint_opts
: Vec
<(String
, lint
::Level
)> [TRACKED_NO_CRATE_HASH
],
162 lint_cap
: Option
<lint
::Level
> [TRACKED_NO_CRATE_HASH
],
163 describe_lints
: bool
[UNTRACKED
],
164 output_types
: OutputTypes
[TRACKED
],
165 search_paths
: Vec
<SearchPath
> [UNTRACKED
],
166 libs
: Vec
<NativeLib
> [TRACKED
],
167 maybe_sysroot
: Option
<PathBuf
> [UNTRACKED
],
169 target_triple
: TargetTriple
[TRACKED
],
171 test
: bool
[TRACKED
],
172 error_format
: ErrorOutputType
[UNTRACKED
],
174 /// If `Some`, enable incremental compilation, using the given
175 /// directory to store intermediate results.
176 incremental
: Option
<PathBuf
> [UNTRACKED
],
177 assert_incr_state
: Option
<IncrementalStateAssertion
> [UNTRACKED
],
179 debugging_opts
: DebuggingOptions
[SUBSTRUCT
],
180 prints
: Vec
<PrintRequest
> [UNTRACKED
],
181 /// Determines which borrow checker(s) to run. This is the parsed, sanitized
182 /// version of `debugging_opts.borrowck`, which is just a plain string.
183 borrowck_mode
: BorrowckMode
[UNTRACKED
],
184 cg
: CodegenOptions
[SUBSTRUCT
],
185 externs
: Externs
[UNTRACKED
],
186 crate_name
: Option
<String
> [TRACKED
],
187 /// Indicates how the compiler should treat unstable features.
188 unstable_features
: UnstableFeatures
[TRACKED
],
190 /// Indicates whether this run of the compiler is actually rustdoc. This
191 /// is currently just a hack and will be removed eventually, so please
192 /// try to not rely on this too much.
193 actually_rustdoc
: bool
[TRACKED
],
195 /// Control path trimming.
196 trimmed_def_paths
: TrimmedDefPaths
[TRACKED
],
198 /// Specifications of codegen units / ThinLTO which are forced as a
199 /// result of parsing command line options. These are not necessarily
200 /// what rustc was invoked with, but massaged a bit to agree with
201 /// commands like `--emit llvm-ir` which they're often incompatible with
202 /// if we otherwise use the defaults of rustc.
203 cli_forced_codegen_units
: Option
<usize> [UNTRACKED
],
204 cli_forced_thinlto_off
: bool
[UNTRACKED
],
206 /// Remap source path prefixes in all output (messages, object files, debug, etc.).
207 remap_path_prefix
: Vec
<(PathBuf
, PathBuf
)> [TRACKED_NO_CRATE_HASH
],
208 /// Base directory containing the `src/` for the Rust standard library, and
209 /// potentially `rustc` as well, if we can can find it. Right now it's always
210 /// `$sysroot/lib/rustlib/src/rust` (i.e. the `rustup` `rust-src` component).
212 /// This directory is what the virtual `/rustc/$hash` is translated back to,
213 /// if Rust was built with path remapping to `/rustc/$hash` enabled
214 /// (the `rust.remap-debuginfo` option in `config.toml`).
215 real_rust_source_base_dir
: Option
<PathBuf
> [TRACKED_NO_CRATE_HASH
],
217 edition
: Edition
[TRACKED
],
219 /// `true` if we're emitting JSON blobs about each artifact produced
221 json_artifact_notifications
: bool
[TRACKED
],
223 /// `true` if we're emitting a JSON blob containing the unused externs
224 json_unused_externs
: JsonUnusedExterns
[UNTRACKED
],
226 /// `true` if we're emitting a JSON job containing a future-incompat report for lints
227 json_future_incompat
: bool
[TRACKED
],
229 pretty
: Option
<PpMode
> [UNTRACKED
],
231 /// The (potentially remapped) working directory
232 working_dir
: RealFileName
[TRACKED
],
236 /// Defines all `CodegenOptions`/`DebuggingOptions` fields and parsers all at once. The goal of this
237 /// macro is to define an interface that can be programmatically used by the option parser
238 /// to initialize the struct without hardcoding field names all over the place.
240 /// The goal is to invoke this macro once with the correct fields, and then this macro generates all
241 /// necessary code. The main gotcha of this macro is the `cgsetters` module which is a bunch of
242 /// generated code to parse an option into its respective field in the struct. There are a few
243 /// hand-written parsers for parsing specific types of values in this module.
244 macro_rules
! options
{
245 ($struct_name
:ident
, $stat
:ident
, $optmod
:ident
, $prefix
:expr
, $outputname
:expr
,
246 $
($
( #[$attr:meta] )* $opt:ident : $t:ty = (
249 [$dep_tracking_marker
:ident
],
254 pub struct $struct_name { $(pub $opt: $t),* }
256 impl Default
for $struct_name
{
257 fn default() -> $struct_name
{
258 $struct_name { $( $( #[$attr] )* $opt: $init),* }
264 matches
: &getopts
::Matches
,
265 error_format
: ErrorOutputType
,
267 build_options(matches
, $stat
, $prefix
, $outputname
, error_format
)
270 fn dep_tracking_hash(&self, for_crate_hash
: bool
, error_format
: ErrorOutputType
) -> u64 {
271 let mut sub_hashes
= BTreeMap
::new();
277 [$dep_tracking_marker
]);
279 let mut hasher
= DefaultHasher
::new();
280 dep_tracking
::stable_hash(sub_hashes
,
289 pub const $stat
: OptionDescrs
<$struct_name
> =
290 &[ $
( (stringify
!($opt
), $optmod
::$opt
, desc
::$parse
, $desc
) ),* ];
294 pub(super) fn $
opt(cg
: &mut super::$struct_name
, v
: Option
<&str>) -> bool
{
295 super::parse
::$
parse(&mut redirect_field
!(cg
.$opt
), v
)
302 // Sometimes different options need to build a common structure.
303 // That structure can be kept in one of the options' fields, the others become dummy.
304 macro_rules
! redirect_field
{
305 ($cg
:ident
.link_arg
) => {
308 ($cg
:ident
.pre_link_arg
) => {
311 ($cg
:ident
.$field
:ident
) => {
316 type OptionSetter
<O
> = fn(&mut O
, v
: Option
<&str>) -> bool
;
317 type OptionDescrs
<O
> = &'
static [(&'
static str, OptionSetter
<O
>, &'
static str, &'
static str)];
319 fn build_options
<O
: Default
>(
320 matches
: &getopts
::Matches
,
321 descrs
: OptionDescrs
<O
>,
324 error_format
: ErrorOutputType
,
326 let mut op
= O
::default();
327 for option
in matches
.opt_strs(prefix
) {
328 let (key
, value
) = match option
.split_once('
='
) {
329 None
=> (option
, None
),
330 Some((k
, v
)) => (k
.to_string(), Some(v
)),
333 let option_to_lookup
= key
.replace('
-'
, "_");
334 match descrs
.iter().find(|(name
, ..)| *name
== option_to_lookup
) {
335 Some((_
, setter
, type_desc
, _
)) => {
336 if !setter(&mut op
, value
) {
341 "{0} option `{1}` requires {2} ({3} {1}=<value>)",
342 outputname
, key
, type_desc
, prefix
345 Some(value
) => early_error(
348 "incorrect value `{value}` for {outputname} option `{key}` - {type_desc} was expected"
354 None
=> early_error(error_format
, &format
!("unknown {outputname} option: `{key}`")),
360 #[allow(non_upper_case_globals)]
362 pub const parse_no_flag
: &str = "no value";
363 pub const parse_bool
: &str = "one of: `y`, `yes`, `on`, `n`, `no`, or `off`";
364 pub const parse_opt_bool
: &str = parse_bool
;
365 pub const parse_string
: &str = "a string";
366 pub const parse_opt_string
: &str = parse_string
;
367 pub const parse_string_push
: &str = parse_string
;
368 pub const parse_opt_langid
: &str = "a language identifier";
369 pub const parse_opt_pathbuf
: &str = "a path";
370 pub const parse_list
: &str = "a space-separated list of strings";
371 pub const parse_list_with_polarity
: &str =
372 "a comma-separated list of strings, with elements beginning with + or -";
373 pub const parse_opt_comma_list
: &str = "a comma-separated list of strings";
374 pub const parse_number
: &str = "a number";
375 pub const parse_opt_number
: &str = parse_number
;
376 pub const parse_threads
: &str = parse_number
;
377 pub const parse_passes
: &str = "a space-separated list of passes, or `all`";
378 pub const parse_panic_strategy
: &str = "either `unwind` or `abort`";
379 pub const parse_opt_panic_strategy
: &str = parse_panic_strategy
;
380 pub const parse_oom_strategy
: &str = "either `panic` or `abort`";
381 pub const parse_relro_level
: &str = "one of: `full`, `partial`, or `off`";
382 pub const parse_sanitizers
: &str = "comma separated list of sanitizers: `address`, `cfi`, `hwaddress`, `leak`, `memory`, `memtag`, or `thread`";
383 pub const parse_sanitizer_memory_track_origins
: &str = "0, 1, or 2";
384 pub const parse_cfguard
: &str =
385 "either a boolean (`yes`, `no`, `on`, `off`, etc), `checks`, or `nochecks`";
386 pub const parse_cfprotection
: &str = "`none`|`no`|`n` (default), `branch`, `return`, or `full`|`yes`|`y` (equivalent to `branch` and `return`)";
387 pub const parse_strip
: &str = "either `none`, `debuginfo`, or `symbols`";
388 pub const parse_linker_flavor
: &str = ::rustc_target
::spec
::LinkerFlavor
::one_of();
389 pub const parse_optimization_fuel
: &str = "crate=integer";
390 pub const parse_mir_spanview
: &str = "`statement` (default), `terminator`, or `block`";
391 pub const parse_instrument_coverage
: &str =
392 "`all` (default), `except-unused-generics`, `except-unused-functions`, or `off`";
393 pub const parse_unpretty
: &str = "`string` or `string=string`";
394 pub const parse_treat_err_as_bug
: &str = "either no value or a number bigger than 0";
395 pub const parse_lto
: &str =
396 "either a boolean (`yes`, `no`, `on`, `off`, etc), `thin`, `fat`, or omitted";
397 pub const parse_linker_plugin_lto
: &str =
398 "either a boolean (`yes`, `no`, `on`, `off`, etc), or the path to the linker plugin";
399 pub const parse_location_detail
: &str =
400 "comma separated list of location details to track: `file`, `line`, or `column`";
401 pub const parse_switch_with_opt_path
: &str =
402 "an optional path to the profiling data output directory";
403 pub const parse_merge_functions
: &str = "one of: `disabled`, `trampolines`, or `aliases`";
404 pub const parse_symbol_mangling_version
: &str = "either `legacy` or `v0` (RFC 2603)";
405 pub const parse_src_file_hash
: &str = "either `md5` or `sha1`";
406 pub const parse_relocation_model
: &str =
407 "one of supported relocation models (`rustc --print relocation-models`)";
408 pub const parse_code_model
: &str = "one of supported code models (`rustc --print code-models`)";
409 pub const parse_tls_model
: &str = "one of supported TLS models (`rustc --print tls-models`)";
410 pub const parse_target_feature
: &str = parse_string
;
411 pub const parse_wasi_exec_model
: &str = "either `command` or `reactor`";
412 pub const parse_split_debuginfo
: &str =
413 "one of supported split-debuginfo modes (`off`, `packed`, or `unpacked`)";
414 pub const parse_split_dwarf_kind
: &str =
415 "one of supported split dwarf modes (`split` or `single`)";
416 pub const parse_gcc_ld
: &str = "one of: no value, `lld`";
417 pub const parse_stack_protector
: &str =
418 "one of (`none` (default), `basic`, `strong`, or `all`)";
419 pub const parse_branch_protection
: &str =
420 "a `,` separated combination of `bti`, `b-key`, `pac-ret`, or `leaf`";
425 use std
::str::FromStr
;
427 /// This is for boolean options that don't take a value and start with
428 /// `no-`. This style of option is deprecated.
429 crate fn parse_no_flag(slot
: &mut bool
, v
: Option
<&str>) -> bool
{
439 /// Use this for any boolean option that has a static default.
440 crate fn parse_bool(slot
: &mut bool
, v
: Option
<&str>) -> bool
{
442 Some("y") | Some("yes") | Some("on") | None
=> {
446 Some("n") | Some("no") | Some("off") => {
454 /// Use this for any boolean option that lacks a static default. (The
455 /// actions taken when such an option is not specified will depend on
456 /// other factors, such as other options, or target options.)
457 crate fn parse_opt_bool(slot
: &mut Option
<bool
>, v
: Option
<&str>) -> bool
{
459 Some("y") | Some("yes") | Some("on") | None
=> {
463 Some("n") | Some("no") | Some("off") => {
471 /// Use this for any string option that has a static default.
472 crate fn parse_string(slot
: &mut String
, v
: Option
<&str>) -> bool
{
475 *slot
= s
.to_string();
482 /// Use this for any string option that lacks a static default.
483 crate fn parse_opt_string(slot
: &mut Option
<String
>, v
: Option
<&str>) -> bool
{
486 *slot
= Some(s
.to_string());
493 /// Parse an optional language identifier, e.g. `en-US` or `zh-CN`.
494 crate fn parse_opt_langid(slot
: &mut Option
<LanguageIdentifier
>, v
: Option
<&str>) -> bool
{
497 *slot
= rustc_errors
::LanguageIdentifier
::from_str(s
).ok();
504 crate fn parse_opt_pathbuf(slot
: &mut Option
<PathBuf
>, v
: Option
<&str>) -> bool
{
507 *slot
= Some(PathBuf
::from(s
));
514 crate fn parse_string_push(slot
: &mut Vec
<String
>, v
: Option
<&str>) -> bool
{
517 slot
.push(s
.to_string());
524 crate fn parse_list(slot
: &mut Vec
<String
>, v
: Option
<&str>) -> bool
{
527 slot
.extend(s
.split_whitespace().map(|s
| s
.to_string()));
534 crate fn parse_list_with_polarity(slot
: &mut Vec
<(String
, bool
)>, v
: Option
<&str>) -> bool
{
537 for s
in s
.split(",") {
538 let Some(pass_name
) = s
.strip_prefix(&['
+'
, '
-'
][..]) else { return false }
;
539 slot
.push((pass_name
.to_string(), &s
[..1] == "+"));
547 crate fn parse_location_detail(ld
: &mut LocationDetail
, v
: Option
<&str>) -> bool
{
552 for s
in v
.split('
,'
) {
554 "file" => ld
.file
= true,
555 "line" => ld
.line
= true,
556 "column" => ld
.column
= true,
566 crate fn parse_opt_comma_list(slot
: &mut Option
<Vec
<String
>>, v
: Option
<&str>) -> bool
{
569 let mut v
: Vec
<_
> = s
.split('
,'
).map(|s
| s
.to_string()).collect();
578 crate fn parse_threads(slot
: &mut usize, v
: Option
<&str>) -> bool
{
579 match v
.and_then(|s
| s
.parse().ok()) {
581 *slot
= ::num_cpus
::get();
592 /// Use this for any numeric option that has a static default.
593 crate fn parse_number
<T
: Copy
+ FromStr
>(slot
: &mut T
, v
: Option
<&str>) -> bool
{
594 match v
.and_then(|s
| s
.parse().ok()) {
603 /// Use this for any numeric option that lacks a static default.
604 crate fn parse_opt_number
<T
: Copy
+ FromStr
>(slot
: &mut Option
<T
>, v
: Option
<&str>) -> bool
{
607 *slot
= s
.parse().ok();
614 crate fn parse_passes(slot
: &mut Passes
, v
: Option
<&str>) -> bool
{
621 let mut passes
= vec
![];
622 if parse_list(&mut passes
, v
) {
632 crate fn parse_opt_panic_strategy(slot
: &mut Option
<PanicStrategy
>, v
: Option
<&str>) -> bool
{
634 Some("unwind") => *slot
= Some(PanicStrategy
::Unwind
),
635 Some("abort") => *slot
= Some(PanicStrategy
::Abort
),
641 crate fn parse_panic_strategy(slot
: &mut PanicStrategy
, v
: Option
<&str>) -> bool
{
643 Some("unwind") => *slot
= PanicStrategy
::Unwind
,
644 Some("abort") => *slot
= PanicStrategy
::Abort
,
650 crate fn parse_oom_strategy(slot
: &mut OomStrategy
, v
: Option
<&str>) -> bool
{
652 Some("panic") => *slot
= OomStrategy
::Panic
,
653 Some("abort") => *slot
= OomStrategy
::Abort
,
659 crate fn parse_relro_level(slot
: &mut Option
<RelroLevel
>, v
: Option
<&str>) -> bool
{
661 Some(s
) => match s
.parse
::<RelroLevel
>() {
662 Ok(level
) => *slot
= Some(level
),
670 crate fn parse_sanitizers(slot
: &mut SanitizerSet
, v
: Option
<&str>) -> bool
{
672 for s
in v
.split('
,'
) {
674 "address" => SanitizerSet
::ADDRESS
,
675 "cfi" => SanitizerSet
::CFI
,
676 "leak" => SanitizerSet
::LEAK
,
677 "memory" => SanitizerSet
::MEMORY
,
678 "memtag" => SanitizerSet
::MEMTAG
,
679 "thread" => SanitizerSet
::THREAD
,
680 "hwaddress" => SanitizerSet
::HWADDRESS
,
690 crate fn parse_sanitizer_memory_track_origins(slot
: &mut usize, v
: Option
<&str>) -> bool
{
692 Some("2") | None
=> {
708 crate fn parse_strip(slot
: &mut Strip
, v
: Option
<&str>) -> bool
{
710 Some("none") => *slot
= Strip
::None
,
711 Some("debuginfo") => *slot
= Strip
::Debuginfo
,
712 Some("symbols") => *slot
= Strip
::Symbols
,
718 crate fn parse_cfguard(slot
: &mut CFGuard
, v
: Option
<&str>) -> bool
{
720 let mut bool_arg
= None
;
721 if parse_opt_bool(&mut bool_arg
, v
) {
722 *slot
= if bool_arg
.unwrap() { CFGuard::Checks }
else { CFGuard::Disabled }
;
728 None
=> CFGuard
::Checks
,
729 Some("checks") => CFGuard
::Checks
,
730 Some("nochecks") => CFGuard
::NoChecks
,
731 Some(_
) => return false,
736 crate fn parse_cfprotection(slot
: &mut CFProtection
, v
: Option
<&str>) -> bool
{
738 let mut bool_arg
= None
;
739 if parse_opt_bool(&mut bool_arg
, v
) {
740 *slot
= if bool_arg
.unwrap() { CFProtection::Full }
else { CFProtection::None }
;
746 None
| Some("none") => CFProtection
::None
,
747 Some("branch") => CFProtection
::Branch
,
748 Some("return") => CFProtection
::Return
,
749 Some("full") => CFProtection
::Full
,
750 Some(_
) => return false,
755 crate fn parse_linker_flavor(slot
: &mut Option
<LinkerFlavor
>, v
: Option
<&str>) -> bool
{
756 match v
.and_then(LinkerFlavor
::from_str
) {
757 Some(lf
) => *slot
= Some(lf
),
763 crate fn parse_optimization_fuel(slot
: &mut Option
<(String
, u64)>, v
: Option
<&str>) -> bool
{
767 let parts
= s
.split('
='
).collect
::<Vec
<_
>>();
768 if parts
.len() != 2 {
771 let crate_name
= parts
[0].to_string();
772 let fuel
= parts
[1].parse
::<u64>();
776 *slot
= Some((crate_name
, fuel
.unwrap()));
782 crate fn parse_unpretty(slot
: &mut Option
<String
>, v
: Option
<&str>) -> bool
{
785 Some(s
) if s
.split('
='
).count() <= 2 => {
786 *slot
= Some(s
.to_string());
793 crate fn parse_mir_spanview(slot
: &mut Option
<MirSpanview
>, v
: Option
<&str>) -> bool
{
795 let mut bool_arg
= None
;
796 if parse_opt_bool(&mut bool_arg
, v
) {
797 *slot
= if bool_arg
.unwrap() { Some(MirSpanview::Statement) }
else { None }
;
802 let Some(v
) = v
else {
803 *slot
= Some(MirSpanview
::Statement
);
807 *slot
= Some(match v
.trim_end_matches('s'
) {
808 "statement" | "stmt" => MirSpanview
::Statement
,
809 "terminator" | "term" => MirSpanview
::Terminator
,
810 "block" | "basicblock" => MirSpanview
::Block
,
816 crate fn parse_instrument_coverage(
817 slot
: &mut Option
<InstrumentCoverage
>,
821 let mut bool_arg
= None
;
822 if parse_opt_bool(&mut bool_arg
, v
) {
823 *slot
= if bool_arg
.unwrap() { Some(InstrumentCoverage::All) }
else { None }
;
828 let Some(v
) = v
else {
829 *slot
= Some(InstrumentCoverage
::All
);
833 *slot
= Some(match v
{
834 "all" => InstrumentCoverage
::All
,
835 "except-unused-generics" | "except_unused_generics" => {
836 InstrumentCoverage
::ExceptUnusedGenerics
838 "except-unused-functions" | "except_unused_functions" => {
839 InstrumentCoverage
::ExceptUnusedFunctions
841 "off" | "no" | "n" | "false" | "0" => InstrumentCoverage
::Off
,
847 crate fn parse_treat_err_as_bug(slot
: &mut Option
<NonZeroUsize
>, v
: Option
<&str>) -> bool
{
850 *slot
= s
.parse().ok();
854 *slot
= NonZeroUsize
::new(1);
860 crate fn parse_lto(slot
: &mut LtoCli
, v
: Option
<&str>) -> bool
{
862 let mut bool_arg
= None
;
863 if parse_opt_bool(&mut bool_arg
, v
) {
864 *slot
= if bool_arg
.unwrap() { LtoCli::Yes }
else { LtoCli::No }
;
870 None
=> LtoCli
::NoParam
,
871 Some("thin") => LtoCli
::Thin
,
872 Some("fat") => LtoCli
::Fat
,
873 Some(_
) => return false,
878 crate fn parse_linker_plugin_lto(slot
: &mut LinkerPluginLto
, v
: Option
<&str>) -> bool
{
880 let mut bool_arg
= None
;
881 if parse_opt_bool(&mut bool_arg
, v
) {
882 *slot
= if bool_arg
.unwrap() {
883 LinkerPluginLto
::LinkerPluginAuto
885 LinkerPluginLto
::Disabled
892 None
=> LinkerPluginLto
::LinkerPluginAuto
,
893 Some(path
) => LinkerPluginLto
::LinkerPlugin(PathBuf
::from(path
)),
898 crate fn parse_switch_with_opt_path(slot
: &mut SwitchWithOptPath
, v
: Option
<&str>) -> bool
{
900 None
=> SwitchWithOptPath
::Enabled(None
),
901 Some(path
) => SwitchWithOptPath
::Enabled(Some(PathBuf
::from(path
))),
906 crate fn parse_merge_functions(slot
: &mut Option
<MergeFunctions
>, v
: Option
<&str>) -> bool
{
907 match v
.and_then(|s
| MergeFunctions
::from_str(s
).ok()) {
908 Some(mergefunc
) => *slot
= Some(mergefunc
),
914 crate fn parse_relocation_model(slot
: &mut Option
<RelocModel
>, v
: Option
<&str>) -> bool
{
915 match v
.and_then(|s
| RelocModel
::from_str(s
).ok()) {
916 Some(relocation_model
) => *slot
= Some(relocation_model
),
917 None
if v
== Some("default") => *slot
= None
,
923 crate fn parse_code_model(slot
: &mut Option
<CodeModel
>, v
: Option
<&str>) -> bool
{
924 match v
.and_then(|s
| CodeModel
::from_str(s
).ok()) {
925 Some(code_model
) => *slot
= Some(code_model
),
931 crate fn parse_tls_model(slot
: &mut Option
<TlsModel
>, v
: Option
<&str>) -> bool
{
932 match v
.and_then(|s
| TlsModel
::from_str(s
).ok()) {
933 Some(tls_model
) => *slot
= Some(tls_model
),
939 crate fn parse_symbol_mangling_version(
940 slot
: &mut Option
<SymbolManglingVersion
>,
944 Some("legacy") => Some(SymbolManglingVersion
::Legacy
),
945 Some("v0") => Some(SymbolManglingVersion
::V0
),
951 crate fn parse_src_file_hash(
952 slot
: &mut Option
<SourceFileHashAlgorithm
>,
955 match v
.and_then(|s
| SourceFileHashAlgorithm
::from_str(s
).ok()) {
956 Some(hash_kind
) => *slot
= Some(hash_kind
),
962 crate fn parse_target_feature(slot
: &mut String
, v
: Option
<&str>) -> bool
{
965 if !slot
.is_empty() {
975 crate fn parse_wasi_exec_model(slot
: &mut Option
<WasiExecModel
>, v
: Option
<&str>) -> bool
{
977 Some("command") => *slot
= Some(WasiExecModel
::Command
),
978 Some("reactor") => *slot
= Some(WasiExecModel
::Reactor
),
984 crate fn parse_split_debuginfo(slot
: &mut Option
<SplitDebuginfo
>, v
: Option
<&str>) -> bool
{
985 match v
.and_then(|s
| SplitDebuginfo
::from_str(s
).ok()) {
986 Some(e
) => *slot
= Some(e
),
992 crate fn parse_split_dwarf_kind(slot
: &mut SplitDwarfKind
, v
: Option
<&str>) -> bool
{
993 match v
.and_then(|s
| SplitDwarfKind
::from_str(s
).ok()) {
994 Some(e
) => *slot
= e
,
1000 crate fn parse_gcc_ld(slot
: &mut Option
<LdImpl
>, v
: Option
<&str>) -> bool
{
1002 None
=> *slot
= None
,
1003 Some("lld") => *slot
= Some(LdImpl
::Lld
),
1009 crate fn parse_stack_protector(slot
: &mut StackProtector
, v
: Option
<&str>) -> bool
{
1010 match v
.and_then(|s
| StackProtector
::from_str(s
).ok()) {
1011 Some(ssp
) => *slot
= ssp
,
1017 crate fn parse_branch_protection(slot
: &mut Option
<BranchProtection
>, v
: Option
<&str>) -> bool
{
1020 let slot
= slot
.get_or_insert_default();
1021 for opt
in s
.split('
,'
) {
1023 "bti" => slot
.bti
= true,
1024 "pac-ret" if slot
.pac_ret
.is_none() => {
1025 slot
.pac_ret
= Some(PacRet { leaf: false, key: PAuthKey::A }
)
1027 "leaf" => match slot
.pac_ret
.as_mut() {
1028 Some(pac
) => pac
.leaf
= true,
1031 "b-key" => match slot
.pac_ret
.as_mut() {
1032 Some(pac
) => pac
.key
= PAuthKey
::B
,
1046 CodegenOptions
, CG_OPTIONS
, cgopts
, "C", "codegen",
1048 // This list is in alphabetical order.
1050 // If you add a new option, please update:
1051 // - compiler/rustc_interface/src/tests.rs
1052 // - src/doc/rustc/src/codegen-options/index.md
1054 ar
: String
= (String
::new(), parse_string
, [UNTRACKED
],
1055 "this option is deprecated and does nothing"),
1056 code_model
: Option
<CodeModel
> = (None
, parse_code_model
, [TRACKED
],
1057 "choose the code model to use (`rustc --print code-models` for details)"),
1058 codegen_units
: Option
<usize> = (None
, parse_opt_number
, [UNTRACKED
],
1059 "divide crate into N units to optimize in parallel"),
1060 control_flow_guard
: CFGuard
= (CFGuard
::Disabled
, parse_cfguard
, [TRACKED
],
1061 "use Windows Control Flow Guard (default: no)"),
1062 debug_assertions
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1063 "explicitly enable the `cfg(debug_assertions)` directive"),
1064 debuginfo
: usize = (0, parse_number
, [TRACKED
],
1065 "debug info emission level (0 = no debug info, 1 = line tables only, \
1066 2 = full debug info with variable and type information; default: 0)"),
1067 default_linker_libraries
: bool
= (false, parse_bool
, [UNTRACKED
],
1068 "allow the linker to link its default libraries (default: no)"),
1069 embed_bitcode
: bool
= (true, parse_bool
, [TRACKED
],
1070 "emit bitcode in rlibs (default: yes)"),
1071 extra_filename
: String
= (String
::new(), parse_string
, [UNTRACKED
],
1072 "extra data to put in each output filename"),
1073 force_frame_pointers
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1074 "force use of the frame pointers"),
1075 force_unwind_tables
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1076 "force use of unwind tables"),
1077 incremental
: Option
<String
> = (None
, parse_opt_string
, [UNTRACKED
],
1078 "enable incremental compilation"),
1079 inline_threshold
: Option
<u32> = (None
, parse_opt_number
, [TRACKED
],
1080 "set the threshold for inlining a function"),
1081 instrument_coverage
: Option
<InstrumentCoverage
> = (None
, parse_instrument_coverage
, [TRACKED
],
1082 "instrument the generated code to support LLVM source-based code coverage \
1083 reports (note, the compiler build config must include `profiler = true`); \
1084 implies `-C symbol-mangling-version=v0`. Optional values are:
1085 `=all` (implicit value)
1086 `=except-unused-generics`
1087 `=except-unused-functions`
1089 link_arg
: (/* redirected to link_args */) = ((), parse_string_push
, [UNTRACKED
],
1090 "a single extra argument to append to the linker invocation (can be used several times)"),
1091 link_args
: Vec
<String
> = (Vec
::new(), parse_list
, [UNTRACKED
],
1092 "extra arguments to append to the linker invocation (space separated)"),
1093 link_dead_code
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1094 "keep dead code at link time (useful for code coverage) (default: no)"),
1095 link_self_contained
: Option
<bool
> = (None
, parse_opt_bool
, [UNTRACKED
],
1096 "control whether to link Rust provided C objects/libraries or rely
1097 on C toolchain installed in the system"),
1098 linker
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [UNTRACKED
],
1099 "system linker to link outputs with"),
1100 linker_flavor
: Option
<LinkerFlavor
> = (None
, parse_linker_flavor
, [UNTRACKED
],
1102 linker_plugin_lto
: LinkerPluginLto
= (LinkerPluginLto
::Disabled
,
1103 parse_linker_plugin_lto
, [TRACKED
],
1104 "generate build artifacts that are compatible with linker-based LTO"),
1105 llvm_args
: Vec
<String
> = (Vec
::new(), parse_list
, [TRACKED
],
1106 "a list of arguments to pass to LLVM (space separated)"),
1107 lto
: LtoCli
= (LtoCli
::Unspecified
, parse_lto
, [TRACKED
],
1108 "perform LLVM link-time optimizations"),
1109 metadata
: Vec
<String
> = (Vec
::new(), parse_list
, [TRACKED
],
1110 "metadata to mangle symbol names with"),
1111 no_prepopulate_passes
: bool
= (false, parse_no_flag
, [TRACKED
],
1112 "give an empty list of passes to the pass manager"),
1113 no_redzone
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1114 "disable the use of the redzone"),
1115 no_stack_check
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1116 "this option is deprecated and does nothing"),
1117 no_vectorize_loops
: bool
= (false, parse_no_flag
, [TRACKED
],
1118 "disable loop vectorization optimization passes"),
1119 no_vectorize_slp
: bool
= (false, parse_no_flag
, [TRACKED
],
1120 "disable LLVM's SLP vectorization pass"),
1121 opt_level
: String
= ("0".to_string(), parse_string
, [TRACKED
],
1122 "optimization level (0-3, s, or z; default: 0)"),
1123 overflow_checks
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1124 "use overflow checks for integer arithmetic"),
1125 panic
: Option
<PanicStrategy
> = (None
, parse_opt_panic_strategy
, [TRACKED
],
1126 "panic strategy to compile crate with"),
1127 passes
: Vec
<String
> = (Vec
::new(), parse_list
, [TRACKED
],
1128 "a list of extra LLVM passes to run (space separated)"),
1129 prefer_dynamic
: bool
= (false, parse_bool
, [TRACKED
],
1130 "prefer dynamic linking to static linking (default: no)"),
1131 profile_generate
: SwitchWithOptPath
= (SwitchWithOptPath
::Disabled
,
1132 parse_switch_with_opt_path
, [TRACKED
],
1133 "compile the program with profiling instrumentation"),
1134 profile_use
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1135 "use the given `.profdata` file for profile-guided optimization"),
1136 relocation_model
: Option
<RelocModel
> = (None
, parse_relocation_model
, [TRACKED
],
1137 "control generation of position-independent code (PIC) \
1138 (`rustc --print relocation-models` for details)"),
1139 remark
: Passes
= (Passes
::Some(Vec
::new()), parse_passes
, [UNTRACKED
],
1140 "print remarks for these optimization passes (space separated, or \"all\")"),
1141 rpath
: bool
= (false, parse_bool
, [UNTRACKED
],
1142 "set rpath values in libs/exes (default: no)"),
1143 save_temps
: bool
= (false, parse_bool
, [UNTRACKED
],
1144 "save all temporary output files during compilation (default: no)"),
1145 soft_float
: bool
= (false, parse_bool
, [TRACKED
],
1146 "use soft float ABI (*eabihf targets only) (default: no)"),
1147 split_debuginfo
: Option
<SplitDebuginfo
> = (None
, parse_split_debuginfo
, [TRACKED
],
1148 "how to handle split-debuginfo, a platform-specific option"),
1149 strip
: Strip
= (Strip
::None
, parse_strip
, [UNTRACKED
],
1150 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1151 symbol_mangling_version
: Option
<SymbolManglingVersion
> = (None
,
1152 parse_symbol_mangling_version
, [TRACKED
],
1153 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1154 target_cpu
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1155 "select target processor (`rustc --print target-cpus` for details)"),
1156 target_feature
: String
= (String
::new(), parse_target_feature
, [TRACKED
],
1157 "target specific attributes. (`rustc --print target-features` for details). \
1158 This feature is unsafe."),
1160 // This list is in alphabetical order.
1162 // If you add a new option, please update:
1163 // - compiler/rustc_interface/src/tests.rs
1164 // - src/doc/rustc/src/codegen-options/index.md
1168 DebuggingOptions
, DB_OPTIONS
, dbopts
, "Z", "debugging",
1170 // This list is in alphabetical order.
1172 // If you add a new option, please update:
1173 // - compiler/rustc_interface/src/tests.rs
1175 allow_features
: Option
<Vec
<String
>> = (None
, parse_opt_comma_list
, [TRACKED
],
1176 "only allow the listed language features to be enabled in code (space separated)"),
1177 always_encode_mir
: bool
= (false, parse_bool
, [TRACKED
],
1178 "encode MIR of all functions into the crate metadata (default: no)"),
1179 assume_incomplete_release
: bool
= (false, parse_bool
, [TRACKED
],
1180 "make cfg(version) treat the current version as incomplete (default: no)"),
1181 asm_comments
: bool
= (false, parse_bool
, [TRACKED
],
1182 "generate comments into the assembly (may change behavior) (default: no)"),
1183 assert_incr_state
: Option
<String
> = (None
, parse_opt_string
, [UNTRACKED
],
1184 "assert that the incremental cache is in given state: \
1185 either `loaded` or `not-loaded`."),
1186 ast_json
: bool
= (false, parse_bool
, [UNTRACKED
],
1187 "print the AST as JSON and halt (default: no)"),
1188 ast_json_noexpand
: bool
= (false, parse_bool
, [UNTRACKED
],
1189 "print the pre-expansion AST as JSON and halt (default: no)"),
1190 binary_dep_depinfo
: bool
= (false, parse_bool
, [TRACKED
],
1191 "include artifacts (sysroot, crate dependencies) used during compilation in dep-info \
1193 borrowck
: String
= ("migrate".to_string(), parse_string
, [UNTRACKED
],
1194 "select which borrowck is used (`mir` or `migrate`) (default: `migrate`)"),
1195 branch_protection
: Option
<BranchProtection
> = (None
, parse_branch_protection
, [TRACKED
],
1196 "set options for branch target identification and pointer authentication on AArch64"),
1197 cf_protection
: CFProtection
= (CFProtection
::None
, parse_cfprotection
, [TRACKED
],
1198 "instrument control-flow architecture protection"),
1199 cgu_partitioning_strategy
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1200 "the codegen unit partitioning strategy to use"),
1201 chalk
: bool
= (false, parse_bool
, [TRACKED
],
1202 "enable the experimental Chalk-based trait solving engine"),
1203 codegen_backend
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1204 "the backend to use"),
1205 combine_cgu
: bool
= (false, parse_bool
, [TRACKED
],
1206 "combine CGUs into a single one"),
1207 crate_attr
: Vec
<String
> = (Vec
::new(), parse_string_push
, [TRACKED
],
1208 "inject the given attribute in the crate"),
1209 debug_info_for_profiling
: bool
= (false, parse_bool
, [TRACKED
],
1210 "emit discriminators and other data necessary for AutoFDO"),
1211 debug_macros
: bool
= (false, parse_bool
, [TRACKED
],
1212 "emit line numbers debug info inside macros (default: no)"),
1213 deduplicate_diagnostics
: bool
= (true, parse_bool
, [UNTRACKED
],
1214 "deduplicate identical diagnostics (default: yes)"),
1215 dep_info_omit_d_target
: bool
= (false, parse_bool
, [TRACKED
],
1216 "in dep-info output, omit targets for tracking dependencies of the dep-info files \
1217 themselves (default: no)"),
1218 dep_tasks
: bool
= (false, parse_bool
, [UNTRACKED
],
1219 "print tasks that execute and the color their dep node gets (requires debug build) \
1221 dlltool
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [UNTRACKED
],
1222 "import library generation tool (windows-gnu only)"),
1223 dont_buffer_diagnostics
: bool
= (false, parse_bool
, [UNTRACKED
],
1224 "emit diagnostics rather than buffering (breaks NLL error downgrading, sorting) \
1226 drop_tracking
: bool
= (false, parse_bool
, [TRACKED
],
1227 "enables drop tracking in generators (default: no)"),
1228 dual_proc_macros
: bool
= (false, parse_bool
, [TRACKED
],
1229 "load proc macros for both target and host, but only link to the target (default: no)"),
1230 dump_dep_graph
: bool
= (false, parse_bool
, [UNTRACKED
],
1231 "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv) \
1233 dump_mir
: Option
<String
> = (None
, parse_opt_string
, [UNTRACKED
],
1234 "dump MIR state to file.
1235 `val` is used to select which passes and functions to dump. For example:
1236 `all` matches all passes and functions,
1237 `foo` matches all passes for functions whose name contains 'foo',
1238 `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
1239 `foo | bar` all passes for function names containing 'foo' or 'bar'."),
1240 dump_mir_dataflow
: bool
= (false, parse_bool
, [UNTRACKED
],
1241 "in addition to `.mir` files, create graphviz `.dot` files with dataflow results \
1243 dump_mir_dir
: String
= ("mir_dump".to_string(), parse_string
, [UNTRACKED
],
1244 "the directory the MIR is dumped into (default: `mir_dump`)"),
1245 dump_mir_exclude_pass_number
: bool
= (false, parse_bool
, [UNTRACKED
],
1246 "exclude the pass number when dumping MIR (used in tests) (default: no)"),
1247 dump_mir_graphviz
: bool
= (false, parse_bool
, [UNTRACKED
],
1248 "in addition to `.mir` files, create graphviz `.dot` files (and with \
1249 `-Z instrument-coverage`, also create a `.dot` file for the MIR-derived \
1250 coverage graph) (default: no)"),
1251 dump_mir_spanview
: Option
<MirSpanview
> = (None
, parse_mir_spanview
, [UNTRACKED
],
1252 "in addition to `.mir` files, create `.html` files to view spans for \
1253 all `statement`s (including terminators), only `terminator` spans, or \
1254 computed `block` spans (one span encompassing a block's terminator and \
1255 all statements). If `-Z instrument-coverage` is also enabled, create \
1256 an additional `.html` file showing the computed coverage spans."),
1257 emit_stack_sizes
: bool
= (false, parse_bool
, [UNTRACKED
],
1258 "emit a section containing stack size metadata (default: no)"),
1259 fewer_names
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1260 "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR) \
1262 force_unstable_if_unmarked
: bool
= (false, parse_bool
, [TRACKED
],
1263 "force all crates to be `rustc_private` unstable (default: no)"),
1264 fuel
: Option
<(String
, u64)> = (None
, parse_optimization_fuel
, [TRACKED
],
1265 "set the optimization fuel quota for a crate"),
1266 function_sections
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1267 "whether each function should go in its own section"),
1268 future_incompat_test
: bool
= (false, parse_bool
, [UNTRACKED
],
1269 "forces all lints to be future incompatible, used for internal testing (default: no)"),
1270 gcc_ld
: Option
<LdImpl
> = (None
, parse_gcc_ld
, [TRACKED
], "implementation of ld used by cc"),
1271 graphviz_dark_mode
: bool
= (false, parse_bool
, [UNTRACKED
],
1272 "use dark-themed colors in graphviz output (default: no)"),
1273 graphviz_font
: String
= ("Courier, monospace".to_string(), parse_string
, [UNTRACKED
],
1274 "use the given `fontname` in graphviz output; can be overridden by setting \
1275 environment variable `RUSTC_GRAPHVIZ_FONT` (default: `Courier, monospace`)"),
1276 hir_stats
: bool
= (false, parse_bool
, [UNTRACKED
],
1277 "print some statistics about AST and HIR (default: no)"),
1278 human_readable_cgu_names
: bool
= (false, parse_bool
, [TRACKED
],
1279 "generate human-readable, predictable names for codegen units (default: no)"),
1280 identify_regions
: bool
= (false, parse_bool
, [UNTRACKED
],
1281 "display unnamed regions as `'<id>`, using a non-ident unique id (default: no)"),
1282 incremental_ignore_spans
: bool
= (false, parse_bool
, [UNTRACKED
],
1283 "ignore spans during ICH computation -- used for testing (default: no)"),
1284 incremental_info
: bool
= (false, parse_bool
, [UNTRACKED
],
1285 "print high-level information about incremental reuse (or the lack thereof) \
1287 incremental_relative_spans
: bool
= (false, parse_bool
, [TRACKED
],
1288 "hash spans relative to their parent item for incr. comp. (default: no)"),
1289 incremental_verify_ich
: bool
= (false, parse_bool
, [UNTRACKED
],
1290 "verify incr. comp. hashes of green query instances (default: no)"),
1291 inline_mir
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1292 "enable MIR inlining (default: no)"),
1293 inline_mir_threshold
: Option
<usize> = (None
, parse_opt_number
, [TRACKED
],
1294 "a default MIR inlining threshold (default: 50)"),
1295 inline_mir_hint_threshold
: Option
<usize> = (None
, parse_opt_number
, [TRACKED
],
1296 "inlining threshold for functions with inline hint (default: 100)"),
1297 inline_in_all_cgus
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1298 "control whether `#[inline]` functions are in all CGUs"),
1299 input_stats
: bool
= (false, parse_bool
, [UNTRACKED
],
1300 "gather statistics about the input (default: no)"),
1301 instrument_coverage
: Option
<InstrumentCoverage
> = (None
, parse_instrument_coverage
, [TRACKED
],
1302 "instrument the generated code to support LLVM source-based code coverage \
1303 reports (note, the compiler build config must include `profiler = true`); \
1304 implies `-C symbol-mangling-version=v0`. Optional values are:
1305 `=all` (implicit value)
1306 `=except-unused-generics`
1307 `=except-unused-functions`
1309 instrument_mcount
: bool
= (false, parse_bool
, [TRACKED
],
1310 "insert function instrument code for mcount-based tracing (default: no)"),
1311 keep_hygiene_data
: bool
= (false, parse_bool
, [UNTRACKED
],
1312 "keep hygiene data after analysis (default: no)"),
1313 link_native_libraries
: bool
= (true, parse_bool
, [UNTRACKED
],
1314 "link native libraries in the linker invocation (default: yes)"),
1315 link_only
: bool
= (false, parse_bool
, [TRACKED
],
1316 "link the `.rlink` file generated by `-Z no-link` (default: no)"),
1317 llvm_plugins
: Vec
<String
> = (Vec
::new(), parse_list
, [TRACKED
],
1318 "a list LLVM plugins to enable (space separated)"),
1319 llvm_time_trace
: bool
= (false, parse_bool
, [UNTRACKED
],
1320 "generate JSON tracing data file from LLVM data (default: no)"),
1321 location_detail
: LocationDetail
= (LocationDetail
::all(), parse_location_detail
, [TRACKED
],
1322 "comma separated list of location details to be tracked when using caller_location \
1323 valid options are `file`, `line`, and `column` (default: all)"),
1324 ls
: bool
= (false, parse_bool
, [UNTRACKED
],
1325 "list the symbols defined by a library crate (default: no)"),
1326 macro_backtrace
: bool
= (false, parse_bool
, [UNTRACKED
],
1327 "show macro backtraces (default: no)"),
1328 merge_functions
: Option
<MergeFunctions
> = (None
, parse_merge_functions
, [TRACKED
],
1329 "control the operation of the MergeFunctions LLVM pass, taking \
1330 the same values as the target option of the same name"),
1331 meta_stats
: bool
= (false, parse_bool
, [UNTRACKED
],
1332 "gather metadata statistics (default: no)"),
1333 mir_emit_retag
: bool
= (false, parse_bool
, [TRACKED
],
1334 "emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0 \
1336 mir_enable_passes
: Vec
<(String
, bool
)> = (Vec
::new(), parse_list_with_polarity
, [TRACKED
],
1337 "use like `-Zmir-enable-passes=+DestProp,-InstCombine`. Forces the specified passes to be \
1338 enabled, overriding all other checks. Passes that are not specified are enabled or \
1339 disabled by other flags as usual."),
1340 mir_opt_level
: Option
<usize> = (None
, parse_opt_number
, [TRACKED
],
1341 "MIR optimization level (0-4; default: 1 in non optimized builds and 2 in optimized builds)"),
1342 move_size_limit
: Option
<usize> = (None
, parse_opt_number
, [TRACKED
],
1343 "the size at which the `large_assignments` lint starts to be emitted"),
1344 mutable_noalias
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1345 "emit noalias metadata for mutable references (default: yes)"),
1346 new_llvm_pass_manager
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1347 "use new LLVM pass manager (default: no)"),
1348 nll_facts
: bool
= (false, parse_bool
, [UNTRACKED
],
1349 "dump facts from NLL analysis into side files (default: no)"),
1350 nll_facts_dir
: String
= ("nll-facts".to_string(), parse_string
, [UNTRACKED
],
1351 "the directory the NLL facts are dumped into (default: `nll-facts`)"),
1352 no_analysis
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1353 "parse and expand the source, but run no analysis"),
1354 no_codegen
: bool
= (false, parse_no_flag
, [TRACKED_NO_CRATE_HASH
],
1355 "run all passes except codegen; no output"),
1356 no_generate_arange_section
: bool
= (false, parse_no_flag
, [TRACKED
],
1357 "omit DWARF address ranges that give faster lookups"),
1358 no_interleave_lints
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1359 "execute lints separately; allows benchmarking individual lints"),
1360 no_leak_check
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1361 "disable the 'leak check' for subtyping; unsound, but useful for tests"),
1362 no_link
: bool
= (false, parse_no_flag
, [TRACKED
],
1363 "compile without linking"),
1364 no_parallel_llvm
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1365 "run LLVM in non-parallel mode (while keeping codegen-units and ThinLTO)"),
1366 no_unique_section_names
: bool
= (false, parse_bool
, [TRACKED
],
1367 "do not use unique names for text and data sections when -Z function-sections is used"),
1368 no_profiler_runtime
: bool
= (false, parse_no_flag
, [TRACKED
],
1369 "prevent automatic injection of the profiler_builtins crate"),
1370 normalize_docs
: bool
= (false, parse_bool
, [TRACKED
],
1371 "normalize associated items in rustdoc when generating documentation"),
1372 oom
: OomStrategy
= (OomStrategy
::Abort
, parse_oom_strategy
, [TRACKED
],
1373 "panic strategy for out-of-memory handling"),
1374 osx_rpath_install_name
: bool
= (false, parse_bool
, [TRACKED
],
1375 "pass `-install_name @rpath/...` to the macOS linker (default: no)"),
1376 panic_abort_tests
: bool
= (false, parse_bool
, [TRACKED
],
1377 "support compiling tests with panic=abort (default: no)"),
1378 panic_in_drop
: PanicStrategy
= (PanicStrategy
::Unwind
, parse_panic_strategy
, [TRACKED
],
1379 "panic strategy for panics in drops"),
1380 parse_only
: bool
= (false, parse_bool
, [UNTRACKED
],
1381 "parse only; do not compile, assemble, or link (default: no)"),
1382 perf_stats
: bool
= (false, parse_bool
, [UNTRACKED
],
1383 "print some performance-related statistics (default: no)"),
1384 pick_stable_methods_before_any_unstable
: bool
= (true, parse_bool
, [TRACKED
],
1385 "try to pick stable methods first before picking any unstable methods (default: yes)"),
1386 plt
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1387 "whether to use the PLT when calling into shared libraries;
1388 only has effect for PIC code on systems with ELF binaries
1389 (default: PLT is disabled if full relro is enabled)"),
1390 polonius
: bool
= (false, parse_bool
, [TRACKED
],
1391 "enable polonius-based borrow-checker (default: no)"),
1392 polymorphize
: bool
= (false, parse_bool
, [TRACKED
],
1393 "perform polymorphization analysis"),
1394 pre_link_arg
: (/* redirected to pre_link_args */) = ((), parse_string_push
, [UNTRACKED
],
1395 "a single extra argument to prepend the linker invocation (can be used several times)"),
1396 pre_link_args
: Vec
<String
> = (Vec
::new(), parse_list
, [UNTRACKED
],
1397 "extra arguments to prepend to the linker invocation (space separated)"),
1398 precise_enum_drop_elaboration
: bool
= (true, parse_bool
, [TRACKED
],
1399 "use a more precise version of drop elaboration for matches on enums (default: yes). \
1400 This results in better codegen, but has caused miscompilations on some tier 2 platforms. \
1401 See #77382 and #74551."),
1402 print_fuel
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1403 "make rustc print the total optimization fuel used by a crate"),
1404 print_llvm_passes
: bool
= (false, parse_bool
, [UNTRACKED
],
1405 "print the LLVM optimization passes being run (default: no)"),
1406 print_mono_items
: Option
<String
> = (None
, parse_opt_string
, [UNTRACKED
],
1407 "print the result of the monomorphization collection pass"),
1408 print_type_sizes
: bool
= (false, parse_bool
, [UNTRACKED
],
1409 "print layout information for each type encountered (default: no)"),
1410 proc_macro_backtrace
: bool
= (false, parse_bool
, [UNTRACKED
],
1411 "show backtraces for panics during proc-macro execution (default: no)"),
1412 profile
: bool
= (false, parse_bool
, [TRACKED
],
1413 "insert profiling code (default: no)"),
1414 profile_closures
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1415 "profile size of closures"),
1416 profile_emit
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1417 "file path to emit profiling data at runtime when using 'profile' \
1418 (default based on relative source path)"),
1419 profiler_runtime
: String
= (String
::from("profiler_builtins"), parse_string
, [TRACKED
],
1420 "name of the profiler runtime crate to automatically inject (default: `profiler_builtins`)"),
1421 profile_sample_use
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1422 "use the given `.prof` file for sampled profile-guided optimization (also known as AutoFDO)"),
1423 query_dep_graph
: bool
= (false, parse_bool
, [UNTRACKED
],
1424 "enable queries of the dependency graph for regression testing (default: no)"),
1425 randomize_layout
: bool
= (false, parse_bool
, [TRACKED
],
1426 "randomize the layout of types (default: no)"),
1427 layout_seed
: Option
<u64> = (None
, parse_opt_number
, [TRACKED
],
1428 "seed layout randomization"),
1429 relax_elf_relocations
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1430 "whether ELF relocations can be relaxed"),
1431 relro_level
: Option
<RelroLevel
> = (None
, parse_relro_level
, [TRACKED
],
1432 "choose which RELRO level to use"),
1433 remap_cwd_prefix
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1434 "remap paths under the current working directory to this path prefix"),
1435 simulate_remapped_rust_src_base
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1436 "simulate the effect of remap-debuginfo = true at bootstrapping by remapping path \
1437 to rust's source base directory. only meant for testing purposes"),
1438 report_delayed_bugs
: bool
= (false, parse_bool
, [TRACKED
],
1439 "immediately print bugs registered with `delay_span_bug` (default: no)"),
1440 sanitizer
: SanitizerSet
= (SanitizerSet
::empty(), parse_sanitizers
, [TRACKED
],
1442 sanitizer_memory_track_origins
: usize = (0, parse_sanitizer_memory_track_origins
, [TRACKED
],
1443 "enable origins tracking in MemorySanitizer"),
1444 sanitizer_recover
: SanitizerSet
= (SanitizerSet
::empty(), parse_sanitizers
, [TRACKED
],
1445 "enable recovery for selected sanitizers"),
1446 saturating_float_casts
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1447 "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
1448 the max/min integer respectively, and NaN is mapped to 0 (default: yes)"),
1449 save_analysis
: bool
= (false, parse_bool
, [UNTRACKED
],
1450 "write syntax and type analysis (in JSON format) information, in \
1451 addition to normal output (default: no)"),
1452 self_profile
: SwitchWithOptPath
= (SwitchWithOptPath
::Disabled
,
1453 parse_switch_with_opt_path
, [UNTRACKED
],
1454 "run the self profiler and output the raw event data"),
1455 /// keep this in sync with the event filter names in librustc_data_structures/profiling.rs
1456 self_profile_events
: Option
<Vec
<String
>> = (None
, parse_opt_comma_list
, [UNTRACKED
],
1457 "specify the events recorded by the self profiler;
1458 for example: `-Z self-profile-events=default,query-keys`
1459 all options: none, all, default, generic-activity, query-provider, query-cache-hit
1460 query-blocked, incr-cache-load, incr-result-hashing, query-keys, function-args, args, llvm, artifact-sizes"),
1461 share_generics
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1462 "make the current crate share its generic instantiations"),
1463 show_span
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1464 "show spans for compiler debugging (expr|pat|ty)"),
1465 span_debug
: bool
= (false, parse_bool
, [UNTRACKED
],
1466 "forward proc_macro::Span's `Debug` impl to `Span`"),
1467 /// o/w tests have closure@path
1468 span_free_formats
: bool
= (false, parse_bool
, [UNTRACKED
],
1469 "exclude spans when debug-printing compiler state (default: no)"),
1470 src_hash_algorithm
: Option
<SourceFileHashAlgorithm
> = (None
, parse_src_file_hash
, [TRACKED
],
1471 "hash algorithm of source files in debug info (`md5`, `sha1`, or `sha256`)"),
1472 stack_protector
: StackProtector
= (StackProtector
::None
, parse_stack_protector
, [TRACKED
],
1473 "control stack smash protection strategy (`rustc --print stack-protector-strategies` for details)"),
1474 strip
: Strip
= (Strip
::None
, parse_strip
, [UNTRACKED
],
1475 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1476 split_dwarf_kind
: SplitDwarfKind
= (SplitDwarfKind
::Split
, parse_split_dwarf_kind
, [UNTRACKED
],
1477 "split dwarf variant (only if -Csplit-debuginfo is enabled and on relevant platform)
1480 `split`: sections which do not require relocation are written into a DWARF object (`.dwo`)
1481 file which is ignored by the linker
1482 `single`: sections which do not require relocation are written into object file but ignored
1484 split_dwarf_inlining
: bool
= (true, parse_bool
, [UNTRACKED
],
1485 "provide minimal debug info in the object/executable to facilitate online \
1486 symbolication/stack traces in the absence of .dwo/.dwp files when using Split DWARF"),
1487 symbol_mangling_version
: Option
<SymbolManglingVersion
> = (None
,
1488 parse_symbol_mangling_version
, [TRACKED
],
1489 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1490 teach
: bool
= (false, parse_bool
, [TRACKED
],
1491 "show extended diagnostic help (default: no)"),
1492 temps_dir
: Option
<String
> = (None
, parse_opt_string
, [UNTRACKED
],
1493 "the directory the intermediate files are written to"),
1494 terminal_width
: Option
<usize> = (None
, parse_opt_number
, [UNTRACKED
],
1495 "set the current terminal width"),
1496 // Diagnostics are considered side-effects of a query (see `QuerySideEffects`) and are saved
1497 // alongside query results and changes to translation options can affect diagnostics - so
1498 // translation options should be tracked.
1499 translate_lang
: Option
<LanguageIdentifier
> = (None
, parse_opt_langid
, [TRACKED
],
1500 "language identifier for diagnostic output"),
1501 translate_additional_ftl
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1502 "additional fluent translation to preferentially use (for testing translation)"),
1503 translate_directionality_markers
: bool
= (false, parse_bool
, [TRACKED
],
1504 "emit directionality isolation markers in translated diagnostics"),
1505 tune_cpu
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1506 "select processor to schedule for (`rustc --print target-cpus` for details)"),
1507 thinlto
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1508 "enable ThinLTO when possible"),
1509 thir_unsafeck
: bool
= (false, parse_bool
, [TRACKED
],
1510 "use the THIR unsafety checker (default: no)"),
1511 /// We default to 1 here since we want to behave like
1512 /// a sequential compiler for now. This'll likely be adjusted
1513 /// in the future. Note that -Zthreads=0 is the way to get
1514 /// the num_cpus behavior.
1515 threads
: usize = (1, parse_threads
, [UNTRACKED
],
1516 "use a thread pool with N threads"),
1517 time
: bool
= (false, parse_bool
, [UNTRACKED
],
1518 "measure time of rustc processes (default: no)"),
1519 time_llvm_passes
: bool
= (false, parse_bool
, [UNTRACKED
],
1520 "measure time of each LLVM pass (default: no)"),
1521 time_passes
: bool
= (false, parse_bool
, [UNTRACKED
],
1522 "measure time of each rustc pass (default: no)"),
1523 tls_model
: Option
<TlsModel
> = (None
, parse_tls_model
, [TRACKED
],
1524 "choose the TLS model to use (`rustc --print tls-models` for details)"),
1525 trace_macros
: bool
= (false, parse_bool
, [UNTRACKED
],
1526 "for every macro invocation, print its name and arguments (default: no)"),
1527 trap_unreachable
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1528 "generate trap instructions for unreachable intrinsics (default: use target setting, usually yes)"),
1529 treat_err_as_bug
: Option
<NonZeroUsize
> = (None
, parse_treat_err_as_bug
, [TRACKED
],
1530 "treat error number `val` that occurs as bug"),
1531 trim_diagnostic_paths
: bool
= (true, parse_bool
, [UNTRACKED
],
1532 "in diagnostics, use heuristics to shorten paths referring to items"),
1533 ui_testing
: bool
= (false, parse_bool
, [UNTRACKED
],
1534 "emit compiler diagnostics in a form suitable for UI testing (default: no)"),
1535 uninit_const_chunk_threshold
: usize = (16, parse_number
, [TRACKED
],
1536 "allow generating const initializers with mixed init/uninit chunks, \
1537 and set the maximum number of chunks for which this is allowed (default: 16)"),
1538 unleash_the_miri_inside_of_you
: bool
= (false, parse_bool
, [TRACKED
],
1539 "take the brakes off const evaluation. NOTE: this is unsound (default: no)"),
1540 unpretty
: Option
<String
> = (None
, parse_unpretty
, [UNTRACKED
],
1541 "present the input source, unstable (and less-pretty) variants;
1542 `normal`, `identified`,
1543 `expanded`, `expanded,identified`,
1544 `expanded,hygiene` (with internal representations),
1545 `ast-tree` (raw AST before expansion),
1546 `ast-tree,expanded` (raw AST after expansion),
1547 `hir` (the HIR), `hir,identified`,
1548 `hir,typed` (HIR with types for each node),
1549 `hir-tree` (dump the raw HIR),
1550 `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)"),
1551 unsound_mir_opts
: bool
= (false, parse_bool
, [TRACKED
],
1552 "enable unsound and buggy MIR optimizations (default: no)"),
1553 unstable_options
: bool
= (false, parse_bool
, [UNTRACKED
],
1554 "adds unstable command line options to rustc interface (default: no)"),
1555 use_ctors_section
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1556 "use legacy .ctors section for initializers rather than .init_array"),
1557 validate_mir
: bool
= (false, parse_bool
, [UNTRACKED
],
1558 "validate MIR after each transformation"),
1559 verbose
: bool
= (false, parse_bool
, [UNTRACKED
],
1560 "in general, enable more debug printouts (default: no)"),
1561 verify_llvm_ir
: bool
= (false, parse_bool
, [TRACKED
],
1562 "verify LLVM IR (default: no)"),
1563 wasi_exec_model
: Option
<WasiExecModel
> = (None
, parse_wasi_exec_model
, [TRACKED
],
1564 "whether to build a wasi command or reactor"),
1566 // This list is in alphabetical order.
1568 // If you add a new option, please update:
1569 // - compiler/rustc_interface/src/tests.rs
1572 #[derive(Clone, Hash, PartialEq, Eq, Debug)]
1573 pub enum WasiExecModel
{
1578 #[derive(Clone, Copy, Hash)]