3 use crate::early_error;
5 use crate::search_paths::SearchPath;
6 use crate::utils::NativeLib;
7 use rustc_target::spec::{CodeModel, LinkerFlavor, MergeFunctions, PanicStrategy, SanitizerSet};
8 use rustc_target::spec::{
9 RelocModel, RelroLevel, SplitDebuginfo, StackProtector, TargetTriple, TlsModel,
12 use rustc_feature::UnstableFeatures;
13 use rustc_span::edition::Edition;
14 use rustc_span::RealFileName;
15 use rustc_span::SourceFileHashAlgorithm;
17 use std::collections::BTreeMap;
19 use std::collections::hash_map::DefaultHasher;
20 use std::hash::Hasher;
21 use std::num::NonZeroUsize;
22 use std::path::PathBuf;
26 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr) => {
28 .insert(stringify!($opt_name), $opt_expr as &dyn dep_tracking::DepTrackingHash)
31 panic!("duplicate key in CLI DepTrackingHash: {}", stringify!($opt_name))
36 macro_rules! hash_opt {
37 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, $_for_crate_hash: ident, [UNTRACKED]) => {{}};
38 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, $_for_crate_hash: ident, [TRACKED]) => {{ insert!($opt_name, $opt_expr, $sub_hashes) }};
39 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, $for_crate_hash: ident, [TRACKED_NO_CRATE_HASH]) => {{
41 insert!($opt_name, $opt_expr, $sub_hashes)
44 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, $_for_crate_hash: ident, [SUBSTRUCT]) => {{}};
47 macro_rules! hash_substruct {
48 ($opt_name:ident, $opt_expr:expr, $error_format:expr, $for_crate_hash:expr, $hasher:expr, [UNTRACKED]) => {{}};
49 ($opt_name:ident, $opt_expr:expr, $error_format:expr, $for_crate_hash:expr, $hasher:expr, [TRACKED]) => {{}};
50 ($opt_name:ident, $opt_expr:expr, $error_format:expr, $for_crate_hash:expr, $hasher:expr, [TRACKED_NO_CRATE_HASH]) => {{}};
51 ($opt_name:ident, $opt_expr:expr, $error_format:expr, $for_crate_hash:expr, $hasher:expr, [SUBSTRUCT]) => {
52 use crate::config::dep_tracking::DepTrackingHash;
53 $opt_expr.dep_tracking_hash($for_crate_hash, $error_format).hash(
61 macro_rules! top_level_options {
62 ( $( #[$top_level_attr:meta] )* pub struct Options { $(
64 $opt:ident : $t:ty [$dep_tracking_marker:ident],
67 $( #[$top_level_attr] )*
76 pub fn dep_tracking_hash(&self, for_crate_hash: bool) -> u64 {
77 let mut sub_hashes = BTreeMap::new();
83 [$dep_tracking_marker]);
85 let mut hasher = DefaultHasher::new();
86 dep_tracking::stable_hash(sub_hashes,
96 [$dep_tracking_marker]);
105 pub fn mir_opt_level(&self) -> usize {
108 .unwrap_or_else(|| if self.optimize != OptLevel::No { 2 } else { 1 })
111 pub fn instrument_coverage(&self) -> bool {
112 self.debugging_opts.instrument_coverage.unwrap_or(InstrumentCoverage::Off)
113 != InstrumentCoverage::Off
116 pub fn instrument_coverage_except_unused_generics(&self) -> bool {
117 self.debugging_opts.instrument_coverage.unwrap_or(InstrumentCoverage::Off)
118 == InstrumentCoverage::ExceptUnusedGenerics
121 pub fn instrument_coverage_except_unused_functions(&self) -> bool {
122 self.debugging_opts.instrument_coverage.unwrap_or(InstrumentCoverage::Off)
123 == InstrumentCoverage::ExceptUnusedFunctions
128 /// The top-level command-line options struct.
130 /// For each option, one has to specify how it behaves with regard to the
131 /// dependency tracking system of incremental compilation. This is done via the
132 /// square-bracketed directive after the field type. The options are:
135 /// A change in the given field will cause the compiler to completely clear the
136 /// incremental compilation cache before proceeding.
138 /// - `[TRACKED_NO_CRATE_HASH]`
139 /// Same as `[TRACKED]`, but will not affect the crate hash. This is useful for options that only
140 /// affect the incremental cache.
143 /// Incremental compilation is not influenced by this option.
146 /// Second-level sub-structs containing more options.
148 /// If you add a new option to this struct or one of the sub-structs like
149 /// `CodegenOptions`, think about how it influences incremental compilation. If in
150 /// doubt, specify `[TRACKED]`, which is always "correct" but might lead to
151 /// unnecessary re-compilation.
153 /// The crate config requested for the session, which may be combined
154 /// with additional crate configurations during the compile process.
155 crate_types: Vec<CrateType> [TRACKED],
156 optimize: OptLevel [TRACKED],
157 /// Include the `debug_assertions` flag in dependency tracking, since it
158 /// can influence whether overflow checks are done or not.
159 debug_assertions: bool [TRACKED],
160 debuginfo: DebugInfo [TRACKED],
161 lint_opts: Vec<(String, lint::Level)> [TRACKED_NO_CRATE_HASH],
162 lint_cap: Option<lint::Level> [TRACKED_NO_CRATE_HASH],
163 describe_lints: bool [UNTRACKED],
164 output_types: OutputTypes [TRACKED],
165 search_paths: Vec<SearchPath> [UNTRACKED],
166 libs: Vec<NativeLib> [TRACKED],
167 maybe_sysroot: Option<PathBuf> [UNTRACKED],
169 target_triple: TargetTriple [TRACKED],
171 test: bool [TRACKED],
172 error_format: ErrorOutputType [UNTRACKED],
174 /// If `Some`, enable incremental compilation, using the given
175 /// directory to store intermediate results.
176 incremental: Option<PathBuf> [UNTRACKED],
177 assert_incr_state: Option<IncrementalStateAssertion> [UNTRACKED],
179 debugging_opts: DebuggingOptions [SUBSTRUCT],
180 prints: Vec<PrintRequest> [UNTRACKED],
181 /// Determines which borrow checker(s) to run. This is the parsed, sanitized
182 /// version of `debugging_opts.borrowck`, which is just a plain string.
183 borrowck_mode: BorrowckMode [UNTRACKED],
184 cg: CodegenOptions [SUBSTRUCT],
185 externs: Externs [UNTRACKED],
186 extern_dep_specs: ExternDepSpecs [UNTRACKED],
187 crate_name: Option<String> [TRACKED],
188 /// An optional name to use as the crate for std during std injection,
189 /// written `extern crate name as std`. Defaults to `std`. Used by
190 /// out-of-tree drivers.
191 alt_std_name: Option<String> [TRACKED],
192 /// Indicates how the compiler should treat unstable features.
193 unstable_features: UnstableFeatures [TRACKED],
195 /// Indicates whether this run of the compiler is actually rustdoc. This
196 /// is currently just a hack and will be removed eventually, so please
197 /// try to not rely on this too much.
198 actually_rustdoc: bool [TRACKED],
200 /// Control path trimming.
201 trimmed_def_paths: TrimmedDefPaths [TRACKED],
203 /// Specifications of codegen units / ThinLTO which are forced as a
204 /// result of parsing command line options. These are not necessarily
205 /// what rustc was invoked with, but massaged a bit to agree with
206 /// commands like `--emit llvm-ir` which they're often incompatible with
207 /// if we otherwise use the defaults of rustc.
208 cli_forced_codegen_units: Option<usize> [UNTRACKED],
209 cli_forced_thinlto_off: bool [UNTRACKED],
211 /// Remap source path prefixes in all output (messages, object files, debug, etc.).
212 remap_path_prefix: Vec<(PathBuf, PathBuf)> [TRACKED_NO_CRATE_HASH],
213 /// Base directory containing the `src/` for the Rust standard library, and
214 /// potentially `rustc` as well, if we can can find it. Right now it's always
215 /// `$sysroot/lib/rustlib/src/rust` (i.e. the `rustup` `rust-src` component).
217 /// This directory is what the virtual `/rustc/$hash` is translated back to,
218 /// if Rust was built with path remapping to `/rustc/$hash` enabled
219 /// (the `rust.remap-debuginfo` option in `config.toml`).
220 real_rust_source_base_dir: Option<PathBuf> [TRACKED_NO_CRATE_HASH],
222 edition: Edition [TRACKED],
224 /// `true` if we're emitting JSON blobs about each artifact produced
226 json_artifact_notifications: bool [TRACKED],
228 /// `true` if we're emitting a JSON blob containing the unused externs
229 json_unused_externs: bool [UNTRACKED],
231 /// `true` if we're emitting a JSON job containg a future-incompat report for lints
232 json_future_incompat: bool [TRACKED],
234 pretty: Option<PpMode> [UNTRACKED],
236 /// The (potentially remapped) working directory
237 working_dir: RealFileName [TRACKED],
241 /// Defines all `CodegenOptions`/`DebuggingOptions` fields and parsers all at once. The goal of this
242 /// macro is to define an interface that can be programmatically used by the option parser
243 /// to initialize the struct without hardcoding field names all over the place.
245 /// The goal is to invoke this macro once with the correct fields, and then this macro generates all
246 /// necessary code. The main gotcha of this macro is the `cgsetters` module which is a bunch of
247 /// generated code to parse an option into its respective field in the struct. There are a few
248 /// hand-written parsers for parsing specific types of values in this module.
249 macro_rules! options {
250 ($struct_name:ident, $stat:ident, $optmod:ident, $prefix:expr, $outputname:expr,
251 $($( #[$attr:meta] )* $opt:ident : $t:ty = (
254 [$dep_tracking_marker:ident],
259 pub struct $struct_name { $(pub $opt: $t),* }
261 impl Default for $struct_name {
262 fn default() -> $struct_name {
263 $struct_name { $( $( #[$attr] )* $opt: $init),* }
269 matches: &getopts::Matches,
270 error_format: ErrorOutputType,
272 build_options(matches, $stat, $prefix, $outputname, error_format)
275 fn dep_tracking_hash(&self, for_crate_hash: bool, error_format: ErrorOutputType) -> u64 {
276 let mut sub_hashes = BTreeMap::new();
282 [$dep_tracking_marker]);
284 let mut hasher = DefaultHasher::new();
285 dep_tracking::stable_hash(sub_hashes,
294 pub const $stat: OptionDescrs<$struct_name> =
295 &[ $( (stringify!($opt), $optmod::$opt, desc::$parse, $desc) ),* ];
299 pub(super) fn $opt(cg: &mut super::$struct_name, v: Option<&str>) -> bool {
300 super::parse::$parse(&mut redirect_field!(cg.$opt), v)
307 // Sometimes different options need to build a common structure.
308 // That structure can be kept in one of the options' fields, the others become dummy.
309 macro_rules! redirect_field {
310 ($cg:ident.link_arg) => {
313 ($cg:ident.pre_link_arg) => {
316 ($cg:ident.$field:ident) => {
321 type OptionSetter<O> = fn(&mut O, v: Option<&str>) -> bool;
322 type OptionDescrs<O> = &'static [(&'static str, OptionSetter<O>, &'static str, &'static str)];
324 fn build_options<O: Default>(
325 matches: &getopts::Matches,
326 descrs: OptionDescrs<O>,
329 error_format: ErrorOutputType,
331 let mut op = O::default();
332 for option in matches.opt_strs(prefix) {
333 let (key, value) = match option.split_once('=') {
334 None => (option, None),
335 Some((k, v)) => (k.to_string(), Some(v)),
338 let option_to_lookup = key.replace('-', "_");
339 match descrs.iter().find(|(name, ..)| *name == option_to_lookup) {
340 Some((_, setter, type_desc, _)) => {
341 if !setter(&mut op, value) {
346 "{0} option `{1}` requires {2} ({3} {1}=<value>)",
347 outputname, key, type_desc, prefix
350 Some(value) => early_error(
353 "incorrect value `{}` for {} option `{}` - {} was expected",
354 value, outputname, key, type_desc
360 None => early_error(error_format, &format!("unknown {} option: `{}`", outputname, key)),
366 #[allow(non_upper_case_globals)]
368 pub const parse_no_flag: &str = "no value";
369 pub const parse_bool: &str = "one of: `y`, `yes`, `on`, `n`, `no`, or `off`";
370 pub const parse_opt_bool: &str = parse_bool;
371 pub const parse_string: &str = "a string";
372 pub const parse_opt_string: &str = parse_string;
373 pub const parse_string_push: &str = parse_string;
374 pub const parse_opt_pathbuf: &str = "a path";
375 pub const parse_list: &str = "a space-separated list of strings";
376 pub const parse_opt_comma_list: &str = "a comma-separated list of strings";
377 pub const parse_number: &str = "a number";
378 pub const parse_opt_number: &str = parse_number;
379 pub const parse_threads: &str = parse_number;
380 pub const parse_passes: &str = "a space-separated list of passes, or `all`";
381 pub const parse_panic_strategy: &str = "either `unwind` or `abort`";
382 pub const parse_opt_panic_strategy: &str = parse_panic_strategy;
383 pub const parse_relro_level: &str = "one of: `full`, `partial`, or `off`";
384 pub const parse_sanitizers: &str = "comma separated list of sanitizers: `address`, `cfi`, `hwaddress`, `leak`, `memory` or `thread`";
385 pub const parse_sanitizer_memory_track_origins: &str = "0, 1, or 2";
386 pub const parse_cfguard: &str =
387 "either a boolean (`yes`, `no`, `on`, `off`, etc), `checks`, or `nochecks`";
388 pub const parse_strip: &str = "either `none`, `debuginfo`, or `symbols`";
389 pub const parse_linker_flavor: &str = ::rustc_target::spec::LinkerFlavor::one_of();
390 pub const parse_optimization_fuel: &str = "crate=integer";
391 pub const parse_mir_spanview: &str = "`statement` (default), `terminator`, or `block`";
392 pub const parse_instrument_coverage: &str =
393 "`all` (default), `except-unused-generics`, `except-unused-functions`, or `off`";
394 pub const parse_unpretty: &str = "`string` or `string=string`";
395 pub const parse_treat_err_as_bug: &str = "either no value or a number bigger than 0";
396 pub const parse_lto: &str =
397 "either a boolean (`yes`, `no`, `on`, `off`, etc), `thin`, `fat`, or omitted";
398 pub const parse_linker_plugin_lto: &str =
399 "either a boolean (`yes`, `no`, `on`, `off`, etc), or the path to the linker plugin";
400 pub const parse_location_detail: &str =
401 "comma seperated list of location details to track: `file`, `line`, or `column`";
402 pub const parse_switch_with_opt_path: &str =
403 "an optional path to the profiling data output directory";
404 pub const parse_merge_functions: &str = "one of: `disabled`, `trampolines`, or `aliases`";
405 pub const parse_symbol_mangling_version: &str = "either `legacy` or `v0` (RFC 2603)";
406 pub const parse_src_file_hash: &str = "either `md5` or `sha1`";
407 pub const parse_relocation_model: &str =
408 "one of supported relocation models (`rustc --print relocation-models`)";
409 pub const parse_code_model: &str = "one of supported code models (`rustc --print code-models`)";
410 pub const parse_tls_model: &str = "one of supported TLS models (`rustc --print tls-models`)";
411 pub const parse_target_feature: &str = parse_string;
412 pub const parse_wasi_exec_model: &str = "either `command` or `reactor`";
413 pub const parse_split_debuginfo: &str =
414 "one of supported split-debuginfo modes (`off`, `packed`, or `unpacked`)";
415 pub const parse_split_dwarf_kind: &str =
416 "one of supported split dwarf modes (`split` or `single`)";
417 pub const parse_gcc_ld: &str = "one of: no value, `lld`";
418 pub const parse_stack_protector: &str =
419 "one of (`none` (default), `basic`, `strong`, or `all`)";
420 pub const parse_branch_protection: &str =
421 "a `,` separated combination of `bti`, `b-key`, `pac-ret`, or `leaf`";
426 use std::str::FromStr;
428 /// This is for boolean options that don't take a value and start with
429 /// `no-`. This style of option is deprecated.
430 crate fn parse_no_flag(slot: &mut bool, v: Option<&str>) -> bool {
440 /// Use this for any boolean option that has a static default.
441 crate fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
443 Some("y") | Some("yes") | Some("on") | None => {
447 Some("n") | Some("no") | Some("off") => {
455 /// Use this for any boolean option that lacks a static default. (The
456 /// actions taken when such an option is not specified will depend on
457 /// other factors, such as other options, or target options.)
458 crate fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
460 Some("y") | Some("yes") | Some("on") | None => {
464 Some("n") | Some("no") | Some("off") => {
472 /// Use this for any string option that has a static default.
473 crate fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
476 *slot = s.to_string();
483 /// Use this for any string option that lacks a static default.
484 crate fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
487 *slot = Some(s.to_string());
494 crate fn parse_opt_pathbuf(slot: &mut Option<PathBuf>, v: Option<&str>) -> bool {
497 *slot = Some(PathBuf::from(s));
504 crate fn parse_string_push(slot: &mut Vec<String>, v: Option<&str>) -> bool {
507 slot.push(s.to_string());
514 crate fn parse_list(slot: &mut Vec<String>, v: Option<&str>) -> bool {
517 slot.extend(s.split_whitespace().map(|s| s.to_string()));
524 crate fn parse_location_detail(ld: &mut LocationDetail, v: Option<&str>) -> bool {
529 for s in v.split(',') {
531 "file" => ld.file = true,
532 "line" => ld.line = true,
533 "column" => ld.column = true,
543 crate fn parse_opt_comma_list(slot: &mut Option<Vec<String>>, v: Option<&str>) -> bool {
546 let mut v: Vec<_> = s.split(',').map(|s| s.to_string()).collect();
555 crate fn parse_threads(slot: &mut usize, v: Option<&str>) -> bool {
556 match v.and_then(|s| s.parse().ok()) {
558 *slot = ::num_cpus::get();
569 /// Use this for any numeric option that has a static default.
570 crate fn parse_number<T: Copy + FromStr>(slot: &mut T, v: Option<&str>) -> bool {
571 match v.and_then(|s| s.parse().ok()) {
580 /// Use this for any numeric option that lacks a static default.
581 crate fn parse_opt_number<T: Copy + FromStr>(slot: &mut Option<T>, v: Option<&str>) -> bool {
584 *slot = s.parse().ok();
591 crate fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
598 let mut passes = vec![];
599 if parse_list(&mut passes, v) {
609 crate fn parse_opt_panic_strategy(slot: &mut Option<PanicStrategy>, v: Option<&str>) -> bool {
611 Some("unwind") => *slot = Some(PanicStrategy::Unwind),
612 Some("abort") => *slot = Some(PanicStrategy::Abort),
618 crate fn parse_panic_strategy(slot: &mut PanicStrategy, v: Option<&str>) -> bool {
620 Some("unwind") => *slot = PanicStrategy::Unwind,
621 Some("abort") => *slot = PanicStrategy::Abort,
627 crate fn parse_relro_level(slot: &mut Option<RelroLevel>, v: Option<&str>) -> bool {
629 Some(s) => match s.parse::<RelroLevel>() {
630 Ok(level) => *slot = Some(level),
638 crate fn parse_sanitizers(slot: &mut SanitizerSet, v: Option<&str>) -> bool {
640 for s in v.split(',') {
642 "address" => SanitizerSet::ADDRESS,
643 "cfi" => SanitizerSet::CFI,
644 "leak" => SanitizerSet::LEAK,
645 "memory" => SanitizerSet::MEMORY,
646 "thread" => SanitizerSet::THREAD,
647 "hwaddress" => SanitizerSet::HWADDRESS,
657 crate fn parse_sanitizer_memory_track_origins(slot: &mut usize, v: Option<&str>) -> bool {
659 Some("2") | None => {
675 crate fn parse_strip(slot: &mut Strip, v: Option<&str>) -> bool {
677 Some("none") => *slot = Strip::None,
678 Some("debuginfo") => *slot = Strip::Debuginfo,
679 Some("symbols") => *slot = Strip::Symbols,
685 crate fn parse_cfguard(slot: &mut CFGuard, v: Option<&str>) -> bool {
687 let mut bool_arg = None;
688 if parse_opt_bool(&mut bool_arg, v) {
689 *slot = if bool_arg.unwrap() { CFGuard::Checks } else { CFGuard::Disabled };
695 None => CFGuard::Checks,
696 Some("checks") => CFGuard::Checks,
697 Some("nochecks") => CFGuard::NoChecks,
698 Some(_) => return false,
703 crate fn parse_linker_flavor(slot: &mut Option<LinkerFlavor>, v: Option<&str>) -> bool {
704 match v.and_then(LinkerFlavor::from_str) {
705 Some(lf) => *slot = Some(lf),
711 crate fn parse_optimization_fuel(slot: &mut Option<(String, u64)>, v: Option<&str>) -> bool {
715 let parts = s.split('=').collect::<Vec<_>>();
716 if parts.len() != 2 {
719 let crate_name = parts[0].to_string();
720 let fuel = parts[1].parse::<u64>();
724 *slot = Some((crate_name, fuel.unwrap()));
730 crate fn parse_unpretty(slot: &mut Option<String>, v: Option<&str>) -> bool {
733 Some(s) if s.split('=').count() <= 2 => {
734 *slot = Some(s.to_string());
741 crate fn parse_mir_spanview(slot: &mut Option<MirSpanview>, v: Option<&str>) -> bool {
743 let mut bool_arg = None;
744 if parse_opt_bool(&mut bool_arg, v) {
745 *slot = if bool_arg.unwrap() { Some(MirSpanview::Statement) } else { None };
752 *slot = Some(MirSpanview::Statement);
758 *slot = Some(match v.trim_end_matches('s') {
759 "statement" | "stmt" => MirSpanview::Statement,
760 "terminator" | "term" => MirSpanview::Terminator,
761 "block" | "basicblock" => MirSpanview::Block,
767 crate fn parse_instrument_coverage(
768 slot: &mut Option<InstrumentCoverage>,
772 let mut bool_arg = None;
773 if parse_opt_bool(&mut bool_arg, v) {
774 *slot = if bool_arg.unwrap() { Some(InstrumentCoverage::All) } else { None };
781 *slot = Some(InstrumentCoverage::All);
787 *slot = Some(match v {
788 "all" => InstrumentCoverage::All,
789 "except-unused-generics" | "except_unused_generics" => {
790 InstrumentCoverage::ExceptUnusedGenerics
792 "except-unused-functions" | "except_unused_functions" => {
793 InstrumentCoverage::ExceptUnusedFunctions
795 "off" | "no" | "n" | "false" | "0" => InstrumentCoverage::Off,
801 crate fn parse_treat_err_as_bug(slot: &mut Option<NonZeroUsize>, v: Option<&str>) -> bool {
804 *slot = s.parse().ok();
808 *slot = NonZeroUsize::new(1);
814 crate fn parse_lto(slot: &mut LtoCli, v: Option<&str>) -> bool {
816 let mut bool_arg = None;
817 if parse_opt_bool(&mut bool_arg, v) {
818 *slot = if bool_arg.unwrap() { LtoCli::Yes } else { LtoCli::No };
824 None => LtoCli::NoParam,
825 Some("thin") => LtoCli::Thin,
826 Some("fat") => LtoCli::Fat,
827 Some(_) => return false,
832 crate fn parse_linker_plugin_lto(slot: &mut LinkerPluginLto, v: Option<&str>) -> bool {
834 let mut bool_arg = None;
835 if parse_opt_bool(&mut bool_arg, v) {
836 *slot = if bool_arg.unwrap() {
837 LinkerPluginLto::LinkerPluginAuto
839 LinkerPluginLto::Disabled
846 None => LinkerPluginLto::LinkerPluginAuto,
847 Some(path) => LinkerPluginLto::LinkerPlugin(PathBuf::from(path)),
852 crate fn parse_switch_with_opt_path(slot: &mut SwitchWithOptPath, v: Option<&str>) -> bool {
854 None => SwitchWithOptPath::Enabled(None),
855 Some(path) => SwitchWithOptPath::Enabled(Some(PathBuf::from(path))),
860 crate fn parse_merge_functions(slot: &mut Option<MergeFunctions>, v: Option<&str>) -> bool {
861 match v.and_then(|s| MergeFunctions::from_str(s).ok()) {
862 Some(mergefunc) => *slot = Some(mergefunc),
868 crate fn parse_relocation_model(slot: &mut Option<RelocModel>, v: Option<&str>) -> bool {
869 match v.and_then(|s| RelocModel::from_str(s).ok()) {
870 Some(relocation_model) => *slot = Some(relocation_model),
871 None if v == Some("default") => *slot = None,
877 crate fn parse_code_model(slot: &mut Option<CodeModel>, v: Option<&str>) -> bool {
878 match v.and_then(|s| CodeModel::from_str(s).ok()) {
879 Some(code_model) => *slot = Some(code_model),
885 crate fn parse_tls_model(slot: &mut Option<TlsModel>, v: Option<&str>) -> bool {
886 match v.and_then(|s| TlsModel::from_str(s).ok()) {
887 Some(tls_model) => *slot = Some(tls_model),
893 crate fn parse_symbol_mangling_version(
894 slot: &mut Option<SymbolManglingVersion>,
898 Some("legacy") => Some(SymbolManglingVersion::Legacy),
899 Some("v0") => Some(SymbolManglingVersion::V0),
905 crate fn parse_src_file_hash(
906 slot: &mut Option<SourceFileHashAlgorithm>,
909 match v.and_then(|s| SourceFileHashAlgorithm::from_str(s).ok()) {
910 Some(hash_kind) => *slot = Some(hash_kind),
916 crate fn parse_target_feature(slot: &mut String, v: Option<&str>) -> bool {
919 if !slot.is_empty() {
929 crate fn parse_wasi_exec_model(slot: &mut Option<WasiExecModel>, v: Option<&str>) -> bool {
931 Some("command") => *slot = Some(WasiExecModel::Command),
932 Some("reactor") => *slot = Some(WasiExecModel::Reactor),
938 crate fn parse_split_debuginfo(slot: &mut Option<SplitDebuginfo>, v: Option<&str>) -> bool {
939 match v.and_then(|s| SplitDebuginfo::from_str(s).ok()) {
940 Some(e) => *slot = Some(e),
946 crate fn parse_split_dwarf_kind(slot: &mut SplitDwarfKind, v: Option<&str>) -> bool {
947 match v.and_then(|s| SplitDwarfKind::from_str(s).ok()) {
948 Some(e) => *slot = e,
954 crate fn parse_gcc_ld(slot: &mut Option<LdImpl>, v: Option<&str>) -> bool {
956 None => *slot = None,
957 Some("lld") => *slot = Some(LdImpl::Lld),
963 crate fn parse_stack_protector(slot: &mut StackProtector, v: Option<&str>) -> bool {
964 match v.and_then(|s| StackProtector::from_str(s).ok()) {
965 Some(ssp) => *slot = ssp,
971 crate fn parse_branch_protection(slot: &mut BranchProtection, v: Option<&str>) -> bool {
974 for opt in s.split(',') {
976 "bti" => slot.bti = true,
977 "pac-ret" if slot.pac_ret.is_none() => {
978 slot.pac_ret = Some(PacRet { leaf: false, key: PAuthKey::A })
980 "leaf" => match slot.pac_ret.as_mut() {
981 Some(pac) => pac.leaf = true,
984 "b-key" => match slot.pac_ret.as_mut() {
985 Some(pac) => pac.key = PAuthKey::B,
999 CodegenOptions, CG_OPTIONS, cgopts, "C", "codegen",
1001 // This list is in alphabetical order.
1003 // If you add a new option, please update:
1004 // - compiler/rustc_interface/src/tests.rs
1005 // - src/doc/rustc/src/codegen-options/index.md
1007 ar: String = (String::new(), parse_string, [UNTRACKED],
1008 "this option is deprecated and does nothing"),
1009 code_model: Option<CodeModel> = (None, parse_code_model, [TRACKED],
1010 "choose the code model to use (`rustc --print code-models` for details)"),
1011 codegen_units: Option<usize> = (None, parse_opt_number, [UNTRACKED],
1012 "divide crate into N units to optimize in parallel"),
1013 control_flow_guard: CFGuard = (CFGuard::Disabled, parse_cfguard, [TRACKED],
1014 "use Windows Control Flow Guard (default: no)"),
1015 debug_assertions: Option<bool> = (None, parse_opt_bool, [TRACKED],
1016 "explicitly enable the `cfg(debug_assertions)` directive"),
1017 debuginfo: usize = (0, parse_number, [TRACKED],
1018 "debug info emission level (0 = no debug info, 1 = line tables only, \
1019 2 = full debug info with variable and type information; default: 0)"),
1020 default_linker_libraries: bool = (false, parse_bool, [UNTRACKED],
1021 "allow the linker to link its default libraries (default: no)"),
1022 embed_bitcode: bool = (true, parse_bool, [TRACKED],
1023 "emit bitcode in rlibs (default: yes)"),
1024 extra_filename: String = (String::new(), parse_string, [UNTRACKED],
1025 "extra data to put in each output filename"),
1026 force_frame_pointers: Option<bool> = (None, parse_opt_bool, [TRACKED],
1027 "force use of the frame pointers"),
1028 force_unwind_tables: Option<bool> = (None, parse_opt_bool, [TRACKED],
1029 "force use of unwind tables"),
1030 incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
1031 "enable incremental compilation"),
1032 inline_threshold: Option<u32> = (None, parse_opt_number, [TRACKED],
1033 "set the threshold for inlining a function"),
1034 link_arg: (/* redirected to link_args */) = ((), parse_string_push, [UNTRACKED],
1035 "a single extra argument to append to the linker invocation (can be used several times)"),
1036 link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
1037 "extra arguments to append to the linker invocation (space separated)"),
1038 link_dead_code: Option<bool> = (None, parse_opt_bool, [TRACKED],
1039 "keep dead code at link time (useful for code coverage) (default: no)"),
1040 link_self_contained: Option<bool> = (None, parse_opt_bool, [UNTRACKED],
1041 "control whether to link Rust provided C objects/libraries or rely
1042 on C toolchain installed in the system"),
1043 linker: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1044 "system linker to link outputs with"),
1045 linker_flavor: Option<LinkerFlavor> = (None, parse_linker_flavor, [UNTRACKED],
1047 linker_plugin_lto: LinkerPluginLto = (LinkerPluginLto::Disabled,
1048 parse_linker_plugin_lto, [TRACKED],
1049 "generate build artifacts that are compatible with linker-based LTO"),
1050 llvm_args: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1051 "a list of arguments to pass to LLVM (space separated)"),
1052 lto: LtoCli = (LtoCli::Unspecified, parse_lto, [TRACKED],
1053 "perform LLVM link-time optimizations"),
1054 metadata: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1055 "metadata to mangle symbol names with"),
1056 no_prepopulate_passes: bool = (false, parse_no_flag, [TRACKED],
1057 "give an empty list of passes to the pass manager"),
1058 no_redzone: Option<bool> = (None, parse_opt_bool, [TRACKED],
1059 "disable the use of the redzone"),
1060 no_stack_check: bool = (false, parse_no_flag, [UNTRACKED],
1061 "this option is deprecated and does nothing"),
1062 no_vectorize_loops: bool = (false, parse_no_flag, [TRACKED],
1063 "disable loop vectorization optimization passes"),
1064 no_vectorize_slp: bool = (false, parse_no_flag, [TRACKED],
1065 "disable LLVM's SLP vectorization pass"),
1066 opt_level: String = ("0".to_string(), parse_string, [TRACKED],
1067 "optimization level (0-3, s, or z; default: 0)"),
1068 overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1069 "use overflow checks for integer arithmetic"),
1070 panic: Option<PanicStrategy> = (None, parse_opt_panic_strategy, [TRACKED],
1071 "panic strategy to compile crate with"),
1072 passes: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1073 "a list of extra LLVM passes to run (space separated)"),
1074 prefer_dynamic: bool = (false, parse_bool, [TRACKED],
1075 "prefer dynamic linking to static linking (default: no)"),
1076 profile_generate: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1077 parse_switch_with_opt_path, [TRACKED],
1078 "compile the program with profiling instrumentation"),
1079 profile_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1080 "use the given `.profdata` file for profile-guided optimization"),
1081 relocation_model: Option<RelocModel> = (None, parse_relocation_model, [TRACKED],
1082 "control generation of position-independent code (PIC) \
1083 (`rustc --print relocation-models` for details)"),
1084 remark: Passes = (Passes::Some(Vec::new()), parse_passes, [UNTRACKED],
1085 "print remarks for these optimization passes (space separated, or \"all\")"),
1086 rpath: bool = (false, parse_bool, [UNTRACKED],
1087 "set rpath values in libs/exes (default: no)"),
1088 save_temps: bool = (false, parse_bool, [UNTRACKED],
1089 "save all temporary output files during compilation (default: no)"),
1090 soft_float: bool = (false, parse_bool, [TRACKED],
1091 "use soft float ABI (*eabihf targets only) (default: no)"),
1092 split_debuginfo: Option<SplitDebuginfo> = (None, parse_split_debuginfo, [TRACKED],
1093 "how to handle split-debuginfo, a platform-specific option"),
1094 strip: Strip = (Strip::None, parse_strip, [UNTRACKED],
1095 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1096 symbol_mangling_version: Option<SymbolManglingVersion> = (None,
1097 parse_symbol_mangling_version, [TRACKED],
1098 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1099 target_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1100 "select target processor (`rustc --print target-cpus` for details)"),
1101 target_feature: String = (String::new(), parse_target_feature, [TRACKED],
1102 "target specific attributes. (`rustc --print target-features` for details). \
1103 This feature is unsafe."),
1105 // This list is in alphabetical order.
1107 // If you add a new option, please update:
1108 // - compiler/rustc_interface/src/tests.rs
1109 // - src/doc/rustc/src/codegen-options/index.md
1113 DebuggingOptions, DB_OPTIONS, dbopts, "Z", "debugging",
1115 // This list is in alphabetical order.
1117 // If you add a new option, please update:
1118 // - compiler/rustc_interface/src/tests.rs
1120 allow_features: Option<Vec<String>> = (None, parse_opt_comma_list, [TRACKED],
1121 "only allow the listed language features to be enabled in code (space separated)"),
1122 always_encode_mir: bool = (false, parse_bool, [TRACKED],
1123 "encode MIR of all functions into the crate metadata (default: no)"),
1124 assume_incomplete_release: bool = (false, parse_bool, [TRACKED],
1125 "make cfg(version) treat the current version as incomplete (default: no)"),
1126 asm_comments: bool = (false, parse_bool, [TRACKED],
1127 "generate comments into the assembly (may change behavior) (default: no)"),
1128 assert_incr_state: Option<String> = (None, parse_opt_string, [UNTRACKED],
1129 "assert that the incremental cache is in given state: \
1130 either `loaded` or `not-loaded`."),
1131 ast_json: bool = (false, parse_bool, [UNTRACKED],
1132 "print the AST as JSON and halt (default: no)"),
1133 ast_json_noexpand: bool = (false, parse_bool, [UNTRACKED],
1134 "print the pre-expansion AST as JSON and halt (default: no)"),
1135 binary_dep_depinfo: bool = (false, parse_bool, [TRACKED],
1136 "include artifacts (sysroot, crate dependencies) used during compilation in dep-info \
1138 borrowck: String = ("migrate".to_string(), parse_string, [UNTRACKED],
1139 "select which borrowck is used (`mir` or `migrate`) (default: `migrate`)"),
1140 branch_protection: BranchProtection = (BranchProtection::default(), parse_branch_protection, [TRACKED],
1141 "set options for branch target identification and pointer authentication on AArch64"),
1142 cgu_partitioning_strategy: Option<String> = (None, parse_opt_string, [TRACKED],
1143 "the codegen unit partitioning strategy to use"),
1144 chalk: bool = (false, parse_bool, [TRACKED],
1145 "enable the experimental Chalk-based trait solving engine"),
1146 codegen_backend: Option<String> = (None, parse_opt_string, [TRACKED],
1147 "the backend to use"),
1148 combine_cgu: bool = (false, parse_bool, [TRACKED],
1149 "combine CGUs into a single one"),
1150 crate_attr: Vec<String> = (Vec::new(), parse_string_push, [TRACKED],
1151 "inject the given attribute in the crate"),
1152 debug_info_for_profiling: bool = (false, parse_bool, [TRACKED],
1153 "emit discriminators and other data necessary for AutoFDO"),
1154 debug_macros: bool = (false, parse_bool, [TRACKED],
1155 "emit line numbers debug info inside macros (default: no)"),
1156 deduplicate_diagnostics: bool = (true, parse_bool, [UNTRACKED],
1157 "deduplicate identical diagnostics (default: yes)"),
1158 dep_info_omit_d_target: bool = (false, parse_bool, [TRACKED],
1159 "in dep-info output, omit targets for tracking dependencies of the dep-info files \
1160 themselves (default: no)"),
1161 dep_tasks: bool = (false, parse_bool, [UNTRACKED],
1162 "print tasks that execute and the color their dep node gets (requires debug build) \
1164 dont_buffer_diagnostics: bool = (false, parse_bool, [UNTRACKED],
1165 "emit diagnostics rather than buffering (breaks NLL error downgrading, sorting) \
1167 dual_proc_macros: bool = (false, parse_bool, [TRACKED],
1168 "load proc macros for both target and host, but only link to the target (default: no)"),
1169 dump_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1170 "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv) \
1172 dump_mir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1173 "dump MIR state to file.
1174 `val` is used to select which passes and functions to dump. For example:
1175 `all` matches all passes and functions,
1176 `foo` matches all passes for functions whose name contains 'foo',
1177 `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
1178 `foo | bar` all passes for function names containing 'foo' or 'bar'."),
1179 dump_mir_dataflow: bool = (false, parse_bool, [UNTRACKED],
1180 "in addition to `.mir` files, create graphviz `.dot` files with dataflow results \
1182 dump_mir_dir: String = ("mir_dump".to_string(), parse_string, [UNTRACKED],
1183 "the directory the MIR is dumped into (default: `mir_dump`)"),
1184 dump_mir_exclude_pass_number: bool = (false, parse_bool, [UNTRACKED],
1185 "exclude the pass number when dumping MIR (used in tests) (default: no)"),
1186 dump_mir_graphviz: bool = (false, parse_bool, [UNTRACKED],
1187 "in addition to `.mir` files, create graphviz `.dot` files (and with \
1188 `-Z instrument-coverage`, also create a `.dot` file for the MIR-derived \
1189 coverage graph) (default: no)"),
1190 dump_mir_spanview: Option<MirSpanview> = (None, parse_mir_spanview, [UNTRACKED],
1191 "in addition to `.mir` files, create `.html` files to view spans for \
1192 all `statement`s (including terminators), only `terminator` spans, or \
1193 computed `block` spans (one span encompassing a block's terminator and \
1194 all statements). If `-Z instrument-coverage` is also enabled, create \
1195 an additional `.html` file showing the computed coverage spans."),
1196 emit_stack_sizes: bool = (false, parse_bool, [UNTRACKED],
1197 "emit a section containing stack size metadata (default: no)"),
1198 fewer_names: Option<bool> = (None, parse_opt_bool, [TRACKED],
1199 "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR) \
1201 force_unstable_if_unmarked: bool = (false, parse_bool, [TRACKED],
1202 "force all crates to be `rustc_private` unstable (default: no)"),
1203 fuel: Option<(String, u64)> = (None, parse_optimization_fuel, [TRACKED],
1204 "set the optimization fuel quota for a crate"),
1205 function_sections: Option<bool> = (None, parse_opt_bool, [TRACKED],
1206 "whether each function should go in its own section"),
1207 future_incompat_test: bool = (false, parse_bool, [UNTRACKED],
1208 "forces all lints to be future incompatible, used for internal testing (default: no)"),
1209 gcc_ld: Option<LdImpl> = (None, parse_gcc_ld, [TRACKED], "implementation of ld used by cc"),
1210 graphviz_dark_mode: bool = (false, parse_bool, [UNTRACKED],
1211 "use dark-themed colors in graphviz output (default: no)"),
1212 graphviz_font: String = ("Courier, monospace".to_string(), parse_string, [UNTRACKED],
1213 "use the given `fontname` in graphviz output; can be overridden by setting \
1214 environment variable `RUSTC_GRAPHVIZ_FONT` (default: `Courier, monospace`)"),
1215 hir_stats: bool = (false, parse_bool, [UNTRACKED],
1216 "print some statistics about AST and HIR (default: no)"),
1217 human_readable_cgu_names: bool = (false, parse_bool, [TRACKED],
1218 "generate human-readable, predictable names for codegen units (default: no)"),
1219 identify_regions: bool = (false, parse_bool, [UNTRACKED],
1220 "display unnamed regions as `'<id>`, using a non-ident unique id (default: no)"),
1221 incremental_ignore_spans: bool = (false, parse_bool, [UNTRACKED],
1222 "ignore spans during ICH computation -- used for testing (default: no)"),
1223 incremental_info: bool = (false, parse_bool, [UNTRACKED],
1224 "print high-level information about incremental reuse (or the lack thereof) \
1226 incremental_relative_spans: bool = (false, parse_bool, [TRACKED],
1227 "hash spans relative to their parent item for incr. comp. (default: no)"),
1228 incremental_verify_ich: bool = (false, parse_bool, [UNTRACKED],
1229 "verify incr. comp. hashes of green query instances (default: no)"),
1230 inline_mir: Option<bool> = (None, parse_opt_bool, [TRACKED],
1231 "enable MIR inlining (default: no)"),
1232 inline_mir_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1233 "a default MIR inlining threshold (default: 50)"),
1234 inline_mir_hint_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1235 "inlining threshold for functions with inline hint (default: 100)"),
1236 inline_in_all_cgus: Option<bool> = (None, parse_opt_bool, [TRACKED],
1237 "control whether `#[inline]` functions are in all CGUs"),
1238 input_stats: bool = (false, parse_bool, [UNTRACKED],
1239 "gather statistics about the input (default: no)"),
1240 instrument_coverage: Option<InstrumentCoverage> = (None, parse_instrument_coverage, [TRACKED],
1241 "instrument the generated code to support LLVM source-based code coverage \
1242 reports (note, the compiler build config must include `profiler = true`); \
1243 implies `-C symbol-mangling-version=v0`. Optional values are:
1244 `=all` (implicit value)
1245 `=except-unused-generics`
1246 `=except-unused-functions`
1248 instrument_mcount: bool = (false, parse_bool, [TRACKED],
1249 "insert function instrument code for mcount-based tracing (default: no)"),
1250 keep_hygiene_data: bool = (false, parse_bool, [UNTRACKED],
1251 "keep hygiene data after analysis (default: no)"),
1252 link_native_libraries: bool = (true, parse_bool, [UNTRACKED],
1253 "link native libraries in the linker invocation (default: yes)"),
1254 link_only: bool = (false, parse_bool, [TRACKED],
1255 "link the `.rlink` file generated by `-Z no-link` (default: no)"),
1256 llvm_plugins: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1257 "a list LLVM plugins to enable (space separated)"),
1258 llvm_time_trace: bool = (false, parse_bool, [UNTRACKED],
1259 "generate JSON tracing data file from LLVM data (default: no)"),
1260 location_detail: LocationDetail = (LocationDetail::all(), parse_location_detail, [TRACKED],
1261 "comma seperated list of location details to be tracked when using caller_location \
1262 valid options are `file`, `line`, and `column` (default: all)"),
1263 ls: bool = (false, parse_bool, [UNTRACKED],
1264 "list the symbols defined by a library crate (default: no)"),
1265 macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1266 "show macro backtraces (default: no)"),
1267 merge_functions: Option<MergeFunctions> = (None, parse_merge_functions, [TRACKED],
1268 "control the operation of the MergeFunctions LLVM pass, taking \
1269 the same values as the target option of the same name"),
1270 meta_stats: bool = (false, parse_bool, [UNTRACKED],
1271 "gather metadata statistics (default: no)"),
1272 mir_emit_retag: bool = (false, parse_bool, [TRACKED],
1273 "emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0 \
1275 mir_opt_level: Option<usize> = (None, parse_opt_number, [TRACKED],
1276 "MIR optimization level (0-4; default: 1 in non optimized builds and 2 in optimized builds)"),
1277 move_size_limit: Option<usize> = (None, parse_opt_number, [TRACKED],
1278 "the size at which the `large_assignments` lint starts to be emitted"),
1279 mutable_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1280 "emit noalias metadata for mutable references (default: yes)"),
1281 new_llvm_pass_manager: Option<bool> = (None, parse_opt_bool, [TRACKED],
1282 "use new LLVM pass manager (default: no)"),
1283 nll_facts: bool = (false, parse_bool, [UNTRACKED],
1284 "dump facts from NLL analysis into side files (default: no)"),
1285 nll_facts_dir: String = ("nll-facts".to_string(), parse_string, [UNTRACKED],
1286 "the directory the NLL facts are dumped into (default: `nll-facts`)"),
1287 no_analysis: bool = (false, parse_no_flag, [UNTRACKED],
1288 "parse and expand the source, but run no analysis"),
1289 no_codegen: bool = (false, parse_no_flag, [TRACKED_NO_CRATE_HASH],
1290 "run all passes except codegen; no output"),
1291 no_generate_arange_section: bool = (false, parse_no_flag, [TRACKED],
1292 "omit DWARF address ranges that give faster lookups"),
1293 no_interleave_lints: bool = (false, parse_no_flag, [UNTRACKED],
1294 "execute lints separately; allows benchmarking individual lints"),
1295 no_leak_check: bool = (false, parse_no_flag, [UNTRACKED],
1296 "disable the 'leak check' for subtyping; unsound, but useful for tests"),
1297 no_link: bool = (false, parse_no_flag, [TRACKED],
1298 "compile without linking"),
1299 no_parallel_llvm: bool = (false, parse_no_flag, [UNTRACKED],
1300 "run LLVM in non-parallel mode (while keeping codegen-units and ThinLTO)"),
1301 no_unique_section_names: bool = (false, parse_bool, [TRACKED],
1302 "do not use unique names for text and data sections when -Z function-sections is used"),
1303 no_profiler_runtime: bool = (false, parse_no_flag, [TRACKED],
1304 "prevent automatic injection of the profiler_builtins crate"),
1305 normalize_docs: bool = (false, parse_bool, [TRACKED],
1306 "normalize associated items in rustdoc when generating documentation"),
1307 osx_rpath_install_name: bool = (false, parse_bool, [TRACKED],
1308 "pass `-install_name @rpath/...` to the macOS linker (default: no)"),
1309 panic_abort_tests: bool = (false, parse_bool, [TRACKED],
1310 "support compiling tests with panic=abort (default: no)"),
1311 panic_in_drop: PanicStrategy = (PanicStrategy::Unwind, parse_panic_strategy, [TRACKED],
1312 "panic strategy for panics in drops"),
1313 parse_only: bool = (false, parse_bool, [UNTRACKED],
1314 "parse only; do not compile, assemble, or link (default: no)"),
1315 partially_uninit_const_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1316 "allow generating const initializers with mixed init/uninit bytes, \
1317 and set the maximum total size of a const allocation for which this is allowed (default: never)"),
1318 perf_stats: bool = (false, parse_bool, [UNTRACKED],
1319 "print some performance-related statistics (default: no)"),
1320 pick_stable_methods_before_any_unstable: bool = (true, parse_bool, [TRACKED],
1321 "try to pick stable methods first before picking any unstable methods (default: yes)"),
1322 plt: Option<bool> = (None, parse_opt_bool, [TRACKED],
1323 "whether to use the PLT when calling into shared libraries;
1324 only has effect for PIC code on systems with ELF binaries
1325 (default: PLT is disabled if full relro is enabled)"),
1326 polonius: bool = (false, parse_bool, [TRACKED],
1327 "enable polonius-based borrow-checker (default: no)"),
1328 polymorphize: bool = (false, parse_bool, [TRACKED],
1329 "perform polymorphization analysis"),
1330 pre_link_arg: (/* redirected to pre_link_args */) = ((), parse_string_push, [UNTRACKED],
1331 "a single extra argument to prepend the linker invocation (can be used several times)"),
1332 pre_link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
1333 "extra arguments to prepend to the linker invocation (space separated)"),
1334 precise_enum_drop_elaboration: bool = (true, parse_bool, [TRACKED],
1335 "use a more precise version of drop elaboration for matches on enums (default: yes). \
1336 This results in better codegen, but has caused miscompilations on some tier 2 platforms. \
1337 See #77382 and #74551."),
1338 print_fuel: Option<String> = (None, parse_opt_string, [TRACKED],
1339 "make rustc print the total optimization fuel used by a crate"),
1340 print_link_args: bool = (false, parse_bool, [UNTRACKED],
1341 "print the arguments passed to the linker (default: no)"),
1342 print_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1343 "print the LLVM optimization passes being run (default: no)"),
1344 print_mono_items: Option<String> = (None, parse_opt_string, [UNTRACKED],
1345 "print the result of the monomorphization collection pass"),
1346 print_type_sizes: bool = (false, parse_bool, [UNTRACKED],
1347 "print layout information for each type encountered (default: no)"),
1348 proc_macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1349 "show backtraces for panics during proc-macro execution (default: no)"),
1350 profile: bool = (false, parse_bool, [TRACKED],
1351 "insert profiling code (default: no)"),
1352 profile_closures: bool = (false, parse_no_flag, [UNTRACKED],
1353 "profile size of closures"),
1354 profile_emit: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1355 "file path to emit profiling data at runtime when using 'profile' \
1356 (default based on relative source path)"),
1357 profiler_runtime: String = (String::from("profiler_builtins"), parse_string, [TRACKED],
1358 "name of the profiler runtime crate to automatically inject (default: `profiler_builtins`)"),
1359 profile_sample_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1360 "use the given `.prof` file for sampled profile-guided optimization (also known as AutoFDO)"),
1361 query_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1362 "enable queries of the dependency graph for regression testing (default: no)"),
1363 query_stats: bool = (false, parse_bool, [UNTRACKED],
1364 "print some statistics about the query system (default: no)"),
1365 randomize_layout: bool = (false, parse_bool, [TRACKED],
1366 "randomize the layout of types (default: no)"),
1367 layout_seed: Option<u64> = (None, parse_opt_number, [TRACKED],
1368 "seed layout randomization"),
1369 relax_elf_relocations: Option<bool> = (None, parse_opt_bool, [TRACKED],
1370 "whether ELF relocations can be relaxed"),
1371 relro_level: Option<RelroLevel> = (None, parse_relro_level, [TRACKED],
1372 "choose which RELRO level to use"),
1373 remap_cwd_prefix: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1374 "remap paths under the current working directory to this path prefix"),
1375 simulate_remapped_rust_src_base: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1376 "simulate the effect of remap-debuginfo = true at bootstrapping by remapping path \
1377 to rust's source base directory. only meant for testing purposes"),
1378 report_delayed_bugs: bool = (false, parse_bool, [TRACKED],
1379 "immediately print bugs registered with `delay_span_bug` (default: no)"),
1380 sanitizer: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
1382 sanitizer_memory_track_origins: usize = (0, parse_sanitizer_memory_track_origins, [TRACKED],
1383 "enable origins tracking in MemorySanitizer"),
1384 sanitizer_recover: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
1385 "enable recovery for selected sanitizers"),
1386 saturating_float_casts: Option<bool> = (None, parse_opt_bool, [TRACKED],
1387 "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
1388 the max/min integer respectively, and NaN is mapped to 0 (default: yes)"),
1389 save_analysis: bool = (false, parse_bool, [UNTRACKED],
1390 "write syntax and type analysis (in JSON format) information, in \
1391 addition to normal output (default: no)"),
1392 self_profile: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1393 parse_switch_with_opt_path, [UNTRACKED],
1394 "run the self profiler and output the raw event data"),
1395 /// keep this in sync with the event filter names in librustc_data_structures/profiling.rs
1396 self_profile_events: Option<Vec<String>> = (None, parse_opt_comma_list, [UNTRACKED],
1397 "specify the events recorded by the self profiler;
1398 for example: `-Z self-profile-events=default,query-keys`
1399 all options: none, all, default, generic-activity, query-provider, query-cache-hit
1400 query-blocked, incr-cache-load, incr-result-hashing, query-keys, function-args, args, llvm, artifact-sizes"),
1401 share_generics: Option<bool> = (None, parse_opt_bool, [TRACKED],
1402 "make the current crate share its generic instantiations"),
1403 show_span: Option<String> = (None, parse_opt_string, [TRACKED],
1404 "show spans for compiler debugging (expr|pat|ty)"),
1405 span_debug: bool = (false, parse_bool, [UNTRACKED],
1406 "forward proc_macro::Span's `Debug` impl to `Span`"),
1407 /// o/w tests have closure@path
1408 span_free_formats: bool = (false, parse_bool, [UNTRACKED],
1409 "exclude spans when debug-printing compiler state (default: no)"),
1410 src_hash_algorithm: Option<SourceFileHashAlgorithm> = (None, parse_src_file_hash, [TRACKED],
1411 "hash algorithm of source files in debug info (`md5`, `sha1`, or `sha256`)"),
1412 stack_protector: StackProtector = (StackProtector::None, parse_stack_protector, [TRACKED],
1413 "control stack smash protection strategy (`rustc --print stack-protector-strategies` for details)"),
1414 strip: Strip = (Strip::None, parse_strip, [UNTRACKED],
1415 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1416 split_dwarf_kind: SplitDwarfKind = (SplitDwarfKind::Split, parse_split_dwarf_kind, [UNTRACKED],
1417 "split dwarf variant (only if -Csplit-debuginfo is enabled and on relevant platform)
1420 `split`: sections which do not require relocation are written into a DWARF object (`.dwo`)
1421 file which is ignored by the linker
1422 `single`: sections which do not require relocation are written into object file but ignored
1424 split_dwarf_inlining: bool = (true, parse_bool, [UNTRACKED],
1425 "provide minimal debug info in the object/executable to facilitate online \
1426 symbolication/stack traces in the absence of .dwo/.dwp files when using Split DWARF"),
1427 symbol_mangling_version: Option<SymbolManglingVersion> = (None,
1428 parse_symbol_mangling_version, [TRACKED],
1429 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1430 teach: bool = (false, parse_bool, [TRACKED],
1431 "show extended diagnostic help (default: no)"),
1432 temps_dir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1433 "the directory the intermediate files are written to"),
1434 terminal_width: Option<usize> = (None, parse_opt_number, [UNTRACKED],
1435 "set the current terminal width"),
1436 tune_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1437 "select processor to schedule for (`rustc --print target-cpus` for details)"),
1438 thinlto: Option<bool> = (None, parse_opt_bool, [TRACKED],
1439 "enable ThinLTO when possible"),
1440 thir_unsafeck: bool = (false, parse_bool, [TRACKED],
1441 "use the THIR unsafety checker (default: no)"),
1442 /// We default to 1 here since we want to behave like
1443 /// a sequential compiler for now. This'll likely be adjusted
1444 /// in the future. Note that -Zthreads=0 is the way to get
1445 /// the num_cpus behavior.
1446 threads: usize = (1, parse_threads, [UNTRACKED],
1447 "use a thread pool with N threads"),
1448 time: bool = (false, parse_bool, [UNTRACKED],
1449 "measure time of rustc processes (default: no)"),
1450 time_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1451 "measure time of each LLVM pass (default: no)"),
1452 time_passes: bool = (false, parse_bool, [UNTRACKED],
1453 "measure time of each rustc pass (default: no)"),
1454 tls_model: Option<TlsModel> = (None, parse_tls_model, [TRACKED],
1455 "choose the TLS model to use (`rustc --print tls-models` for details)"),
1456 trace_macros: bool = (false, parse_bool, [UNTRACKED],
1457 "for every macro invocation, print its name and arguments (default: no)"),
1458 trap_unreachable: Option<bool> = (None, parse_opt_bool, [TRACKED],
1459 "generate trap instructions for unreachable intrinsics (default: use target setting, usually yes)"),
1460 treat_err_as_bug: Option<NonZeroUsize> = (None, parse_treat_err_as_bug, [TRACKED],
1461 "treat error number `val` that occurs as bug"),
1462 trim_diagnostic_paths: bool = (true, parse_bool, [UNTRACKED],
1463 "in diagnostics, use heuristics to shorten paths referring to items"),
1464 ui_testing: bool = (false, parse_bool, [UNTRACKED],
1465 "emit compiler diagnostics in a form suitable for UI testing (default: no)"),
1466 unleash_the_miri_inside_of_you: bool = (false, parse_bool, [TRACKED],
1467 "take the brakes off const evaluation. NOTE: this is unsound (default: no)"),
1468 unpretty: Option<String> = (None, parse_unpretty, [UNTRACKED],
1469 "present the input source, unstable (and less-pretty) variants;
1470 `normal`, `identified`,
1471 `expanded`, `expanded,identified`,
1472 `expanded,hygiene` (with internal representations),
1473 `everybody_loops` (all function bodies replaced with `loop {}`),
1474 `ast-tree` (raw AST before expansion),
1475 `ast-tree,expanded` (raw AST after expansion),
1476 `hir` (the HIR), `hir,identified`,
1477 `hir,typed` (HIR with types for each node),
1478 `hir-tree` (dump the raw HIR),
1479 `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)"),
1480 unsound_mir_opts: bool = (false, parse_bool, [TRACKED],
1481 "enable unsound and buggy MIR optimizations (default: no)"),
1482 unstable_options: bool = (false, parse_bool, [UNTRACKED],
1483 "adds unstable command line options to rustc interface (default: no)"),
1484 use_ctors_section: Option<bool> = (None, parse_opt_bool, [TRACKED],
1485 "use legacy .ctors section for initializers rather than .init_array"),
1486 validate_mir: bool = (false, parse_bool, [UNTRACKED],
1487 "validate MIR after each transformation"),
1488 verbose: bool = (false, parse_bool, [UNTRACKED],
1489 "in general, enable more debug printouts (default: no)"),
1490 verify_llvm_ir: bool = (false, parse_bool, [TRACKED],
1491 "verify LLVM IR (default: no)"),
1492 wasi_exec_model: Option<WasiExecModel> = (None, parse_wasi_exec_model, [TRACKED],
1493 "whether to build a wasi command or reactor"),
1495 // This list is in alphabetical order.
1497 // If you add a new option, please update:
1498 // - compiler/rustc_interface/src/tests.rs
1501 #[derive(Clone, Hash, PartialEq, Eq, Debug)]
1502 pub enum WasiExecModel {
1507 #[derive(Clone, Copy, Hash)]