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_gcc_ld: &str = "one of: no value, `lld`";
416 pub const parse_stack_protector: &str =
417 "one of (`none` (default), `basic`, `strong`, or `all`)";
422 use std::str::FromStr;
424 /// This is for boolean options that don't take a value and start with
425 /// `no-`. This style of option is deprecated.
426 crate fn parse_no_flag(slot: &mut bool, v: Option<&str>) -> bool {
436 /// Use this for any boolean option that has a static default.
437 crate fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
439 Some("y") | Some("yes") | Some("on") | None => {
443 Some("n") | Some("no") | Some("off") => {
451 /// Use this for any boolean option that lacks a static default. (The
452 /// actions taken when such an option is not specified will depend on
453 /// other factors, such as other options, or target options.)
454 crate fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
456 Some("y") | Some("yes") | Some("on") | None => {
460 Some("n") | Some("no") | Some("off") => {
468 /// Use this for any string option that has a static default.
469 crate fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
472 *slot = s.to_string();
479 /// Use this for any string option that lacks a static default.
480 crate fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
483 *slot = Some(s.to_string());
490 crate fn parse_opt_pathbuf(slot: &mut Option<PathBuf>, v: Option<&str>) -> bool {
493 *slot = Some(PathBuf::from(s));
500 crate fn parse_string_push(slot: &mut Vec<String>, v: Option<&str>) -> bool {
503 slot.push(s.to_string());
510 crate fn parse_list(slot: &mut Vec<String>, v: Option<&str>) -> bool {
513 slot.extend(s.split_whitespace().map(|s| s.to_string()));
520 crate fn parse_location_detail(ld: &mut LocationDetail, v: Option<&str>) -> bool {
525 for s in v.split(',') {
527 "file" => ld.file = true,
528 "line" => ld.line = true,
529 "column" => ld.column = true,
539 crate fn parse_opt_comma_list(slot: &mut Option<Vec<String>>, v: Option<&str>) -> bool {
542 let mut v: Vec<_> = s.split(',').map(|s| s.to_string()).collect();
551 crate fn parse_threads(slot: &mut usize, v: Option<&str>) -> bool {
552 match v.and_then(|s| s.parse().ok()) {
554 *slot = ::num_cpus::get();
565 /// Use this for any numeric option that has a static default.
566 crate fn parse_number<T: Copy + FromStr>(slot: &mut T, v: Option<&str>) -> bool {
567 match v.and_then(|s| s.parse().ok()) {
576 /// Use this for any numeric option that lacks a static default.
577 crate fn parse_opt_number<T: Copy + FromStr>(slot: &mut Option<T>, v: Option<&str>) -> bool {
580 *slot = s.parse().ok();
587 crate fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
594 let mut passes = vec![];
595 if parse_list(&mut passes, v) {
605 crate fn parse_opt_panic_strategy(slot: &mut Option<PanicStrategy>, v: Option<&str>) -> bool {
607 Some("unwind") => *slot = Some(PanicStrategy::Unwind),
608 Some("abort") => *slot = Some(PanicStrategy::Abort),
614 crate fn parse_panic_strategy(slot: &mut PanicStrategy, v: Option<&str>) -> bool {
616 Some("unwind") => *slot = PanicStrategy::Unwind,
617 Some("abort") => *slot = PanicStrategy::Abort,
623 crate fn parse_relro_level(slot: &mut Option<RelroLevel>, v: Option<&str>) -> bool {
625 Some(s) => match s.parse::<RelroLevel>() {
626 Ok(level) => *slot = Some(level),
634 crate fn parse_sanitizers(slot: &mut SanitizerSet, v: Option<&str>) -> bool {
636 for s in v.split(',') {
638 "address" => SanitizerSet::ADDRESS,
639 "cfi" => SanitizerSet::CFI,
640 "leak" => SanitizerSet::LEAK,
641 "memory" => SanitizerSet::MEMORY,
642 "thread" => SanitizerSet::THREAD,
643 "hwaddress" => SanitizerSet::HWADDRESS,
653 crate fn parse_sanitizer_memory_track_origins(slot: &mut usize, v: Option<&str>) -> bool {
655 Some("2") | None => {
671 crate fn parse_strip(slot: &mut Strip, v: Option<&str>) -> bool {
673 Some("none") => *slot = Strip::None,
674 Some("debuginfo") => *slot = Strip::Debuginfo,
675 Some("symbols") => *slot = Strip::Symbols,
681 crate fn parse_cfguard(slot: &mut CFGuard, v: Option<&str>) -> bool {
683 let mut bool_arg = None;
684 if parse_opt_bool(&mut bool_arg, v) {
685 *slot = if bool_arg.unwrap() { CFGuard::Checks } else { CFGuard::Disabled };
691 None => CFGuard::Checks,
692 Some("checks") => CFGuard::Checks,
693 Some("nochecks") => CFGuard::NoChecks,
694 Some(_) => return false,
699 crate fn parse_linker_flavor(slot: &mut Option<LinkerFlavor>, v: Option<&str>) -> bool {
700 match v.and_then(LinkerFlavor::from_str) {
701 Some(lf) => *slot = Some(lf),
707 crate fn parse_optimization_fuel(slot: &mut Option<(String, u64)>, v: Option<&str>) -> bool {
711 let parts = s.split('=').collect::<Vec<_>>();
712 if parts.len() != 2 {
715 let crate_name = parts[0].to_string();
716 let fuel = parts[1].parse::<u64>();
720 *slot = Some((crate_name, fuel.unwrap()));
726 crate fn parse_unpretty(slot: &mut Option<String>, v: Option<&str>) -> bool {
729 Some(s) if s.split('=').count() <= 2 => {
730 *slot = Some(s.to_string());
737 crate fn parse_mir_spanview(slot: &mut Option<MirSpanview>, v: Option<&str>) -> bool {
739 let mut bool_arg = None;
740 if parse_opt_bool(&mut bool_arg, v) {
741 *slot = if bool_arg.unwrap() { Some(MirSpanview::Statement) } else { None };
748 *slot = Some(MirSpanview::Statement);
754 *slot = Some(match v.trim_end_matches('s') {
755 "statement" | "stmt" => MirSpanview::Statement,
756 "terminator" | "term" => MirSpanview::Terminator,
757 "block" | "basicblock" => MirSpanview::Block,
763 crate fn parse_instrument_coverage(
764 slot: &mut Option<InstrumentCoverage>,
768 let mut bool_arg = None;
769 if parse_opt_bool(&mut bool_arg, v) {
770 *slot = if bool_arg.unwrap() { Some(InstrumentCoverage::All) } else { None };
777 *slot = Some(InstrumentCoverage::All);
783 *slot = Some(match v {
784 "all" => InstrumentCoverage::All,
785 "except-unused-generics" | "except_unused_generics" => {
786 InstrumentCoverage::ExceptUnusedGenerics
788 "except-unused-functions" | "except_unused_functions" => {
789 InstrumentCoverage::ExceptUnusedFunctions
791 "off" | "no" | "n" | "false" | "0" => InstrumentCoverage::Off,
797 crate fn parse_treat_err_as_bug(slot: &mut Option<NonZeroUsize>, v: Option<&str>) -> bool {
800 *slot = s.parse().ok();
804 *slot = NonZeroUsize::new(1);
810 crate fn parse_lto(slot: &mut LtoCli, v: Option<&str>) -> bool {
812 let mut bool_arg = None;
813 if parse_opt_bool(&mut bool_arg, v) {
814 *slot = if bool_arg.unwrap() { LtoCli::Yes } else { LtoCli::No };
820 None => LtoCli::NoParam,
821 Some("thin") => LtoCli::Thin,
822 Some("fat") => LtoCli::Fat,
823 Some(_) => return false,
828 crate fn parse_linker_plugin_lto(slot: &mut LinkerPluginLto, v: Option<&str>) -> bool {
830 let mut bool_arg = None;
831 if parse_opt_bool(&mut bool_arg, v) {
832 *slot = if bool_arg.unwrap() {
833 LinkerPluginLto::LinkerPluginAuto
835 LinkerPluginLto::Disabled
842 None => LinkerPluginLto::LinkerPluginAuto,
843 Some(path) => LinkerPluginLto::LinkerPlugin(PathBuf::from(path)),
848 crate fn parse_switch_with_opt_path(slot: &mut SwitchWithOptPath, v: Option<&str>) -> bool {
850 None => SwitchWithOptPath::Enabled(None),
851 Some(path) => SwitchWithOptPath::Enabled(Some(PathBuf::from(path))),
856 crate fn parse_merge_functions(slot: &mut Option<MergeFunctions>, v: Option<&str>) -> bool {
857 match v.and_then(|s| MergeFunctions::from_str(s).ok()) {
858 Some(mergefunc) => *slot = Some(mergefunc),
864 crate fn parse_relocation_model(slot: &mut Option<RelocModel>, v: Option<&str>) -> bool {
865 match v.and_then(|s| RelocModel::from_str(s).ok()) {
866 Some(relocation_model) => *slot = Some(relocation_model),
867 None if v == Some("default") => *slot = None,
873 crate fn parse_code_model(slot: &mut Option<CodeModel>, v: Option<&str>) -> bool {
874 match v.and_then(|s| CodeModel::from_str(s).ok()) {
875 Some(code_model) => *slot = Some(code_model),
881 crate fn parse_tls_model(slot: &mut Option<TlsModel>, v: Option<&str>) -> bool {
882 match v.and_then(|s| TlsModel::from_str(s).ok()) {
883 Some(tls_model) => *slot = Some(tls_model),
889 crate fn parse_symbol_mangling_version(
890 slot: &mut Option<SymbolManglingVersion>,
894 Some("legacy") => Some(SymbolManglingVersion::Legacy),
895 Some("v0") => Some(SymbolManglingVersion::V0),
901 crate fn parse_src_file_hash(
902 slot: &mut Option<SourceFileHashAlgorithm>,
905 match v.and_then(|s| SourceFileHashAlgorithm::from_str(s).ok()) {
906 Some(hash_kind) => *slot = Some(hash_kind),
912 crate fn parse_target_feature(slot: &mut String, v: Option<&str>) -> bool {
915 if !slot.is_empty() {
925 crate fn parse_wasi_exec_model(slot: &mut Option<WasiExecModel>, v: Option<&str>) -> bool {
927 Some("command") => *slot = Some(WasiExecModel::Command),
928 Some("reactor") => *slot = Some(WasiExecModel::Reactor),
934 crate fn parse_split_debuginfo(slot: &mut Option<SplitDebuginfo>, v: Option<&str>) -> bool {
935 match v.and_then(|s| SplitDebuginfo::from_str(s).ok()) {
936 Some(e) => *slot = Some(e),
942 crate fn parse_gcc_ld(slot: &mut Option<LdImpl>, v: Option<&str>) -> bool {
944 None => *slot = None,
945 Some("lld") => *slot = Some(LdImpl::Lld),
951 crate fn parse_stack_protector(slot: &mut StackProtector, v: Option<&str>) -> bool {
952 match v.and_then(|s| StackProtector::from_str(s).ok()) {
953 Some(ssp) => *slot = ssp,
961 CodegenOptions, CG_OPTIONS, cgopts, "C", "codegen",
963 // This list is in alphabetical order.
965 // If you add a new option, please update:
966 // - compiler/rustc_interface/src/tests.rs
967 // - src/doc/rustc/src/codegen-options/index.md
969 ar: String = (String::new(), parse_string, [UNTRACKED],
970 "this option is deprecated and does nothing"),
971 code_model: Option<CodeModel> = (None, parse_code_model, [TRACKED],
972 "choose the code model to use (`rustc --print code-models` for details)"),
973 codegen_units: Option<usize> = (None, parse_opt_number, [UNTRACKED],
974 "divide crate into N units to optimize in parallel"),
975 control_flow_guard: CFGuard = (CFGuard::Disabled, parse_cfguard, [TRACKED],
976 "use Windows Control Flow Guard (default: no)"),
977 debug_assertions: Option<bool> = (None, parse_opt_bool, [TRACKED],
978 "explicitly enable the `cfg(debug_assertions)` directive"),
979 debuginfo: usize = (0, parse_number, [TRACKED],
980 "debug info emission level (0 = no debug info, 1 = line tables only, \
981 2 = full debug info with variable and type information; default: 0)"),
982 default_linker_libraries: bool = (false, parse_bool, [UNTRACKED],
983 "allow the linker to link its default libraries (default: no)"),
984 embed_bitcode: bool = (true, parse_bool, [TRACKED],
985 "emit bitcode in rlibs (default: yes)"),
986 extra_filename: String = (String::new(), parse_string, [UNTRACKED],
987 "extra data to put in each output filename"),
988 force_frame_pointers: Option<bool> = (None, parse_opt_bool, [TRACKED],
989 "force use of the frame pointers"),
990 force_unwind_tables: Option<bool> = (None, parse_opt_bool, [TRACKED],
991 "force use of unwind tables"),
992 incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
993 "enable incremental compilation"),
994 inline_threshold: Option<u32> = (None, parse_opt_number, [TRACKED],
995 "set the threshold for inlining a function"),
996 link_arg: (/* redirected to link_args */) = ((), parse_string_push, [UNTRACKED],
997 "a single extra argument to append to the linker invocation (can be used several times)"),
998 link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
999 "extra arguments to append to the linker invocation (space separated)"),
1000 link_dead_code: Option<bool> = (None, parse_opt_bool, [TRACKED],
1001 "keep dead code at link time (useful for code coverage) (default: no)"),
1002 link_self_contained: Option<bool> = (None, parse_opt_bool, [UNTRACKED],
1003 "control whether to link Rust provided C objects/libraries or rely
1004 on C toolchain installed in the system"),
1005 linker: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1006 "system linker to link outputs with"),
1007 linker_flavor: Option<LinkerFlavor> = (None, parse_linker_flavor, [UNTRACKED],
1009 linker_plugin_lto: LinkerPluginLto = (LinkerPluginLto::Disabled,
1010 parse_linker_plugin_lto, [TRACKED],
1011 "generate build artifacts that are compatible with linker-based LTO"),
1012 llvm_args: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1013 "a list of arguments to pass to LLVM (space separated)"),
1014 lto: LtoCli = (LtoCli::Unspecified, parse_lto, [TRACKED],
1015 "perform LLVM link-time optimizations"),
1016 metadata: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1017 "metadata to mangle symbol names with"),
1018 no_prepopulate_passes: bool = (false, parse_no_flag, [TRACKED],
1019 "give an empty list of passes to the pass manager"),
1020 no_redzone: Option<bool> = (None, parse_opt_bool, [TRACKED],
1021 "disable the use of the redzone"),
1022 no_stack_check: bool = (false, parse_no_flag, [UNTRACKED],
1023 "this option is deprecated and does nothing"),
1024 no_vectorize_loops: bool = (false, parse_no_flag, [TRACKED],
1025 "disable loop vectorization optimization passes"),
1026 no_vectorize_slp: bool = (false, parse_no_flag, [TRACKED],
1027 "disable LLVM's SLP vectorization pass"),
1028 opt_level: String = ("0".to_string(), parse_string, [TRACKED],
1029 "optimization level (0-3, s, or z; default: 0)"),
1030 overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1031 "use overflow checks for integer arithmetic"),
1032 panic: Option<PanicStrategy> = (None, parse_opt_panic_strategy, [TRACKED],
1033 "panic strategy to compile crate with"),
1034 passes: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1035 "a list of extra LLVM passes to run (space separated)"),
1036 prefer_dynamic: bool = (false, parse_bool, [TRACKED],
1037 "prefer dynamic linking to static linking (default: no)"),
1038 profile_generate: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1039 parse_switch_with_opt_path, [TRACKED],
1040 "compile the program with profiling instrumentation"),
1041 profile_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1042 "use the given `.profdata` file for profile-guided optimization"),
1043 relocation_model: Option<RelocModel> = (None, parse_relocation_model, [TRACKED],
1044 "control generation of position-independent code (PIC) \
1045 (`rustc --print relocation-models` for details)"),
1046 remark: Passes = (Passes::Some(Vec::new()), parse_passes, [UNTRACKED],
1047 "print remarks for these optimization passes (space separated, or \"all\")"),
1048 rpath: bool = (false, parse_bool, [UNTRACKED],
1049 "set rpath values in libs/exes (default: no)"),
1050 save_temps: bool = (false, parse_bool, [UNTRACKED],
1051 "save all temporary output files during compilation (default: no)"),
1052 soft_float: bool = (false, parse_bool, [TRACKED],
1053 "use soft float ABI (*eabihf targets only) (default: no)"),
1054 split_debuginfo: Option<SplitDebuginfo> = (None, parse_split_debuginfo, [TRACKED],
1055 "how to handle split-debuginfo, a platform-specific option"),
1056 strip: Strip = (Strip::None, parse_strip, [UNTRACKED],
1057 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1058 target_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1059 "select target processor (`rustc --print target-cpus` for details)"),
1060 target_feature: String = (String::new(), parse_target_feature, [TRACKED],
1061 "target specific attributes. (`rustc --print target-features` for details). \
1062 This feature is unsafe."),
1064 // This list is in alphabetical order.
1066 // If you add a new option, please update:
1067 // - compiler/rustc_interface/src/tests.rs
1068 // - src/doc/rustc/src/codegen-options/index.md
1072 DebuggingOptions, DB_OPTIONS, dbopts, "Z", "debugging",
1074 // This list is in alphabetical order.
1076 // If you add a new option, please update:
1077 // - compiler/rustc_interface/src/tests.rs
1079 allow_features: Option<Vec<String>> = (None, parse_opt_comma_list, [TRACKED],
1080 "only allow the listed language features to be enabled in code (space separated)"),
1081 always_encode_mir: bool = (false, parse_bool, [TRACKED],
1082 "encode MIR of all functions into the crate metadata (default: no)"),
1083 assume_incomplete_release: bool = (false, parse_bool, [TRACKED],
1084 "make cfg(version) treat the current version as incomplete (default: no)"),
1085 asm_comments: bool = (false, parse_bool, [TRACKED],
1086 "generate comments into the assembly (may change behavior) (default: no)"),
1087 assert_incr_state: Option<String> = (None, parse_opt_string, [UNTRACKED],
1088 "assert that the incremental cache is in given state: \
1089 either `loaded` or `not-loaded`."),
1090 ast_json: bool = (false, parse_bool, [UNTRACKED],
1091 "print the AST as JSON and halt (default: no)"),
1092 ast_json_noexpand: bool = (false, parse_bool, [UNTRACKED],
1093 "print the pre-expansion AST as JSON and halt (default: no)"),
1094 binary_dep_depinfo: bool = (false, parse_bool, [TRACKED],
1095 "include artifacts (sysroot, crate dependencies) used during compilation in dep-info \
1097 borrowck: String = ("migrate".to_string(), parse_string, [UNTRACKED],
1098 "select which borrowck is used (`mir` or `migrate`) (default: `migrate`)"),
1099 cgu_partitioning_strategy: Option<String> = (None, parse_opt_string, [TRACKED],
1100 "the codegen unit partitioning strategy to use"),
1101 chalk: bool = (false, parse_bool, [TRACKED],
1102 "enable the experimental Chalk-based trait solving engine"),
1103 codegen_backend: Option<String> = (None, parse_opt_string, [TRACKED],
1104 "the backend to use"),
1105 combine_cgu: bool = (false, parse_bool, [TRACKED],
1106 "combine CGUs into a single one"),
1107 crate_attr: Vec<String> = (Vec::new(), parse_string_push, [TRACKED],
1108 "inject the given attribute in the crate"),
1109 debug_info_for_profiling: bool = (false, parse_bool, [TRACKED],
1110 "emit discriminators and other data necessary for AutoFDO"),
1111 debug_macros: bool = (false, parse_bool, [TRACKED],
1112 "emit line numbers debug info inside macros (default: no)"),
1113 deduplicate_diagnostics: bool = (true, parse_bool, [UNTRACKED],
1114 "deduplicate identical diagnostics (default: yes)"),
1115 dep_info_omit_d_target: bool = (false, parse_bool, [TRACKED],
1116 "in dep-info output, omit targets for tracking dependencies of the dep-info files \
1117 themselves (default: no)"),
1118 dep_tasks: bool = (false, parse_bool, [UNTRACKED],
1119 "print tasks that execute and the color their dep node gets (requires debug build) \
1121 dont_buffer_diagnostics: bool = (false, parse_bool, [UNTRACKED],
1122 "emit diagnostics rather than buffering (breaks NLL error downgrading, sorting) \
1124 dual_proc_macros: bool = (false, parse_bool, [TRACKED],
1125 "load proc macros for both target and host, but only link to the target (default: no)"),
1126 dump_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1127 "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv) \
1129 dump_mir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1130 "dump MIR state to file.
1131 `val` is used to select which passes and functions to dump. For example:
1132 `all` matches all passes and functions,
1133 `foo` matches all passes for functions whose name contains 'foo',
1134 `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
1135 `foo | bar` all passes for function names containing 'foo' or 'bar'."),
1136 dump_mir_dataflow: bool = (false, parse_bool, [UNTRACKED],
1137 "in addition to `.mir` files, create graphviz `.dot` files with dataflow results \
1139 dump_mir_dir: String = ("mir_dump".to_string(), parse_string, [UNTRACKED],
1140 "the directory the MIR is dumped into (default: `mir_dump`)"),
1141 dump_mir_exclude_pass_number: bool = (false, parse_bool, [UNTRACKED],
1142 "exclude the pass number when dumping MIR (used in tests) (default: no)"),
1143 dump_mir_graphviz: bool = (false, parse_bool, [UNTRACKED],
1144 "in addition to `.mir` files, create graphviz `.dot` files (and with \
1145 `-Z instrument-coverage`, also create a `.dot` file for the MIR-derived \
1146 coverage graph) (default: no)"),
1147 dump_mir_spanview: Option<MirSpanview> = (None, parse_mir_spanview, [UNTRACKED],
1148 "in addition to `.mir` files, create `.html` files to view spans for \
1149 all `statement`s (including terminators), only `terminator` spans, or \
1150 computed `block` spans (one span encompassing a block's terminator and \
1151 all statements). If `-Z instrument-coverage` is also enabled, create \
1152 an additional `.html` file showing the computed coverage spans."),
1153 emit_stack_sizes: bool = (false, parse_bool, [UNTRACKED],
1154 "emit a section containing stack size metadata (default: no)"),
1155 fewer_names: Option<bool> = (None, parse_opt_bool, [TRACKED],
1156 "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR) \
1158 force_unstable_if_unmarked: bool = (false, parse_bool, [TRACKED],
1159 "force all crates to be `rustc_private` unstable (default: no)"),
1160 fuel: Option<(String, u64)> = (None, parse_optimization_fuel, [TRACKED],
1161 "set the optimization fuel quota for a crate"),
1162 function_sections: Option<bool> = (None, parse_opt_bool, [TRACKED],
1163 "whether each function should go in its own section"),
1164 future_incompat_test: bool = (false, parse_bool, [UNTRACKED],
1165 "forces all lints to be future incompatible, used for internal testing (default: no)"),
1166 gcc_ld: Option<LdImpl> = (None, parse_gcc_ld, [TRACKED], "implementation of ld used by cc"),
1167 graphviz_dark_mode: bool = (false, parse_bool, [UNTRACKED],
1168 "use dark-themed colors in graphviz output (default: no)"),
1169 graphviz_font: String = ("Courier, monospace".to_string(), parse_string, [UNTRACKED],
1170 "use the given `fontname` in graphviz output; can be overridden by setting \
1171 environment variable `RUSTC_GRAPHVIZ_FONT` (default: `Courier, monospace`)"),
1172 hir_stats: bool = (false, parse_bool, [UNTRACKED],
1173 "print some statistics about AST and HIR (default: no)"),
1174 human_readable_cgu_names: bool = (false, parse_bool, [TRACKED],
1175 "generate human-readable, predictable names for codegen units (default: no)"),
1176 identify_regions: bool = (false, parse_bool, [UNTRACKED],
1177 "display unnamed regions as `'<id>`, using a non-ident unique id (default: no)"),
1178 incremental_ignore_spans: bool = (false, parse_bool, [UNTRACKED],
1179 "ignore spans during ICH computation -- used for testing (default: no)"),
1180 incremental_info: bool = (false, parse_bool, [UNTRACKED],
1181 "print high-level information about incremental reuse (or the lack thereof) \
1183 incremental_relative_spans: bool = (false, parse_bool, [TRACKED],
1184 "hash spans relative to their parent item for incr. comp. (default: no)"),
1185 incremental_verify_ich: bool = (false, parse_bool, [UNTRACKED],
1186 "verify incr. comp. hashes of green query instances (default: no)"),
1187 inline_mir: Option<bool> = (None, parse_opt_bool, [TRACKED],
1188 "enable MIR inlining (default: no)"),
1189 inline_mir_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1190 "a default MIR inlining threshold (default: 50)"),
1191 inline_mir_hint_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1192 "inlining threshold for functions with inline hint (default: 100)"),
1193 inline_in_all_cgus: Option<bool> = (None, parse_opt_bool, [TRACKED],
1194 "control whether `#[inline]` functions are in all CGUs"),
1195 input_stats: bool = (false, parse_bool, [UNTRACKED],
1196 "gather statistics about the input (default: no)"),
1197 instrument_coverage: Option<InstrumentCoverage> = (None, parse_instrument_coverage, [TRACKED],
1198 "instrument the generated code to support LLVM source-based code coverage \
1199 reports (note, the compiler build config must include `profiler = true`); \
1200 implies `-Z symbol-mangling-version=v0`. Optional values are:
1201 `=all` (implicit value)
1202 `=except-unused-generics`
1203 `=except-unused-functions`
1205 instrument_mcount: bool = (false, parse_bool, [TRACKED],
1206 "insert function instrument code for mcount-based tracing (default: no)"),
1207 keep_hygiene_data: bool = (false, parse_bool, [UNTRACKED],
1208 "keep hygiene data after analysis (default: no)"),
1209 link_native_libraries: bool = (true, parse_bool, [UNTRACKED],
1210 "link native libraries in the linker invocation (default: yes)"),
1211 link_only: bool = (false, parse_bool, [TRACKED],
1212 "link the `.rlink` file generated by `-Z no-link` (default: no)"),
1213 llvm_plugins: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1214 "a list LLVM plugins to enable (space separated)"),
1215 llvm_time_trace: bool = (false, parse_bool, [UNTRACKED],
1216 "generate JSON tracing data file from LLVM data (default: no)"),
1217 location_detail: LocationDetail = (LocationDetail::all(), parse_location_detail, [TRACKED],
1218 "comma seperated list of location details to be tracked when using caller_location \
1219 valid options are `file`, `line`, and `column` (default: all)"),
1220 ls: bool = (false, parse_bool, [UNTRACKED],
1221 "list the symbols defined by a library crate (default: no)"),
1222 macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1223 "show macro backtraces (default: no)"),
1224 merge_functions: Option<MergeFunctions> = (None, parse_merge_functions, [TRACKED],
1225 "control the operation of the MergeFunctions LLVM pass, taking \
1226 the same values as the target option of the same name"),
1227 meta_stats: bool = (false, parse_bool, [UNTRACKED],
1228 "gather metadata statistics (default: no)"),
1229 mir_emit_retag: bool = (false, parse_bool, [TRACKED],
1230 "emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0 \
1232 mir_opt_level: Option<usize> = (None, parse_opt_number, [TRACKED],
1233 "MIR optimization level (0-4; default: 1 in non optimized builds and 2 in optimized builds)"),
1234 move_size_limit: Option<usize> = (None, parse_opt_number, [TRACKED],
1235 "the size at which the `large_assignments` lint starts to be emitted"),
1236 mutable_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1237 "emit noalias metadata for mutable references (default: yes)"),
1238 new_llvm_pass_manager: Option<bool> = (None, parse_opt_bool, [TRACKED],
1239 "use new LLVM pass manager (default: no)"),
1240 nll_facts: bool = (false, parse_bool, [UNTRACKED],
1241 "dump facts from NLL analysis into side files (default: no)"),
1242 nll_facts_dir: String = ("nll-facts".to_string(), parse_string, [UNTRACKED],
1243 "the directory the NLL facts are dumped into (default: `nll-facts`)"),
1244 no_analysis: bool = (false, parse_no_flag, [UNTRACKED],
1245 "parse and expand the source, but run no analysis"),
1246 no_codegen: bool = (false, parse_no_flag, [TRACKED_NO_CRATE_HASH],
1247 "run all passes except codegen; no output"),
1248 no_generate_arange_section: bool = (false, parse_no_flag, [TRACKED],
1249 "omit DWARF address ranges that give faster lookups"),
1250 no_interleave_lints: bool = (false, parse_no_flag, [UNTRACKED],
1251 "execute lints separately; allows benchmarking individual lints"),
1252 no_leak_check: bool = (false, parse_no_flag, [UNTRACKED],
1253 "disable the 'leak check' for subtyping; unsound, but useful for tests"),
1254 no_link: bool = (false, parse_no_flag, [TRACKED],
1255 "compile without linking"),
1256 no_parallel_llvm: bool = (false, parse_no_flag, [UNTRACKED],
1257 "run LLVM in non-parallel mode (while keeping codegen-units and ThinLTO)"),
1258 no_unique_section_names: bool = (false, parse_bool, [TRACKED],
1259 "do not use unique names for text and data sections when -Z function-sections is used"),
1260 no_profiler_runtime: bool = (false, parse_no_flag, [TRACKED],
1261 "prevent automatic injection of the profiler_builtins crate"),
1262 normalize_docs: bool = (false, parse_bool, [TRACKED],
1263 "normalize associated items in rustdoc when generating documentation"),
1264 osx_rpath_install_name: bool = (false, parse_bool, [TRACKED],
1265 "pass `-install_name @rpath/...` to the macOS linker (default: no)"),
1266 panic_abort_tests: bool = (false, parse_bool, [TRACKED],
1267 "support compiling tests with panic=abort (default: no)"),
1268 panic_in_drop: PanicStrategy = (PanicStrategy::Unwind, parse_panic_strategy, [TRACKED],
1269 "panic strategy for panics in drops"),
1270 parse_only: bool = (false, parse_bool, [UNTRACKED],
1271 "parse only; do not compile, assemble, or link (default: no)"),
1272 partially_uninit_const_threshold: Option<usize> = (None, parse_opt_number, [TRACKED],
1273 "allow generating const initializers with mixed init/uninit bytes, \
1274 and set the maximum total size of a const allocation for which this is allowed (default: never)"),
1275 perf_stats: bool = (false, parse_bool, [UNTRACKED],
1276 "print some performance-related statistics (default: no)"),
1277 pick_stable_methods_before_any_unstable: bool = (true, parse_bool, [TRACKED],
1278 "try to pick stable methods first before picking any unstable methods (default: yes)"),
1279 plt: Option<bool> = (None, parse_opt_bool, [TRACKED],
1280 "whether to use the PLT when calling into shared libraries;
1281 only has effect for PIC code on systems with ELF binaries
1282 (default: PLT is disabled if full relro is enabled)"),
1283 polonius: bool = (false, parse_bool, [TRACKED],
1284 "enable polonius-based borrow-checker (default: no)"),
1285 polymorphize: bool = (false, parse_bool, [TRACKED],
1286 "perform polymorphization analysis"),
1287 pre_link_arg: (/* redirected to pre_link_args */) = ((), parse_string_push, [UNTRACKED],
1288 "a single extra argument to prepend the linker invocation (can be used several times)"),
1289 pre_link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
1290 "extra arguments to prepend to the linker invocation (space separated)"),
1291 precise_enum_drop_elaboration: bool = (true, parse_bool, [TRACKED],
1292 "use a more precise version of drop elaboration for matches on enums (default: yes). \
1293 This results in better codegen, but has caused miscompilations on some tier 2 platforms. \
1294 See #77382 and #74551."),
1295 print_fuel: Option<String> = (None, parse_opt_string, [TRACKED],
1296 "make rustc print the total optimization fuel used by a crate"),
1297 print_link_args: bool = (false, parse_bool, [UNTRACKED],
1298 "print the arguments passed to the linker (default: no)"),
1299 print_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1300 "print the LLVM optimization passes being run (default: no)"),
1301 print_mono_items: Option<String> = (None, parse_opt_string, [UNTRACKED],
1302 "print the result of the monomorphization collection pass"),
1303 print_type_sizes: bool = (false, parse_bool, [UNTRACKED],
1304 "print layout information for each type encountered (default: no)"),
1305 proc_macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1306 "show backtraces for panics during proc-macro execution (default: no)"),
1307 profile: bool = (false, parse_bool, [TRACKED],
1308 "insert profiling code (default: no)"),
1309 profile_closures: bool = (false, parse_no_flag, [UNTRACKED],
1310 "profile size of closures"),
1311 profile_emit: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1312 "file path to emit profiling data at runtime when using 'profile' \
1313 (default based on relative source path)"),
1314 profiler_runtime: String = (String::from("profiler_builtins"), parse_string, [TRACKED],
1315 "name of the profiler runtime crate to automatically inject (default: `profiler_builtins`)"),
1316 profile_sample_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1317 "use the given `.prof` file for sampled profile-guided optimization (also known as AutoFDO)"),
1318 query_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1319 "enable queries of the dependency graph for regression testing (default: no)"),
1320 query_stats: bool = (false, parse_bool, [UNTRACKED],
1321 "print some statistics about the query system (default: no)"),
1322 randomize_layout: bool = (false, parse_bool, [TRACKED],
1323 "randomize the layout of types (default: no)"),
1324 relax_elf_relocations: Option<bool> = (None, parse_opt_bool, [TRACKED],
1325 "whether ELF relocations can be relaxed"),
1326 relro_level: Option<RelroLevel> = (None, parse_relro_level, [TRACKED],
1327 "choose which RELRO level to use"),
1328 remap_cwd_prefix: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1329 "remap paths under the current working directory to this path prefix"),
1330 simulate_remapped_rust_src_base: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1331 "simulate the effect of remap-debuginfo = true at bootstrapping by remapping path \
1332 to rust's source base directory. only meant for testing purposes"),
1333 report_delayed_bugs: bool = (false, parse_bool, [TRACKED],
1334 "immediately print bugs registered with `delay_span_bug` (default: no)"),
1335 sanitizer: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
1337 sanitizer_memory_track_origins: usize = (0, parse_sanitizer_memory_track_origins, [TRACKED],
1338 "enable origins tracking in MemorySanitizer"),
1339 sanitizer_recover: SanitizerSet = (SanitizerSet::empty(), parse_sanitizers, [TRACKED],
1340 "enable recovery for selected sanitizers"),
1341 saturating_float_casts: Option<bool> = (None, parse_opt_bool, [TRACKED],
1342 "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
1343 the max/min integer respectively, and NaN is mapped to 0 (default: yes)"),
1344 save_analysis: bool = (false, parse_bool, [UNTRACKED],
1345 "write syntax and type analysis (in JSON format) information, in \
1346 addition to normal output (default: no)"),
1347 self_profile: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1348 parse_switch_with_opt_path, [UNTRACKED],
1349 "run the self profiler and output the raw event data"),
1350 /// keep this in sync with the event filter names in librustc_data_structures/profiling.rs
1351 self_profile_events: Option<Vec<String>> = (None, parse_opt_comma_list, [UNTRACKED],
1352 "specify the events recorded by the self profiler;
1353 for example: `-Z self-profile-events=default,query-keys`
1354 all options: none, all, default, generic-activity, query-provider, query-cache-hit
1355 query-blocked, incr-cache-load, incr-result-hashing, query-keys, function-args, args, llvm, artifact-sizes"),
1356 share_generics: Option<bool> = (None, parse_opt_bool, [TRACKED],
1357 "make the current crate share its generic instantiations"),
1358 show_span: Option<String> = (None, parse_opt_string, [TRACKED],
1359 "show spans for compiler debugging (expr|pat|ty)"),
1360 span_debug: bool = (false, parse_bool, [UNTRACKED],
1361 "forward proc_macro::Span's `Debug` impl to `Span`"),
1362 /// o/w tests have closure@path
1363 span_free_formats: bool = (false, parse_bool, [UNTRACKED],
1364 "exclude spans when debug-printing compiler state (default: no)"),
1365 src_hash_algorithm: Option<SourceFileHashAlgorithm> = (None, parse_src_file_hash, [TRACKED],
1366 "hash algorithm of source files in debug info (`md5`, `sha1`, or `sha256`)"),
1367 stack_protector: StackProtector = (StackProtector::None, parse_stack_protector, [TRACKED],
1368 "control stack smash protection strategy (`rustc --print stack-protector-strategies` for details)"),
1369 strip: Strip = (Strip::None, parse_strip, [UNTRACKED],
1370 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1371 split_dwarf_inlining: bool = (true, parse_bool, [UNTRACKED],
1372 "provide minimal debug info in the object/executable to facilitate online \
1373 symbolication/stack traces in the absence of .dwo/.dwp files when using Split DWARF"),
1374 symbol_mangling_version: Option<SymbolManglingVersion> = (None,
1375 parse_symbol_mangling_version, [TRACKED],
1376 "which mangling version to use for symbol names ('legacy' (default) or 'v0')"),
1377 teach: bool = (false, parse_bool, [TRACKED],
1378 "show extended diagnostic help (default: no)"),
1379 temps_dir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1380 "the directory the intermediate files are written to"),
1381 terminal_width: Option<usize> = (None, parse_opt_number, [UNTRACKED],
1382 "set the current terminal width"),
1383 tune_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1384 "select processor to schedule for (`rustc --print target-cpus` for details)"),
1385 thinlto: Option<bool> = (None, parse_opt_bool, [TRACKED],
1386 "enable ThinLTO when possible"),
1387 thir_unsafeck: bool = (false, parse_bool, [TRACKED],
1388 "use the THIR unsafety checker (default: no)"),
1389 /// We default to 1 here since we want to behave like
1390 /// a sequential compiler for now. This'll likely be adjusted
1391 /// in the future. Note that -Zthreads=0 is the way to get
1392 /// the num_cpus behavior.
1393 threads: usize = (1, parse_threads, [UNTRACKED],
1394 "use a thread pool with N threads"),
1395 time: bool = (false, parse_bool, [UNTRACKED],
1396 "measure time of rustc processes (default: no)"),
1397 time_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1398 "measure time of each LLVM pass (default: no)"),
1399 time_passes: bool = (false, parse_bool, [UNTRACKED],
1400 "measure time of each rustc pass (default: no)"),
1401 tls_model: Option<TlsModel> = (None, parse_tls_model, [TRACKED],
1402 "choose the TLS model to use (`rustc --print tls-models` for details)"),
1403 trace_macros: bool = (false, parse_bool, [UNTRACKED],
1404 "for every macro invocation, print its name and arguments (default: no)"),
1405 trap_unreachable: Option<bool> = (None, parse_opt_bool, [TRACKED],
1406 "generate trap instructions for unreachable intrinsics (default: use target setting, usually yes)"),
1407 treat_err_as_bug: Option<NonZeroUsize> = (None, parse_treat_err_as_bug, [TRACKED],
1408 "treat error number `val` that occurs as bug"),
1409 trim_diagnostic_paths: bool = (true, parse_bool, [UNTRACKED],
1410 "in diagnostics, use heuristics to shorten paths referring to items"),
1411 ui_testing: bool = (false, parse_bool, [UNTRACKED],
1412 "emit compiler diagnostics in a form suitable for UI testing (default: no)"),
1413 unleash_the_miri_inside_of_you: bool = (false, parse_bool, [TRACKED],
1414 "take the brakes off const evaluation. NOTE: this is unsound (default: no)"),
1415 unpretty: Option<String> = (None, parse_unpretty, [UNTRACKED],
1416 "present the input source, unstable (and less-pretty) variants;
1417 `normal`, `identified`,
1418 `expanded`, `expanded,identified`,
1419 `expanded,hygiene` (with internal representations),
1420 `everybody_loops` (all function bodies replaced with `loop {}`),
1421 `ast-tree` (raw AST before expansion),
1422 `ast-tree,expanded` (raw AST after expansion),
1423 `hir` (the HIR), `hir,identified`,
1424 `hir,typed` (HIR with types for each node),
1425 `hir-tree` (dump the raw HIR),
1426 `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)"),
1427 unsound_mir_opts: bool = (false, parse_bool, [TRACKED],
1428 "enable unsound and buggy MIR optimizations (default: no)"),
1429 unstable_options: bool = (false, parse_bool, [UNTRACKED],
1430 "adds unstable command line options to rustc interface (default: no)"),
1431 use_ctors_section: Option<bool> = (None, parse_opt_bool, [TRACKED],
1432 "use legacy .ctors section for initializers rather than .init_array"),
1433 validate_mir: bool = (false, parse_bool, [UNTRACKED],
1434 "validate MIR after each transformation"),
1435 verbose: bool = (false, parse_bool, [UNTRACKED],
1436 "in general, enable more debug printouts (default: no)"),
1437 verify_llvm_ir: bool = (false, parse_bool, [TRACKED],
1438 "verify LLVM IR (default: no)"),
1439 wasi_exec_model: Option<WasiExecModel> = (None, parse_wasi_exec_model, [TRACKED],
1440 "whether to build a wasi command or reactor"),
1442 // This list is in alphabetical order.
1444 // If you add a new option, please update:
1445 // - compiler/rustc_interface/src/tests.rs
1448 #[derive(Clone, Hash, PartialEq, Eq, Debug)]
1449 pub enum WasiExecModel {
1454 #[derive(Clone, Copy, Hash)]