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_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 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)
284 // JUSTIFICATION: defn of the suggested wrapper fn
285 #[allow(rustc::bad_opt_access)]
286 pub fn time_passes(&self) -> bool {
287 self.unstable_opts.time_passes || self.unstable_opts.time
291 impl CodegenOptions {
292 // JUSTIFICATION: defn of the suggested wrapper fn
293 #[allow(rustc::bad_opt_access)]
294 pub fn instrument_coverage(&self) -> InstrumentCoverage {
295 self.instrument_coverage.unwrap_or(InstrumentCoverage::Off)
299 // Sometimes different options need to build a common structure.
300 // That structure can be kept in one of the options' fields, the others become dummy.
301 macro_rules! redirect_field {
302 ($cg:ident.link_arg) => {
305 ($cg:ident.pre_link_arg) => {
308 ($cg:ident.$field:ident) => {
313 type OptionSetter<O> = fn(&mut O, v: Option<&str>) -> bool;
314 type OptionDescrs<O> = &'static [(&'static str, OptionSetter<O>, &'static str, &'static str)];
316 fn build_options<O: Default>(
317 matches: &getopts::Matches,
318 descrs: OptionDescrs<O>,
321 error_format: ErrorOutputType,
323 let mut op = O::default();
324 for option in matches.opt_strs(prefix) {
325 let (key, value) = match option.split_once('=') {
326 None => (option, None),
327 Some((k, v)) => (k.to_string(), Some(v)),
330 let option_to_lookup = key.replace('-', "_");
331 match descrs.iter().find(|(name, ..)| *name == option_to_lookup) {
332 Some((_, setter, type_desc, _)) => {
333 if !setter(&mut op, value) {
338 "{0} option `{1}` requires {2} ({3} {1}=<value>)",
339 outputname, key, type_desc, prefix
342 Some(value) => early_error(
345 "incorrect value `{value}` for {outputname} option `{key}` - {type_desc} was expected"
351 None => early_error(error_format, &format!("unknown {outputname} option: `{key}`")),
357 #[allow(non_upper_case_globals)]
359 pub const parse_no_flag: &str = "no value";
360 pub const parse_bool: &str = "one of: `y`, `yes`, `on`, `n`, `no`, or `off`";
361 pub const parse_opt_bool: &str = parse_bool;
362 pub const parse_string: &str = "a string";
363 pub const parse_opt_string: &str = parse_string;
364 pub const parse_string_push: &str = parse_string;
365 pub const parse_opt_langid: &str = "a language identifier";
366 pub const parse_opt_pathbuf: &str = "a path";
367 pub const parse_list: &str = "a space-separated list of strings";
368 pub const parse_list_with_polarity: &str =
369 "a comma-separated list of strings, with elements beginning with + or -";
370 pub const parse_opt_comma_list: &str = "a comma-separated list of strings";
371 pub const parse_number: &str = "a number";
372 pub const parse_opt_number: &str = parse_number;
373 pub const parse_threads: &str = parse_number;
374 pub const parse_passes: &str = "a space-separated list of passes, or `all`";
375 pub const parse_panic_strategy: &str = "either `unwind` or `abort`";
376 pub const parse_opt_panic_strategy: &str = parse_panic_strategy;
377 pub const parse_oom_strategy: &str = "either `panic` or `abort`";
378 pub const parse_relro_level: &str = "one of: `full`, `partial`, or `off`";
379 pub const parse_sanitizers: &str = "comma separated list of sanitizers: `address`, `cfi`, `hwaddress`, `leak`, `memory`, `memtag`, `shadow-call-stack`, or `thread`";
380 pub const parse_sanitizer_memory_track_origins: &str = "0, 1, or 2";
381 pub const parse_cfguard: &str =
382 "either a boolean (`yes`, `no`, `on`, `off`, etc), `checks`, or `nochecks`";
383 pub const parse_cfprotection: &str = "`none`|`no`|`n` (default), `branch`, `return`, or `full`|`yes`|`y` (equivalent to `branch` and `return`)";
384 pub const parse_strip: &str = "either `none`, `debuginfo`, or `symbols`";
385 pub const parse_linker_flavor: &str = ::rustc_target::spec::LinkerFlavorCli::one_of();
386 pub const parse_optimization_fuel: &str = "crate=integer";
387 pub const parse_mir_spanview: &str = "`statement` (default), `terminator`, or `block`";
388 pub const parse_instrument_coverage: &str =
389 "`all` (default), `except-unused-generics`, `except-unused-functions`, or `off`";
390 pub const parse_unpretty: &str = "`string` or `string=string`";
391 pub const parse_treat_err_as_bug: &str = "either no value or a number bigger than 0";
392 pub const parse_lto: &str =
393 "either a boolean (`yes`, `no`, `on`, `off`, etc), `thin`, `fat`, or omitted";
394 pub const parse_linker_plugin_lto: &str =
395 "either a boolean (`yes`, `no`, `on`, `off`, etc), or the path to the linker plugin";
396 pub const parse_location_detail: &str = "either `none`, or a comma separated list of location details to track: `file`, `line`, or `column`";
397 pub const parse_switch_with_opt_path: &str =
398 "an optional path to the profiling data output directory";
399 pub const parse_merge_functions: &str = "one of: `disabled`, `trampolines`, or `aliases`";
400 pub const parse_symbol_mangling_version: &str = "either `legacy` or `v0` (RFC 2603)";
401 pub const parse_src_file_hash: &str = "either `md5` or `sha1`";
402 pub const parse_relocation_model: &str =
403 "one of supported relocation models (`rustc --print relocation-models`)";
404 pub const parse_code_model: &str = "one of supported code models (`rustc --print code-models`)";
405 pub const parse_tls_model: &str = "one of supported TLS models (`rustc --print tls-models`)";
406 pub const parse_target_feature: &str = parse_string;
407 pub const parse_wasi_exec_model: &str = "either `command` or `reactor`";
408 pub const parse_split_debuginfo: &str =
409 "one of supported split-debuginfo modes (`off`, `packed`, or `unpacked`)";
410 pub const parse_split_dwarf_kind: &str =
411 "one of supported split dwarf modes (`split` or `single`)";
412 pub const parse_gcc_ld: &str = "one of: no value, `lld`";
413 pub const parse_stack_protector: &str =
414 "one of (`none` (default), `basic`, `strong`, or `all`)";
415 pub const parse_branch_protection: &str =
416 "a `,` separated combination of `bti`, `b-key`, `pac-ret`, or `leaf`";
417 pub const parse_proc_macro_execution_strategy: &str =
418 "one of supported execution strategies (`same-thread`, or `cross-thread`)";
422 pub(crate) use super::*;
423 use std::str::FromStr;
425 /// This is for boolean options that don't take a value and start with
426 /// `no-`. This style of option is deprecated.
427 pub(crate) fn parse_no_flag(slot: &mut bool, v: Option<&str>) -> bool {
437 /// Use this for any boolean option that has a static default.
438 pub(crate) fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
440 Some("y") | Some("yes") | Some("on") | None => {
444 Some("n") | Some("no") | Some("off") => {
452 /// Use this for any boolean option that lacks a static default. (The
453 /// actions taken when such an option is not specified will depend on
454 /// other factors, such as other options, or target options.)
455 pub(crate) fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
457 Some("y") | Some("yes") | Some("on") | None => {
461 Some("n") | Some("no") | Some("off") => {
469 /// Use this for any string option that has a static default.
470 pub(crate) fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
473 *slot = s.to_string();
480 /// Use this for any string option that lacks a static default.
481 pub(crate) fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
484 *slot = Some(s.to_string());
491 /// Parse an optional language identifier, e.g. `en-US` or `zh-CN`.
492 pub(crate) fn parse_opt_langid(slot: &mut Option<LanguageIdentifier>, v: Option<&str>) -> bool {
495 *slot = rustc_errors::LanguageIdentifier::from_str(s).ok();
502 pub(crate) fn parse_opt_pathbuf(slot: &mut Option<PathBuf>, v: Option<&str>) -> bool {
505 *slot = Some(PathBuf::from(s));
512 pub(crate) fn parse_string_push(slot: &mut Vec<String>, v: Option<&str>) -> bool {
515 slot.push(s.to_string());
522 pub(crate) fn parse_list(slot: &mut Vec<String>, v: Option<&str>) -> bool {
525 slot.extend(s.split_whitespace().map(|s| s.to_string()));
532 pub(crate) fn parse_list_with_polarity(
533 slot: &mut Vec<(String, bool)>,
538 for s in s.split(',') {
539 let Some(pass_name) = s.strip_prefix(&['+', '-'][..]) else { return false };
540 slot.push((pass_name.to_string(), &s[..1] == "+"));
548 pub(crate) fn parse_location_detail(ld: &mut LocationDetail, v: Option<&str>) -> bool {
556 for s in v.split(',') {
558 "file" => ld.file = true,
559 "line" => ld.line = true,
560 "column" => ld.column = true,
570 pub(crate) fn parse_opt_comma_list(slot: &mut Option<Vec<String>>, v: Option<&str>) -> bool {
573 let mut v: Vec<_> = s.split(',').map(|s| s.to_string()).collect();
582 pub(crate) fn parse_threads(slot: &mut usize, v: Option<&str>) -> bool {
583 match v.and_then(|s| s.parse().ok()) {
585 *slot = std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get);
596 /// Use this for any numeric option that has a static default.
597 pub(crate) fn parse_number<T: Copy + FromStr>(slot: &mut T, v: Option<&str>) -> bool {
598 match v.and_then(|s| s.parse().ok()) {
607 /// Use this for any numeric option that lacks a static default.
608 pub(crate) fn parse_opt_number<T: Copy + FromStr>(
609 slot: &mut Option<T>,
614 *slot = s.parse().ok();
621 pub(crate) fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
628 let mut passes = vec![];
629 if parse_list(&mut passes, v) {
639 pub(crate) fn parse_opt_panic_strategy(
640 slot: &mut Option<PanicStrategy>,
644 Some("unwind") => *slot = Some(PanicStrategy::Unwind),
645 Some("abort") => *slot = Some(PanicStrategy::Abort),
651 pub(crate) fn parse_panic_strategy(slot: &mut PanicStrategy, v: Option<&str>) -> bool {
653 Some("unwind") => *slot = PanicStrategy::Unwind,
654 Some("abort") => *slot = PanicStrategy::Abort,
660 pub(crate) fn parse_oom_strategy(slot: &mut OomStrategy, v: Option<&str>) -> bool {
662 Some("panic") => *slot = OomStrategy::Panic,
663 Some("abort") => *slot = OomStrategy::Abort,
669 pub(crate) fn parse_relro_level(slot: &mut Option<RelroLevel>, v: Option<&str>) -> bool {
671 Some(s) => match s.parse::<RelroLevel>() {
672 Ok(level) => *slot = Some(level),
680 pub(crate) fn parse_sanitizers(slot: &mut SanitizerSet, v: Option<&str>) -> bool {
682 for s in v.split(',') {
684 "address" => SanitizerSet::ADDRESS,
685 "cfi" => SanitizerSet::CFI,
686 "leak" => SanitizerSet::LEAK,
687 "memory" => SanitizerSet::MEMORY,
688 "memtag" => SanitizerSet::MEMTAG,
689 "shadow-call-stack" => SanitizerSet::SHADOWCALLSTACK,
690 "thread" => SanitizerSet::THREAD,
691 "hwaddress" => SanitizerSet::HWADDRESS,
701 pub(crate) fn parse_sanitizer_memory_track_origins(slot: &mut usize, v: Option<&str>) -> bool {
703 Some("2") | None => {
719 pub(crate) fn parse_strip(slot: &mut Strip, v: Option<&str>) -> bool {
721 Some("none") => *slot = Strip::None,
722 Some("debuginfo") => *slot = Strip::Debuginfo,
723 Some("symbols") => *slot = Strip::Symbols,
729 pub(crate) fn parse_cfguard(slot: &mut CFGuard, v: Option<&str>) -> bool {
731 let mut bool_arg = None;
732 if parse_opt_bool(&mut bool_arg, v) {
733 *slot = if bool_arg.unwrap() { CFGuard::Checks } else { CFGuard::Disabled };
739 None => CFGuard::Checks,
740 Some("checks") => CFGuard::Checks,
741 Some("nochecks") => CFGuard::NoChecks,
742 Some(_) => return false,
747 pub(crate) fn parse_cfprotection(slot: &mut CFProtection, v: Option<&str>) -> bool {
749 let mut bool_arg = None;
750 if parse_opt_bool(&mut bool_arg, v) {
751 *slot = if bool_arg.unwrap() { CFProtection::Full } else { CFProtection::None };
757 None | Some("none") => CFProtection::None,
758 Some("branch") => CFProtection::Branch,
759 Some("return") => CFProtection::Return,
760 Some("full") => CFProtection::Full,
761 Some(_) => return false,
766 pub(crate) fn parse_linker_flavor(slot: &mut Option<LinkerFlavorCli>, v: Option<&str>) -> bool {
767 match v.and_then(LinkerFlavorCli::from_str) {
768 Some(lf) => *slot = Some(lf),
774 pub(crate) fn parse_optimization_fuel(
775 slot: &mut Option<(String, u64)>,
781 let parts = s.split('=').collect::<Vec<_>>();
782 if parts.len() != 2 {
785 let crate_name = parts[0].to_string();
786 let fuel = parts[1].parse::<u64>();
790 *slot = Some((crate_name, fuel.unwrap()));
796 pub(crate) fn parse_unpretty(slot: &mut Option<String>, v: Option<&str>) -> bool {
799 Some(s) if s.split('=').count() <= 2 => {
800 *slot = Some(s.to_string());
807 pub(crate) fn parse_mir_spanview(slot: &mut Option<MirSpanview>, v: Option<&str>) -> bool {
809 let mut bool_arg = None;
810 if parse_opt_bool(&mut bool_arg, v) {
811 *slot = if bool_arg.unwrap() { Some(MirSpanview::Statement) } else { None };
816 let Some(v) = v else {
817 *slot = Some(MirSpanview::Statement);
821 *slot = Some(match v.trim_end_matches('s') {
822 "statement" | "stmt" => MirSpanview::Statement,
823 "terminator" | "term" => MirSpanview::Terminator,
824 "block" | "basicblock" => MirSpanview::Block,
830 pub(crate) fn parse_instrument_coverage(
831 slot: &mut Option<InstrumentCoverage>,
835 let mut bool_arg = None;
836 if parse_opt_bool(&mut bool_arg, v) {
837 *slot = if bool_arg.unwrap() { Some(InstrumentCoverage::All) } else { None };
842 let Some(v) = v else {
843 *slot = Some(InstrumentCoverage::All);
847 *slot = Some(match v {
848 "all" => InstrumentCoverage::All,
849 "except-unused-generics" | "except_unused_generics" => {
850 InstrumentCoverage::ExceptUnusedGenerics
852 "except-unused-functions" | "except_unused_functions" => {
853 InstrumentCoverage::ExceptUnusedFunctions
855 "off" | "no" | "n" | "false" | "0" => InstrumentCoverage::Off,
861 pub(crate) fn parse_treat_err_as_bug(slot: &mut Option<NonZeroUsize>, v: Option<&str>) -> bool {
864 *slot = s.parse().ok();
868 *slot = NonZeroUsize::new(1);
874 pub(crate) fn parse_lto(slot: &mut LtoCli, v: Option<&str>) -> bool {
876 let mut bool_arg = None;
877 if parse_opt_bool(&mut bool_arg, v) {
878 *slot = if bool_arg.unwrap() { LtoCli::Yes } else { LtoCli::No };
884 None => LtoCli::NoParam,
885 Some("thin") => LtoCli::Thin,
886 Some("fat") => LtoCli::Fat,
887 Some(_) => return false,
892 pub(crate) fn parse_linker_plugin_lto(slot: &mut LinkerPluginLto, v: Option<&str>) -> bool {
894 let mut bool_arg = None;
895 if parse_opt_bool(&mut bool_arg, v) {
896 *slot = if bool_arg.unwrap() {
897 LinkerPluginLto::LinkerPluginAuto
899 LinkerPluginLto::Disabled
906 None => LinkerPluginLto::LinkerPluginAuto,
907 Some(path) => LinkerPluginLto::LinkerPlugin(PathBuf::from(path)),
912 pub(crate) fn parse_switch_with_opt_path(
913 slot: &mut SwitchWithOptPath,
917 None => SwitchWithOptPath::Enabled(None),
918 Some(path) => SwitchWithOptPath::Enabled(Some(PathBuf::from(path))),
923 pub(crate) fn parse_merge_functions(
924 slot: &mut Option<MergeFunctions>,
927 match v.and_then(|s| MergeFunctions::from_str(s).ok()) {
928 Some(mergefunc) => *slot = Some(mergefunc),
934 pub(crate) fn parse_relocation_model(slot: &mut Option<RelocModel>, v: Option<&str>) -> bool {
935 match v.and_then(|s| RelocModel::from_str(s).ok()) {
936 Some(relocation_model) => *slot = Some(relocation_model),
937 None if v == Some("default") => *slot = None,
943 pub(crate) fn parse_code_model(slot: &mut Option<CodeModel>, v: Option<&str>) -> bool {
944 match v.and_then(|s| CodeModel::from_str(s).ok()) {
945 Some(code_model) => *slot = Some(code_model),
951 pub(crate) fn parse_tls_model(slot: &mut Option<TlsModel>, v: Option<&str>) -> bool {
952 match v.and_then(|s| TlsModel::from_str(s).ok()) {
953 Some(tls_model) => *slot = Some(tls_model),
959 pub(crate) fn parse_symbol_mangling_version(
960 slot: &mut Option<SymbolManglingVersion>,
964 Some("legacy") => Some(SymbolManglingVersion::Legacy),
965 Some("v0") => Some(SymbolManglingVersion::V0),
971 pub(crate) fn parse_src_file_hash(
972 slot: &mut Option<SourceFileHashAlgorithm>,
975 match v.and_then(|s| SourceFileHashAlgorithm::from_str(s).ok()) {
976 Some(hash_kind) => *slot = Some(hash_kind),
982 pub(crate) fn parse_target_feature(slot: &mut String, v: Option<&str>) -> bool {
985 if !slot.is_empty() {
995 pub(crate) fn parse_wasi_exec_model(slot: &mut Option<WasiExecModel>, v: Option<&str>) -> bool {
997 Some("command") => *slot = Some(WasiExecModel::Command),
998 Some("reactor") => *slot = Some(WasiExecModel::Reactor),
1004 pub(crate) fn parse_split_debuginfo(
1005 slot: &mut Option<SplitDebuginfo>,
1008 match v.and_then(|s| SplitDebuginfo::from_str(s).ok()) {
1009 Some(e) => *slot = Some(e),
1015 pub(crate) fn parse_split_dwarf_kind(slot: &mut SplitDwarfKind, v: Option<&str>) -> bool {
1016 match v.and_then(|s| SplitDwarfKind::from_str(s).ok()) {
1017 Some(e) => *slot = e,
1023 pub(crate) fn parse_gcc_ld(slot: &mut Option<LdImpl>, v: Option<&str>) -> bool {
1025 None => *slot = None,
1026 Some("lld") => *slot = Some(LdImpl::Lld),
1032 pub(crate) fn parse_stack_protector(slot: &mut StackProtector, v: Option<&str>) -> bool {
1033 match v.and_then(|s| StackProtector::from_str(s).ok()) {
1034 Some(ssp) => *slot = ssp,
1040 pub(crate) fn parse_branch_protection(
1041 slot: &mut Option<BranchProtection>,
1046 let slot = slot.get_or_insert_default();
1047 for opt in s.split(',') {
1049 "bti" => slot.bti = true,
1050 "pac-ret" if slot.pac_ret.is_none() => {
1051 slot.pac_ret = Some(PacRet { leaf: false, key: PAuthKey::A })
1053 "leaf" => match slot.pac_ret.as_mut() {
1054 Some(pac) => pac.leaf = true,
1057 "b-key" => match slot.pac_ret.as_mut() {
1058 Some(pac) => pac.key = PAuthKey::B,
1070 pub(crate) fn parse_proc_macro_execution_strategy(
1071 slot: &mut ProcMacroExecutionStrategy,
1075 Some("same-thread") => ProcMacroExecutionStrategy::SameThread,
1076 Some("cross-thread") => ProcMacroExecutionStrategy::CrossThread,
1084 CodegenOptions, CG_OPTIONS, cgopts, "C", "codegen",
1086 // This list is in alphabetical order.
1088 // If you add a new option, please update:
1089 // - compiler/rustc_interface/src/tests.rs
1090 // - src/doc/rustc/src/codegen-options/index.md
1092 ar: String = (String::new(), parse_string, [UNTRACKED],
1093 "this option is deprecated and does nothing"),
1094 #[rustc_lint_opt_deny_field_access("use `Session::code_model` instead of this field")]
1095 code_model: Option<CodeModel> = (None, parse_code_model, [TRACKED],
1096 "choose the code model to use (`rustc --print code-models` for details)"),
1097 codegen_units: Option<usize> = (None, parse_opt_number, [UNTRACKED],
1098 "divide crate into N units to optimize in parallel"),
1099 control_flow_guard: CFGuard = (CFGuard::Disabled, parse_cfguard, [TRACKED],
1100 "use Windows Control Flow Guard (default: no)"),
1101 debug_assertions: Option<bool> = (None, parse_opt_bool, [TRACKED],
1102 "explicitly enable the `cfg(debug_assertions)` directive"),
1103 debuginfo: usize = (0, parse_number, [TRACKED],
1104 "debug info emission level (0 = no debug info, 1 = line tables only, \
1105 2 = full debug info with variable and type information; default: 0)"),
1106 default_linker_libraries: bool = (false, parse_bool, [UNTRACKED],
1107 "allow the linker to link its default libraries (default: no)"),
1108 embed_bitcode: bool = (true, parse_bool, [TRACKED],
1109 "emit bitcode in rlibs (default: yes)"),
1110 extra_filename: String = (String::new(), parse_string, [UNTRACKED],
1111 "extra data to put in each output filename"),
1112 force_frame_pointers: Option<bool> = (None, parse_opt_bool, [TRACKED],
1113 "force use of the frame pointers"),
1114 #[rustc_lint_opt_deny_field_access("use `Session::must_emit_unwind_tables` instead of this field")]
1115 force_unwind_tables: Option<bool> = (None, parse_opt_bool, [TRACKED],
1116 "force use of unwind tables"),
1117 incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
1118 "enable incremental compilation"),
1119 inline_threshold: Option<u32> = (None, parse_opt_number, [TRACKED],
1120 "set the threshold for inlining a function"),
1121 #[rustc_lint_opt_deny_field_access("use `Session::instrument_coverage` instead of this field")]
1122 instrument_coverage: Option<InstrumentCoverage> = (None, parse_instrument_coverage, [TRACKED],
1123 "instrument the generated code to support LLVM source-based code coverage \
1124 reports (note, the compiler build config must include `profiler = true`); \
1125 implies `-C symbol-mangling-version=v0`. Optional values are:
1126 `=all` (implicit value)
1127 `=except-unused-generics`
1128 `=except-unused-functions`
1130 link_arg: (/* redirected to link_args */) = ((), parse_string_push, [UNTRACKED],
1131 "a single extra argument to append to the linker invocation (can be used several times)"),
1132 link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
1133 "extra arguments to append to the linker invocation (space separated)"),
1134 #[rustc_lint_opt_deny_field_access("use `Session::link_dead_code` instead of this field")]
1135 link_dead_code: Option<bool> = (None, parse_opt_bool, [TRACKED],
1136 "keep dead code at link time (useful for code coverage) (default: no)"),
1137 link_self_contained: Option<bool> = (None, parse_opt_bool, [UNTRACKED],
1138 "control whether to link Rust provided C objects/libraries or rely
1139 on C toolchain installed in the system"),
1140 linker: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1141 "system linker to link outputs with"),
1142 linker_flavor: Option<LinkerFlavorCli> = (None, parse_linker_flavor, [UNTRACKED],
1144 linker_plugin_lto: LinkerPluginLto = (LinkerPluginLto::Disabled,
1145 parse_linker_plugin_lto, [TRACKED],
1146 "generate build artifacts that are compatible with linker-based LTO"),
1147 llvm_args: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1148 "a list of arguments to pass to LLVM (space separated)"),
1149 #[rustc_lint_opt_deny_field_access("use `Session::lto` instead of this field")]
1150 lto: LtoCli = (LtoCli::Unspecified, parse_lto, [TRACKED],
1151 "perform LLVM link-time optimizations"),
1152 metadata: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1153 "metadata to mangle symbol names with"),
1154 no_prepopulate_passes: bool = (false, parse_no_flag, [TRACKED],
1155 "give an empty list of passes to the pass manager"),
1156 no_redzone: Option<bool> = (None, parse_opt_bool, [TRACKED],
1157 "disable the use of the redzone"),
1158 no_stack_check: bool = (false, parse_no_flag, [UNTRACKED],
1159 "this option is deprecated and does nothing"),
1160 no_vectorize_loops: bool = (false, parse_no_flag, [TRACKED],
1161 "disable loop vectorization optimization passes"),
1162 no_vectorize_slp: bool = (false, parse_no_flag, [TRACKED],
1163 "disable LLVM's SLP vectorization pass"),
1164 opt_level: String = ("0".to_string(), parse_string, [TRACKED],
1165 "optimization level (0-3, s, or z; default: 0)"),
1166 #[rustc_lint_opt_deny_field_access("use `Session::overflow_checks` instead of this field")]
1167 overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1168 "use overflow checks for integer arithmetic"),
1169 #[rustc_lint_opt_deny_field_access("use `Session::panic_strategy` instead of this field")]
1170 panic: Option<PanicStrategy> = (None, parse_opt_panic_strategy, [TRACKED],
1171 "panic strategy to compile crate with"),
1172 passes: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1173 "a list of extra LLVM passes to run (space separated)"),
1174 prefer_dynamic: bool = (false, parse_bool, [TRACKED],
1175 "prefer dynamic linking to static linking (default: no)"),
1176 profile_generate: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1177 parse_switch_with_opt_path, [TRACKED],
1178 "compile the program with profiling instrumentation"),
1179 profile_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1180 "use the given `.profdata` file for profile-guided optimization"),
1181 #[rustc_lint_opt_deny_field_access("use `Session::relocation_model` instead of this field")]
1182 relocation_model: Option<RelocModel> = (None, parse_relocation_model, [TRACKED],
1183 "control generation of position-independent code (PIC) \
1184 (`rustc --print relocation-models` for details)"),
1185 remark: Passes = (Passes::Some(Vec::new()), parse_passes, [UNTRACKED],
1186 "print remarks for these optimization passes (space separated, or \"all\")"),
1187 rpath: bool = (false, parse_bool, [UNTRACKED],
1188 "set rpath values in libs/exes (default: no)"),
1189 save_temps: bool = (false, parse_bool, [UNTRACKED],
1190 "save all temporary output files during compilation (default: no)"),
1191 soft_float: bool = (false, parse_bool, [TRACKED],
1192 "use soft float ABI (*eabihf targets only) (default: no)"),
1193 #[rustc_lint_opt_deny_field_access("use `Session::split_debuginfo` instead of this field")]
1194 split_debuginfo: Option<SplitDebuginfo> = (None, parse_split_debuginfo, [TRACKED],
1195 "how to handle split-debuginfo, a platform-specific option"),
1196 strip: Strip = (Strip::None, parse_strip, [UNTRACKED],
1197 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1198 symbol_mangling_version: Option<SymbolManglingVersion> = (None,
1199 parse_symbol_mangling_version, [TRACKED],
1200 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1201 target_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1202 "select target processor (`rustc --print target-cpus` for details)"),
1203 target_feature: String = (String::new(), parse_target_feature, [TRACKED],
1204 "target specific attributes. (`rustc --print target-features` for details). \
1205 This feature is unsafe."),
1207 // This list is in alphabetical order.
1209 // If you add a new option, please update:
1210 // - compiler/rustc_interface/src/tests.rs
1211 // - src/doc/rustc/src/codegen-options/index.md
1215 UnstableOptions, Z_OPTIONS, dbopts, "Z", "unstable",
1217 // This list is in alphabetical order.
1219 // If you add a new option, please update:
1220 // - compiler/rustc_interface/src/tests.rs
1221 // - src/doc/unstable-book/src/compiler-flags
1223 allow_features: Option<Vec<String>> = (None, parse_opt_comma_list, [TRACKED],
1224 "only allow the listed language features to be enabled in code (space separated)"),
1225 always_encode_mir: bool = (false, parse_bool, [TRACKED],
1226 "encode MIR of all functions into the crate metadata (default: no)"),
1227 assume_incomplete_release: bool = (false, parse_bool, [TRACKED],
1228 "make cfg(version) treat the current version as incomplete (default: no)"),
1229 #[rustc_lint_opt_deny_field_access("use `Session::asm_comments` instead of this field")]
1230 asm_comments: bool = (false, parse_bool, [TRACKED],
1231 "generate comments into the assembly (may change behavior) (default: no)"),
1232 assert_incr_state: Option<String> = (None, parse_opt_string, [UNTRACKED],
1233 "assert that the incremental cache is in given state: \
1234 either `loaded` or `not-loaded`."),
1235 #[rustc_lint_opt_deny_field_access("use `Session::binary_dep_depinfo` instead of this field")]
1236 binary_dep_depinfo: bool = (false, parse_bool, [TRACKED],
1237 "include artifacts (sysroot, crate dependencies) used during compilation in dep-info \
1239 box_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1240 "emit noalias metadata for box (default: yes)"),
1241 branch_protection: Option<BranchProtection> = (None, parse_branch_protection, [TRACKED],
1242 "set options for branch target identification and pointer authentication on AArch64"),
1243 cf_protection: CFProtection = (CFProtection::None, parse_cfprotection, [TRACKED],
1244 "instrument control-flow architecture protection"),
1245 cgu_partitioning_strategy: Option<String> = (None, parse_opt_string, [TRACKED],
1246 "the codegen unit partitioning strategy to use"),
1247 chalk: bool = (false, parse_bool, [TRACKED],
1248 "enable the experimental Chalk-based trait solving engine"),
1249 codegen_backend: Option<String> = (None, parse_opt_string, [TRACKED],
1250 "the backend to use"),
1251 combine_cgu: bool = (false, parse_bool, [TRACKED],
1252 "combine CGUs into a single one"),
1253 crate_attr: Vec<String> = (Vec::new(), parse_string_push, [TRACKED],
1254 "inject the given attribute in the crate"),
1255 debug_info_for_profiling: bool = (false, parse_bool, [TRACKED],
1256 "emit discriminators and other data necessary for AutoFDO"),
1257 debug_macros: bool = (false, parse_bool, [TRACKED],
1258 "emit line numbers debug info inside macros (default: no)"),
1259 deduplicate_diagnostics: bool = (true, parse_bool, [UNTRACKED],
1260 "deduplicate identical diagnostics (default: yes)"),
1261 dep_info_omit_d_target: bool = (false, parse_bool, [TRACKED],
1262 "in dep-info output, omit targets for tracking dependencies of the dep-info files \
1263 themselves (default: no)"),
1264 dep_tasks: bool = (false, parse_bool, [UNTRACKED],
1265 "print tasks that execute and the color their dep node gets (requires debug build) \
1267 dlltool: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1268 "import library generation tool (windows-gnu only)"),
1269 dont_buffer_diagnostics: bool = (false, parse_bool, [UNTRACKED],
1270 "emit diagnostics rather than buffering (breaks NLL error downgrading, sorting) \
1272 drop_tracking: bool = (false, parse_bool, [TRACKED],
1273 "enables drop tracking in generators (default: no)"),
1274 dual_proc_macros: bool = (false, parse_bool, [TRACKED],
1275 "load proc macros for both target and host, but only link to the target (default: no)"),
1276 dump_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1277 "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv) \
1279 dump_drop_tracking_cfg: Option<String> = (None, parse_opt_string, [UNTRACKED],
1280 "dump drop-tracking control-flow graph as a `.dot` file (default: no)"),
1281 dump_mir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1282 "dump MIR state to file.
1283 `val` is used to select which passes and functions to dump. For example:
1284 `all` matches all passes and functions,
1285 `foo` matches all passes for functions whose name contains 'foo',
1286 `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
1287 `foo | bar` all passes for function names containing 'foo' or 'bar'."),
1288 dump_mir_dataflow: bool = (false, parse_bool, [UNTRACKED],
1289 "in addition to `.mir` files, create graphviz `.dot` files with dataflow results \
1291 dump_mir_dir: String = ("mir_dump".to_string(), parse_string, [UNTRACKED],
1292 "the directory the MIR is dumped into (default: `mir_dump`)"),
1293 dump_mir_exclude_pass_number: bool = (false, parse_bool, [UNTRACKED],
1294 "exclude the pass number when dumping MIR (used in tests) (default: no)"),
1295 dump_mir_graphviz: bool = (false, parse_bool, [UNTRACKED],
1296 "in addition to `.mir` files, create graphviz `.dot` files (and with \
1297 `-Z instrument-coverage`, also create a `.dot` file for the MIR-derived \
1298 coverage graph) (default: no)"),
1299 dump_mir_spanview: Option<MirSpanview> = (None, parse_mir_spanview, [UNTRACKED],
1300 "in addition to `.mir` files, create `.html` files to view spans for \
1301 all `statement`s (including terminators), only `terminator` spans, or \
1302 computed `block` spans (one span encompassing a block's terminator and \
1303 all statements). If `-Z instrument-coverage` is also enabled, create \
1304 an additional `.html` file showing the computed coverage spans."),
1305 dwarf_version: Option<u32> = (None, parse_opt_number, [TRACKED],
1306 "version of DWARF debug information to emit (default: 2 or 4, depending on platform)"),
1307 emit_stack_sizes: bool = (false, parse_bool, [UNTRACKED],
1308 "emit a section containing stack size metadata (default: no)"),
1309 emit_thin_lto: bool = (true, parse_bool, [TRACKED],
1310 "emit the bc module with thin LTO info (default: yes)"),
1311 export_executable_symbols: bool = (false, parse_bool, [TRACKED],
1312 "export symbols from executables, as if they were dynamic libraries"),
1313 extra_const_ub_checks: bool = (false, parse_bool, [TRACKED],
1314 "turns on more checks to detect const UB, which can be slow (default: no)"),
1315 #[rustc_lint_opt_deny_field_access("use `Session::fewer_names` instead of this field")]
1316 fewer_names: Option<bool> = (None, parse_opt_bool, [TRACKED],
1317 "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR) \
1319 force_unstable_if_unmarked: bool = (false, parse_bool, [TRACKED],
1320 "force all crates to be `rustc_private` unstable (default: no)"),
1321 fuel: Option<(String, u64)> = (None, parse_optimization_fuel, [TRACKED],
1322 "set the optimization fuel quota for a crate"),
1323 function_sections: Option<bool> = (None, parse_opt_bool, [TRACKED],
1324 "whether each function should go in its own section"),
1325 future_incompat_test: bool = (false, parse_bool, [UNTRACKED],
1326 "forces all lints to be future incompatible, used for internal testing (default: no)"),
1327 gcc_ld: Option<LdImpl> = (None, parse_gcc_ld, [TRACKED], "implementation of ld used by cc"),
1328 graphviz_dark_mode: bool = (false, parse_bool, [UNTRACKED],
1329 "use dark-themed colors in graphviz output (default: no)"),
1330 graphviz_font: String = ("Courier, monospace".to_string(), parse_string, [UNTRACKED],
1331 "use the given `fontname` in graphviz output; can be overridden by setting \
1332 environment variable `RUSTC_GRAPHVIZ_FONT` (default: `Courier, monospace`)"),
1333 hir_stats: bool = (false, parse_bool, [UNTRACKED],
1334 "print some statistics about AST and HIR (default: no)"),
1335 human_readable_cgu_names: bool = (false, parse_bool, [TRACKED],
1336 "generate human-readable, predictable names for codegen units (default: no)"),
1337 identify_regions: bool = (false, parse_bool, [UNTRACKED],
1338 "display unnamed regions as `'<id>`, using a non-ident unique id (default: no)"),
1339 incremental_ignore_spans: bool = (false, parse_bool, [UNTRACKED],
1340 "ignore spans during ICH computation -- used for testing (default: no)"),
1341 incremental_info: bool = (false, parse_bool, [UNTRACKED],
1342 "print high-level information about incremental reuse (or the lack thereof) \
1344 incremental_relative_spans: bool = (false, parse_bool, [TRACKED],
1345 "hash spans relative to their parent item for incr. comp. (default: no)"),
1346 incremental_verify_ich: bool = (false, parse_bool, [UNTRACKED],
1347 "verify incr. comp. hashes of green query instances (default: no)"),
1348 inline_llvm: bool = (true, parse_bool, [TRACKED],
1349 "enable LLVM inlining (default: yes)"),
1350 inline_mir: Option<bool> = (None, parse_opt_bool, [TRACKED],
1351 "enable MIR inlining (default: no)"),
1352 inline_mir_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1353 "a default MIR inlining threshold (default: 50)"),
1354 inline_mir_hint_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1355 "inlining threshold for functions with inline hint (default: 100)"),
1356 inline_in_all_cgus: Option<bool> = (None, parse_opt_bool, [TRACKED],
1357 "control whether `#[inline]` functions are in all CGUs"),
1358 input_stats: bool = (false, parse_bool, [UNTRACKED],
1359 "gather statistics about the input (default: no)"),
1360 #[rustc_lint_opt_deny_field_access("use `Session::instrument_coverage` instead of this field")]
1361 instrument_coverage: Option<InstrumentCoverage> = (None, parse_instrument_coverage, [TRACKED],
1362 "instrument the generated code to support LLVM source-based code coverage \
1363 reports (note, the compiler build config must include `profiler = true`); \
1364 implies `-C symbol-mangling-version=v0`. Optional values are:
1365 `=all` (implicit value)
1366 `=except-unused-generics`
1367 `=except-unused-functions`
1369 #[rustc_lint_opt_deny_field_access("use `Session::instrument_mcount` instead of this field")]
1370 instrument_mcount: bool = (false, parse_bool, [TRACKED],
1371 "insert function instrument code for mcount-based tracing (default: no)"),
1372 keep_hygiene_data: bool = (false, parse_bool, [UNTRACKED],
1373 "keep hygiene data after analysis (default: no)"),
1374 link_native_libraries: bool = (true, parse_bool, [UNTRACKED],
1375 "link native libraries in the linker invocation (default: yes)"),
1376 link_only: bool = (false, parse_bool, [TRACKED],
1377 "link the `.rlink` file generated by `-Z no-link` (default: no)"),
1378 llvm_plugins: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1379 "a list LLVM plugins to enable (space separated)"),
1380 llvm_time_trace: bool = (false, parse_bool, [UNTRACKED],
1381 "generate JSON tracing data file from LLVM data (default: no)"),
1382 location_detail: LocationDetail = (LocationDetail::all(), parse_location_detail, [TRACKED],
1383 "what location details should be tracked when using caller_location, either \
1384 `none`, or a comma separated list of location details, for which \
1385 valid options are `file`, `line`, and `column` (default: `file,line,column`)"),
1386 ls: bool = (false, parse_bool, [UNTRACKED],
1387 "list the symbols defined by a library crate (default: no)"),
1388 macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1389 "show macro backtraces (default: no)"),
1390 merge_functions: Option<MergeFunctions> = (None, parse_merge_functions, [TRACKED],
1391 "control the operation of the MergeFunctions LLVM pass, taking \
1392 the same values as the target option of the same name"),
1393 #[rustc_lint_opt_deny_field_access("use `Session::meta_stats` instead of this field")]
1394 meta_stats: bool = (false, parse_bool, [UNTRACKED],
1395 "gather metadata statistics (default: no)"),
1396 mir_emit_retag: bool = (false, parse_bool, [TRACKED],
1397 "emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0 \
1399 mir_enable_passes: Vec<(String, bool)> = (Vec::new(), parse_list_with_polarity, [TRACKED],
1400 "use like `-Zmir-enable-passes=+DestProp,-InstCombine`. Forces the specified passes to be \
1401 enabled, overriding all other checks. Passes that are not specified are enabled or \
1402 disabled by other flags as usual."),
1403 mir_pretty_relative_line_numbers: bool = (false, parse_bool, [UNTRACKED],
1404 "use line numbers relative to the function in mir pretty printing"),
1405 #[rustc_lint_opt_deny_field_access("use `Session::mir_opt_level` instead of this field")]
1406 mir_opt_level: Option<usize> = (None, parse_opt_number, [TRACKED],
1407 "MIR optimization level (0-4; default: 1 in non optimized builds and 2 in optimized builds)"),
1408 move_size_limit: Option<usize> = (None, parse_opt_number, [TRACKED],
1409 "the size at which the `large_assignments` lint starts to be emitted"),
1410 mutable_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1411 "emit noalias metadata for mutable references (default: yes)"),
1412 new_llvm_pass_manager: Option<bool> = (None, parse_opt_bool, [TRACKED],
1413 "use new LLVM pass manager (default: no)"),
1414 nll_facts: bool = (false, parse_bool, [UNTRACKED],
1415 "dump facts from NLL analysis into side files (default: no)"),
1416 nll_facts_dir: String = ("nll-facts".to_string(), parse_string, [UNTRACKED],
1417 "the directory the NLL facts are dumped into (default: `nll-facts`)"),
1418 no_analysis: bool = (false, parse_no_flag, [UNTRACKED],
1419 "parse and expand the source, but run no analysis"),
1420 no_codegen: bool = (false, parse_no_flag, [TRACKED_NO_CRATE_HASH],
1421 "run all passes except codegen; no output"),
1422 no_generate_arange_section: bool = (false, parse_no_flag, [TRACKED],
1423 "omit DWARF address ranges that give faster lookups"),
1424 no_interleave_lints: bool = (false, parse_no_flag, [UNTRACKED],
1425 "execute lints separately; allows benchmarking individual lints"),
1426 no_leak_check: bool = (false, parse_no_flag, [UNTRACKED],
1427 "disable the 'leak check' for subtyping; unsound, but useful for tests"),
1428 no_link: bool = (false, parse_no_flag, [TRACKED],
1429 "compile without linking"),
1430 no_parallel_llvm: bool = (false, parse_no_flag, [UNTRACKED],
1431 "run LLVM in non-parallel mode (while keeping codegen-units and ThinLTO)"),
1432 no_unique_section_names: bool = (false, parse_bool, [TRACKED],
1433 "do not use unique names for text and data sections when -Z function-sections is used"),
1434 no_profiler_runtime: bool = (false, parse_no_flag, [TRACKED],
1435 "prevent automatic injection of the profiler_builtins crate"),
1436 normalize_docs: bool = (false, parse_bool, [TRACKED],
1437 "normalize associated items in rustdoc when generating documentation"),
1438 oom: OomStrategy = (OomStrategy::Abort, parse_oom_strategy, [TRACKED],
1439 "panic strategy for out-of-memory handling"),
1440 osx_rpath_install_name: bool = (false, parse_bool, [TRACKED],
1441 "pass `-install_name @rpath/...` to the macOS linker (default: no)"),
1442 diagnostic_width: Option<usize> = (None, parse_opt_number, [UNTRACKED],
1443 "set the current output width for diagnostic truncation"),
1444 packed_bundled_libs: bool = (false, parse_bool, [TRACKED],
1445 "change rlib format to store native libraries as archives"),
1446 panic_abort_tests: bool = (false, parse_bool, [TRACKED],
1447 "support compiling tests with panic=abort (default: no)"),
1448 panic_in_drop: PanicStrategy = (PanicStrategy::Unwind, parse_panic_strategy, [TRACKED],
1449 "panic strategy for panics in drops"),
1450 parse_only: bool = (false, parse_bool, [UNTRACKED],
1451 "parse only; do not compile, assemble, or link (default: no)"),
1452 perf_stats: bool = (false, parse_bool, [UNTRACKED],
1453 "print some performance-related statistics (default: no)"),
1454 pick_stable_methods_before_any_unstable: bool = (true, parse_bool, [TRACKED],
1455 "try to pick stable methods first before picking any unstable methods (default: yes)"),
1456 plt: Option<bool> = (None, parse_opt_bool, [TRACKED],
1457 "whether to use the PLT when calling into shared libraries;
1458 only has effect for PIC code on systems with ELF binaries
1459 (default: PLT is disabled if full relro is enabled)"),
1460 polonius: bool = (false, parse_bool, [TRACKED],
1461 "enable polonius-based borrow-checker (default: no)"),
1462 polymorphize: bool = (false, parse_bool, [TRACKED],
1463 "perform polymorphization analysis"),
1464 pre_link_arg: (/* redirected to pre_link_args */) = ((), parse_string_push, [UNTRACKED],
1465 "a single extra argument to prepend the linker invocation (can be used several times)"),
1466 pre_link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
1467 "extra arguments to prepend to the linker invocation (space separated)"),
1468 precise_enum_drop_elaboration: bool = (true, parse_bool, [TRACKED],
1469 "use a more precise version of drop elaboration for matches on enums (default: yes). \
1470 This results in better codegen, but has caused miscompilations on some tier 2 platforms. \
1471 See #77382 and #74551."),
1472 print_fuel: Option<String> = (None, parse_opt_string, [TRACKED],
1473 "make rustc print the total optimization fuel used by a crate"),
1474 #[rustc_lint_opt_deny_field_access("use `Session::print_llvm_passes` instead of this field")]
1475 print_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1476 "print the LLVM optimization passes being run (default: no)"),
1477 print_mono_items: Option<String> = (None, parse_opt_string, [UNTRACKED],
1478 "print the result of the monomorphization collection pass"),
1479 print_type_sizes: bool = (false, parse_bool, [UNTRACKED],
1480 "print layout information for each type encountered (default: no)"),
1481 proc_macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1482 "show backtraces for panics during proc-macro execution (default: no)"),
1483 proc_macro_execution_strategy: ProcMacroExecutionStrategy = (ProcMacroExecutionStrategy::SameThread,
1484 parse_proc_macro_execution_strategy, [UNTRACKED],
1485 "how to run proc-macro code (default: same-thread)"),
1486 profile: bool = (false, parse_bool, [TRACKED],
1487 "insert profiling code (default: no)"),
1488 profile_closures: bool = (false, parse_no_flag, [UNTRACKED],
1489 "profile size of closures"),
1490 profile_emit: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1491 "file path to emit profiling data at runtime when using 'profile' \
1492 (default based on relative source path)"),
1493 profiler_runtime: String = (String::from("profiler_builtins"), parse_string, [TRACKED],
1494 "name of the profiler runtime crate to automatically inject (default: `profiler_builtins`)"),
1495 profile_sample_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1496 "use the given `.prof` file for sampled profile-guided optimization (also known as AutoFDO)"),
1497 query_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1498 "enable queries of the dependency graph for regression testing (default: no)"),
1499 randomize_layout: bool = (false, parse_bool, [TRACKED],
1500 "randomize the layout of types (default: no)"),
1501 layout_seed: Option<u64> = (None, parse_opt_number, [TRACKED],
1502 "seed layout randomization"),
1503 relax_elf_relocations: Option<bool> = (None, parse_opt_bool, [TRACKED],
1504 "whether ELF relocations can be relaxed"),
1505 relro_level: Option<RelroLevel> = (None, parse_relro_level, [TRACKED],
1506 "choose which RELRO level to use"),
1507 remap_cwd_prefix: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1508 "remap paths under the current working directory to this path prefix"),
1509 simulate_remapped_rust_src_base: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1510 "simulate the effect of remap-debuginfo = true at bootstrapping by remapping path \
1511 to rust's source base directory. only meant for testing purposes"),
1512 report_delayed_bugs: bool = (false, parse_bool, [TRACKED],
1513 "immediately print bugs registered with `delay_span_bug` (default: no)"),
1514 sanitizer: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
1516 sanitizer_memory_track_origins: usize = (0, parse_sanitizer_memory_track_origins, [TRACKED],
1517 "enable origins tracking in MemorySanitizer"),
1518 sanitizer_recover: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
1519 "enable recovery for selected sanitizers"),
1520 saturating_float_casts: Option<bool> = (None, parse_opt_bool, [TRACKED],
1521 "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
1522 the max/min integer respectively, and NaN is mapped to 0 (default: yes)"),
1523 save_analysis: bool = (false, parse_bool, [UNTRACKED],
1524 "write syntax and type analysis (in JSON format) information, in \
1525 addition to normal output (default: no)"),
1526 self_profile: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1527 parse_switch_with_opt_path, [UNTRACKED],
1528 "run the self profiler and output the raw event data"),
1529 /// keep this in sync with the event filter names in librustc_data_structures/profiling.rs
1530 self_profile_events: Option<Vec<String>> = (None, parse_opt_comma_list, [UNTRACKED],
1531 "specify the events recorded by the self profiler;
1532 for example: `-Z self-profile-events=default,query-keys`
1533 all options: none, all, default, generic-activity, query-provider, query-cache-hit
1534 query-blocked, incr-cache-load, incr-result-hashing, query-keys, function-args, args, llvm, artifact-sizes"),
1535 self_profile_counter: String = ("wall-time".to_string(), parse_string, [UNTRACKED],
1536 "counter used by the self profiler (default: `wall-time`), one of:
1537 `wall-time` (monotonic clock, i.e. `std::time::Instant`)
1538 `instructions:u` (retired instructions, userspace-only)
1539 `instructions-minus-irqs:u` (subtracting hardware interrupt counts for extra accuracy)"
1541 share_generics: Option<bool> = (None, parse_opt_bool, [TRACKED],
1542 "make the current crate share its generic instantiations"),
1543 show_span: Option<String> = (None, parse_opt_string, [TRACKED],
1544 "show spans for compiler debugging (expr|pat|ty)"),
1545 span_debug: bool = (false, parse_bool, [UNTRACKED],
1546 "forward proc_macro::Span's `Debug` impl to `Span`"),
1547 /// o/w tests have closure@path
1548 span_free_formats: bool = (false, parse_bool, [UNTRACKED],
1549 "exclude spans when debug-printing compiler state (default: no)"),
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 split_dwarf_kind: SplitDwarfKind = (SplitDwarfKind::Split, parse_split_dwarf_kind, [TRACKED],
1560 "split dwarf variant (only if -Csplit-debuginfo is enabled and on relevant platform)
1563 `split`: sections which do not require relocation are written into a DWARF object (`.dwo`)
1564 file which is ignored by the linker
1565 `single`: sections which do not require relocation are written into object file but ignored
1567 split_dwarf_inlining: bool = (true, parse_bool, [TRACKED],
1568 "provide minimal debug info in the object/executable to facilitate online \
1569 symbolication/stack traces in the absence of .dwo/.dwp files when using Split DWARF"),
1570 symbol_mangling_version: Option<SymbolManglingVersion> = (None,
1571 parse_symbol_mangling_version, [TRACKED],
1572 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1573 #[rustc_lint_opt_deny_field_access("use `Session::teach` instead of this field")]
1574 teach: bool = (false, parse_bool, [TRACKED],
1575 "show extended diagnostic help (default: no)"),
1576 temps_dir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1577 "the directory the intermediate files are written to"),
1578 // Diagnostics are considered side-effects of a query (see `QuerySideEffects`) and are saved
1579 // alongside query results and changes to translation options can affect diagnostics - so
1580 // translation options should be tracked.
1581 translate_lang: Option<LanguageIdentifier> = (None, parse_opt_langid, [TRACKED],
1582 "language identifier for diagnostic output"),
1583 translate_additional_ftl: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1584 "additional fluent translation to preferentially use (for testing translation)"),
1585 translate_directionality_markers: bool = (false, parse_bool, [TRACKED],
1586 "emit directionality isolation markers in translated diagnostics"),
1587 tune_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1588 "select processor to schedule for (`rustc --print target-cpus` for details)"),
1589 #[rustc_lint_opt_deny_field_access("use `Session::lto` instead of this field")]
1590 thinlto: Option<bool> = (None, parse_opt_bool, [TRACKED],
1591 "enable ThinLTO when possible"),
1592 thir_unsafeck: bool = (false, parse_bool, [TRACKED],
1593 "use the THIR unsafety checker (default: no)"),
1594 /// We default to 1 here since we want to behave like
1595 /// a sequential compiler for now. This'll likely be adjusted
1596 /// in the future. Note that -Zthreads=0 is the way to get
1597 /// the num_cpus behavior.
1598 #[rustc_lint_opt_deny_field_access("use `Session::threads` instead of this field")]
1599 threads: usize = (1, parse_threads, [UNTRACKED],
1600 "use a thread pool with N threads"),
1601 #[rustc_lint_opt_deny_field_access("use `Session::time_passes` instead of this field")]
1602 time: bool = (false, parse_bool, [UNTRACKED],
1603 "measure time of rustc processes (default: no)"),
1604 #[rustc_lint_opt_deny_field_access("use `Session::time_llvm_passes` instead of this field")]
1605 time_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1606 "measure time of each LLVM pass (default: no)"),
1607 #[rustc_lint_opt_deny_field_access("use `Session::time_passes` instead of this field")]
1608 time_passes: bool = (false, parse_bool, [UNTRACKED],
1609 "measure time of each rustc pass (default: no)"),
1610 #[rustc_lint_opt_deny_field_access("use `Session::tls_model` instead of this field")]
1611 tls_model: Option<TlsModel> = (None, parse_tls_model, [TRACKED],
1612 "choose the TLS model to use (`rustc --print tls-models` for details)"),
1613 trace_macros: bool = (false, parse_bool, [UNTRACKED],
1614 "for every macro invocation, print its name and arguments (default: no)"),
1615 translate_remapped_path_to_local_path: bool = (true, parse_bool, [TRACKED],
1616 "translate remapped paths into local paths when possible (default: yes)"),
1617 trap_unreachable: Option<bool> = (None, parse_opt_bool, [TRACKED],
1618 "generate trap instructions for unreachable intrinsics (default: use target setting, usually yes)"),
1619 treat_err_as_bug: Option<NonZeroUsize> = (None, parse_treat_err_as_bug, [TRACKED],
1620 "treat error number `val` that occurs as bug"),
1621 trim_diagnostic_paths: bool = (true, parse_bool, [UNTRACKED],
1622 "in diagnostics, use heuristics to shorten paths referring to items"),
1623 ui_testing: bool = (false, parse_bool, [UNTRACKED],
1624 "emit compiler diagnostics in a form suitable for UI testing (default: no)"),
1625 uninit_const_chunk_threshold: usize = (16, parse_number, [TRACKED],
1626 "allow generating const initializers with mixed init/uninit chunks, \
1627 and set the maximum number of chunks for which this is allowed (default: 16)"),
1628 unleash_the_miri_inside_of_you: bool = (false, parse_bool, [TRACKED],
1629 "take the brakes off const evaluation. NOTE: this is unsound (default: no)"),
1630 unpretty: Option<String> = (None, parse_unpretty, [UNTRACKED],
1631 "present the input source, unstable (and less-pretty) variants;
1632 `normal`, `identified`,
1633 `expanded`, `expanded,identified`,
1634 `expanded,hygiene` (with internal representations),
1635 `ast-tree` (raw AST before expansion),
1636 `ast-tree,expanded` (raw AST after expansion),
1637 `hir` (the HIR), `hir,identified`,
1638 `hir,typed` (HIR with types for each node),
1639 `hir-tree` (dump the raw HIR),
1640 `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)"),
1641 unsound_mir_opts: bool = (false, parse_bool, [TRACKED],
1642 "enable unsound and buggy MIR optimizations (default: no)"),
1643 /// This name is kind of confusing: Most unstable options enable something themselves, while
1644 /// this just allows "normal" options to be feature-gated.
1645 #[rustc_lint_opt_deny_field_access("use `Session::unstable_options` instead of this field")]
1646 unstable_options: bool = (false, parse_bool, [UNTRACKED],
1647 "adds unstable command line options to rustc interface (default: no)"),
1648 use_ctors_section: Option<bool> = (None, parse_opt_bool, [TRACKED],
1649 "use legacy .ctors section for initializers rather than .init_array"),
1650 validate_mir: bool = (false, parse_bool, [UNTRACKED],
1651 "validate MIR after each transformation"),
1652 #[rustc_lint_opt_deny_field_access("use `Session::verbose` instead of this field")]
1653 verbose: bool = (false, parse_bool, [UNTRACKED],
1654 "in general, enable more debug printouts (default: no)"),
1655 #[rustc_lint_opt_deny_field_access("use `Session::verify_llvm_ir` instead of this field")]
1656 verify_llvm_ir: bool = (false, parse_bool, [TRACKED],
1657 "verify LLVM IR (default: no)"),
1658 virtual_function_elimination: bool = (false, parse_bool, [TRACKED],
1659 "enables dead virtual function elimination optimization. \
1660 Requires `-Clto[=[fat,yes]]`"),
1661 wasi_exec_model: Option<WasiExecModel> = (None, parse_wasi_exec_model, [TRACKED],
1662 "whether to build a wasi command or reactor"),
1664 // This list is in alphabetical order.
1666 // If you add a new option, please update:
1667 // - compiler/rustc_interface/src/tests.rs
1670 #[derive(Clone, Hash, PartialEq, Eq, Debug)]
1671 pub enum WasiExecModel {
1676 #[derive(Clone, Copy, Hash)]