3 use crate::early_error;
5 use crate::search_paths::SearchPath;
6 use crate::utils::NativeLibKind;
8 use rustc_target::spec::{CodeModel, LinkerFlavor, MergeFunctions, PanicStrategy};
9 use rustc_target::spec::{RelocModel, RelroLevel, TargetTriple, TlsModel};
11 use rustc_feature::UnstableFeatures;
12 use rustc_span::edition::Edition;
13 use rustc_span::SourceFileHashAlgorithm;
15 use std::collections::BTreeMap;
17 use std::collections::hash_map::DefaultHasher;
18 use std::hash::Hasher;
19 use std::path::PathBuf;
22 macro_rules! hash_option {
23 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, [UNTRACKED]) => {{}};
24 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, [TRACKED]) => {{
26 .insert(stringify!($opt_name), $opt_expr as &dyn dep_tracking::DepTrackingHash)
29 panic!("duplicate key in CLI DepTrackingHash: {}", stringify!($opt_name))
34 macro_rules! top_level_options {
35 (pub struct Options { $(
36 $opt:ident : $t:ty [$dep_tracking_marker:ident $($warn_val:expr, $warn_text:expr)*],
44 pub fn dep_tracking_hash(&self) -> u64 {
45 let mut sub_hashes = BTreeMap::new();
50 [$dep_tracking_marker $($warn_val,
52 self.error_format)*]);
54 let mut hasher = DefaultHasher::new();
55 dep_tracking::stable_hash(sub_hashes,
64 // The top-level command-line options struct.
66 // For each option, one has to specify how it behaves with regard to the
67 // dependency tracking system of incremental compilation. This is done via the
68 // square-bracketed directive after the field type. The options are:
71 // A change in the given field will cause the compiler to completely clear the
72 // incremental compilation cache before proceeding.
75 // Incremental compilation is not influenced by this option.
77 // If you add a new option to this struct or one of the sub-structs like
78 // `CodegenOptions`, think about how it influences incremental compilation. If in
79 // doubt, specify [TRACKED], which is always "correct" but might lead to
80 // unnecessary re-compilation.
83 // The crate config requested for the session, which may be combined
84 // with additional crate configurations during the compile process.
85 crate_types: Vec<CrateType> [TRACKED],
86 optimize: OptLevel [TRACKED],
87 // Include the `debug_assertions` flag in dependency tracking, since it
88 // can influence whether overflow checks are done or not.
89 debug_assertions: bool [TRACKED],
90 debuginfo: DebugInfo [TRACKED],
91 lint_opts: Vec<(String, lint::Level)> [TRACKED],
92 lint_cap: Option<lint::Level> [TRACKED],
93 describe_lints: bool [UNTRACKED],
94 output_types: OutputTypes [TRACKED],
95 search_paths: Vec<SearchPath> [UNTRACKED],
96 libs: Vec<(String, Option<String>, NativeLibKind)> [TRACKED],
97 maybe_sysroot: Option<PathBuf> [UNTRACKED],
99 target_triple: TargetTriple [TRACKED],
101 test: bool [TRACKED],
102 error_format: ErrorOutputType [UNTRACKED],
104 // If `Some`, enable incremental compilation, using the given
105 // directory to store intermediate results.
106 incremental: Option<PathBuf> [UNTRACKED],
108 debugging_opts: DebuggingOptions [TRACKED],
109 prints: Vec<PrintRequest> [UNTRACKED],
110 // Determines which borrow checker(s) to run. This is the parsed, sanitized
111 // version of `debugging_opts.borrowck`, which is just a plain string.
112 borrowck_mode: BorrowckMode [UNTRACKED],
113 cg: CodegenOptions [TRACKED],
114 externs: Externs [UNTRACKED],
115 crate_name: Option<String> [TRACKED],
116 // An optional name to use as the crate for std during std injection,
117 // written `extern crate name as std`. Defaults to `std`. Used by
118 // out-of-tree drivers.
119 alt_std_name: Option<String> [TRACKED],
120 // Indicates how the compiler should treat unstable features.
121 unstable_features: UnstableFeatures [TRACKED],
123 // Indicates whether this run of the compiler is actually rustdoc. This
124 // is currently just a hack and will be removed eventually, so please
125 // try to not rely on this too much.
126 actually_rustdoc: bool [TRACKED],
128 // Specifications of codegen units / ThinLTO which are forced as a
129 // result of parsing command line options. These are not necessarily
130 // what rustc was invoked with, but massaged a bit to agree with
131 // commands like `--emit llvm-ir` which they're often incompatible with
132 // if we otherwise use the defaults of rustc.
133 cli_forced_codegen_units: Option<usize> [UNTRACKED],
134 cli_forced_thinlto_off: bool [UNTRACKED],
136 // Remap source path prefixes in all output (messages, object files, debug, etc.).
137 remap_path_prefix: Vec<(PathBuf, PathBuf)> [UNTRACKED],
139 edition: Edition [TRACKED],
141 // `true` if we're emitting JSON blobs about each artifact produced
143 json_artifact_notifications: bool [TRACKED],
145 pretty: Option<PpMode> [UNTRACKED],
149 /// Defines all `CodegenOptions`/`DebuggingOptions` fields and parsers all at once. The goal of this
150 /// macro is to define an interface that can be programmatically used by the option parser
151 /// to initialize the struct without hardcoding field names all over the place.
153 /// The goal is to invoke this macro once with the correct fields, and then this macro generates all
154 /// necessary code. The main gotcha of this macro is the `cgsetters` module which is a bunch of
155 /// generated code to parse an option into its respective field in the struct. There are a few
156 /// hand-written parsers for parsing specific types of values in this module.
157 macro_rules! options {
158 ($struct_name:ident, $setter_name:ident, $defaultfn:ident,
159 $buildfn:ident, $prefix:expr, $outputname:expr,
160 $stat:ident, $mod_desc:ident, $mod_set:ident,
161 $($opt:ident : $t:ty = (
164 [$dep_tracking_marker:ident $(($dep_warn_val:expr, $dep_warn_text:expr))*],
169 pub struct $struct_name { $(pub $opt: $t),* }
171 pub fn $defaultfn() -> $struct_name {
172 $struct_name { $($opt: $init),* }
175 pub fn $buildfn(matches: &getopts::Matches, error_format: ErrorOutputType) -> $struct_name
177 let mut op = $defaultfn();
178 for option in matches.opt_strs($prefix) {
179 let mut iter = option.splitn(2, '=');
180 let key = iter.next().unwrap();
181 let value = iter.next();
182 let option_to_lookup = key.replace("-", "_");
183 let mut found = false;
184 for &(candidate, setter, type_desc, _) in $stat {
185 if option_to_lookup != candidate { continue }
186 if !setter(&mut op, value) {
189 early_error(error_format, &format!("{0} option `{1}` requires \
190 {2} ({3} {1}=<value>)",
195 early_error(error_format, &format!("incorrect value `{}` for {} \
196 option `{}` - {} was expected",
206 early_error(error_format, &format!("unknown {} option: `{}`",
213 impl dep_tracking::DepTrackingHash for $struct_name {
214 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
215 let mut sub_hashes = BTreeMap::new();
220 [$dep_tracking_marker $($dep_warn_val,
224 dep_tracking::stable_hash(sub_hashes, hasher, error_format);
228 pub type $setter_name = fn(&mut $struct_name, v: Option<&str>) -> bool;
229 pub const $stat: &[(&str, $setter_name, &str, &str)] =
230 &[ $( (stringify!($opt), $mod_set::$opt, $mod_desc::$parse, $desc) ),* ];
232 #[allow(non_upper_case_globals, dead_code)]
234 pub const parse_no_flag: &str = "no value";
235 pub const parse_bool: &str = "one of: `y`, `yes`, `on`, `n`, `no`, or `off`";
236 pub const parse_opt_bool: &str = parse_bool;
237 pub const parse_string: &str = "a string";
238 pub const parse_opt_string: &str = parse_string;
239 pub const parse_string_push: &str = parse_string;
240 pub const parse_opt_pathbuf: &str = "a path";
241 pub const parse_pathbuf_push: &str = parse_opt_pathbuf;
242 pub const parse_list: &str = "a space-separated list of strings";
243 pub const parse_opt_list: &str = parse_list;
244 pub const parse_opt_comma_list: &str = "a comma-separated list of strings";
245 pub const parse_uint: &str = "a number";
246 pub const parse_opt_uint: &str = parse_uint;
247 pub const parse_threads: &str = parse_uint;
248 pub const parse_passes: &str = "a space-separated list of passes, or `all`";
249 pub const parse_panic_strategy: &str = "either `unwind` or `abort`";
250 pub const parse_relro_level: &str = "one of: `full`, `partial`, or `off`";
251 pub const parse_sanitizer: &str = "one of: `address`, `leak`, `memory` or `thread`";
252 pub const parse_sanitizer_list: &str = "comma separated list of sanitizers";
253 pub const parse_sanitizer_memory_track_origins: &str = "0, 1, or 2";
254 pub const parse_cfguard: &str = "either `disabled`, `nochecks`, or `checks`";
255 pub const parse_strip: &str = "either `none`, `debuginfo`, or `symbols`";
256 pub const parse_linker_flavor: &str = ::rustc_target::spec::LinkerFlavor::one_of();
257 pub const parse_optimization_fuel: &str = "crate=integer";
258 pub const parse_unpretty: &str = "`string` or `string=string`";
259 pub const parse_treat_err_as_bug: &str = "either no value or a number bigger than 0";
260 pub const parse_lto: &str =
261 "either a boolean (`yes`, `no`, `on`, `off`, etc), `thin`, `fat`, or omitted";
262 pub const parse_linker_plugin_lto: &str =
263 "either a boolean (`yes`, `no`, `on`, `off`, etc), or the path to the linker plugin";
264 pub const parse_switch_with_opt_path: &str =
265 "an optional path to the profiling data output directory";
266 pub const parse_merge_functions: &str = "one of: `disabled`, `trampolines`, or `aliases`";
267 pub const parse_symbol_mangling_version: &str = "either `legacy` or `v0` (RFC 2603)";
268 pub const parse_src_file_hash: &str = "either `md5` or `sha1`";
269 pub const parse_relocation_model: &str =
270 "one of supported relocation models (`rustc --print relocation-models`)";
271 pub const parse_code_model: &str =
272 "one of supported code models (`rustc --print code-models`)";
273 pub const parse_tls_model: &str =
274 "one of supported TLS models (`rustc --print tls-models`)";
275 pub const parse_target_feature: &str = parse_string;
281 use std::str::FromStr;
283 // Sometimes different options need to build a common structure.
284 // That structure can kept in one of the options' fields, the others become dummy.
285 macro_rules! redirect_field {
286 ($cg:ident.link_arg) => { $cg.link_args };
287 ($cg:ident.pre_link_arg) => { $cg.pre_link_args };
288 ($cg:ident.$field:ident) => { $cg.$field };
292 pub fn $opt(cg: &mut $struct_name, v: Option<&str>) -> bool {
293 $parse(&mut redirect_field!(cg.$opt), v)
297 /// This is for boolean options that don't take a value and start with
298 /// `no-`. This style of option is deprecated.
299 fn parse_no_flag(slot: &mut bool, v: Option<&str>) -> bool {
301 None => { *slot = true; true }
306 /// Use this for any boolean option that has a static default.
307 fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
309 Some("y") | Some("yes") | Some("on") | None => { *slot = true; true }
310 Some("n") | Some("no") | Some("off") => { *slot = false; true }
315 /// Use this for any boolean option that lacks a static default. (The
316 /// actions taken when such an option is not specified will depend on
317 /// other factors, such as other options, or target options.)
318 fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
320 Some("y") | Some("yes") | Some("on") | None => { *slot = Some(true); true }
321 Some("n") | Some("no") | Some("off") => { *slot = Some(false); true }
326 /// Use this for any string option that has a static default.
327 fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
329 Some(s) => { *slot = s.to_string(); true },
334 /// Use this for any string option that lacks a static default.
335 fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
337 Some(s) => { *slot = Some(s.to_string()); true },
342 fn parse_opt_pathbuf(slot: &mut Option<PathBuf>, v: Option<&str>) -> bool {
344 Some(s) => { *slot = Some(PathBuf::from(s)); true },
349 fn parse_string_push(slot: &mut Vec<String>, v: Option<&str>) -> bool {
351 Some(s) => { slot.push(s.to_string()); true },
356 fn parse_pathbuf_push(slot: &mut Vec<PathBuf>, v: Option<&str>) -> bool {
358 Some(s) => { slot.push(PathBuf::from(s)); true },
363 fn parse_list(slot: &mut Vec<String>, v: Option<&str>)
367 slot.extend(s.split_whitespace().map(|s| s.to_string()));
374 fn parse_opt_list(slot: &mut Option<Vec<String>>, v: Option<&str>)
378 let v = s.split_whitespace().map(|s| s.to_string()).collect();
386 fn parse_opt_comma_list(slot: &mut Option<Vec<String>>, v: Option<&str>)
390 let v = s.split(',').map(|s| s.to_string()).collect();
398 fn parse_threads(slot: &mut usize, v: Option<&str>) -> bool {
399 match v.and_then(|s| s.parse().ok()) {
400 Some(0) => { *slot = ::num_cpus::get(); true },
401 Some(i) => { *slot = i; true },
406 /// Use this for any uint option that has a static default.
407 fn parse_uint(slot: &mut usize, v: Option<&str>) -> bool {
408 match v.and_then(|s| s.parse().ok()) {
409 Some(i) => { *slot = i; true },
414 /// Use this for any uint option that lacks a static default.
415 fn parse_opt_uint(slot: &mut Option<usize>, v: Option<&str>) -> bool {
417 Some(s) => { *slot = s.parse().ok(); slot.is_some() }
422 fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
429 let mut passes = vec![];
430 if parse_list(&mut passes, v) {
431 *slot = Passes::Some(passes);
440 fn parse_panic_strategy(slot: &mut Option<PanicStrategy>, v: Option<&str>) -> bool {
442 Some("unwind") => *slot = Some(PanicStrategy::Unwind),
443 Some("abort") => *slot = Some(PanicStrategy::Abort),
449 fn parse_relro_level(slot: &mut Option<RelroLevel>, v: Option<&str>) -> bool {
452 match s.parse::<RelroLevel>() {
453 Ok(level) => *slot = Some(level),
462 fn parse_sanitizer(slot: &mut Option<Sanitizer>, v: Option<&str>) -> bool {
463 if let Some(Ok(s)) = v.map(str::parse) {
471 fn parse_sanitizer_list(slot: &mut Vec<Sanitizer>, v: Option<&str>) -> bool {
473 for s in v.split(',').map(str::parse) {
475 if !slot.contains(&s) {
488 fn parse_sanitizer_memory_track_origins(slot: &mut usize, v: Option<&str>) -> bool {
490 Some("2") | None => { *slot = 2; true }
491 Some("1") => { *slot = 1; true }
492 Some("0") => { *slot = 0; true }
497 fn parse_strip(slot: &mut Strip, v: Option<&str>) -> bool {
499 Some("none") => *slot = Strip::None,
500 Some("debuginfo") => *slot = Strip::Debuginfo,
501 Some("symbols") => *slot = Strip::Symbols,
507 fn parse_cfguard(slot: &mut CFGuard, v: Option<&str>) -> bool {
509 Some("disabled") => *slot = CFGuard::Disabled,
510 Some("nochecks") => *slot = CFGuard::NoChecks,
511 Some("checks") => *slot = CFGuard::Checks,
517 fn parse_linker_flavor(slote: &mut Option<LinkerFlavor>, v: Option<&str>) -> bool {
518 match v.and_then(LinkerFlavor::from_str) {
519 Some(lf) => *slote = Some(lf),
525 fn parse_optimization_fuel(slot: &mut Option<(String, u64)>, v: Option<&str>) -> bool {
529 let parts = s.split('=').collect::<Vec<_>>();
530 if parts.len() != 2 { return false; }
531 let crate_name = parts[0].to_string();
532 let fuel = parts[1].parse::<u64>();
533 if fuel.is_err() { return false; }
534 *slot = Some((crate_name, fuel.unwrap()));
540 fn parse_unpretty(slot: &mut Option<String>, v: Option<&str>) -> bool {
543 Some(s) if s.split('=').count() <= 2 => {
544 *slot = Some(s.to_string());
551 fn parse_treat_err_as_bug(slot: &mut Option<usize>, v: Option<&str>) -> bool {
553 Some(s) => { *slot = s.parse().ok().filter(|&x| x != 0); slot.unwrap_or(0) != 0 }
554 None => { *slot = Some(1); true }
558 fn parse_lto(slot: &mut LtoCli, v: Option<&str>) -> bool {
560 let mut bool_arg = None;
561 if parse_opt_bool(&mut bool_arg, v) {
562 *slot = if bool_arg.unwrap() {
572 None => LtoCli::NoParam,
573 Some("thin") => LtoCli::Thin,
574 Some("fat") => LtoCli::Fat,
575 Some(_) => return false,
580 fn parse_linker_plugin_lto(slot: &mut LinkerPluginLto, v: Option<&str>) -> bool {
582 let mut bool_arg = None;
583 if parse_opt_bool(&mut bool_arg, v) {
584 *slot = if bool_arg.unwrap() {
585 LinkerPluginLto::LinkerPluginAuto
587 LinkerPluginLto::Disabled
594 None => LinkerPluginLto::LinkerPluginAuto,
595 Some(path) => LinkerPluginLto::LinkerPlugin(PathBuf::from(path)),
600 fn parse_switch_with_opt_path(slot: &mut SwitchWithOptPath, v: Option<&str>) -> bool {
602 None => SwitchWithOptPath::Enabled(None),
603 Some(path) => SwitchWithOptPath::Enabled(Some(PathBuf::from(path))),
608 fn parse_merge_functions(slot: &mut Option<MergeFunctions>, v: Option<&str>) -> bool {
609 match v.and_then(|s| MergeFunctions::from_str(s).ok()) {
610 Some(mergefunc) => *slot = Some(mergefunc),
616 fn parse_relocation_model(slot: &mut Option<RelocModel>, v: Option<&str>) -> bool {
617 match v.and_then(|s| RelocModel::from_str(s).ok()) {
618 Some(relocation_model) => *slot = Some(relocation_model),
619 None if v == Some("default") => *slot = None,
625 fn parse_code_model(slot: &mut Option<CodeModel>, v: Option<&str>) -> bool {
626 match v.and_then(|s| CodeModel::from_str(s).ok()) {
627 Some(code_model) => *slot = Some(code_model),
633 fn parse_tls_model(slot: &mut Option<TlsModel>, v: Option<&str>) -> bool {
634 match v.and_then(|s| TlsModel::from_str(s).ok()) {
635 Some(tls_model) => *slot = Some(tls_model),
641 fn parse_symbol_mangling_version(
642 slot: &mut SymbolManglingVersion,
646 Some("legacy") => SymbolManglingVersion::Legacy,
647 Some("v0") => SymbolManglingVersion::V0,
653 fn parse_src_file_hash(slot: &mut Option<SourceFileHashAlgorithm>, v: Option<&str>) -> bool {
654 match v.and_then(|s| SourceFileHashAlgorithm::from_str(s).ok()) {
655 Some(hash_kind) => *slot = Some(hash_kind),
661 fn parse_target_feature(slot: &mut String, v: Option<&str>) -> bool {
664 if !slot.is_empty() {
676 options! {CodegenOptions, CodegenSetter, basic_codegen_options,
677 build_codegen_options, "C", "codegen",
678 CG_OPTIONS, cg_type_desc, cgsetters,
680 // This list is in alphabetical order.
682 // If you add a new option, please update:
683 // - src/librustc_interface/tests.rs
684 // - src/doc/rustc/src/codegen-options/index.md
686 ar: String = (String::new(), parse_string, [UNTRACKED],
687 "this option is deprecated and does nothing"),
688 code_model: Option<CodeModel> = (None, parse_code_model, [TRACKED],
689 "choose the code model to use (`rustc --print code-models` for details)"),
690 codegen_units: Option<usize> = (None, parse_opt_uint, [UNTRACKED],
691 "divide crate into N units to optimize in parallel"),
692 debug_assertions: Option<bool> = (None, parse_opt_bool, [TRACKED],
693 "explicitly enable the `cfg(debug_assertions)` directive"),
694 debuginfo: usize = (0, parse_uint, [TRACKED],
695 "debug info emission level (0 = no debug info, 1 = line tables only, \
696 2 = full debug info with variable and type information; default: 0)"),
697 default_linker_libraries: bool = (false, parse_bool, [UNTRACKED],
698 "allow the linker to link its default libraries (default: no)"),
699 embed_bitcode: bool = (true, parse_bool, [TRACKED],
700 "emit bitcode in rlibs (default: yes)"),
701 extra_filename: String = (String::new(), parse_string, [UNTRACKED],
702 "extra data to put in each output filename"),
703 force_frame_pointers: Option<bool> = (None, parse_opt_bool, [TRACKED],
704 "force use of the frame pointers"),
705 force_unwind_tables: Option<bool> = (None, parse_opt_bool, [TRACKED],
706 "force use of unwind tables"),
707 incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
708 "enable incremental compilation"),
709 inline_threshold: Option<usize> = (None, parse_opt_uint, [TRACKED],
710 "set the threshold for inlining a function"),
711 link_arg: (/* redirected to link_args */) = ((), parse_string_push, [UNTRACKED],
712 "a single extra argument to append to the linker invocation (can be used several times)"),
713 link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
714 "extra arguments to append to the linker invocation (space separated)"),
715 link_dead_code: bool = (false, parse_bool, [UNTRACKED],
716 "keep dead code at link time (useful for code coverage) (default: no)"),
717 linker: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
718 "system linker to link outputs with"),
719 linker_flavor: Option<LinkerFlavor> = (None, parse_linker_flavor, [UNTRACKED],
721 linker_plugin_lto: LinkerPluginLto = (LinkerPluginLto::Disabled,
722 parse_linker_plugin_lto, [TRACKED],
723 "generate build artifacts that are compatible with linker-based LTO"),
724 llvm_args: Vec<String> = (Vec::new(), parse_list, [TRACKED],
725 "a list of arguments to pass to LLVM (space separated)"),
726 lto: LtoCli = (LtoCli::Unspecified, parse_lto, [TRACKED],
727 "perform LLVM link-time optimizations"),
728 metadata: Vec<String> = (Vec::new(), parse_list, [TRACKED],
729 "metadata to mangle symbol names with"),
730 no_prepopulate_passes: bool = (false, parse_no_flag, [TRACKED],
731 "give an empty list of passes to the pass manager"),
732 no_redzone: Option<bool> = (None, parse_opt_bool, [TRACKED],
733 "disable the use of the redzone"),
734 no_stack_check: bool = (false, parse_no_flag, [UNTRACKED],
735 "this option is deprecated and does nothing"),
736 no_vectorize_loops: bool = (false, parse_no_flag, [TRACKED],
737 "disable loop vectorization optimization passes"),
738 no_vectorize_slp: bool = (false, parse_no_flag, [TRACKED],
739 "disable LLVM's SLP vectorization pass"),
740 opt_level: String = ("0".to_string(), parse_string, [TRACKED],
741 "optimization level (0-3, s, or z; default: 0)"),
742 overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
743 "use overflow checks for integer arithmetic"),
744 panic: Option<PanicStrategy> = (None, parse_panic_strategy, [TRACKED],
745 "panic strategy to compile crate with"),
746 passes: Vec<String> = (Vec::new(), parse_list, [TRACKED],
747 "a list of extra LLVM passes to run (space separated)"),
748 prefer_dynamic: bool = (false, parse_bool, [TRACKED],
749 "prefer dynamic linking to static linking (default: no)"),
750 profile_generate: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
751 parse_switch_with_opt_path, [TRACKED],
752 "compile the program with profiling instrumentation"),
753 profile_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
754 "use the given `.profdata` file for profile-guided optimization"),
755 relocation_model: Option<RelocModel> = (None, parse_relocation_model, [TRACKED],
756 "control generation of position-independent code (PIC) \
757 (`rustc --print relocation-models` for details)"),
758 remark: Passes = (Passes::Some(Vec::new()), parse_passes, [UNTRACKED],
759 "print remarks for these optimization passes (space separated, or \"all\")"),
760 rpath: bool = (false, parse_bool, [UNTRACKED],
761 "set rpath values in libs/exes (default: no)"),
762 save_temps: bool = (false, parse_bool, [UNTRACKED],
763 "save all temporary output files during compilation (default: no)"),
764 soft_float: bool = (false, parse_bool, [TRACKED],
765 "use soft float ABI (*eabihf targets only) (default: no)"),
766 target_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
767 "select target processor (`rustc --print target-cpus` for details)"),
768 target_feature: String = (String::new(), parse_target_feature, [TRACKED],
769 "target specific attributes. (`rustc --print target-features` for details). \
770 This feature is unsafe."),
772 // This list is in alphabetical order.
774 // If you add a new option, please update:
775 // - src/librustc_interface/tests.rs
776 // - src/doc/rustc/src/codegen-options/index.md
779 options! {DebuggingOptions, DebuggingSetter, basic_debugging_options,
780 build_debugging_options, "Z", "debugging",
781 DB_OPTIONS, db_type_desc, dbsetters,
783 // This list is in alphabetical order.
785 // If you add a new option, please update:
786 // - src/librustc_interface/tests.rs
788 allow_features: Option<Vec<String>> = (None, parse_opt_comma_list, [TRACKED],
789 "only allow the listed language features to be enabled in code (space separated)"),
790 always_encode_mir: bool = (false, parse_bool, [TRACKED],
791 "encode MIR of all functions into the crate metadata (default: no)"),
792 asm_comments: bool = (false, parse_bool, [TRACKED],
793 "generate comments into the assembly (may change behavior) (default: no)"),
794 ast_json: bool = (false, parse_bool, [UNTRACKED],
795 "print the AST as JSON and halt (default: no)"),
796 ast_json_noexpand: bool = (false, parse_bool, [UNTRACKED],
797 "print the pre-expansion AST as JSON and halt (default: no)"),
798 binary_dep_depinfo: bool = (false, parse_bool, [TRACKED],
799 "include artifacts (sysroot, crate dependencies) used during compilation in dep-info \
801 borrowck: String = ("migrate".to_string(), parse_string, [UNTRACKED],
802 "select which borrowck is used (`mir` or `migrate`) (default: `migrate`)"),
803 borrowck_stats: bool = (false, parse_bool, [UNTRACKED],
804 "gather borrowck statistics (default: no)"),
805 chalk: bool = (false, parse_bool, [TRACKED],
806 "enable the experimental Chalk-based trait solving engine"),
807 codegen_backend: Option<String> = (None, parse_opt_string, [TRACKED],
808 "the backend to use"),
809 control_flow_guard: CFGuard = (CFGuard::Disabled, parse_cfguard, [UNTRACKED],
810 "use Windows Control Flow Guard (`disabled`, `nochecks` or `checks`)"),
811 crate_attr: Vec<String> = (Vec::new(), parse_string_push, [TRACKED],
812 "inject the given attribute in the crate"),
813 debug_macros: bool = (false, parse_bool, [TRACKED],
814 "emit line numbers debug info inside macros (default: no)"),
815 deduplicate_diagnostics: bool = (true, parse_bool, [UNTRACKED],
816 "deduplicate identical diagnostics (default: yes)"),
817 dep_info_omit_d_target: bool = (false, parse_bool, [TRACKED],
818 "in dep-info output, omit targets for tracking dependencies of the dep-info files \
819 themselves (default: no)"),
820 dep_tasks: bool = (false, parse_bool, [UNTRACKED],
821 "print tasks that execute and the color their dep node gets (requires debug build) \
823 dont_buffer_diagnostics: bool = (false, parse_bool, [UNTRACKED],
824 "emit diagnostics rather than buffering (breaks NLL error downgrading, sorting) \
826 dual_proc_macros: bool = (false, parse_bool, [TRACKED],
827 "load proc macros for both target and host, but only link to the target (default: no)"),
828 dump_dep_graph: bool = (false, parse_bool, [UNTRACKED],
829 "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv) \
831 dump_mir: Option<String> = (None, parse_opt_string, [UNTRACKED],
832 "dump MIR state to file.
833 `val` is used to select which passes and functions to dump. For example:
834 `all` matches all passes and functions,
835 `foo` matches all passes for functions whose name contains 'foo',
836 `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
837 `foo | bar` all passes for function names containing 'foo' or 'bar'."),
838 dump_mir_dataflow: bool = (false, parse_bool, [UNTRACKED],
839 "in addition to `.mir` files, create graphviz `.dot` files with dataflow results \
841 dump_mir_dir: String = ("mir_dump".to_string(), parse_string, [UNTRACKED],
842 "the directory the MIR is dumped into (default: `mir_dump`)"),
843 dump_mir_exclude_pass_number: bool = (false, parse_bool, [UNTRACKED],
844 "exclude the pass number when dumping MIR (used in tests) (default: no)"),
845 dump_mir_graphviz: bool = (false, parse_bool, [UNTRACKED],
846 "in addition to `.mir` files, create graphviz `.dot` files (default: no)"),
847 emit_stack_sizes: bool = (false, parse_bool, [UNTRACKED],
848 "emit a section containing stack size metadata (default: no)"),
849 fewer_names: bool = (false, parse_bool, [TRACKED],
850 "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR) \
852 force_overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
853 "force overflow checks on or off"),
854 force_unstable_if_unmarked: bool = (false, parse_bool, [TRACKED],
855 "force all crates to be `rustc_private` unstable (default: no)"),
856 fuel: Option<(String, u64)> = (None, parse_optimization_fuel, [TRACKED],
857 "set the optimization fuel quota for a crate"),
858 hir_stats: bool = (false, parse_bool, [UNTRACKED],
859 "print some statistics about AST and HIR (default: no)"),
860 human_readable_cgu_names: bool = (false, parse_bool, [TRACKED],
861 "generate human-readable, predictable names for codegen units (default: no)"),
862 identify_regions: bool = (false, parse_bool, [UNTRACKED],
863 "display unnamed regions as `'<id>`, using a non-ident unique id (default: no)"),
864 incremental_ignore_spans: bool = (false, parse_bool, [UNTRACKED],
865 "ignore spans during ICH computation -- used for testing (default: no)"),
866 incremental_info: bool = (false, parse_bool, [UNTRACKED],
867 "print high-level information about incremental reuse (or the lack thereof) \
869 incremental_verify_ich: bool = (false, parse_bool, [UNTRACKED],
870 "verify incr. comp. hashes of green query instances (default: no)"),
871 inline_in_all_cgus: Option<bool> = (None, parse_opt_bool, [TRACKED],
872 "control whether `#[inline]` functions are in all CGUs"),
873 input_stats: bool = (false, parse_bool, [UNTRACKED],
874 "gather statistics about the input (default: no)"),
875 insert_sideeffect: bool = (false, parse_bool, [TRACKED],
876 "fix undefined behavior when a thread doesn't eventually make progress \
877 (such as entering an empty infinite loop) by inserting llvm.sideeffect \
879 instrument_coverage: bool = (false, parse_bool, [TRACKED],
880 "instrument the generated code with LLVM code region counters to (in the \
881 future) generate coverage reports (default: no; note, the compiler build \
882 config must include `profiler = true`)"),
883 instrument_mcount: bool = (false, parse_bool, [TRACKED],
884 "insert function instrument code for mcount-based tracing (default: no)"),
885 keep_hygiene_data: bool = (false, parse_bool, [UNTRACKED],
886 "keep hygiene data after analysis (default: no)"),
887 link_native_libraries: bool = (true, parse_bool, [UNTRACKED],
888 "link native libraries in the linker invocation (default: yes)"),
889 link_only: bool = (false, parse_bool, [TRACKED],
890 "link the `.rlink` file generated by `-Z no-link` (default: no)"),
891 llvm_time_trace: bool = (false, parse_bool, [UNTRACKED],
892 "generate JSON tracing data file from LLVM data (default: no)"),
893 ls: bool = (false, parse_bool, [UNTRACKED],
894 "list the symbols defined by a library crate (default: no)"),
895 macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
896 "show macro backtraces (default: no)"),
897 merge_functions: Option<MergeFunctions> = (None, parse_merge_functions, [TRACKED],
898 "control the operation of the MergeFunctions LLVM pass, taking \
899 the same values as the target option of the same name"),
900 meta_stats: bool = (false, parse_bool, [UNTRACKED],
901 "gather metadata statistics (default: no)"),
902 mir_emit_retag: bool = (false, parse_bool, [TRACKED],
903 "emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0 \
905 mir_opt_level: usize = (1, parse_uint, [TRACKED],
906 "MIR optimization level (0-3; default: 1)"),
907 mutable_noalias: bool = (false, parse_bool, [TRACKED],
908 "emit noalias metadata for mutable references (default: no)"),
909 new_llvm_pass_manager: bool = (false, parse_bool, [TRACKED],
910 "use new LLVM pass manager (default: no)"),
911 nll_facts: bool = (false, parse_bool, [UNTRACKED],
912 "dump facts from NLL analysis into side files (default: no)"),
913 no_analysis: bool = (false, parse_no_flag, [UNTRACKED],
914 "parse and expand the source, but run no analysis"),
915 no_codegen: bool = (false, parse_no_flag, [TRACKED],
916 "run all passes except codegen; no output"),
917 no_generate_arange_section: bool = (false, parse_no_flag, [TRACKED],
918 "omit DWARF address ranges that give faster lookups"),
919 no_interleave_lints: bool = (false, parse_no_flag, [UNTRACKED],
920 "execute lints separately; allows benchmarking individual lints"),
921 no_leak_check: bool = (false, parse_no_flag, [UNTRACKED],
922 "disable the 'leak check' for subtyping; unsound, but useful for tests"),
923 no_link: bool = (false, parse_no_flag, [TRACKED],
924 "compile without linking"),
925 no_parallel_llvm: bool = (false, parse_no_flag, [UNTRACKED],
926 "run LLVM in non-parallel mode (while keeping codegen-units and ThinLTO)"),
927 no_profiler_runtime: bool = (false, parse_no_flag, [TRACKED],
928 "prevent automatic injection of the profiler_builtins crate"),
929 osx_rpath_install_name: bool = (false, parse_bool, [TRACKED],
930 "pass `-install_name @rpath/...` to the macOS linker (default: no)"),
931 panic_abort_tests: bool = (false, parse_bool, [TRACKED],
932 "support compiling tests with panic=abort (default: no)"),
933 parse_only: bool = (false, parse_bool, [UNTRACKED],
934 "parse only; do not compile, assemble, or link (default: no)"),
935 perf_stats: bool = (false, parse_bool, [UNTRACKED],
936 "print some performance-related statistics (default: no)"),
937 plt: Option<bool> = (None, parse_opt_bool, [TRACKED],
938 "whether to use the PLT when calling into shared libraries;
939 only has effect for PIC code on systems with ELF binaries
940 (default: PLT is disabled if full relro is enabled)"),
941 polonius: bool = (false, parse_bool, [UNTRACKED],
942 "enable polonius-based borrow-checker (default: no)"),
943 pre_link_arg: (/* redirected to pre_link_args */) = ((), parse_string_push, [UNTRACKED],
944 "a single extra argument to prepend the linker invocation (can be used several times)"),
945 pre_link_args: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
946 "extra arguments to prepend to the linker invocation (space separated)"),
947 print_fuel: Option<String> = (None, parse_opt_string, [TRACKED],
948 "make rustc print the total optimization fuel used by a crate"),
949 print_link_args: bool = (false, parse_bool, [UNTRACKED],
950 "print the arguments passed to the linker (default: no)"),
951 print_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
952 "print the LLVM optimization passes being run (default: no)"),
953 print_mono_items: Option<String> = (None, parse_opt_string, [UNTRACKED],
954 "print the result of the monomorphization collection pass"),
955 print_region_graph: bool = (false, parse_bool, [UNTRACKED],
956 "prints region inference graph. \
957 Use with RUST_REGION_GRAPH=help for more info (default: no)"),
958 print_type_sizes: bool = (false, parse_bool, [UNTRACKED],
959 "print layout information for each type encountered (default: no)"),
960 profile: bool = (false, parse_bool, [TRACKED],
961 "insert profiling code (default: no)"),
962 profile_emit: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
963 "file path to emit profiling data at runtime when using 'profile' \
964 (default based on relative source path)"),
965 query_dep_graph: bool = (false, parse_bool, [UNTRACKED],
966 "enable queries of the dependency graph for regression testing (default: no)"),
967 query_stats: bool = (false, parse_bool, [UNTRACKED],
968 "print some statistics about the query system (default: no)"),
969 relro_level: Option<RelroLevel> = (None, parse_relro_level, [TRACKED],
970 "choose which RELRO level to use"),
971 report_delayed_bugs: bool = (false, parse_bool, [TRACKED],
972 "immediately print bugs registered with `delay_span_bug` (default: no)"),
973 // The default historical behavior was to always run dsymutil, so we're
974 // preserving that temporarily, but we're likely to switch the default
976 run_dsymutil: bool = (true, parse_bool, [TRACKED],
977 "if on Mac, run `dsymutil` and delete intermediate object files (default: yes)"),
978 sanitizer: Option<Sanitizer> = (None, parse_sanitizer, [TRACKED],
980 sanitizer_memory_track_origins: usize = (0, parse_sanitizer_memory_track_origins, [TRACKED],
981 "enable origins tracking in MemorySanitizer"),
982 sanitizer_recover: Vec<Sanitizer> = (vec![], parse_sanitizer_list, [TRACKED],
983 "enable recovery for selected sanitizers"),
984 saturating_float_casts: Option<bool> = (None, parse_opt_bool, [TRACKED],
985 "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
986 the max/min integer respectively, and NaN is mapped to 0 (default: yes)"),
987 save_analysis: bool = (false, parse_bool, [UNTRACKED],
988 "write syntax and type analysis (in JSON format) information, in \
989 addition to normal output (default: no)"),
990 self_profile: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
991 parse_switch_with_opt_path, [UNTRACKED],
992 "run the self profiler and output the raw event data"),
993 // keep this in sync with the event filter names in librustc_data_structures/profiling.rs
994 self_profile_events: Option<Vec<String>> = (None, parse_opt_comma_list, [UNTRACKED],
995 "specify the events recorded by the self profiler;
996 for example: `-Z self-profile-events=default,query-keys`
997 all options: none, all, default, generic-activity, query-provider, query-cache-hit
998 query-blocked, incr-cache-load, query-keys, function-args, args, llvm"),
999 share_generics: Option<bool> = (None, parse_opt_bool, [TRACKED],
1000 "make the current crate share its generic instantiations"),
1001 show_span: Option<String> = (None, parse_opt_string, [TRACKED],
1002 "show spans for compiler debugging (expr|pat|ty)"),
1003 span_debug: bool = (false, parse_bool, [UNTRACKED],
1004 "forward proc_macro::Span's `Debug` impl to `Span`"),
1005 // o/w tests have closure@path
1006 span_free_formats: bool = (false, parse_bool, [UNTRACKED],
1007 "exclude spans when debug-printing compiler state (default: no)"),
1008 src_hash_algorithm: Option<SourceFileHashAlgorithm> = (None, parse_src_file_hash, [TRACKED],
1009 "hash algorithm of source files in debug info (`md5`, or `sha1`)"),
1010 strip: Strip = (Strip::None, parse_strip, [UNTRACKED],
1011 "tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)"),
1012 symbol_mangling_version: SymbolManglingVersion = (SymbolManglingVersion::Legacy,
1013 parse_symbol_mangling_version, [TRACKED],
1014 "which mangling version to use for symbol names"),
1015 teach: bool = (false, parse_bool, [TRACKED],
1016 "show extended diagnostic help (default: no)"),
1017 terminal_width: Option<usize> = (None, parse_opt_uint, [UNTRACKED],
1018 "set the current terminal width"),
1019 thinlto: Option<bool> = (None, parse_opt_bool, [TRACKED],
1020 "enable ThinLTO when possible"),
1021 // We default to 1 here since we want to behave like
1022 // a sequential compiler for now. This'll likely be adjusted
1023 // in the future. Note that -Zthreads=0 is the way to get
1024 // the num_cpus behavior.
1025 threads: usize = (1, parse_threads, [UNTRACKED],
1026 "use a thread pool with N threads"),
1027 time: bool = (false, parse_bool, [UNTRACKED],
1028 "measure time of rustc processes (default: no)"),
1029 time_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1030 "measure time of each LLVM pass (default: no)"),
1031 time_passes: bool = (false, parse_bool, [UNTRACKED],
1032 "measure time of each rustc pass (default: no)"),
1033 tls_model: Option<TlsModel> = (None, parse_tls_model, [TRACKED],
1034 "choose the TLS model to use (`rustc --print tls-models` for details)"),
1035 trace_macros: bool = (false, parse_bool, [UNTRACKED],
1036 "for every macro invocation, print its name and arguments (default: no)"),
1037 treat_err_as_bug: Option<usize> = (None, parse_treat_err_as_bug, [TRACKED],
1038 "treat error number `val` that occurs as bug"),
1039 ui_testing: bool = (false, parse_bool, [UNTRACKED],
1040 "emit compiler diagnostics in a form suitable for UI testing (default: no)"),
1041 unleash_the_miri_inside_of_you: bool = (false, parse_bool, [TRACKED],
1042 "take the brakes off const evaluation. NOTE: this is unsound (default: no)"),
1043 unpretty: Option<String> = (None, parse_unpretty, [UNTRACKED],
1044 "present the input source, unstable (and less-pretty) variants;
1045 valid types are any of the types for `--pretty`, as well as:
1046 `expanded`, `expanded,identified`,
1047 `expanded,hygiene` (with internal representations),
1048 `everybody_loops` (all function bodies replaced with `loop {}`),
1049 `hir` (the HIR), `hir,identified`,
1050 `hir,typed` (HIR with types for each node),
1051 `hir-tree` (dump the raw HIR),
1052 `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)"),
1053 unstable_options: bool = (false, parse_bool, [UNTRACKED],
1054 "adds unstable command line options to rustc interface (default: no)"),
1055 use_ctors_section: Option<bool> = (None, parse_opt_bool, [TRACKED],
1056 "use legacy .ctors section for initializers rather than .init_array"),
1057 validate_mir: bool = (false, parse_bool, [UNTRACKED],
1058 "validate MIR after each transformation"),
1059 verbose: bool = (false, parse_bool, [UNTRACKED],
1060 "in general, enable more debug printouts (default: no)"),
1061 verify_llvm_ir: bool = (false, parse_bool, [TRACKED],
1062 "verify LLVM IR (default: no)"),
1064 // This list is in alphabetical order.
1066 // If you add a new option, please update:
1067 // - src/librustc_interface/tests.rs