3 use crate::early_error
;
5 use crate::search_paths
::SearchPath
;
6 use crate::utils
::NativeLib
;
7 use rustc_target
::spec
::{CodeModel, LinkerFlavor, MergeFunctions, PanicStrategy, SanitizerSet}
;
8 use rustc_target
::spec
::{
9 RelocModel
, RelroLevel
, SplitDebuginfo
, StackProtector
, TargetTriple
, TlsModel
,
12 use rustc_feature
::UnstableFeatures
;
13 use rustc_span
::edition
::Edition
;
14 use rustc_span
::RealFileName
;
15 use rustc_span
::SourceFileHashAlgorithm
;
17 use std
::collections
::BTreeMap
;
19 use std
::collections
::hash_map
::DefaultHasher
;
20 use std
::hash
::Hasher
;
21 use std
::num
::NonZeroUsize
;
22 use std
::path
::PathBuf
;
26 ($opt_name
:ident
, $opt_expr
:expr
, $sub_hashes
:expr
) => {
28 .insert(stringify
!($opt_name
), $opt_expr
as &dyn dep_tracking
::DepTrackingHash
)
31 panic
!("duplicate key in CLI DepTrackingHash: {}", stringify
!($opt_name
))
36 macro_rules
! hash_opt
{
37 ($opt_name
:ident
, $opt_expr
:expr
, $sub_hashes
:expr
, $_for_crate_hash
: ident
, [UNTRACKED
]) => {{}
};
38 ($opt_name
:ident
, $opt_expr
:expr
, $sub_hashes
:expr
, $_for_crate_hash
: ident
, [TRACKED
]) => {{ insert!($opt_name, $opt_expr, $sub_hashes) }
};
39 ($opt_name
:ident
, $opt_expr
:expr
, $sub_hashes
:expr
, $for_crate_hash
: ident
, [TRACKED_NO_CRATE_HASH
]) => {{
41 insert
!($opt_name
, $opt_expr
, $sub_hashes
)
44 ($opt_name
:ident
, $opt_expr
:expr
, $sub_hashes
:expr
, $_for_crate_hash
: ident
, [SUBSTRUCT
]) => {{}
};
47 macro_rules
! hash_substruct
{
48 ($opt_name
:ident
, $opt_expr
:expr
, $error_format
:expr
, $for_crate_hash
:expr
, $hasher
:expr
, [UNTRACKED
]) => {{}
};
49 ($opt_name
:ident
, $opt_expr
:expr
, $error_format
:expr
, $for_crate_hash
:expr
, $hasher
:expr
, [TRACKED
]) => {{}
};
50 ($opt_name
:ident
, $opt_expr
:expr
, $error_format
:expr
, $for_crate_hash
:expr
, $hasher
:expr
, [TRACKED_NO_CRATE_HASH
]) => {{}
};
51 ($opt_name
:ident
, $opt_expr
:expr
, $error_format
:expr
, $for_crate_hash
:expr
, $hasher
:expr
, [SUBSTRUCT
]) => {
52 use crate::config
::dep_tracking
::DepTrackingHash
;
53 $opt_expr
.dep_tracking_hash($for_crate_hash
, $error_format
).hash(
61 macro_rules
! top_level_options
{
62 ( $
( #[$top_level_attr:meta] )* pub struct Options { $(
64 $opt
:ident
: $t
:ty
[$dep_tracking_marker
:ident
],
67 $
( #[$top_level_attr] )*
76 pub fn dep_tracking_hash(&self, for_crate_hash
: bool
) -> u64 {
77 let mut sub_hashes
= BTreeMap
::new();
83 [$dep_tracking_marker
]);
85 let mut hasher
= DefaultHasher
::new();
86 dep_tracking
::stable_hash(sub_hashes
,
96 [$dep_tracking_marker
]);
105 pub fn mir_opt_level(&self) -> usize {
108 .unwrap_or_else(|| if self.optimize
!= OptLevel
::No { 2 }
else { 1 }
)
111 pub fn instrument_coverage(&self) -> bool
{
112 self.cg
.instrument_coverage
.unwrap_or(InstrumentCoverage
::Off
) != InstrumentCoverage
::Off
115 pub fn instrument_coverage_except_unused_generics(&self) -> bool
{
116 self.cg
.instrument_coverage
.unwrap_or(InstrumentCoverage
::Off
)
117 == InstrumentCoverage
::ExceptUnusedGenerics
120 pub fn instrument_coverage_except_unused_functions(&self) -> bool
{
121 self.cg
.instrument_coverage
.unwrap_or(InstrumentCoverage
::Off
)
122 == InstrumentCoverage
::ExceptUnusedFunctions
127 /// The top-level command-line options struct.
129 /// For each option, one has to specify how it behaves with regard to the
130 /// dependency tracking system of incremental compilation. This is done via the
131 /// square-bracketed directive after the field type. The options are:
134 /// A change in the given field will cause the compiler to completely clear the
135 /// incremental compilation cache before proceeding.
137 /// - `[TRACKED_NO_CRATE_HASH]`
138 /// Same as `[TRACKED]`, but will not affect the crate hash. This is useful for options that only
139 /// affect the incremental cache.
142 /// Incremental compilation is not influenced by this option.
145 /// Second-level sub-structs containing more options.
147 /// If you add a new option to this struct or one of the sub-structs like
148 /// `CodegenOptions`, think about how it influences incremental compilation. If in
149 /// doubt, specify `[TRACKED]`, which is always "correct" but might lead to
150 /// unnecessary re-compilation.
152 /// The crate config requested for the session, which may be combined
153 /// with additional crate configurations during the compile process.
154 crate_types
: Vec
<CrateType
> [TRACKED
],
155 optimize
: OptLevel
[TRACKED
],
156 /// Include the `debug_assertions` flag in dependency tracking, since it
157 /// can influence whether overflow checks are done or not.
158 debug_assertions
: bool
[TRACKED
],
159 debuginfo
: DebugInfo
[TRACKED
],
160 lint_opts
: Vec
<(String
, lint
::Level
)> [TRACKED_NO_CRATE_HASH
],
161 lint_cap
: Option
<lint
::Level
> [TRACKED_NO_CRATE_HASH
],
162 describe_lints
: bool
[UNTRACKED
],
163 output_types
: OutputTypes
[TRACKED
],
164 search_paths
: Vec
<SearchPath
> [UNTRACKED
],
165 libs
: Vec
<NativeLib
> [TRACKED
],
166 maybe_sysroot
: Option
<PathBuf
> [UNTRACKED
],
168 target_triple
: TargetTriple
[TRACKED
],
170 test
: bool
[TRACKED
],
171 error_format
: ErrorOutputType
[UNTRACKED
],
173 /// If `Some`, enable incremental compilation, using the given
174 /// directory to store intermediate results.
175 incremental
: Option
<PathBuf
> [UNTRACKED
],
176 assert_incr_state
: Option
<IncrementalStateAssertion
> [UNTRACKED
],
178 debugging_opts
: DebuggingOptions
[SUBSTRUCT
],
179 prints
: Vec
<PrintRequest
> [UNTRACKED
],
180 /// Determines which borrow checker(s) to run. This is the parsed, sanitized
181 /// version of `debugging_opts.borrowck`, which is just a plain string.
182 borrowck_mode
: BorrowckMode
[UNTRACKED
],
183 cg
: CodegenOptions
[SUBSTRUCT
],
184 externs
: Externs
[UNTRACKED
],
185 extern_dep_specs
: ExternDepSpecs
[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
: bool
[UNTRACKED
],
226 /// `true` if we're emitting a JSON job containg 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 `{}` for {} option `{}` - {} was expected",
349 value
, outputname
, key
, type_desc
355 None
=> early_error(error_format
, &format
!("unknown {} option: `{}`", outputname
, key
)),
361 #[allow(non_upper_case_globals)]
363 pub const parse_no_flag
: &str = "no value";
364 pub const parse_bool
: &str = "one of: `y`, `yes`, `on`, `n`, `no`, or `off`";
365 pub const parse_opt_bool
: &str = parse_bool
;
366 pub const parse_string
: &str = "a string";
367 pub const parse_opt_string
: &str = parse_string
;
368 pub const parse_string_push
: &str = parse_string
;
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_opt_comma_list
: &str = "a comma-separated list of strings";
372 pub const parse_number
: &str = "a number";
373 pub const parse_opt_number
: &str = parse_number
;
374 pub const parse_threads
: &str = parse_number
;
375 pub const parse_passes
: &str = "a space-separated list of passes, or `all`";
376 pub const parse_panic_strategy
: &str = "either `unwind` or `abort`";
377 pub const parse_opt_panic_strategy
: &str = parse_panic_strategy
;
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`, 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 =
397 "comma seperated list of location details to track: `file`, `line`, or `column`";
398 pub const parse_switch_with_opt_path
: &str =
399 "an optional path to the profiling data output directory";
400 pub const parse_merge_functions
: &str = "one of: `disabled`, `trampolines`, or `aliases`";
401 pub const parse_symbol_mangling_version
: &str = "either `legacy` or `v0` (RFC 2603)";
402 pub const parse_src_file_hash
: &str = "either `md5` or `sha1`";
403 pub const parse_relocation_model
: &str =
404 "one of supported relocation models (`rustc --print relocation-models`)";
405 pub const parse_code_model
: &str = "one of supported code models (`rustc --print code-models`)";
406 pub const parse_tls_model
: &str = "one of supported TLS models (`rustc --print tls-models`)";
407 pub const parse_target_feature
: &str = parse_string
;
408 pub const parse_wasi_exec_model
: &str = "either `command` or `reactor`";
409 pub const parse_split_debuginfo
: &str =
410 "one of supported split-debuginfo modes (`off`, `packed`, or `unpacked`)";
411 pub const parse_split_dwarf_kind
: &str =
412 "one of supported split dwarf modes (`split` or `single`)";
413 pub const parse_gcc_ld
: &str = "one of: no value, `lld`";
414 pub const parse_stack_protector
: &str =
415 "one of (`none` (default), `basic`, `strong`, or `all`)";
416 pub const parse_branch_protection
: &str =
417 "a `,` separated combination of `bti`, `b-key`, `pac-ret`, or `leaf`";
422 use std
::str::FromStr
;
424 /// This is for boolean options that don't take a value and start with
425 /// `no-`. This style of option is deprecated.
426 crate fn parse_no_flag(slot
: &mut bool
, v
: Option
<&str>) -> bool
{
436 /// Use this for any boolean option that has a static default.
437 crate fn parse_bool(slot
: &mut bool
, v
: Option
<&str>) -> bool
{
439 Some("y") | Some("yes") | Some("on") | None
=> {
443 Some("n") | Some("no") | Some("off") => {
451 /// Use this for any boolean option that lacks a static default. (The
452 /// actions taken when such an option is not specified will depend on
453 /// other factors, such as other options, or target options.)
454 crate fn parse_opt_bool(slot
: &mut Option
<bool
>, v
: Option
<&str>) -> bool
{
456 Some("y") | Some("yes") | Some("on") | None
=> {
460 Some("n") | Some("no") | Some("off") => {
468 /// Use this for any string option that has a static default.
469 crate fn parse_string(slot
: &mut String
, v
: Option
<&str>) -> bool
{
472 *slot
= s
.to_string();
479 /// Use this for any string option that lacks a static default.
480 crate fn parse_opt_string(slot
: &mut Option
<String
>, v
: Option
<&str>) -> bool
{
483 *slot
= Some(s
.to_string());
490 crate fn parse_opt_pathbuf(slot
: &mut Option
<PathBuf
>, v
: Option
<&str>) -> bool
{
493 *slot
= Some(PathBuf
::from(s
));
500 crate fn parse_string_push(slot
: &mut Vec
<String
>, v
: Option
<&str>) -> bool
{
503 slot
.push(s
.to_string());
510 crate fn parse_list(slot
: &mut Vec
<String
>, v
: Option
<&str>) -> bool
{
513 slot
.extend(s
.split_whitespace().map(|s
| s
.to_string()));
520 crate fn parse_location_detail(ld
: &mut LocationDetail
, v
: Option
<&str>) -> bool
{
525 for s
in v
.split('
,'
) {
527 "file" => ld
.file
= true,
528 "line" => ld
.line
= true,
529 "column" => ld
.column
= true,
539 crate fn parse_opt_comma_list(slot
: &mut Option
<Vec
<String
>>, v
: Option
<&str>) -> bool
{
542 let mut v
: Vec
<_
> = s
.split('
,'
).map(|s
| s
.to_string()).collect();
551 crate fn parse_threads(slot
: &mut usize, v
: Option
<&str>) -> bool
{
552 match v
.and_then(|s
| s
.parse().ok()) {
554 *slot
= ::num_cpus
::get();
565 /// Use this for any numeric option that has a static default.
566 crate fn parse_number
<T
: Copy
+ FromStr
>(slot
: &mut T
, v
: Option
<&str>) -> bool
{
567 match v
.and_then(|s
| s
.parse().ok()) {
576 /// Use this for any numeric option that lacks a static default.
577 crate fn parse_opt_number
<T
: Copy
+ FromStr
>(slot
: &mut Option
<T
>, v
: Option
<&str>) -> bool
{
580 *slot
= s
.parse().ok();
587 crate fn parse_passes(slot
: &mut Passes
, v
: Option
<&str>) -> bool
{
594 let mut passes
= vec
![];
595 if parse_list(&mut passes
, v
) {
605 crate fn parse_opt_panic_strategy(slot
: &mut Option
<PanicStrategy
>, v
: Option
<&str>) -> bool
{
607 Some("unwind") => *slot
= Some(PanicStrategy
::Unwind
),
608 Some("abort") => *slot
= Some(PanicStrategy
::Abort
),
614 crate fn parse_panic_strategy(slot
: &mut PanicStrategy
, v
: Option
<&str>) -> bool
{
616 Some("unwind") => *slot
= PanicStrategy
::Unwind
,
617 Some("abort") => *slot
= PanicStrategy
::Abort
,
623 crate fn parse_relro_level(slot
: &mut Option
<RelroLevel
>, v
: Option
<&str>) -> bool
{
625 Some(s
) => match s
.parse
::<RelroLevel
>() {
626 Ok(level
) => *slot
= Some(level
),
634 crate fn parse_sanitizers(slot
: &mut SanitizerSet
, v
: Option
<&str>) -> bool
{
636 for s
in v
.split('
,'
) {
638 "address" => SanitizerSet
::ADDRESS
,
639 "cfi" => SanitizerSet
::CFI
,
640 "leak" => SanitizerSet
::LEAK
,
641 "memory" => SanitizerSet
::MEMORY
,
642 "memtag" => SanitizerSet
::MEMTAG
,
643 "thread" => SanitizerSet
::THREAD
,
644 "hwaddress" => SanitizerSet
::HWADDRESS
,
654 crate fn parse_sanitizer_memory_track_origins(slot
: &mut usize, v
: Option
<&str>) -> bool
{
656 Some("2") | None
=> {
672 crate fn parse_strip(slot
: &mut Strip
, v
: Option
<&str>) -> bool
{
674 Some("none") => *slot
= Strip
::None
,
675 Some("debuginfo") => *slot
= Strip
::Debuginfo
,
676 Some("symbols") => *slot
= Strip
::Symbols
,
682 crate fn parse_cfguard(slot
: &mut CFGuard
, v
: Option
<&str>) -> bool
{
684 let mut bool_arg
= None
;
685 if parse_opt_bool(&mut bool_arg
, v
) {
686 *slot
= if bool_arg
.unwrap() { CFGuard::Checks }
else { CFGuard::Disabled }
;
692 None
=> CFGuard
::Checks
,
693 Some("checks") => CFGuard
::Checks
,
694 Some("nochecks") => CFGuard
::NoChecks
,
695 Some(_
) => return false,
700 crate fn parse_cfprotection(slot
: &mut CFProtection
, v
: Option
<&str>) -> bool
{
702 let mut bool_arg
= None
;
703 if parse_opt_bool(&mut bool_arg
, v
) {
704 *slot
= if bool_arg
.unwrap() { CFProtection::Full }
else { CFProtection::None }
;
710 None
| Some("none") => CFProtection
::None
,
711 Some("branch") => CFProtection
::Branch
,
712 Some("return") => CFProtection
::Return
,
713 Some("full") => CFProtection
::Full
,
714 Some(_
) => return false,
719 crate fn parse_linker_flavor(slot
: &mut Option
<LinkerFlavor
>, v
: Option
<&str>) -> bool
{
720 match v
.and_then(LinkerFlavor
::from_str
) {
721 Some(lf
) => *slot
= Some(lf
),
727 crate fn parse_optimization_fuel(slot
: &mut Option
<(String
, u64)>, v
: Option
<&str>) -> bool
{
731 let parts
= s
.split('
='
).collect
::<Vec
<_
>>();
732 if parts
.len() != 2 {
735 let crate_name
= parts
[0].to_string();
736 let fuel
= parts
[1].parse
::<u64>();
740 *slot
= Some((crate_name
, fuel
.unwrap()));
746 crate fn parse_unpretty(slot
: &mut Option
<String
>, v
: Option
<&str>) -> bool
{
749 Some(s
) if s
.split('
='
).count() <= 2 => {
750 *slot
= Some(s
.to_string());
757 crate fn parse_mir_spanview(slot
: &mut Option
<MirSpanview
>, v
: Option
<&str>) -> bool
{
759 let mut bool_arg
= None
;
760 if parse_opt_bool(&mut bool_arg
, v
) {
761 *slot
= if bool_arg
.unwrap() { Some(MirSpanview::Statement) }
else { None }
;
768 *slot
= Some(MirSpanview
::Statement
);
774 *slot
= Some(match v
.trim_end_matches('s'
) {
775 "statement" | "stmt" => MirSpanview
::Statement
,
776 "terminator" | "term" => MirSpanview
::Terminator
,
777 "block" | "basicblock" => MirSpanview
::Block
,
783 crate fn parse_instrument_coverage(
784 slot
: &mut Option
<InstrumentCoverage
>,
788 let mut bool_arg
= None
;
789 if parse_opt_bool(&mut bool_arg
, v
) {
790 *slot
= if bool_arg
.unwrap() { Some(InstrumentCoverage::All) }
else { None }
;
797 *slot
= Some(InstrumentCoverage
::All
);
803 *slot
= Some(match v
{
804 "all" => InstrumentCoverage
::All
,
805 "except-unused-generics" | "except_unused_generics" => {
806 InstrumentCoverage
::ExceptUnusedGenerics
808 "except-unused-functions" | "except_unused_functions" => {
809 InstrumentCoverage
::ExceptUnusedFunctions
811 "off" | "no" | "n" | "false" | "0" => InstrumentCoverage
::Off
,
817 crate fn parse_treat_err_as_bug(slot
: &mut Option
<NonZeroUsize
>, v
: Option
<&str>) -> bool
{
820 *slot
= s
.parse().ok();
824 *slot
= NonZeroUsize
::new(1);
830 crate fn parse_lto(slot
: &mut LtoCli
, v
: Option
<&str>) -> bool
{
832 let mut bool_arg
= None
;
833 if parse_opt_bool(&mut bool_arg
, v
) {
834 *slot
= if bool_arg
.unwrap() { LtoCli::Yes }
else { LtoCli::No }
;
840 None
=> LtoCli
::NoParam
,
841 Some("thin") => LtoCli
::Thin
,
842 Some("fat") => LtoCli
::Fat
,
843 Some(_
) => return false,
848 crate fn parse_linker_plugin_lto(slot
: &mut LinkerPluginLto
, v
: Option
<&str>) -> bool
{
850 let mut bool_arg
= None
;
851 if parse_opt_bool(&mut bool_arg
, v
) {
852 *slot
= if bool_arg
.unwrap() {
853 LinkerPluginLto
::LinkerPluginAuto
855 LinkerPluginLto
::Disabled
862 None
=> LinkerPluginLto
::LinkerPluginAuto
,
863 Some(path
) => LinkerPluginLto
::LinkerPlugin(PathBuf
::from(path
)),
868 crate fn parse_switch_with_opt_path(slot
: &mut SwitchWithOptPath
, v
: Option
<&str>) -> bool
{
870 None
=> SwitchWithOptPath
::Enabled(None
),
871 Some(path
) => SwitchWithOptPath
::Enabled(Some(PathBuf
::from(path
))),
876 crate fn parse_merge_functions(slot
: &mut Option
<MergeFunctions
>, v
: Option
<&str>) -> bool
{
877 match v
.and_then(|s
| MergeFunctions
::from_str(s
).ok()) {
878 Some(mergefunc
) => *slot
= Some(mergefunc
),
884 crate fn parse_relocation_model(slot
: &mut Option
<RelocModel
>, v
: Option
<&str>) -> bool
{
885 match v
.and_then(|s
| RelocModel
::from_str(s
).ok()) {
886 Some(relocation_model
) => *slot
= Some(relocation_model
),
887 None
if v
== Some("default") => *slot
= None
,
893 crate fn parse_code_model(slot
: &mut Option
<CodeModel
>, v
: Option
<&str>) -> bool
{
894 match v
.and_then(|s
| CodeModel
::from_str(s
).ok()) {
895 Some(code_model
) => *slot
= Some(code_model
),
901 crate fn parse_tls_model(slot
: &mut Option
<TlsModel
>, v
: Option
<&str>) -> bool
{
902 match v
.and_then(|s
| TlsModel
::from_str(s
).ok()) {
903 Some(tls_model
) => *slot
= Some(tls_model
),
909 crate fn parse_symbol_mangling_version(
910 slot
: &mut Option
<SymbolManglingVersion
>,
914 Some("legacy") => Some(SymbolManglingVersion
::Legacy
),
915 Some("v0") => Some(SymbolManglingVersion
::V0
),
921 crate fn parse_src_file_hash(
922 slot
: &mut Option
<SourceFileHashAlgorithm
>,
925 match v
.and_then(|s
| SourceFileHashAlgorithm
::from_str(s
).ok()) {
926 Some(hash_kind
) => *slot
= Some(hash_kind
),
932 crate fn parse_target_feature(slot
: &mut String
, v
: Option
<&str>) -> bool
{
935 if !slot
.is_empty() {
945 crate fn parse_wasi_exec_model(slot
: &mut Option
<WasiExecModel
>, v
: Option
<&str>) -> bool
{
947 Some("command") => *slot
= Some(WasiExecModel
::Command
),
948 Some("reactor") => *slot
= Some(WasiExecModel
::Reactor
),
954 crate fn parse_split_debuginfo(slot
: &mut Option
<SplitDebuginfo
>, v
: Option
<&str>) -> bool
{
955 match v
.and_then(|s
| SplitDebuginfo
::from_str(s
).ok()) {
956 Some(e
) => *slot
= Some(e
),
962 crate fn parse_split_dwarf_kind(slot
: &mut SplitDwarfKind
, v
: Option
<&str>) -> bool
{
963 match v
.and_then(|s
| SplitDwarfKind
::from_str(s
).ok()) {
964 Some(e
) => *slot
= e
,
970 crate fn parse_gcc_ld(slot
: &mut Option
<LdImpl
>, v
: Option
<&str>) -> bool
{
972 None
=> *slot
= None
,
973 Some("lld") => *slot
= Some(LdImpl
::Lld
),
979 crate fn parse_stack_protector(slot
: &mut StackProtector
, v
: Option
<&str>) -> bool
{
980 match v
.and_then(|s
| StackProtector
::from_str(s
).ok()) {
981 Some(ssp
) => *slot
= ssp
,
987 crate fn parse_branch_protection(slot
: &mut Option
<BranchProtection
>, v
: Option
<&str>) -> bool
{
990 let slot
= slot
.get_or_insert_default();
991 for opt
in s
.split('
,'
) {
993 "bti" => slot
.bti
= true,
994 "pac-ret" if slot
.pac_ret
.is_none() => {
995 slot
.pac_ret
= Some(PacRet { leaf: false, key: PAuthKey::A }
)
997 "leaf" => match slot
.pac_ret
.as_mut() {
998 Some(pac
) => pac
.leaf
= true,
1001 "b-key" => match slot
.pac_ret
.as_mut() {
1002 Some(pac
) => pac
.key
= PAuthKey
::B
,
1016 CodegenOptions
, CG_OPTIONS
, cgopts
, "C", "codegen",
1018 // This list is in alphabetical order.
1020 // If you add a new option, please update:
1021 // - compiler/rustc_interface/src/tests.rs
1022 // - src/doc/rustc/src/codegen-options/index.md
1024 ar
: String
= (String
::new(), parse_string
, [UNTRACKED
],
1025 "this option is deprecated and does nothing"),
1026 code_model
: Option
<CodeModel
> = (None
, parse_code_model
, [TRACKED
],
1027 "choose the code model to use (`rustc --print code-models` for details)"),
1028 codegen_units
: Option
<usize> = (None
, parse_opt_number
, [UNTRACKED
],
1029 "divide crate into N units to optimize in parallel"),
1030 control_flow_guard
: CFGuard
= (CFGuard
::Disabled
, parse_cfguard
, [TRACKED
],
1031 "use Windows Control Flow Guard (default: no)"),
1032 debug_assertions
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1033 "explicitly enable the `cfg(debug_assertions)` directive"),
1034 debuginfo
: usize = (0, parse_number
, [TRACKED
],
1035 "debug info emission level (0 = no debug info, 1 = line tables only, \
1036 2 = full debug info with variable and type information; default: 0)"),
1037 default_linker_libraries
: bool
= (false, parse_bool
, [UNTRACKED
],
1038 "allow the linker to link its default libraries (default: no)"),
1039 embed_bitcode
: bool
= (true, parse_bool
, [TRACKED
],
1040 "emit bitcode in rlibs (default: yes)"),
1041 extra_filename
: String
= (String
::new(), parse_string
, [UNTRACKED
],
1042 "extra data to put in each output filename"),
1043 force_frame_pointers
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1044 "force use of the frame pointers"),
1045 force_unwind_tables
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1046 "force use of unwind tables"),
1047 incremental
: Option
<String
> = (None
, parse_opt_string
, [UNTRACKED
],
1048 "enable incremental compilation"),
1049 inline_threshold
: Option
<u32> = (None
, parse_opt_number
, [TRACKED
],
1050 "set the threshold for inlining a function"),
1051 instrument_coverage
: Option
<InstrumentCoverage
> = (None
, parse_instrument_coverage
, [TRACKED
],
1052 "instrument the generated code to support LLVM source-based code coverage \
1053 reports (note, the compiler build config must include `profiler = true`); \
1054 implies `-C symbol-mangling-version=v0`. Optional values are:
1055 `=all` (implicit value)
1056 `=except-unused-generics`
1057 `=except-unused-functions`
1059 link_arg
: (/* redirected to link_args */) = ((), parse_string_push
, [UNTRACKED
],
1060 "a single extra argument to append to the linker invocation (can be used several times)"),
1061 link_args
: Vec
<String
> = (Vec
::new(), parse_list
, [UNTRACKED
],
1062 "extra arguments to append to the linker invocation (space separated)"),
1063 link_dead_code
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1064 "keep dead code at link time (useful for code coverage) (default: no)"),
1065 link_self_contained
: Option
<bool
> = (None
, parse_opt_bool
, [UNTRACKED
],
1066 "control whether to link Rust provided C objects/libraries or rely
1067 on C toolchain installed in the system"),
1068 linker
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [UNTRACKED
],
1069 "system linker to link outputs with"),
1070 linker_flavor
: Option
<LinkerFlavor
> = (None
, parse_linker_flavor
, [UNTRACKED
],
1072 linker_plugin_lto
: LinkerPluginLto
= (LinkerPluginLto
::Disabled
,
1073 parse_linker_plugin_lto
, [TRACKED
],
1074 "generate build artifacts that are compatible with linker-based LTO"),
1075 llvm_args
: Vec
<String
> = (Vec
::new(), parse_list
, [TRACKED
],
1076 "a list of arguments to pass to LLVM (space separated)"),
1077 lto
: LtoCli
= (LtoCli
::Unspecified
, parse_lto
, [TRACKED
],
1078 "perform LLVM link-time optimizations"),
1079 metadata
: Vec
<String
> = (Vec
::new(), parse_list
, [TRACKED
],
1080 "metadata to mangle symbol names with"),
1081 no_prepopulate_passes
: bool
= (false, parse_no_flag
, [TRACKED
],
1082 "give an empty list of passes to the pass manager"),
1083 no_redzone
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1084 "disable the use of the redzone"),
1085 no_stack_check
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1086 "this option is deprecated and does nothing"),
1087 no_vectorize_loops
: bool
= (false, parse_no_flag
, [TRACKED
],
1088 "disable loop vectorization optimization passes"),
1089 no_vectorize_slp
: bool
= (false, parse_no_flag
, [TRACKED
],
1090 "disable LLVM's SLP vectorization pass"),
1091 opt_level
: String
= ("0".to_string(), parse_string
, [TRACKED
],
1092 "optimization level (0-3, s, or z; default: 0)"),
1093 overflow_checks
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1094 "use overflow checks for integer arithmetic"),
1095 panic
: Option
<PanicStrategy
> = (None
, parse_opt_panic_strategy
, [TRACKED
],
1096 "panic strategy to compile crate with"),
1097 passes
: Vec
<String
> = (Vec
::new(), parse_list
, [TRACKED
],
1098 "a list of extra LLVM passes to run (space separated)"),
1099 prefer_dynamic
: bool
= (false, parse_bool
, [TRACKED
],
1100 "prefer dynamic linking to static linking (default: no)"),
1101 profile_generate
: SwitchWithOptPath
= (SwitchWithOptPath
::Disabled
,
1102 parse_switch_with_opt_path
, [TRACKED
],
1103 "compile the program with profiling instrumentation"),
1104 profile_use
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1105 "use the given `.profdata` file for profile-guided optimization"),
1106 relocation_model
: Option
<RelocModel
> = (None
, parse_relocation_model
, [TRACKED
],
1107 "control generation of position-independent code (PIC) \
1108 (`rustc --print relocation-models` for details)"),
1109 remark
: Passes
= (Passes
::Some(Vec
::new()), parse_passes
, [UNTRACKED
],
1110 "print remarks for these optimization passes (space separated, or \"all\")"),
1111 rpath
: bool
= (false, parse_bool
, [UNTRACKED
],
1112 "set rpath values in libs/exes (default: no)"),
1113 save_temps
: bool
= (false, parse_bool
, [UNTRACKED
],
1114 "save all temporary output files during compilation (default: no)"),
1115 soft_float
: bool
= (false, parse_bool
, [TRACKED
],
1116 "use soft float ABI (*eabihf targets only) (default: no)"),
1117 split_debuginfo
: Option
<SplitDebuginfo
> = (None
, parse_split_debuginfo
, [TRACKED
],
1118 "how to handle split-debuginfo, a platform-specific option"),
1119 strip
: Strip
= (Strip
::None
, parse_strip
, [UNTRACKED
],
1120 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1121 symbol_mangling_version
: Option
<SymbolManglingVersion
> = (None
,
1122 parse_symbol_mangling_version
, [TRACKED
],
1123 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1124 target_cpu
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1125 "select target processor (`rustc --print target-cpus` for details)"),
1126 target_feature
: String
= (String
::new(), parse_target_feature
, [TRACKED
],
1127 "target specific attributes. (`rustc --print target-features` for details). \
1128 This feature is unsafe."),
1130 // This list is in alphabetical order.
1132 // If you add a new option, please update:
1133 // - compiler/rustc_interface/src/tests.rs
1134 // - src/doc/rustc/src/codegen-options/index.md
1138 DebuggingOptions
, DB_OPTIONS
, dbopts
, "Z", "debugging",
1140 // This list is in alphabetical order.
1142 // If you add a new option, please update:
1143 // - compiler/rustc_interface/src/tests.rs
1145 allow_features
: Option
<Vec
<String
>> = (None
, parse_opt_comma_list
, [TRACKED
],
1146 "only allow the listed language features to be enabled in code (space separated)"),
1147 always_encode_mir
: bool
= (false, parse_bool
, [TRACKED
],
1148 "encode MIR of all functions into the crate metadata (default: no)"),
1149 assume_incomplete_release
: bool
= (false, parse_bool
, [TRACKED
],
1150 "make cfg(version) treat the current version as incomplete (default: no)"),
1151 asm_comments
: bool
= (false, parse_bool
, [TRACKED
],
1152 "generate comments into the assembly (may change behavior) (default: no)"),
1153 assert_incr_state
: Option
<String
> = (None
, parse_opt_string
, [UNTRACKED
],
1154 "assert that the incremental cache is in given state: \
1155 either `loaded` or `not-loaded`."),
1156 ast_json
: bool
= (false, parse_bool
, [UNTRACKED
],
1157 "print the AST as JSON and halt (default: no)"),
1158 ast_json_noexpand
: bool
= (false, parse_bool
, [UNTRACKED
],
1159 "print the pre-expansion AST as JSON and halt (default: no)"),
1160 binary_dep_depinfo
: bool
= (false, parse_bool
, [TRACKED
],
1161 "include artifacts (sysroot, crate dependencies) used during compilation in dep-info \
1163 borrowck
: String
= ("migrate".to_string(), parse_string
, [UNTRACKED
],
1164 "select which borrowck is used (`mir` or `migrate`) (default: `migrate`)"),
1165 branch_protection
: Option
<BranchProtection
> = (None
, parse_branch_protection
, [TRACKED
],
1166 "set options for branch target identification and pointer authentication on AArch64"),
1167 cf_protection
: CFProtection
= (CFProtection
::None
, parse_cfprotection
, [TRACKED
],
1168 "instrument control-flow architecture protection"),
1169 cgu_partitioning_strategy
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1170 "the codegen unit partitioning strategy to use"),
1171 chalk
: bool
= (false, parse_bool
, [TRACKED
],
1172 "enable the experimental Chalk-based trait solving engine"),
1173 codegen_backend
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1174 "the backend to use"),
1175 combine_cgu
: bool
= (false, parse_bool
, [TRACKED
],
1176 "combine CGUs into a single one"),
1177 crate_attr
: Vec
<String
> = (Vec
::new(), parse_string_push
, [TRACKED
],
1178 "inject the given attribute in the crate"),
1179 debug_info_for_profiling
: bool
= (false, parse_bool
, [TRACKED
],
1180 "emit discriminators and other data necessary for AutoFDO"),
1181 debug_macros
: bool
= (false, parse_bool
, [TRACKED
],
1182 "emit line numbers debug info inside macros (default: no)"),
1183 deduplicate_diagnostics
: bool
= (true, parse_bool
, [UNTRACKED
],
1184 "deduplicate identical diagnostics (default: yes)"),
1185 dep_info_omit_d_target
: bool
= (false, parse_bool
, [TRACKED
],
1186 "in dep-info output, omit targets for tracking dependencies of the dep-info files \
1187 themselves (default: no)"),
1188 dep_tasks
: bool
= (false, parse_bool
, [UNTRACKED
],
1189 "print tasks that execute and the color their dep node gets (requires debug build) \
1191 dlltool
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [UNTRACKED
],
1192 "import library generation tool (windows-gnu only)"),
1193 dont_buffer_diagnostics
: bool
= (false, parse_bool
, [UNTRACKED
],
1194 "emit diagnostics rather than buffering (breaks NLL error downgrading, sorting) \
1196 drop_tracking
: bool
= (false, parse_bool
, [TRACKED
],
1197 "enables drop tracking in generators (default: no)"),
1198 dual_proc_macros
: bool
= (false, parse_bool
, [TRACKED
],
1199 "load proc macros for both target and host, but only link to the target (default: no)"),
1200 dump_dep_graph
: bool
= (false, parse_bool
, [UNTRACKED
],
1201 "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv) \
1203 dump_mir
: Option
<String
> = (None
, parse_opt_string
, [UNTRACKED
],
1204 "dump MIR state to file.
1205 `val` is used to select which passes and functions to dump. For example:
1206 `all` matches all passes and functions,
1207 `foo` matches all passes for functions whose name contains 'foo',
1208 `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
1209 `foo | bar` all passes for function names containing 'foo' or 'bar'."),
1210 dump_mir_dataflow
: bool
= (false, parse_bool
, [UNTRACKED
],
1211 "in addition to `.mir` files, create graphviz `.dot` files with dataflow results \
1213 dump_mir_dir
: String
= ("mir_dump".to_string(), parse_string
, [UNTRACKED
],
1214 "the directory the MIR is dumped into (default: `mir_dump`)"),
1215 dump_mir_exclude_pass_number
: bool
= (false, parse_bool
, [UNTRACKED
],
1216 "exclude the pass number when dumping MIR (used in tests) (default: no)"),
1217 dump_mir_graphviz
: bool
= (false, parse_bool
, [UNTRACKED
],
1218 "in addition to `.mir` files, create graphviz `.dot` files (and with \
1219 `-Z instrument-coverage`, also create a `.dot` file for the MIR-derived \
1220 coverage graph) (default: no)"),
1221 dump_mir_spanview
: Option
<MirSpanview
> = (None
, parse_mir_spanview
, [UNTRACKED
],
1222 "in addition to `.mir` files, create `.html` files to view spans for \
1223 all `statement`s (including terminators), only `terminator` spans, or \
1224 computed `block` spans (one span encompassing a block's terminator and \
1225 all statements). If `-Z instrument-coverage` is also enabled, create \
1226 an additional `.html` file showing the computed coverage spans."),
1227 emit_stack_sizes
: bool
= (false, parse_bool
, [UNTRACKED
],
1228 "emit a section containing stack size metadata (default: no)"),
1229 fewer_names
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1230 "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR) \
1232 force_unstable_if_unmarked
: bool
= (false, parse_bool
, [TRACKED
],
1233 "force all crates to be `rustc_private` unstable (default: no)"),
1234 fuel
: Option
<(String
, u64)> = (None
, parse_optimization_fuel
, [TRACKED
],
1235 "set the optimization fuel quota for a crate"),
1236 function_sections
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1237 "whether each function should go in its own section"),
1238 future_incompat_test
: bool
= (false, parse_bool
, [UNTRACKED
],
1239 "forces all lints to be future incompatible, used for internal testing (default: no)"),
1240 gcc_ld
: Option
<LdImpl
> = (None
, parse_gcc_ld
, [TRACKED
], "implementation of ld used by cc"),
1241 graphviz_dark_mode
: bool
= (false, parse_bool
, [UNTRACKED
],
1242 "use dark-themed colors in graphviz output (default: no)"),
1243 graphviz_font
: String
= ("Courier, monospace".to_string(), parse_string
, [UNTRACKED
],
1244 "use the given `fontname` in graphviz output; can be overridden by setting \
1245 environment variable `RUSTC_GRAPHVIZ_FONT` (default: `Courier, monospace`)"),
1246 hir_stats
: bool
= (false, parse_bool
, [UNTRACKED
],
1247 "print some statistics about AST and HIR (default: no)"),
1248 human_readable_cgu_names
: bool
= (false, parse_bool
, [TRACKED
],
1249 "generate human-readable, predictable names for codegen units (default: no)"),
1250 identify_regions
: bool
= (false, parse_bool
, [UNTRACKED
],
1251 "display unnamed regions as `'<id>`, using a non-ident unique id (default: no)"),
1252 incremental_ignore_spans
: bool
= (false, parse_bool
, [UNTRACKED
],
1253 "ignore spans during ICH computation -- used for testing (default: no)"),
1254 incremental_info
: bool
= (false, parse_bool
, [UNTRACKED
],
1255 "print high-level information about incremental reuse (or the lack thereof) \
1257 incremental_relative_spans
: bool
= (false, parse_bool
, [TRACKED
],
1258 "hash spans relative to their parent item for incr. comp. (default: no)"),
1259 incremental_verify_ich
: bool
= (false, parse_bool
, [UNTRACKED
],
1260 "verify incr. comp. hashes of green query instances (default: no)"),
1261 inline_mir
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1262 "enable MIR inlining (default: no)"),
1263 inline_mir_threshold
: Option
<usize> = (None
, parse_opt_number
, [TRACKED
],
1264 "a default MIR inlining threshold (default: 50)"),
1265 inline_mir_hint_threshold
: Option
<usize> = (None
, parse_opt_number
, [TRACKED
],
1266 "inlining threshold for functions with inline hint (default: 100)"),
1267 inline_in_all_cgus
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1268 "control whether `#[inline]` functions are in all CGUs"),
1269 input_stats
: bool
= (false, parse_bool
, [UNTRACKED
],
1270 "gather statistics about the input (default: no)"),
1271 instrument_coverage
: Option
<InstrumentCoverage
> = (None
, parse_instrument_coverage
, [TRACKED
],
1272 "instrument the generated code to support LLVM source-based code coverage \
1273 reports (note, the compiler build config must include `profiler = true`); \
1274 implies `-C symbol-mangling-version=v0`. Optional values are:
1275 `=all` (implicit value)
1276 `=except-unused-generics`
1277 `=except-unused-functions`
1279 instrument_mcount
: bool
= (false, parse_bool
, [TRACKED
],
1280 "insert function instrument code for mcount-based tracing (default: no)"),
1281 keep_hygiene_data
: bool
= (false, parse_bool
, [UNTRACKED
],
1282 "keep hygiene data after analysis (default: no)"),
1283 link_native_libraries
: bool
= (true, parse_bool
, [UNTRACKED
],
1284 "link native libraries in the linker invocation (default: yes)"),
1285 link_only
: bool
= (false, parse_bool
, [TRACKED
],
1286 "link the `.rlink` file generated by `-Z no-link` (default: no)"),
1287 llvm_plugins
: Vec
<String
> = (Vec
::new(), parse_list
, [TRACKED
],
1288 "a list LLVM plugins to enable (space separated)"),
1289 llvm_time_trace
: bool
= (false, parse_bool
, [UNTRACKED
],
1290 "generate JSON tracing data file from LLVM data (default: no)"),
1291 location_detail
: LocationDetail
= (LocationDetail
::all(), parse_location_detail
, [TRACKED
],
1292 "comma seperated list of location details to be tracked when using caller_location \
1293 valid options are `file`, `line`, and `column` (default: all)"),
1294 ls
: bool
= (false, parse_bool
, [UNTRACKED
],
1295 "list the symbols defined by a library crate (default: no)"),
1296 macro_backtrace
: bool
= (false, parse_bool
, [UNTRACKED
],
1297 "show macro backtraces (default: no)"),
1298 merge_functions
: Option
<MergeFunctions
> = (None
, parse_merge_functions
, [TRACKED
],
1299 "control the operation of the MergeFunctions LLVM pass, taking \
1300 the same values as the target option of the same name"),
1301 meta_stats
: bool
= (false, parse_bool
, [UNTRACKED
],
1302 "gather metadata statistics (default: no)"),
1303 mir_emit_retag
: bool
= (false, parse_bool
, [TRACKED
],
1304 "emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0 \
1306 mir_opt_level
: Option
<usize> = (None
, parse_opt_number
, [TRACKED
],
1307 "MIR optimization level (0-4; default: 1 in non optimized builds and 2 in optimized builds)"),
1308 move_size_limit
: Option
<usize> = (None
, parse_opt_number
, [TRACKED
],
1309 "the size at which the `large_assignments` lint starts to be emitted"),
1310 mutable_noalias
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1311 "emit noalias metadata for mutable references (default: yes)"),
1312 new_llvm_pass_manager
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1313 "use new LLVM pass manager (default: no)"),
1314 nll_facts
: bool
= (false, parse_bool
, [UNTRACKED
],
1315 "dump facts from NLL analysis into side files (default: no)"),
1316 nll_facts_dir
: String
= ("nll-facts".to_string(), parse_string
, [UNTRACKED
],
1317 "the directory the NLL facts are dumped into (default: `nll-facts`)"),
1318 no_analysis
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1319 "parse and expand the source, but run no analysis"),
1320 no_codegen
: bool
= (false, parse_no_flag
, [TRACKED_NO_CRATE_HASH
],
1321 "run all passes except codegen; no output"),
1322 no_generate_arange_section
: bool
= (false, parse_no_flag
, [TRACKED
],
1323 "omit DWARF address ranges that give faster lookups"),
1324 no_interleave_lints
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1325 "execute lints separately; allows benchmarking individual lints"),
1326 no_leak_check
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1327 "disable the 'leak check' for subtyping; unsound, but useful for tests"),
1328 no_link
: bool
= (false, parse_no_flag
, [TRACKED
],
1329 "compile without linking"),
1330 no_parallel_llvm
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1331 "run LLVM in non-parallel mode (while keeping codegen-units and ThinLTO)"),
1332 no_unique_section_names
: bool
= (false, parse_bool
, [TRACKED
],
1333 "do not use unique names for text and data sections when -Z function-sections is used"),
1334 no_profiler_runtime
: bool
= (false, parse_no_flag
, [TRACKED
],
1335 "prevent automatic injection of the profiler_builtins crate"),
1336 normalize_docs
: bool
= (false, parse_bool
, [TRACKED
],
1337 "normalize associated items in rustdoc when generating documentation"),
1338 osx_rpath_install_name
: bool
= (false, parse_bool
, [TRACKED
],
1339 "pass `-install_name @rpath/...` to the macOS linker (default: no)"),
1340 panic_abort_tests
: bool
= (false, parse_bool
, [TRACKED
],
1341 "support compiling tests with panic=abort (default: no)"),
1342 panic_in_drop
: PanicStrategy
= (PanicStrategy
::Unwind
, parse_panic_strategy
, [TRACKED
],
1343 "panic strategy for panics in drops"),
1344 parse_only
: bool
= (false, parse_bool
, [UNTRACKED
],
1345 "parse only; do not compile, assemble, or link (default: no)"),
1346 partially_uninit_const_threshold
: Option
<usize> = (None
, parse_opt_number
, [TRACKED
],
1347 "allow generating const initializers with mixed init/uninit bytes, \
1348 and set the maximum total size of a const allocation for which this is allowed (default: never)"),
1349 perf_stats
: bool
= (false, parse_bool
, [UNTRACKED
],
1350 "print some performance-related statistics (default: no)"),
1351 pick_stable_methods_before_any_unstable
: bool
= (true, parse_bool
, [TRACKED
],
1352 "try to pick stable methods first before picking any unstable methods (default: yes)"),
1353 plt
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1354 "whether to use the PLT when calling into shared libraries;
1355 only has effect for PIC code on systems with ELF binaries
1356 (default: PLT is disabled if full relro is enabled)"),
1357 polonius
: bool
= (false, parse_bool
, [TRACKED
],
1358 "enable polonius-based borrow-checker (default: no)"),
1359 polymorphize
: bool
= (false, parse_bool
, [TRACKED
],
1360 "perform polymorphization analysis"),
1361 pre_link_arg
: (/* redirected to pre_link_args */) = ((), parse_string_push
, [UNTRACKED
],
1362 "a single extra argument to prepend the linker invocation (can be used several times)"),
1363 pre_link_args
: Vec
<String
> = (Vec
::new(), parse_list
, [UNTRACKED
],
1364 "extra arguments to prepend to the linker invocation (space separated)"),
1365 precise_enum_drop_elaboration
: bool
= (true, parse_bool
, [TRACKED
],
1366 "use a more precise version of drop elaboration for matches on enums (default: yes). \
1367 This results in better codegen, but has caused miscompilations on some tier 2 platforms. \
1368 See #77382 and #74551."),
1369 print_fuel
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1370 "make rustc print the total optimization fuel used by a crate"),
1371 print_llvm_passes
: bool
= (false, parse_bool
, [UNTRACKED
],
1372 "print the LLVM optimization passes being run (default: no)"),
1373 print_mono_items
: Option
<String
> = (None
, parse_opt_string
, [UNTRACKED
],
1374 "print the result of the monomorphization collection pass"),
1375 print_type_sizes
: bool
= (false, parse_bool
, [UNTRACKED
],
1376 "print layout information for each type encountered (default: no)"),
1377 proc_macro_backtrace
: bool
= (false, parse_bool
, [UNTRACKED
],
1378 "show backtraces for panics during proc-macro execution (default: no)"),
1379 profile
: bool
= (false, parse_bool
, [TRACKED
],
1380 "insert profiling code (default: no)"),
1381 profile_closures
: bool
= (false, parse_no_flag
, [UNTRACKED
],
1382 "profile size of closures"),
1383 profile_emit
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1384 "file path to emit profiling data at runtime when using 'profile' \
1385 (default based on relative source path)"),
1386 profiler_runtime
: String
= (String
::from("profiler_builtins"), parse_string
, [TRACKED
],
1387 "name of the profiler runtime crate to automatically inject (default: `profiler_builtins`)"),
1388 profile_sample_use
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1389 "use the given `.prof` file for sampled profile-guided optimization (also known as AutoFDO)"),
1390 query_dep_graph
: bool
= (false, parse_bool
, [UNTRACKED
],
1391 "enable queries of the dependency graph for regression testing (default: no)"),
1392 randomize_layout
: bool
= (false, parse_bool
, [TRACKED
],
1393 "randomize the layout of types (default: no)"),
1394 layout_seed
: Option
<u64> = (None
, parse_opt_number
, [TRACKED
],
1395 "seed layout randomization"),
1396 relax_elf_relocations
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1397 "whether ELF relocations can be relaxed"),
1398 relro_level
: Option
<RelroLevel
> = (None
, parse_relro_level
, [TRACKED
],
1399 "choose which RELRO level to use"),
1400 remap_cwd_prefix
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1401 "remap paths under the current working directory to this path prefix"),
1402 simulate_remapped_rust_src_base
: Option
<PathBuf
> = (None
, parse_opt_pathbuf
, [TRACKED
],
1403 "simulate the effect of remap-debuginfo = true at bootstrapping by remapping path \
1404 to rust's source base directory. only meant for testing purposes"),
1405 report_delayed_bugs
: bool
= (false, parse_bool
, [TRACKED
],
1406 "immediately print bugs registered with `delay_span_bug` (default: no)"),
1407 sanitizer
: SanitizerSet
= (SanitizerSet
::empty(), parse_sanitizers
, [TRACKED
],
1409 sanitizer_memory_track_origins
: usize = (0, parse_sanitizer_memory_track_origins
, [TRACKED
],
1410 "enable origins tracking in MemorySanitizer"),
1411 sanitizer_recover
: SanitizerSet
= (SanitizerSet
::empty(), parse_sanitizers
, [TRACKED
],
1412 "enable recovery for selected sanitizers"),
1413 saturating_float_casts
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1414 "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
1415 the max/min integer respectively, and NaN is mapped to 0 (default: yes)"),
1416 save_analysis
: bool
= (false, parse_bool
, [UNTRACKED
],
1417 "write syntax and type analysis (in JSON format) information, in \
1418 addition to normal output (default: no)"),
1419 self_profile
: SwitchWithOptPath
= (SwitchWithOptPath
::Disabled
,
1420 parse_switch_with_opt_path
, [UNTRACKED
],
1421 "run the self profiler and output the raw event data"),
1422 /// keep this in sync with the event filter names in librustc_data_structures/profiling.rs
1423 self_profile_events
: Option
<Vec
<String
>> = (None
, parse_opt_comma_list
, [UNTRACKED
],
1424 "specify the events recorded by the self profiler;
1425 for example: `-Z self-profile-events=default,query-keys`
1426 all options: none, all, default, generic-activity, query-provider, query-cache-hit
1427 query-blocked, incr-cache-load, incr-result-hashing, query-keys, function-args, args, llvm, artifact-sizes"),
1428 share_generics
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1429 "make the current crate share its generic instantiations"),
1430 show_span
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1431 "show spans for compiler debugging (expr|pat|ty)"),
1432 span_debug
: bool
= (false, parse_bool
, [UNTRACKED
],
1433 "forward proc_macro::Span's `Debug` impl to `Span`"),
1434 /// o/w tests have closure@path
1435 span_free_formats
: bool
= (false, parse_bool
, [UNTRACKED
],
1436 "exclude spans when debug-printing compiler state (default: no)"),
1437 src_hash_algorithm
: Option
<SourceFileHashAlgorithm
> = (None
, parse_src_file_hash
, [TRACKED
],
1438 "hash algorithm of source files in debug info (`md5`, `sha1`, or `sha256`)"),
1439 stack_protector
: StackProtector
= (StackProtector
::None
, parse_stack_protector
, [TRACKED
],
1440 "control stack smash protection strategy (`rustc --print stack-protector-strategies` for details)"),
1441 strip
: Strip
= (Strip
::None
, parse_strip
, [UNTRACKED
],
1442 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1443 split_dwarf_kind
: SplitDwarfKind
= (SplitDwarfKind
::Split
, parse_split_dwarf_kind
, [UNTRACKED
],
1444 "split dwarf variant (only if -Csplit-debuginfo is enabled and on relevant platform)
1447 `split`: sections which do not require relocation are written into a DWARF object (`.dwo`)
1448 file which is ignored by the linker
1449 `single`: sections which do not require relocation are written into object file but ignored
1451 split_dwarf_inlining
: bool
= (true, parse_bool
, [UNTRACKED
],
1452 "provide minimal debug info in the object/executable to facilitate online \
1453 symbolication/stack traces in the absence of .dwo/.dwp files when using Split DWARF"),
1454 symbol_mangling_version
: Option
<SymbolManglingVersion
> = (None
,
1455 parse_symbol_mangling_version
, [TRACKED
],
1456 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1457 teach
: bool
= (false, parse_bool
, [TRACKED
],
1458 "show extended diagnostic help (default: no)"),
1459 temps_dir
: Option
<String
> = (None
, parse_opt_string
, [UNTRACKED
],
1460 "the directory the intermediate files are written to"),
1461 terminal_width
: Option
<usize> = (None
, parse_opt_number
, [UNTRACKED
],
1462 "set the current terminal width"),
1463 tune_cpu
: Option
<String
> = (None
, parse_opt_string
, [TRACKED
],
1464 "select processor to schedule for (`rustc --print target-cpus` for details)"),
1465 thinlto
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1466 "enable ThinLTO when possible"),
1467 thir_unsafeck
: bool
= (false, parse_bool
, [TRACKED
],
1468 "use the THIR unsafety checker (default: no)"),
1469 /// We default to 1 here since we want to behave like
1470 /// a sequential compiler for now. This'll likely be adjusted
1471 /// in the future. Note that -Zthreads=0 is the way to get
1472 /// the num_cpus behavior.
1473 threads
: usize = (1, parse_threads
, [UNTRACKED
],
1474 "use a thread pool with N threads"),
1475 time
: bool
= (false, parse_bool
, [UNTRACKED
],
1476 "measure time of rustc processes (default: no)"),
1477 time_llvm_passes
: bool
= (false, parse_bool
, [UNTRACKED
],
1478 "measure time of each LLVM pass (default: no)"),
1479 time_passes
: bool
= (false, parse_bool
, [UNTRACKED
],
1480 "measure time of each rustc pass (default: no)"),
1481 tls_model
: Option
<TlsModel
> = (None
, parse_tls_model
, [TRACKED
],
1482 "choose the TLS model to use (`rustc --print tls-models` for details)"),
1483 trace_macros
: bool
= (false, parse_bool
, [UNTRACKED
],
1484 "for every macro invocation, print its name and arguments (default: no)"),
1485 trap_unreachable
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1486 "generate trap instructions for unreachable intrinsics (default: use target setting, usually yes)"),
1487 treat_err_as_bug
: Option
<NonZeroUsize
> = (None
, parse_treat_err_as_bug
, [TRACKED
],
1488 "treat error number `val` that occurs as bug"),
1489 trim_diagnostic_paths
: bool
= (true, parse_bool
, [UNTRACKED
],
1490 "in diagnostics, use heuristics to shorten paths referring to items"),
1491 ui_testing
: bool
= (false, parse_bool
, [UNTRACKED
],
1492 "emit compiler diagnostics in a form suitable for UI testing (default: no)"),
1493 unleash_the_miri_inside_of_you
: bool
= (false, parse_bool
, [TRACKED
],
1494 "take the brakes off const evaluation. NOTE: this is unsound (default: no)"),
1495 unpretty
: Option
<String
> = (None
, parse_unpretty
, [UNTRACKED
],
1496 "present the input source, unstable (and less-pretty) variants;
1497 `normal`, `identified`,
1498 `expanded`, `expanded,identified`,
1499 `expanded,hygiene` (with internal representations),
1500 `everybody_loops` (all function bodies replaced with `loop {}`),
1501 `ast-tree` (raw AST before expansion),
1502 `ast-tree,expanded` (raw AST after expansion),
1503 `hir` (the HIR), `hir,identified`,
1504 `hir,typed` (HIR with types for each node),
1505 `hir-tree` (dump the raw HIR),
1506 `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)"),
1507 unsound_mir_opts
: bool
= (false, parse_bool
, [TRACKED
],
1508 "enable unsound and buggy MIR optimizations (default: no)"),
1509 unstable_options
: bool
= (false, parse_bool
, [UNTRACKED
],
1510 "adds unstable command line options to rustc interface (default: no)"),
1511 use_ctors_section
: Option
<bool
> = (None
, parse_opt_bool
, [TRACKED
],
1512 "use legacy .ctors section for initializers rather than .init_array"),
1513 validate_mir
: bool
= (false, parse_bool
, [UNTRACKED
],
1514 "validate MIR after each transformation"),
1515 verbose
: bool
= (false, parse_bool
, [UNTRACKED
],
1516 "in general, enable more debug printouts (default: no)"),
1517 verify_llvm_ir
: bool
= (false, parse_bool
, [TRACKED
],
1518 "verify LLVM IR (default: no)"),
1519 wasi_exec_model
: Option
<WasiExecModel
> = (None
, parse_wasi_exec_model
, [TRACKED
],
1520 "whether to build a wasi command or reactor"),
1522 // This list is in alphabetical order.
1524 // If you add a new option, please update:
1525 // - compiler/rustc_interface/src/tests.rs
1528 #[derive(Clone, Hash, PartialEq, Eq, Debug)]
1529 pub enum WasiExecModel
{
1534 #[derive(Clone, Copy, Hash)]