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, LinkerFlavorCli, 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 /// The top-level command-line options struct.
108 /// For each option, one has to specify how it behaves with regard to the
109 /// dependency tracking system of incremental compilation. This is done via the
110 /// square-bracketed directive after the field type. The options are:
113 /// A change in the given field will cause the compiler to completely clear the
114 /// incremental compilation cache before proceeding.
116 /// - `[TRACKED_NO_CRATE_HASH]`
117 /// Same as `[TRACKED]`, but will not affect the crate hash. This is useful for options that only
118 /// affect the incremental cache.
121 /// Incremental compilation is not influenced by this option.
124 /// Second-level sub-structs containing more options.
126 /// If you add a new option to this struct or one of the sub-structs like
127 /// `CodegenOptions`, think about how it influences incremental compilation. If in
128 /// doubt, specify `[TRACKED]`, which is always "correct" but might lead to
129 /// unnecessary re-compilation.
132 /// The crate config requested for the session, which may be combined
133 /// with additional crate configurations during the compile process.
134 #[rustc_lint_opt_deny_field_access("use `Session::crate_types` instead of this field")]
135 crate_types: Vec<CrateType> [TRACKED],
136 optimize: OptLevel [TRACKED],
137 /// Include the `debug_assertions` flag in dependency tracking, since it
138 /// can influence whether overflow checks are done or not.
139 debug_assertions: bool [TRACKED],
140 debuginfo: DebugInfo [TRACKED],
141 lint_opts: Vec<(String, lint::Level)> [TRACKED_NO_CRATE_HASH],
142 lint_cap: Option<lint::Level> [TRACKED_NO_CRATE_HASH],
143 describe_lints: bool [UNTRACKED],
144 output_types: OutputTypes [TRACKED],
145 search_paths: Vec<SearchPath> [UNTRACKED],
146 libs: Vec<NativeLib> [TRACKED],
147 maybe_sysroot: Option<PathBuf> [UNTRACKED],
149 target_triple: TargetTriple [TRACKED],
151 test: bool [TRACKED],
152 error_format: ErrorOutputType [UNTRACKED],
153 diagnostic_width: Option<usize> [UNTRACKED],
155 /// If `Some`, enable incremental compilation, using the given
156 /// directory to store intermediate results.
157 incremental: Option<PathBuf> [UNTRACKED],
158 assert_incr_state: Option<IncrementalStateAssertion> [UNTRACKED],
160 unstable_opts: UnstableOptions [SUBSTRUCT],
161 prints: Vec<PrintRequest> [UNTRACKED],
162 cg: CodegenOptions [SUBSTRUCT],
163 externs: Externs [UNTRACKED],
164 crate_name: Option<String> [TRACKED],
165 /// Indicates how the compiler should treat unstable features.
166 unstable_features: UnstableFeatures [TRACKED],
168 /// Indicates whether this run of the compiler is actually rustdoc. This
169 /// is currently just a hack and will be removed eventually, so please
170 /// try to not rely on this too much.
171 actually_rustdoc: bool [TRACKED],
173 /// Control path trimming.
174 trimmed_def_paths: TrimmedDefPaths [TRACKED],
176 /// Specifications of codegen units / ThinLTO which are forced as a
177 /// result of parsing command line options. These are not necessarily
178 /// what rustc was invoked with, but massaged a bit to agree with
179 /// commands like `--emit llvm-ir` which they're often incompatible with
180 /// if we otherwise use the defaults of rustc.
181 #[rustc_lint_opt_deny_field_access("use `Session::codegen_units` instead of this field")]
182 cli_forced_codegen_units: Option<usize> [UNTRACKED],
183 #[rustc_lint_opt_deny_field_access("use `Session::lto` instead of this field")]
184 cli_forced_local_thinlto_off: bool [UNTRACKED],
186 /// Remap source path prefixes in all output (messages, object files, debug, etc.).
187 remap_path_prefix: Vec<(PathBuf, PathBuf)> [TRACKED_NO_CRATE_HASH],
188 /// Base directory containing the `src/` for the Rust standard library, and
189 /// potentially `rustc` as well, if we can find it. Right now it's always
190 /// `$sysroot/lib/rustlib/src/rust` (i.e. the `rustup` `rust-src` component).
192 /// This directory is what the virtual `/rustc/$hash` is translated back to,
193 /// if Rust was built with path remapping to `/rustc/$hash` enabled
194 /// (the `rust.remap-debuginfo` option in `config.toml`).
195 real_rust_source_base_dir: Option<PathBuf> [TRACKED_NO_CRATE_HASH],
197 edition: Edition [TRACKED],
199 /// `true` if we're emitting JSON blobs about each artifact produced
201 json_artifact_notifications: bool [TRACKED],
203 /// `true` if we're emitting a JSON blob containing the unused externs
204 json_unused_externs: JsonUnusedExterns [UNTRACKED],
206 /// `true` if we're emitting a JSON job containing a future-incompat report for lints
207 json_future_incompat: bool [TRACKED],
209 pretty: Option<PpMode> [UNTRACKED],
211 /// The (potentially remapped) working directory
212 working_dir: RealFileName [TRACKED],
216 /// Defines all `CodegenOptions`/`DebuggingOptions` fields and parsers all at once. The goal of this
217 /// macro is to define an interface that can be programmatically used by the option parser
218 /// to initialize the struct without hardcoding field names all over the place.
220 /// The goal is to invoke this macro once with the correct fields, and then this macro generates all
221 /// necessary code. The main gotcha of this macro is the `cgsetters` module which is a bunch of
222 /// generated code to parse an option into its respective field in the struct. There are a few
223 /// hand-written parsers for parsing specific types of values in this module.
224 macro_rules! options {
225 ($struct_name:ident, $stat:ident, $optmod:ident, $prefix:expr, $outputname:expr,
226 $($( #[$attr:meta] )* $opt:ident : $t:ty = (
229 [$dep_tracking_marker:ident],
235 pub struct $struct_name { $( $( #[$attr] )* pub $opt: $t),* }
237 impl Default for $struct_name {
238 fn default() -> $struct_name {
239 $struct_name { $($opt: $init),* }
245 matches: &getopts::Matches,
246 error_format: ErrorOutputType,
248 build_options(matches, $stat, $prefix, $outputname, error_format)
251 fn dep_tracking_hash(&self, for_crate_hash: bool, error_format: ErrorOutputType) -> u64 {
252 let mut sub_hashes = BTreeMap::new();
258 [$dep_tracking_marker]);
260 let mut hasher = DefaultHasher::new();
261 dep_tracking::stable_hash(sub_hashes,
270 pub const $stat: OptionDescrs<$struct_name> =
271 &[ $( (stringify!($opt), $optmod::$opt, desc::$parse, $desc) ),* ];
275 pub(super) fn $opt(cg: &mut super::$struct_name, v: Option<&str>) -> bool {
276 super::parse::$parse(&mut redirect_field!(cg.$opt), v)
283 impl CodegenOptions {
284 // JUSTIFICATION: defn of the suggested wrapper fn
285 #[allow(rustc::bad_opt_access)]
286 pub fn instrument_coverage(&self) -> InstrumentCoverage {
287 self.instrument_coverage.unwrap_or(InstrumentCoverage::Off)
291 // Sometimes different options need to build a common structure.
292 // That structure can be kept in one of the options' fields, the others become dummy.
293 macro_rules! redirect_field {
294 ($cg:ident.link_arg) => {
297 ($cg:ident.pre_link_arg) => {
300 ($cg:ident.$field:ident) => {
305 type OptionSetter<O> = fn(&mut O, v: Option<&str>) -> bool;
306 type OptionDescrs<O> = &'static [(&'static str, OptionSetter<O>, &'static str, &'static str)];
308 fn build_options<O: Default>(
309 matches: &getopts::Matches,
310 descrs: OptionDescrs<O>,
313 error_format: ErrorOutputType,
315 let mut op = O::default();
316 for option in matches.opt_strs(prefix) {
317 let (key, value) = match option.split_once('=') {
318 None => (option, None),
319 Some((k, v)) => (k.to_string(), Some(v)),
322 let option_to_lookup = key.replace('-', "_");
323 match descrs.iter().find(|(name, ..)| *name == option_to_lookup) {
324 Some((_, setter, type_desc, _)) => {
325 if !setter(&mut op, value) {
330 "{0} option `{1}` requires {2} ({3} {1}=<value>)",
331 outputname, key, type_desc, prefix
334 Some(value) => early_error(
337 "incorrect value `{value}` for {outputname} option `{key}` - {type_desc} was expected"
343 None => early_error(error_format, &format!("unknown {outputname} option: `{key}`")),
349 #[allow(non_upper_case_globals)]
351 pub const parse_no_flag: &str = "no value";
352 pub const parse_bool: &str = "one of: `y`, `yes`, `on`, `n`, `no`, or `off`";
353 pub const parse_opt_bool: &str = parse_bool;
354 pub const parse_string: &str = "a string";
355 pub const parse_opt_string: &str = parse_string;
356 pub const parse_string_push: &str = parse_string;
357 pub const parse_opt_langid: &str = "a language identifier";
358 pub const parse_opt_pathbuf: &str = "a path";
359 pub const parse_list: &str = "a space-separated list of strings";
360 pub const parse_list_with_polarity: &str =
361 "a comma-separated list of strings, with elements beginning with + or -";
362 pub const parse_opt_comma_list: &str = "a comma-separated list of strings";
363 pub const parse_number: &str = "a number";
364 pub const parse_opt_number: &str = parse_number;
365 pub const parse_threads: &str = parse_number;
366 pub const parse_passes: &str = "a space-separated list of passes, or `all`";
367 pub const parse_panic_strategy: &str = "either `unwind` or `abort`";
368 pub const parse_opt_panic_strategy: &str = parse_panic_strategy;
369 pub const parse_oom_strategy: &str = "either `panic` or `abort`";
370 pub const parse_relro_level: &str = "one of: `full`, `partial`, or `off`";
371 pub const parse_sanitizers: &str = "comma separated list of sanitizers: `address`, `cfi`, `hwaddress`, `leak`, `memory`, `memtag`, `shadow-call-stack`, or `thread`";
372 pub const parse_sanitizer_memory_track_origins: &str = "0, 1, or 2";
373 pub const parse_cfguard: &str =
374 "either a boolean (`yes`, `no`, `on`, `off`, etc), `checks`, or `nochecks`";
375 pub const parse_cfprotection: &str = "`none`|`no`|`n` (default), `branch`, `return`, or `full`|`yes`|`y` (equivalent to `branch` and `return`)";
376 pub const parse_strip: &str = "either `none`, `debuginfo`, or `symbols`";
377 pub const parse_linker_flavor: &str = ::rustc_target::spec::LinkerFlavorCli::one_of();
378 pub const parse_optimization_fuel: &str = "crate=integer";
379 pub const parse_mir_spanview: &str = "`statement` (default), `terminator`, or `block`";
380 pub const parse_instrument_coverage: &str =
381 "`all` (default), `except-unused-generics`, `except-unused-functions`, or `off`";
382 pub const parse_unpretty: &str = "`string` or `string=string`";
383 pub const parse_treat_err_as_bug: &str = "either no value or a number bigger than 0";
384 pub const parse_lto: &str =
385 "either a boolean (`yes`, `no`, `on`, `off`, etc), `thin`, `fat`, or omitted";
386 pub const parse_linker_plugin_lto: &str =
387 "either a boolean (`yes`, `no`, `on`, `off`, etc), or the path to the linker plugin";
388 pub const parse_location_detail: &str = "either `none`, or a comma separated list of location details to track: `file`, `line`, or `column`";
389 pub const parse_switch_with_opt_path: &str =
390 "an optional path to the profiling data output directory";
391 pub const parse_merge_functions: &str = "one of: `disabled`, `trampolines`, or `aliases`";
392 pub const parse_symbol_mangling_version: &str = "either `legacy` or `v0` (RFC 2603)";
393 pub const parse_src_file_hash: &str = "either `md5` or `sha1`";
394 pub const parse_relocation_model: &str =
395 "one of supported relocation models (`rustc --print relocation-models`)";
396 pub const parse_code_model: &str = "one of supported code models (`rustc --print code-models`)";
397 pub const parse_tls_model: &str = "one of supported TLS models (`rustc --print tls-models`)";
398 pub const parse_target_feature: &str = parse_string;
399 pub const parse_wasi_exec_model: &str = "either `command` or `reactor`";
400 pub const parse_split_debuginfo: &str =
401 "one of supported split-debuginfo modes (`off`, `packed`, or `unpacked`)";
402 pub const parse_split_dwarf_kind: &str =
403 "one of supported split dwarf modes (`split` or `single`)";
404 pub const parse_gcc_ld: &str = "one of: no value, `lld`";
405 pub const parse_stack_protector: &str =
406 "one of (`none` (default), `basic`, `strong`, or `all`)";
407 pub const parse_branch_protection: &str =
408 "a `,` separated combination of `bti`, `b-key`, `pac-ret`, or `leaf`";
409 pub const parse_proc_macro_execution_strategy: &str =
410 "one of supported execution strategies (`same-thread`, or `cross-thread`)";
414 pub(crate) use super::*;
415 use std::str::FromStr;
417 /// This is for boolean options that don't take a value and start with
418 /// `no-`. This style of option is deprecated.
419 pub(crate) fn parse_no_flag(slot: &mut bool, v: Option<&str>) -> bool {
429 /// Use this for any boolean option that has a static default.
430 pub(crate) fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
432 Some("y") | Some("yes") | Some("on") | None => {
436 Some("n") | Some("no") | Some("off") => {
444 /// Use this for any boolean option that lacks a static default. (The
445 /// actions taken when such an option is not specified will depend on
446 /// other factors, such as other options, or target options.)
447 pub(crate) fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
449 Some("y") | Some("yes") | Some("on") | None => {
453 Some("n") | Some("no") | Some("off") => {
461 /// Use this for any string option that has a static default.
462 pub(crate) fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
465 *slot = s.to_string();
472 /// Use this for any string option that lacks a static default.
473 pub(crate) fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
476 *slot = Some(s.to_string());
483 /// Parse an optional language identifier, e.g. `en-US` or `zh-CN`.
484 pub(crate) fn parse_opt_langid(slot: &mut Option<LanguageIdentifier>, v: Option<&str>) -> bool {
487 *slot = rustc_errors::LanguageIdentifier::from_str(s).ok();
494 pub(crate) fn parse_opt_pathbuf(slot: &mut Option<PathBuf>, v: Option<&str>) -> bool {
497 *slot = Some(PathBuf::from(s));
504 pub(crate) fn parse_string_push(slot: &mut Vec<String>, v: Option<&str>) -> bool {
507 slot.push(s.to_string());
514 pub(crate) fn parse_list(slot: &mut Vec<String>, v: Option<&str>) -> bool {
517 slot.extend(s.split_whitespace().map(|s| s.to_string()));
524 pub(crate) fn parse_list_with_polarity(
525 slot: &mut Vec<(String, bool)>,
530 for s in s.split(',') {
531 let Some(pass_name) = s.strip_prefix(&['+', '-'][..]) else { return false };
532 slot.push((pass_name.to_string(), &s[..1] == "+"));
540 pub(crate) fn parse_location_detail(ld: &mut LocationDetail, v: Option<&str>) -> bool {
548 for s in v.split(',') {
550 "file" => ld.file = true,
551 "line" => ld.line = true,
552 "column" => ld.column = true,
562 pub(crate) fn parse_opt_comma_list(slot: &mut Option<Vec<String>>, v: Option<&str>) -> bool {
565 let mut v: Vec<_> = s.split(',').map(|s| s.to_string()).collect();
574 pub(crate) fn parse_threads(slot: &mut usize, v: Option<&str>) -> bool {
575 match v.and_then(|s| s.parse().ok()) {
577 *slot = std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get);
588 /// Use this for any numeric option that has a static default.
589 pub(crate) fn parse_number<T: Copy + FromStr>(slot: &mut T, v: Option<&str>) -> bool {
590 match v.and_then(|s| s.parse().ok()) {
599 /// Use this for any numeric option that lacks a static default.
600 pub(crate) fn parse_opt_number<T: Copy + FromStr>(
601 slot: &mut Option<T>,
606 *slot = s.parse().ok();
613 pub(crate) fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
620 let mut passes = vec![];
621 if parse_list(&mut passes, v) {
631 pub(crate) fn parse_opt_panic_strategy(
632 slot: &mut Option<PanicStrategy>,
636 Some("unwind") => *slot = Some(PanicStrategy::Unwind),
637 Some("abort") => *slot = Some(PanicStrategy::Abort),
643 pub(crate) fn parse_panic_strategy(slot: &mut PanicStrategy, v: Option<&str>) -> bool {
645 Some("unwind") => *slot = PanicStrategy::Unwind,
646 Some("abort") => *slot = PanicStrategy::Abort,
652 pub(crate) fn parse_oom_strategy(slot: &mut OomStrategy, v: Option<&str>) -> bool {
654 Some("panic") => *slot = OomStrategy::Panic,
655 Some("abort") => *slot = OomStrategy::Abort,
661 pub(crate) fn parse_relro_level(slot: &mut Option<RelroLevel>, v: Option<&str>) -> bool {
663 Some(s) => match s.parse::<RelroLevel>() {
664 Ok(level) => *slot = Some(level),
672 pub(crate) fn parse_sanitizers(slot: &mut SanitizerSet, v: Option<&str>) -> bool {
674 for s in v.split(',') {
676 "address" => SanitizerSet::ADDRESS,
677 "cfi" => SanitizerSet::CFI,
678 "leak" => SanitizerSet::LEAK,
679 "memory" => SanitizerSet::MEMORY,
680 "memtag" => SanitizerSet::MEMTAG,
681 "shadow-call-stack" => SanitizerSet::SHADOWCALLSTACK,
682 "thread" => SanitizerSet::THREAD,
683 "hwaddress" => SanitizerSet::HWADDRESS,
693 pub(crate) fn parse_sanitizer_memory_track_origins(slot: &mut usize, v: Option<&str>) -> bool {
695 Some("2") | None => {
711 pub(crate) fn parse_strip(slot: &mut Strip, v: Option<&str>) -> bool {
713 Some("none") => *slot = Strip::None,
714 Some("debuginfo") => *slot = Strip::Debuginfo,
715 Some("symbols") => *slot = Strip::Symbols,
721 pub(crate) fn parse_cfguard(slot: &mut CFGuard, v: Option<&str>) -> bool {
723 let mut bool_arg = None;
724 if parse_opt_bool(&mut bool_arg, v) {
725 *slot = if bool_arg.unwrap() { CFGuard::Checks } else { CFGuard::Disabled };
731 None => CFGuard::Checks,
732 Some("checks") => CFGuard::Checks,
733 Some("nochecks") => CFGuard::NoChecks,
734 Some(_) => return false,
739 pub(crate) fn parse_cfprotection(slot: &mut CFProtection, v: Option<&str>) -> bool {
741 let mut bool_arg = None;
742 if parse_opt_bool(&mut bool_arg, v) {
743 *slot = if bool_arg.unwrap() { CFProtection::Full } else { CFProtection::None };
749 None | Some("none") => CFProtection::None,
750 Some("branch") => CFProtection::Branch,
751 Some("return") => CFProtection::Return,
752 Some("full") => CFProtection::Full,
753 Some(_) => return false,
758 pub(crate) fn parse_linker_flavor(slot: &mut Option<LinkerFlavorCli>, v: Option<&str>) -> bool {
759 match v.and_then(LinkerFlavorCli::from_str) {
760 Some(lf) => *slot = Some(lf),
766 pub(crate) fn parse_optimization_fuel(
767 slot: &mut Option<(String, u64)>,
773 let parts = s.split('=').collect::<Vec<_>>();
774 if parts.len() != 2 {
777 let crate_name = parts[0].to_string();
778 let fuel = parts[1].parse::<u64>();
782 *slot = Some((crate_name, fuel.unwrap()));
788 pub(crate) fn parse_unpretty(slot: &mut Option<String>, v: Option<&str>) -> bool {
791 Some(s) if s.split('=').count() <= 2 => {
792 *slot = Some(s.to_string());
799 pub(crate) fn parse_mir_spanview(slot: &mut Option<MirSpanview>, v: Option<&str>) -> bool {
801 let mut bool_arg = None;
802 if parse_opt_bool(&mut bool_arg, v) {
803 *slot = if bool_arg.unwrap() { Some(MirSpanview::Statement) } else { None };
808 let Some(v) = v else {
809 *slot = Some(MirSpanview::Statement);
813 *slot = Some(match v.trim_end_matches('s') {
814 "statement" | "stmt" => MirSpanview::Statement,
815 "terminator" | "term" => MirSpanview::Terminator,
816 "block" | "basicblock" => MirSpanview::Block,
822 pub(crate) fn parse_instrument_coverage(
823 slot: &mut Option<InstrumentCoverage>,
827 let mut bool_arg = None;
828 if parse_opt_bool(&mut bool_arg, v) {
829 *slot = if bool_arg.unwrap() { Some(InstrumentCoverage::All) } else { None };
834 let Some(v) = v else {
835 *slot = Some(InstrumentCoverage::All);
839 *slot = Some(match v {
840 "all" => InstrumentCoverage::All,
841 "except-unused-generics" | "except_unused_generics" => {
842 InstrumentCoverage::ExceptUnusedGenerics
844 "except-unused-functions" | "except_unused_functions" => {
845 InstrumentCoverage::ExceptUnusedFunctions
847 "off" | "no" | "n" | "false" | "0" => InstrumentCoverage::Off,
853 pub(crate) fn parse_treat_err_as_bug(slot: &mut Option<NonZeroUsize>, v: Option<&str>) -> bool {
856 *slot = s.parse().ok();
860 *slot = NonZeroUsize::new(1);
866 pub(crate) fn parse_lto(slot: &mut LtoCli, v: Option<&str>) -> bool {
868 let mut bool_arg = None;
869 if parse_opt_bool(&mut bool_arg, v) {
870 *slot = if bool_arg.unwrap() { LtoCli::Yes } else { LtoCli::No };
876 None => LtoCli::NoParam,
877 Some("thin") => LtoCli::Thin,
878 Some("fat") => LtoCli::Fat,
879 Some(_) => return false,
884 pub(crate) fn parse_linker_plugin_lto(slot: &mut LinkerPluginLto, v: Option<&str>) -> bool {
886 let mut bool_arg = None;
887 if parse_opt_bool(&mut bool_arg, v) {
888 *slot = if bool_arg.unwrap() {
889 LinkerPluginLto::LinkerPluginAuto
891 LinkerPluginLto::Disabled
898 None => LinkerPluginLto::LinkerPluginAuto,
899 Some(path) => LinkerPluginLto::LinkerPlugin(PathBuf::from(path)),
904 pub(crate) fn parse_switch_with_opt_path(
905 slot: &mut SwitchWithOptPath,
909 None => SwitchWithOptPath::Enabled(None),
910 Some(path) => SwitchWithOptPath::Enabled(Some(PathBuf::from(path))),
915 pub(crate) fn parse_merge_functions(
916 slot: &mut Option<MergeFunctions>,
919 match v.and_then(|s| MergeFunctions::from_str(s).ok()) {
920 Some(mergefunc) => *slot = Some(mergefunc),
926 pub(crate) fn parse_relocation_model(slot: &mut Option<RelocModel>, v: Option<&str>) -> bool {
927 match v.and_then(|s| RelocModel::from_str(s).ok()) {
928 Some(relocation_model) => *slot = Some(relocation_model),
929 None if v == Some("default") => *slot = None,
935 pub(crate) fn parse_code_model(slot: &mut Option<CodeModel>, v: Option<&str>) -> bool {
936 match v.and_then(|s| CodeModel::from_str(s).ok()) {
937 Some(code_model) => *slot = Some(code_model),
943 pub(crate) fn parse_tls_model(slot: &mut Option<TlsModel>, v: Option<&str>) -> bool {
944 match v.and_then(|s| TlsModel::from_str(s).ok()) {
945 Some(tls_model) => *slot = Some(tls_model),
951 pub(crate) fn parse_symbol_mangling_version(
952 slot: &mut Option<SymbolManglingVersion>,
956 Some("legacy") => Some(SymbolManglingVersion::Legacy),
957 Some("v0") => Some(SymbolManglingVersion::V0),
963 pub(crate) fn parse_src_file_hash(
964 slot: &mut Option<SourceFileHashAlgorithm>,
967 match v.and_then(|s| SourceFileHashAlgorithm::from_str(s).ok()) {
968 Some(hash_kind) => *slot = Some(hash_kind),
974 pub(crate) fn parse_target_feature(slot: &mut String, v: Option<&str>) -> bool {
977 if !slot.is_empty() {
987 pub(crate) fn parse_wasi_exec_model(slot: &mut Option<WasiExecModel>, v: Option<&str>) -> bool {
989 Some("command") => *slot = Some(WasiExecModel::Command),
990 Some("reactor") => *slot = Some(WasiExecModel::Reactor),
996 pub(crate) fn parse_split_debuginfo(
997 slot: &mut Option<SplitDebuginfo>,
1000 match v.and_then(|s| SplitDebuginfo::from_str(s).ok()) {
1001 Some(e) => *slot = Some(e),
1007 pub(crate) fn parse_split_dwarf_kind(slot: &mut SplitDwarfKind, v: Option<&str>) -> bool {
1008 match v.and_then(|s| SplitDwarfKind::from_str(s).ok()) {
1009 Some(e) => *slot = e,
1015 pub(crate) fn parse_gcc_ld(slot: &mut Option<LdImpl>, v: Option<&str>) -> bool {
1017 None => *slot = None,
1018 Some("lld") => *slot = Some(LdImpl::Lld),
1024 pub(crate) fn parse_stack_protector(slot: &mut StackProtector, v: Option<&str>) -> bool {
1025 match v.and_then(|s| StackProtector::from_str(s).ok()) {
1026 Some(ssp) => *slot = ssp,
1032 pub(crate) fn parse_branch_protection(
1033 slot: &mut Option<BranchProtection>,
1038 let slot = slot.get_or_insert_default();
1039 for opt in s.split(',') {
1041 "bti" => slot.bti = true,
1042 "pac-ret" if slot.pac_ret.is_none() => {
1043 slot.pac_ret = Some(PacRet { leaf: false, key: PAuthKey::A })
1045 "leaf" => match slot.pac_ret.as_mut() {
1046 Some(pac) => pac.leaf = true,
1049 "b-key" => match slot.pac_ret.as_mut() {
1050 Some(pac) => pac.key = PAuthKey::B,
1062 pub(crate) fn parse_proc_macro_execution_strategy(
1063 slot: &mut ProcMacroExecutionStrategy,
1067 Some("same-thread") => ProcMacroExecutionStrategy::SameThread,
1068 Some("cross-thread") => ProcMacroExecutionStrategy::CrossThread,
1076 CodegenOptions, CG_OPTIONS, cgopts, "C", "codegen",
1078 // If you add a new option, please update:
1079 // - compiler/rustc_interface/src/tests.rs
1080 // - src/doc/rustc/src/codegen-options/index.md
1082 // tidy-alphabetical-start
1083 ar: String = (String::new(), parse_string, [UNTRACKED],
1084 "this option is deprecated and does nothing"),
1085 #[rustc_lint_opt_deny_field_access("use `Session::code_model` instead of this field")]
1086 code_model: Option<CodeModel> = (None, parse_code_model, [TRACKED],
1087 "choose the code model to use (`rustc --print code-models` for details)"),
1088 codegen_units: Option<usize> = (None, parse_opt_number, [UNTRACKED],
1089 "divide crate into N units to optimize in parallel"),
1090 control_flow_guard: CFGuard = (CFGuard::Disabled, parse_cfguard, [TRACKED],
1091 "use Windows Control Flow Guard (default: no)"),
1092 debug_assertions: Option<bool> = (None, parse_opt_bool, [TRACKED],
1093 "explicitly enable the `cfg(debug_assertions)` directive"),
1094 debuginfo: usize = (0, parse_number, [TRACKED],
1095 "debug info emission level (0 = no debug info, 1 = line tables only, \
1096 2 = full debug info with variable and type information; default: 0)"),
1097 default_linker_libraries: bool = (false, parse_bool, [UNTRACKED],
1098 "allow the linker to link its default libraries (default: no)"),
1099 embed_bitcode: bool = (true, parse_bool, [TRACKED],
1100 "emit bitcode in rlibs (default: yes)"),
1101 extra_filename: String = (String::new(), parse_string, [UNTRACKED],
1102 "extra data to put in each output filename"),
1103 force_frame_pointers: Option<bool> = (None, parse_opt_bool, [TRACKED],
1104 "force use of the frame pointers"),
1105 #[rustc_lint_opt_deny_field_access("use `Session::must_emit_unwind_tables` instead of this field")]
1106 force_unwind_tables: Option<bool> = (None, parse_opt_bool, [TRACKED],
1107 "force use of unwind tables"),
1108 incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
1109 "enable incremental compilation"),
1110 inline_threshold: Option<u32> = (None, parse_opt_number, [TRACKED],
1111 "set the threshold for inlining a function"),
1112 #[rustc_lint_opt_deny_field_access("use `Session::instrument_coverage` instead of this field")]
1113 instrument_coverage: Option<InstrumentCoverage> = (None, parse_instrument_coverage, [TRACKED],
1114 "instrument the generated code to support LLVM source-based code coverage \
1115 reports (note, the compiler build config must include `profiler = true`); \
1116 implies `-C symbol-mangling-version=v0`. Optional values are:
1117 `=all` (implicit value)
1118 `=except-unused-generics`
1119 `=except-unused-functions`
1121 link_arg: (/* redirected to link_args */) = ((), parse_string_push, [UNTRACKED],
1122 "a single extra argument to append to the linker invocation (can be used several times)"),
1123 link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
1124 "extra arguments to append to the linker invocation (space separated)"),
1125 #[rustc_lint_opt_deny_field_access("use `Session::link_dead_code` instead of this field")]
1126 link_dead_code: Option<bool> = (None, parse_opt_bool, [TRACKED],
1127 "keep dead code at link time (useful for code coverage) (default: no)"),
1128 link_self_contained: Option<bool> = (None, parse_opt_bool, [UNTRACKED],
1129 "control whether to link Rust provided C objects/libraries or rely
1130 on C toolchain installed in the system"),
1131 linker: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1132 "system linker to link outputs with"),
1133 linker_flavor: Option<LinkerFlavorCli> = (None, parse_linker_flavor, [UNTRACKED],
1135 linker_plugin_lto: LinkerPluginLto = (LinkerPluginLto::Disabled,
1136 parse_linker_plugin_lto, [TRACKED],
1137 "generate build artifacts that are compatible with linker-based LTO"),
1138 llvm_args: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1139 "a list of arguments to pass to LLVM (space separated)"),
1140 #[rustc_lint_opt_deny_field_access("use `Session::lto` instead of this field")]
1141 lto: LtoCli = (LtoCli::Unspecified, parse_lto, [TRACKED],
1142 "perform LLVM link-time optimizations"),
1143 metadata: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1144 "metadata to mangle symbol names with"),
1145 no_prepopulate_passes: bool = (false, parse_no_flag, [TRACKED],
1146 "give an empty list of passes to the pass manager"),
1147 no_redzone: Option<bool> = (None, parse_opt_bool, [TRACKED],
1148 "disable the use of the redzone"),
1149 no_stack_check: bool = (false, parse_no_flag, [UNTRACKED],
1150 "this option is deprecated and does nothing"),
1151 no_vectorize_loops: bool = (false, parse_no_flag, [TRACKED],
1152 "disable loop vectorization optimization passes"),
1153 no_vectorize_slp: bool = (false, parse_no_flag, [TRACKED],
1154 "disable LLVM's SLP vectorization pass"),
1155 opt_level: String = ("0".to_string(), parse_string, [TRACKED],
1156 "optimization level (0-3, s, or z; default: 0)"),
1157 #[rustc_lint_opt_deny_field_access("use `Session::overflow_checks` instead of this field")]
1158 overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1159 "use overflow checks for integer arithmetic"),
1160 #[rustc_lint_opt_deny_field_access("use `Session::panic_strategy` instead of this field")]
1161 panic: Option<PanicStrategy> = (None, parse_opt_panic_strategy, [TRACKED],
1162 "panic strategy to compile crate with"),
1163 passes: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1164 "a list of extra LLVM passes to run (space separated)"),
1165 prefer_dynamic: bool = (false, parse_bool, [TRACKED],
1166 "prefer dynamic linking to static linking (default: no)"),
1167 profile_generate: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1168 parse_switch_with_opt_path, [TRACKED],
1169 "compile the program with profiling instrumentation"),
1170 profile_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1171 "use the given `.profdata` file for profile-guided optimization"),
1172 #[rustc_lint_opt_deny_field_access("use `Session::relocation_model` instead of this field")]
1173 relocation_model: Option<RelocModel> = (None, parse_relocation_model, [TRACKED],
1174 "control generation of position-independent code (PIC) \
1175 (`rustc --print relocation-models` for details)"),
1176 remark: Passes = (Passes::Some(Vec::new()), parse_passes, [UNTRACKED],
1177 "print remarks for these optimization passes (space separated, or \"all\")"),
1178 rpath: bool = (false, parse_bool, [UNTRACKED],
1179 "set rpath values in libs/exes (default: no)"),
1180 save_temps: bool = (false, parse_bool, [UNTRACKED],
1181 "save all temporary output files during compilation (default: no)"),
1182 soft_float: bool = (false, parse_bool, [TRACKED],
1183 "use soft float ABI (*eabihf targets only) (default: no)"),
1184 #[rustc_lint_opt_deny_field_access("use `Session::split_debuginfo` instead of this field")]
1185 split_debuginfo: Option<SplitDebuginfo> = (None, parse_split_debuginfo, [TRACKED],
1186 "how to handle split-debuginfo, a platform-specific option"),
1187 strip: Strip = (Strip::None, parse_strip, [UNTRACKED],
1188 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1189 symbol_mangling_version: Option<SymbolManglingVersion> = (None,
1190 parse_symbol_mangling_version, [TRACKED],
1191 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1192 target_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1193 "select target processor (`rustc --print target-cpus` for details)"),
1194 target_feature: String = (String::new(), parse_target_feature, [TRACKED],
1195 "target specific attributes. (`rustc --print target-features` for details). \
1196 This feature is unsafe."),
1197 // tidy-alphabetical-end
1199 // If you add a new option, please update:
1200 // - compiler/rustc_interface/src/tests.rs
1201 // - src/doc/rustc/src/codegen-options/index.md
1205 UnstableOptions, Z_OPTIONS, dbopts, "Z", "unstable",
1207 // If you add a new option, please update:
1208 // - compiler/rustc_interface/src/tests.rs
1209 // - src/doc/unstable-book/src/compiler-flags
1211 // tidy-alphabetical-start
1212 allow_features: Option<Vec<String>> = (None, parse_opt_comma_list, [TRACKED],
1213 "only allow the listed language features to be enabled in code (space separated)"),
1214 always_encode_mir: bool = (false, parse_bool, [TRACKED],
1215 "encode MIR of all functions into the crate metadata (default: no)"),
1216 #[rustc_lint_opt_deny_field_access("use `Session::asm_comments` instead of this field")]
1217 asm_comments: bool = (false, parse_bool, [TRACKED],
1218 "generate comments into the assembly (may change behavior) (default: no)"),
1219 assert_incr_state: Option<String> = (None, parse_opt_string, [UNTRACKED],
1220 "assert that the incremental cache is in given state: \
1221 either `loaded` or `not-loaded`."),
1222 assume_incomplete_release: bool = (false, parse_bool, [TRACKED],
1223 "make cfg(version) treat the current version as incomplete (default: no)"),
1224 #[rustc_lint_opt_deny_field_access("use `Session::binary_dep_depinfo` instead of this field")]
1225 binary_dep_depinfo: bool = (false, parse_bool, [TRACKED],
1226 "include artifacts (sysroot, crate dependencies) used during compilation in dep-info \
1228 box_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1229 "emit noalias metadata for box (default: yes)"),
1230 branch_protection: Option<BranchProtection> = (None, parse_branch_protection, [TRACKED],
1231 "set options for branch target identification and pointer authentication on AArch64"),
1232 cf_protection: CFProtection = (CFProtection::None, parse_cfprotection, [TRACKED],
1233 "instrument control-flow architecture protection"),
1234 cgu_partitioning_strategy: Option<String> = (None, parse_opt_string, [TRACKED],
1235 "the codegen unit partitioning strategy to use"),
1236 chalk: bool = (false, parse_bool, [TRACKED],
1237 "enable the experimental Chalk-based trait solving engine"),
1238 codegen_backend: Option<String> = (None, parse_opt_string, [TRACKED],
1239 "the backend to use"),
1240 combine_cgu: bool = (false, parse_bool, [TRACKED],
1241 "combine CGUs into a single one"),
1242 crate_attr: Vec<String> = (Vec::new(), parse_string_push, [TRACKED],
1243 "inject the given attribute in the crate"),
1244 debug_info_for_profiling: bool = (false, parse_bool, [TRACKED],
1245 "emit discriminators and other data necessary for AutoFDO"),
1246 debug_macros: bool = (false, parse_bool, [TRACKED],
1247 "emit line numbers debug info inside macros (default: no)"),
1248 deduplicate_diagnostics: bool = (true, parse_bool, [UNTRACKED],
1249 "deduplicate identical diagnostics (default: yes)"),
1250 dep_info_omit_d_target: bool = (false, parse_bool, [TRACKED],
1251 "in dep-info output, omit targets for tracking dependencies of the dep-info files \
1252 themselves (default: no)"),
1253 dep_tasks: bool = (false, parse_bool, [UNTRACKED],
1254 "print tasks that execute and the color their dep node gets (requires debug build) \
1256 diagnostic_width: Option<usize> = (None, parse_opt_number, [UNTRACKED],
1257 "set the current output width for diagnostic truncation"),
1258 dlltool: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1259 "import library generation tool (windows-gnu only)"),
1260 dont_buffer_diagnostics: bool = (false, parse_bool, [UNTRACKED],
1261 "emit diagnostics rather than buffering (breaks NLL error downgrading, sorting) \
1263 drop_tracking: bool = (false, parse_bool, [TRACKED],
1264 "enables drop tracking in generators (default: no)"),
1265 dual_proc_macros: bool = (false, parse_bool, [TRACKED],
1266 "load proc macros for both target and host, but only link to the target (default: no)"),
1267 dump_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1268 "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv) \
1270 dump_drop_tracking_cfg: Option<String> = (None, parse_opt_string, [UNTRACKED],
1271 "dump drop-tracking control-flow graph as a `.dot` file (default: no)"),
1272 dump_mir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1273 "dump MIR state to file.
1274 `val` is used to select which passes and functions to dump. For example:
1275 `all` matches all passes and functions,
1276 `foo` matches all passes for functions whose name contains 'foo',
1277 `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
1278 `foo | bar` all passes for function names containing 'foo' or 'bar'."),
1279 dump_mir_dataflow: bool = (false, parse_bool, [UNTRACKED],
1280 "in addition to `.mir` files, create graphviz `.dot` files with dataflow results \
1282 dump_mir_dir: String = ("mir_dump".to_string(), parse_string, [UNTRACKED],
1283 "the directory the MIR is dumped into (default: `mir_dump`)"),
1284 dump_mir_exclude_pass_number: bool = (false, parse_bool, [UNTRACKED],
1285 "exclude the pass number when dumping MIR (used in tests) (default: no)"),
1286 dump_mir_graphviz: bool = (false, parse_bool, [UNTRACKED],
1287 "in addition to `.mir` files, create graphviz `.dot` files (and with \
1288 `-Z instrument-coverage`, also create a `.dot` file for the MIR-derived \
1289 coverage graph) (default: no)"),
1290 dump_mir_spanview: Option<MirSpanview> = (None, parse_mir_spanview, [UNTRACKED],
1291 "in addition to `.mir` files, create `.html` files to view spans for \
1292 all `statement`s (including terminators), only `terminator` spans, or \
1293 computed `block` spans (one span encompassing a block's terminator and \
1294 all statements). If `-Z instrument-coverage` is also enabled, create \
1295 an additional `.html` file showing the computed coverage spans."),
1296 dwarf_version: Option<u32> = (None, parse_opt_number, [TRACKED],
1297 "version of DWARF debug information to emit (default: 2 or 4, depending on platform)"),
1298 dylib_lto: bool = (false, parse_bool, [UNTRACKED],
1299 "enables LTO for dylib crate type"),
1300 emit_stack_sizes: bool = (false, parse_bool, [UNTRACKED],
1301 "emit a section containing stack size metadata (default: no)"),
1302 emit_thin_lto: bool = (true, parse_bool, [TRACKED],
1303 "emit the bc module with thin LTO info (default: yes)"),
1304 export_executable_symbols: bool = (false, parse_bool, [TRACKED],
1305 "export symbols from executables, as if they were dynamic libraries"),
1306 extra_const_ub_checks: bool = (false, parse_bool, [TRACKED],
1307 "turns on more checks to detect const UB, which can be slow (default: no)"),
1308 #[rustc_lint_opt_deny_field_access("use `Session::fewer_names` instead of this field")]
1309 fewer_names: Option<bool> = (None, parse_opt_bool, [TRACKED],
1310 "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR) \
1312 force_unstable_if_unmarked: bool = (false, parse_bool, [TRACKED],
1313 "force all crates to be `rustc_private` unstable (default: no)"),
1314 fuel: Option<(String, u64)> = (None, parse_optimization_fuel, [TRACKED],
1315 "set the optimization fuel quota for a crate"),
1316 function_sections: Option<bool> = (None, parse_opt_bool, [TRACKED],
1317 "whether each function should go in its own section"),
1318 future_incompat_test: bool = (false, parse_bool, [UNTRACKED],
1319 "forces all lints to be future incompatible, used for internal testing (default: no)"),
1320 gcc_ld: Option<LdImpl> = (None, parse_gcc_ld, [TRACKED], "implementation of ld used by cc"),
1321 graphviz_dark_mode: bool = (false, parse_bool, [UNTRACKED],
1322 "use dark-themed colors in graphviz output (default: no)"),
1323 graphviz_font: String = ("Courier, monospace".to_string(), parse_string, [UNTRACKED],
1324 "use the given `fontname` in graphviz output; can be overridden by setting \
1325 environment variable `RUSTC_GRAPHVIZ_FONT` (default: `Courier, monospace`)"),
1326 hir_stats: bool = (false, parse_bool, [UNTRACKED],
1327 "print some statistics about AST and HIR (default: no)"),
1328 human_readable_cgu_names: bool = (false, parse_bool, [TRACKED],
1329 "generate human-readable, predictable names for codegen units (default: no)"),
1330 identify_regions: bool = (false, parse_bool, [UNTRACKED],
1331 "display unnamed regions as `'<id>`, using a non-ident unique id (default: no)"),
1332 incremental_ignore_spans: bool = (false, parse_bool, [UNTRACKED],
1333 "ignore spans during ICH computation -- used for testing (default: no)"),
1334 incremental_info: bool = (false, parse_bool, [UNTRACKED],
1335 "print high-level information about incremental reuse (or the lack thereof) \
1337 incremental_relative_spans: bool = (false, parse_bool, [TRACKED],
1338 "hash spans relative to their parent item for incr. comp. (default: no)"),
1339 incremental_verify_ich: bool = (false, parse_bool, [UNTRACKED],
1340 "verify incr. comp. hashes of green query instances (default: no)"),
1341 inline_in_all_cgus: Option<bool> = (None, parse_opt_bool, [TRACKED],
1342 "control whether `#[inline]` functions are in all CGUs"),
1343 inline_llvm: bool = (true, parse_bool, [TRACKED],
1344 "enable LLVM inlining (default: yes)"),
1345 inline_mir: Option<bool> = (None, parse_opt_bool, [TRACKED],
1346 "enable MIR inlining (default: no)"),
1347 inline_mir_hint_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1348 "inlining threshold for functions with inline hint (default: 100)"),
1349 inline_mir_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1350 "a default MIR inlining threshold (default: 50)"),
1351 input_stats: bool = (false, parse_bool, [UNTRACKED],
1352 "gather statistics about the input (default: no)"),
1353 #[rustc_lint_opt_deny_field_access("use `Session::instrument_coverage` instead of this field")]
1354 instrument_coverage: Option<InstrumentCoverage> = (None, parse_instrument_coverage, [TRACKED],
1355 "instrument the generated code to support LLVM source-based code coverage \
1356 reports (note, the compiler build config must include `profiler = true`); \
1357 implies `-C symbol-mangling-version=v0`. Optional values are:
1358 `=all` (implicit value)
1359 `=except-unused-generics`
1360 `=except-unused-functions`
1362 #[rustc_lint_opt_deny_field_access("use `Session::instrument_mcount` instead of this field")]
1363 instrument_mcount: bool = (false, parse_bool, [TRACKED],
1364 "insert function instrument code for mcount-based tracing (default: no)"),
1365 keep_hygiene_data: bool = (false, parse_bool, [UNTRACKED],
1366 "keep hygiene data after analysis (default: no)"),
1367 layout_seed: Option<u64> = (None, parse_opt_number, [TRACKED],
1368 "seed layout randomization"),
1369 link_native_libraries: bool = (true, parse_bool, [UNTRACKED],
1370 "link native libraries in the linker invocation (default: yes)"),
1371 link_only: bool = (false, parse_bool, [TRACKED],
1372 "link the `.rlink` file generated by `-Z no-link` (default: no)"),
1373 llvm_plugins: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1374 "a list LLVM plugins to enable (space separated)"),
1375 llvm_time_trace: bool = (false, parse_bool, [UNTRACKED],
1376 "generate JSON tracing data file from LLVM data (default: no)"),
1377 location_detail: LocationDetail = (LocationDetail::all(), parse_location_detail, [TRACKED],
1378 "what location details should be tracked when using caller_location, either \
1379 `none`, or a comma separated list of location details, for which \
1380 valid options are `file`, `line`, and `column` (default: `file,line,column`)"),
1381 ls: bool = (false, parse_bool, [UNTRACKED],
1382 "list the symbols defined by a library crate (default: no)"),
1383 macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1384 "show macro backtraces (default: no)"),
1385 merge_functions: Option<MergeFunctions> = (None, parse_merge_functions, [TRACKED],
1386 "control the operation of the MergeFunctions LLVM pass, taking \
1387 the same values as the target option of the same name"),
1388 #[rustc_lint_opt_deny_field_access("use `Session::meta_stats` instead of this field")]
1389 meta_stats: bool = (false, parse_bool, [UNTRACKED],
1390 "gather metadata statistics (default: no)"),
1391 mir_emit_retag: bool = (false, parse_bool, [TRACKED],
1392 "emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0 \
1394 mir_enable_passes: Vec<(String, bool)> = (Vec::new(), parse_list_with_polarity, [TRACKED],
1395 "use like `-Zmir-enable-passes=+DestProp,-InstCombine`. Forces the specified passes to be \
1396 enabled, overriding all other checks. Passes that are not specified are enabled or \
1397 disabled by other flags as usual."),
1398 #[rustc_lint_opt_deny_field_access("use `Session::mir_opt_level` instead of this field")]
1399 mir_opt_level: Option<usize> = (None, parse_opt_number, [TRACKED],
1400 "MIR optimization level (0-4; default: 1 in non optimized builds and 2 in optimized builds)"),
1401 mir_pretty_relative_line_numbers: bool = (false, parse_bool, [UNTRACKED],
1402 "use line numbers relative to the function in mir pretty printing"),
1403 move_size_limit: Option<usize> = (None, parse_opt_number, [TRACKED],
1404 "the size at which the `large_assignments` lint starts to be emitted"),
1405 mutable_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1406 "emit noalias metadata for mutable references (default: yes)"),
1407 nll_facts: bool = (false, parse_bool, [UNTRACKED],
1408 "dump facts from NLL analysis into side files (default: no)"),
1409 nll_facts_dir: String = ("nll-facts".to_string(), parse_string, [UNTRACKED],
1410 "the directory the NLL facts are dumped into (default: `nll-facts`)"),
1411 no_analysis: bool = (false, parse_no_flag, [UNTRACKED],
1412 "parse and expand the source, but run no analysis"),
1413 no_codegen: bool = (false, parse_no_flag, [TRACKED_NO_CRATE_HASH],
1414 "run all passes except codegen; no output"),
1415 no_generate_arange_section: bool = (false, parse_no_flag, [TRACKED],
1416 "omit DWARF address ranges that give faster lookups"),
1417 no_interleave_lints: bool = (false, parse_no_flag, [UNTRACKED],
1418 "execute lints separately; allows benchmarking individual lints"),
1419 no_leak_check: bool = (false, parse_no_flag, [UNTRACKED],
1420 "disable the 'leak check' for subtyping; unsound, but useful for tests"),
1421 no_link: bool = (false, parse_no_flag, [TRACKED],
1422 "compile without linking"),
1423 no_parallel_llvm: bool = (false, parse_no_flag, [UNTRACKED],
1424 "run LLVM in non-parallel mode (while keeping codegen-units and ThinLTO)"),
1425 no_profiler_runtime: bool = (false, parse_no_flag, [TRACKED],
1426 "prevent automatic injection of the profiler_builtins crate"),
1427 no_unique_section_names: bool = (false, parse_bool, [TRACKED],
1428 "do not use unique names for text and data sections when -Z function-sections is used"),
1429 normalize_docs: bool = (false, parse_bool, [TRACKED],
1430 "normalize associated items in rustdoc when generating documentation"),
1431 oom: OomStrategy = (OomStrategy::Abort, parse_oom_strategy, [TRACKED],
1432 "panic strategy for out-of-memory handling"),
1433 osx_rpath_install_name: bool = (false, parse_bool, [TRACKED],
1434 "pass `-install_name @rpath/...` to the macOS linker (default: no)"),
1435 packed_bundled_libs: bool = (false, parse_bool, [TRACKED],
1436 "change rlib format to store native libraries as archives"),
1437 panic_abort_tests: bool = (false, parse_bool, [TRACKED],
1438 "support compiling tests with panic=abort (default: no)"),
1439 panic_in_drop: PanicStrategy = (PanicStrategy::Unwind, parse_panic_strategy, [TRACKED],
1440 "panic strategy for panics in drops"),
1441 parse_only: bool = (false, parse_bool, [UNTRACKED],
1442 "parse only; do not compile, assemble, or link (default: no)"),
1443 perf_stats: bool = (false, parse_bool, [UNTRACKED],
1444 "print some performance-related statistics (default: no)"),
1445 pick_stable_methods_before_any_unstable: bool = (true, parse_bool, [TRACKED],
1446 "try to pick stable methods first before picking any unstable methods (default: yes)"),
1447 plt: Option<bool> = (None, parse_opt_bool, [TRACKED],
1448 "whether to use the PLT when calling into shared libraries;
1449 only has effect for PIC code on systems with ELF binaries
1450 (default: PLT is disabled if full relro is enabled)"),
1451 polonius: bool = (false, parse_bool, [TRACKED],
1452 "enable polonius-based borrow-checker (default: no)"),
1453 polymorphize: bool = (false, parse_bool, [TRACKED],
1454 "perform polymorphization analysis"),
1455 pre_link_arg: (/* redirected to pre_link_args */) = ((), parse_string_push, [UNTRACKED],
1456 "a single extra argument to prepend the linker invocation (can be used several times)"),
1457 pre_link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
1458 "extra arguments to prepend to the linker invocation (space separated)"),
1459 precise_enum_drop_elaboration: bool = (true, parse_bool, [TRACKED],
1460 "use a more precise version of drop elaboration for matches on enums (default: yes). \
1461 This results in better codegen, but has caused miscompilations on some tier 2 platforms. \
1462 See #77382 and #74551."),
1463 print_fuel: Option<String> = (None, parse_opt_string, [TRACKED],
1464 "make rustc print the total optimization fuel used by a crate"),
1465 #[rustc_lint_opt_deny_field_access("use `Session::print_llvm_passes` instead of this field")]
1466 print_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1467 "print the LLVM optimization passes being run (default: no)"),
1468 print_mono_items: Option<String> = (None, parse_opt_string, [UNTRACKED],
1469 "print the result of the monomorphization collection pass"),
1470 print_type_sizes: bool = (false, parse_bool, [UNTRACKED],
1471 "print layout information for each type encountered (default: no)"),
1472 proc_macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1473 "show backtraces for panics during proc-macro execution (default: no)"),
1474 proc_macro_execution_strategy: ProcMacroExecutionStrategy = (ProcMacroExecutionStrategy::SameThread,
1475 parse_proc_macro_execution_strategy, [UNTRACKED],
1476 "how to run proc-macro code (default: same-thread)"),
1477 profile: bool = (false, parse_bool, [TRACKED],
1478 "insert profiling code (default: no)"),
1479 profile_closures: bool = (false, parse_no_flag, [UNTRACKED],
1480 "profile size of closures"),
1481 profile_emit: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1482 "file path to emit profiling data at runtime when using 'profile' \
1483 (default based on relative source path)"),
1484 profile_sample_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1485 "use the given `.prof` file for sampled profile-guided optimization (also known as AutoFDO)"),
1486 profiler_runtime: String = (String::from("profiler_builtins"), parse_string, [TRACKED],
1487 "name of the profiler runtime crate to automatically inject (default: `profiler_builtins`)"),
1488 query_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1489 "enable queries of the dependency graph for regression testing (default: no)"),
1490 randomize_layout: bool = (false, parse_bool, [TRACKED],
1491 "randomize the layout of types (default: no)"),
1492 relax_elf_relocations: Option<bool> = (None, parse_opt_bool, [TRACKED],
1493 "whether ELF relocations can be relaxed"),
1494 relro_level: Option<RelroLevel> = (None, parse_relro_level, [TRACKED],
1495 "choose which RELRO level to use"),
1496 remap_cwd_prefix: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1497 "remap paths under the current working directory to this path prefix"),
1498 report_delayed_bugs: bool = (false, parse_bool, [TRACKED],
1499 "immediately print bugs registered with `delay_span_bug` (default: no)"),
1500 sanitizer: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
1502 sanitizer_memory_track_origins: usize = (0, parse_sanitizer_memory_track_origins, [TRACKED],
1503 "enable origins tracking in MemorySanitizer"),
1504 sanitizer_recover: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
1505 "enable recovery for selected sanitizers"),
1506 saturating_float_casts: Option<bool> = (None, parse_opt_bool, [TRACKED],
1507 "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
1508 the max/min integer respectively, and NaN is mapped to 0 (default: yes)"),
1509 save_analysis: bool = (false, parse_bool, [UNTRACKED],
1510 "write syntax and type analysis (in JSON format) information, in \
1511 addition to normal output (default: no)"),
1512 self_profile: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1513 parse_switch_with_opt_path, [UNTRACKED],
1514 "run the self profiler and output the raw event data"),
1515 self_profile_counter: String = ("wall-time".to_string(), parse_string, [UNTRACKED],
1516 "counter used by the self profiler (default: `wall-time`), one of:
1517 `wall-time` (monotonic clock, i.e. `std::time::Instant`)
1518 `instructions:u` (retired instructions, userspace-only)
1519 `instructions-minus-irqs:u` (subtracting hardware interrupt counts for extra accuracy)"
1521 /// keep this in sync with the event filter names in librustc_data_structures/profiling.rs
1522 self_profile_events: Option<Vec<String>> = (None, parse_opt_comma_list, [UNTRACKED],
1523 "specify the events recorded by the self profiler;
1524 for example: `-Z self-profile-events=default,query-keys`
1525 all options: none, all, default, generic-activity, query-provider, query-cache-hit
1526 query-blocked, incr-cache-load, incr-result-hashing, query-keys, function-args, args, llvm, artifact-sizes"),
1527 share_generics: Option<bool> = (None, parse_opt_bool, [TRACKED],
1528 "make the current crate share its generic instantiations"),
1529 show_span: Option<String> = (None, parse_opt_string, [TRACKED],
1530 "show spans for compiler debugging (expr|pat|ty)"),
1531 simulate_remapped_rust_src_base: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1532 "simulate the effect of remap-debuginfo = true at bootstrapping by remapping path \
1533 to rust's source base directory. only meant for testing purposes"),
1534 span_debug: bool = (false, parse_bool, [UNTRACKED],
1535 "forward proc_macro::Span's `Debug` impl to `Span`"),
1536 /// o/w tests have closure@path
1537 span_free_formats: bool = (false, parse_bool, [UNTRACKED],
1538 "exclude spans when debug-printing compiler state (default: no)"),
1539 split_dwarf_inlining: bool = (true, parse_bool, [TRACKED],
1540 "provide minimal debug info in the object/executable to facilitate online \
1541 symbolication/stack traces in the absence of .dwo/.dwp files when using Split DWARF"),
1542 split_dwarf_kind: SplitDwarfKind = (SplitDwarfKind::Split, parse_split_dwarf_kind, [TRACKED],
1543 "split dwarf variant (only if -Csplit-debuginfo is enabled and on relevant platform)
1546 `split`: sections which do not require relocation are written into a DWARF object (`.dwo`)
1547 file which is ignored by the linker
1548 `single`: sections which do not require relocation are written into object file but ignored
1550 src_hash_algorithm: Option<SourceFileHashAlgorithm> = (None, parse_src_file_hash, [TRACKED],
1551 "hash algorithm of source files in debug info (`md5`, `sha1`, or `sha256`)"),
1552 #[rustc_lint_opt_deny_field_access("use `Session::stack_protector` instead of this field")]
1553 stack_protector: StackProtector = (StackProtector::None, parse_stack_protector, [TRACKED],
1554 "control stack smash protection strategy (`rustc --print stack-protector-strategies` for details)"),
1555 strict_init_checks: bool = (false, parse_bool, [TRACKED],
1556 "control if mem::uninitialized and mem::zeroed panic on more UB"),
1557 strip: Strip = (Strip::None, parse_strip, [UNTRACKED],
1558 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1559 symbol_mangling_version: Option<SymbolManglingVersion> = (None,
1560 parse_symbol_mangling_version, [TRACKED],
1561 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1562 #[rustc_lint_opt_deny_field_access("use `Session::teach` instead of this field")]
1563 teach: bool = (false, parse_bool, [TRACKED],
1564 "show extended diagnostic help (default: no)"),
1565 temps_dir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1566 "the directory the intermediate files are written to"),
1567 #[rustc_lint_opt_deny_field_access("use `Session::lto` instead of this field")]
1568 thinlto: Option<bool> = (None, parse_opt_bool, [TRACKED],
1569 "enable ThinLTO when possible"),
1570 thir_unsafeck: bool = (false, parse_bool, [TRACKED],
1571 "use the THIR unsafety checker (default: no)"),
1572 /// We default to 1 here since we want to behave like
1573 /// a sequential compiler for now. This'll likely be adjusted
1574 /// in the future. Note that -Zthreads=0 is the way to get
1575 /// the num_cpus behavior.
1576 #[rustc_lint_opt_deny_field_access("use `Session::threads` instead of this field")]
1577 threads: usize = (1, parse_threads, [UNTRACKED],
1578 "use a thread pool with N threads"),
1579 #[rustc_lint_opt_deny_field_access("use `Session::time_llvm_passes` instead of this field")]
1580 time_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1581 "measure time of each LLVM pass (default: no)"),
1582 #[rustc_lint_opt_deny_field_access("use `Session::time_passes` instead of this field")]
1583 time_passes: bool = (false, parse_bool, [UNTRACKED],
1584 "measure time of each rustc pass (default: no)"),
1585 #[rustc_lint_opt_deny_field_access("use `Session::tls_model` instead of this field")]
1586 tls_model: Option<TlsModel> = (None, parse_tls_model, [TRACKED],
1587 "choose the TLS model to use (`rustc --print tls-models` for details)"),
1588 trace_macros: bool = (false, parse_bool, [UNTRACKED],
1589 "for every macro invocation, print its name and arguments (default: no)"),
1590 track_diagnostics: bool = (false, parse_bool, [UNTRACKED],
1591 "tracks where in rustc a diagnostic was emitted"),
1592 // Diagnostics are considered side-effects of a query (see `QuerySideEffects`) and are saved
1593 // alongside query results and changes to translation options can affect diagnostics - so
1594 // translation options should be tracked.
1595 translate_additional_ftl: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1596 "additional fluent translation to preferentially use (for testing translation)"),
1597 translate_directionality_markers: bool = (false, parse_bool, [TRACKED],
1598 "emit directionality isolation markers in translated diagnostics"),
1599 translate_lang: Option<LanguageIdentifier> = (None, parse_opt_langid, [TRACKED],
1600 "language identifier for diagnostic output"),
1601 translate_remapped_path_to_local_path: bool = (true, parse_bool, [TRACKED],
1602 "translate remapped paths into local paths when possible (default: yes)"),
1603 trap_unreachable: Option<bool> = (None, parse_opt_bool, [TRACKED],
1604 "generate trap instructions for unreachable intrinsics (default: use target setting, usually yes)"),
1605 treat_err_as_bug: Option<NonZeroUsize> = (None, parse_treat_err_as_bug, [TRACKED],
1606 "treat error number `val` that occurs as bug"),
1607 trim_diagnostic_paths: bool = (true, parse_bool, [UNTRACKED],
1608 "in diagnostics, use heuristics to shorten paths referring to items"),
1609 tune_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1610 "select processor to schedule for (`rustc --print target-cpus` for details)"),
1611 ui_testing: bool = (false, parse_bool, [UNTRACKED],
1612 "emit compiler diagnostics in a form suitable for UI testing (default: no)"),
1613 uninit_const_chunk_threshold: usize = (16, parse_number, [TRACKED],
1614 "allow generating const initializers with mixed init/uninit chunks, \
1615 and set the maximum number of chunks for which this is allowed (default: 16)"),
1616 unleash_the_miri_inside_of_you: bool = (false, parse_bool, [TRACKED],
1617 "take the brakes off const evaluation. NOTE: this is unsound (default: no)"),
1618 unpretty: Option<String> = (None, parse_unpretty, [UNTRACKED],
1619 "present the input source, unstable (and less-pretty) variants;
1620 `normal`, `identified`,
1621 `expanded`, `expanded,identified`,
1622 `expanded,hygiene` (with internal representations),
1623 `ast-tree` (raw AST before expansion),
1624 `ast-tree,expanded` (raw AST after expansion),
1625 `hir` (the HIR), `hir,identified`,
1626 `hir,typed` (HIR with types for each node),
1627 `hir-tree` (dump the raw HIR),
1628 `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)"),
1629 unsound_mir_opts: bool = (false, parse_bool, [TRACKED],
1630 "enable unsound and buggy MIR optimizations (default: no)"),
1631 /// This name is kind of confusing: Most unstable options enable something themselves, while
1632 /// this just allows "normal" options to be feature-gated.
1633 #[rustc_lint_opt_deny_field_access("use `Session::unstable_options` instead of this field")]
1634 unstable_options: bool = (false, parse_bool, [UNTRACKED],
1635 "adds unstable command line options to rustc interface (default: no)"),
1636 use_ctors_section: Option<bool> = (None, parse_opt_bool, [TRACKED],
1637 "use legacy .ctors section for initializers rather than .init_array"),
1638 validate_mir: bool = (false, parse_bool, [UNTRACKED],
1639 "validate MIR after each transformation"),
1640 #[rustc_lint_opt_deny_field_access("use `Session::verbose` instead of this field")]
1641 verbose: bool = (false, parse_bool, [UNTRACKED],
1642 "in general, enable more debug printouts (default: no)"),
1643 #[rustc_lint_opt_deny_field_access("use `Session::verify_llvm_ir` instead of this field")]
1644 verify_llvm_ir: bool = (false, parse_bool, [TRACKED],
1645 "verify LLVM IR (default: no)"),
1646 virtual_function_elimination: bool = (false, parse_bool, [TRACKED],
1647 "enables dead virtual function elimination optimization. \
1648 Requires `-Clto[=[fat,yes]]`"),
1649 wasi_exec_model: Option<WasiExecModel> = (None, parse_wasi_exec_model, [TRACKED],
1650 "whether to build a wasi command or reactor"),
1651 // tidy-alphabetical-end
1653 // If you add a new option, please update:
1654 // - compiler/rustc_interface/src/tests.rs
1657 #[derive(Clone, Hash, PartialEq, Eq, Debug)]
1658 pub enum WasiExecModel {
1663 #[derive(Clone, Copy, Hash)]