1 // ignore-tidy-filelength
3 //! Contains infrastructure for configuring the compiler, including parsing
4 //! command line options.
8 use crate::session::{early_error, early_warn, Session};
9 use crate::session::search_paths::SearchPath;
11 use rustc_target::spec::{LinkerFlavor, MergeFunctions, PanicStrategy, RelroLevel};
12 use rustc_target::spec::{Target, TargetTriple};
14 use crate::middle::cstore;
17 use syntax::ast::{self, IntTy, UintTy, MetaItemKind};
18 use syntax::source_map::{FileName, FilePathMapping};
19 use syntax::edition::{Edition, EDITION_NAME_LIST, DEFAULT_EDITION};
20 use syntax::parse::token;
22 use syntax::symbol::{sym, Symbol};
23 use syntax::feature_gate::UnstableFeatures;
24 use errors::emitter::HumanReadableErrorType;
26 use errors::{ColorConfig, FatalError, Handler};
29 use std::collections::{BTreeMap, BTreeSet};
30 use std::collections::btree_map::Iter as BTreeMapIter;
31 use std::collections::btree_map::Keys as BTreeMapKeysIter;
32 use std::collections::btree_map::Values as BTreeMapValuesIter;
34 use rustc_data_structures::fx::FxHashSet;
36 use std::hash::Hasher;
37 use std::collections::hash_map::DefaultHasher;
38 use std::iter::FromIterator;
39 use std::path::{Path, PathBuf};
47 #[derive(Clone, Hash, Debug)]
55 #[derive(Clone, Copy, Debug, PartialEq, Hash)]
65 impl_stable_hash_via_hash!(OptLevel);
67 /// This is what the `LtoCli` values get mapped to after resolving defaults and
68 /// and taking other command line options into account.
69 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
71 /// Don't do any LTO whatsoever
74 /// Do a full crate graph LTO with ThinLTO
77 /// Do a local graph LTO with ThinLTO (only relevant for multiple codegen
81 /// Do a full crate graph LTO with "fat" LTO
85 /// The different settings that the `-C lto` flag can have.
86 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
98 /// No `-C lto` flag passed
102 #[derive(Clone, PartialEq, Hash)]
103 pub enum LinkerPluginLto {
104 LinkerPlugin(PathBuf),
109 impl LinkerPluginLto {
110 pub fn enabled(&self) -> bool {
112 LinkerPluginLto::LinkerPlugin(_) |
113 LinkerPluginLto::LinkerPluginAuto => true,
114 LinkerPluginLto::Disabled => false,
119 #[derive(Clone, PartialEq, Hash)]
120 pub enum PgoGenerate {
121 Enabled(Option<PathBuf>),
126 pub fn enabled(&self) -> bool {
128 PgoGenerate::Enabled(_) => true,
129 PgoGenerate::Disabled => false,
134 #[derive(Clone, Copy, PartialEq, Hash)]
141 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, PartialOrd, Ord, RustcEncodable, RustcDecodable)]
142 pub enum OutputType {
153 impl_stable_hash_via_hash!(OutputType);
156 fn is_compatible_with_codegen_units_and_single_output_file(&self) -> bool {
158 OutputType::Exe | OutputType::DepInfo | OutputType::Metadata => true,
160 | OutputType::Assembly
161 | OutputType::LlvmAssembly
163 | OutputType::Object => false,
167 fn shorthand(&self) -> &'static str {
169 OutputType::Bitcode => "llvm-bc",
170 OutputType::Assembly => "asm",
171 OutputType::LlvmAssembly => "llvm-ir",
172 OutputType::Mir => "mir",
173 OutputType::Object => "obj",
174 OutputType::Metadata => "metadata",
175 OutputType::Exe => "link",
176 OutputType::DepInfo => "dep-info",
180 fn from_shorthand(shorthand: &str) -> Option<Self> {
181 Some(match shorthand {
182 "asm" => OutputType::Assembly,
183 "llvm-ir" => OutputType::LlvmAssembly,
184 "mir" => OutputType::Mir,
185 "llvm-bc" => OutputType::Bitcode,
186 "obj" => OutputType::Object,
187 "metadata" => OutputType::Metadata,
188 "link" => OutputType::Exe,
189 "dep-info" => OutputType::DepInfo,
194 fn shorthands_display() -> String {
196 "`{}`, `{}`, `{}`, `{}`, `{}`, `{}`, `{}`, `{}`",
197 OutputType::Bitcode.shorthand(),
198 OutputType::Assembly.shorthand(),
199 OutputType::LlvmAssembly.shorthand(),
200 OutputType::Mir.shorthand(),
201 OutputType::Object.shorthand(),
202 OutputType::Metadata.shorthand(),
203 OutputType::Exe.shorthand(),
204 OutputType::DepInfo.shorthand(),
208 pub fn extension(&self) -> &'static str {
210 OutputType::Bitcode => "bc",
211 OutputType::Assembly => "s",
212 OutputType::LlvmAssembly => "ll",
213 OutputType::Mir => "mir",
214 OutputType::Object => "o",
215 OutputType::Metadata => "rmeta",
216 OutputType::DepInfo => "d",
217 OutputType::Exe => "",
222 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
223 pub enum ErrorOutputType {
224 HumanReadable(HumanReadableErrorType),
226 /// Render the json in a human readable way (with indents and newlines)
228 /// The way the `rendered` field is created
229 json_rendered: HumanReadableErrorType,
233 impl Default for ErrorOutputType {
234 fn default() -> ErrorOutputType {
235 ErrorOutputType::HumanReadable(HumanReadableErrorType::Default(ColorConfig::Auto))
239 // Use tree-based collections to cheaply get a deterministic Hash implementation.
240 // DO NOT switch BTreeMap out for an unsorted container type! That would break
241 // dependency tracking for command-line arguments.
242 #[derive(Clone, Hash)]
243 pub struct OutputTypes(BTreeMap<OutputType, Option<PathBuf>>);
245 impl_stable_hash_via_hash!(OutputTypes);
248 pub fn new(entries: &[(OutputType, Option<PathBuf>)]) -> OutputTypes {
249 OutputTypes(BTreeMap::from_iter(
250 entries.iter().map(|&(k, ref v)| (k, v.clone())),
254 pub fn get(&self, key: &OutputType) -> Option<&Option<PathBuf>> {
258 pub fn contains_key(&self, key: &OutputType) -> bool {
259 self.0.contains_key(key)
262 pub fn keys<'a>(&'a self) -> BTreeMapKeysIter<'a, OutputType, Option<PathBuf>> {
266 pub fn values<'a>(&'a self) -> BTreeMapValuesIter<'a, OutputType, Option<PathBuf>> {
270 pub fn len(&self) -> usize {
274 // True if any of the output types require codegen or linking.
275 pub fn should_codegen(&self) -> bool {
276 self.0.keys().any(|k| match *k {
278 | OutputType::Assembly
279 | OutputType::LlvmAssembly
282 | OutputType::Exe => true,
283 OutputType::Metadata | OutputType::DepInfo => false,
288 // Use tree-based collections to cheaply get a deterministic Hash implementation.
289 // DO NOT switch BTreeMap or BTreeSet out for an unsorted container type! That
290 // would break dependency tracking for command-line arguments.
291 #[derive(Clone, Hash)]
292 pub struct Externs(BTreeMap<String, ExternEntry>);
294 #[derive(Clone, Hash, Eq, PartialEq, Ord, PartialOrd, Debug, Default)]
295 pub struct ExternEntry {
296 pub locations: BTreeSet<Option<String>>,
297 pub is_private_dep: bool
301 pub fn new(data: BTreeMap<String, ExternEntry>) -> Externs {
305 pub fn get(&self, key: &str) -> Option<&ExternEntry> {
309 pub fn iter<'a>(&'a self) -> BTreeMapIter<'a, String, ExternEntry> {
315 macro_rules! hash_option {
316 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, [UNTRACKED]) => ({});
317 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, [TRACKED]) => ({
318 if $sub_hashes.insert(stringify!($opt_name),
319 $opt_expr as &dyn dep_tracking::DepTrackingHash).is_some() {
320 bug!("Duplicate key in CLI DepTrackingHash: {}", stringify!($opt_name))
326 [UNTRACKED_WITH_WARNING $warn_val:expr, $warn_text:expr, $error_format:expr]) => ({
327 if *$opt_expr == $warn_val {
328 early_warn($error_format, $warn_text)
333 macro_rules! top_level_options {
334 (pub struct Options { $(
335 $opt:ident : $t:ty [$dep_tracking_marker:ident $($warn_val:expr, $warn_text:expr)*],
343 pub fn dep_tracking_hash(&self) -> u64 {
344 let mut sub_hashes = BTreeMap::new();
349 [$dep_tracking_marker $($warn_val,
351 self.error_format)*]);
353 let mut hasher = DefaultHasher::new();
354 dep_tracking::stable_hash(sub_hashes,
363 // The top-level command-line options struct
365 // For each option, one has to specify how it behaves with regard to the
366 // dependency tracking system of incremental compilation. This is done via the
367 // square-bracketed directive after the field type. The options are:
370 // A change in the given field will cause the compiler to completely clear the
371 // incremental compilation cache before proceeding.
374 // Incremental compilation is not influenced by this option.
376 // [UNTRACKED_WITH_WARNING(val, warning)]
377 // The option is incompatible with incremental compilation in some way. If it
378 // has the value `val`, the string `warning` is emitted as a warning.
380 // If you add a new option to this struct or one of the sub-structs like
381 // CodegenOptions, think about how it influences incremental compilation. If in
382 // doubt, specify [TRACKED], which is always "correct" but might lead to
383 // unnecessary re-compilation.
386 // The crate config requested for the session, which may be combined
387 // with additional crate configurations during the compile process
388 crate_types: Vec<CrateType> [TRACKED],
389 optimize: OptLevel [TRACKED],
390 // Include the debug_assertions flag into dependency tracking, since it
391 // can influence whether overflow checks are done or not.
392 debug_assertions: bool [TRACKED],
393 debuginfo: DebugInfo [TRACKED],
394 lint_opts: Vec<(String, lint::Level)> [TRACKED],
395 lint_cap: Option<lint::Level> [TRACKED],
396 describe_lints: bool [UNTRACKED],
397 output_types: OutputTypes [TRACKED],
398 search_paths: Vec<SearchPath> [UNTRACKED],
399 libs: Vec<(String, Option<String>, Option<cstore::NativeLibraryKind>)> [TRACKED],
400 maybe_sysroot: Option<PathBuf> [TRACKED],
402 target_triple: TargetTriple [TRACKED],
404 test: bool [TRACKED],
405 error_format: ErrorOutputType [UNTRACKED],
407 // if Some, enable incremental compilation, using the given
408 // directory to store intermediate results
409 incremental: Option<PathBuf> [UNTRACKED],
411 debugging_opts: DebuggingOptions [TRACKED],
412 prints: Vec<PrintRequest> [UNTRACKED],
413 // Determines which borrow checker(s) to run. This is the parsed, sanitized
414 // version of `debugging_opts.borrowck`, which is just a plain string.
415 borrowck_mode: BorrowckMode [UNTRACKED],
416 cg: CodegenOptions [TRACKED],
417 externs: Externs [UNTRACKED],
418 crate_name: Option<String> [TRACKED],
419 // An optional name to use as the crate for std during std injection,
420 // written `extern crate name as std`. Defaults to `std`. Used by
421 // out-of-tree drivers.
422 alt_std_name: Option<String> [TRACKED],
423 // Indicates how the compiler should treat unstable features
424 unstable_features: UnstableFeatures [TRACKED],
426 // Indicates whether this run of the compiler is actually rustdoc. This
427 // is currently just a hack and will be removed eventually, so please
428 // try to not rely on this too much.
429 actually_rustdoc: bool [TRACKED],
431 // Specifications of codegen units / ThinLTO which are forced as a
432 // result of parsing command line options. These are not necessarily
433 // what rustc was invoked with, but massaged a bit to agree with
434 // commands like `--emit llvm-ir` which they're often incompatible with
435 // if we otherwise use the defaults of rustc.
436 cli_forced_codegen_units: Option<usize> [UNTRACKED],
437 cli_forced_thinlto_off: bool [UNTRACKED],
439 // Remap source path prefixes in all output (messages, object files, debug, etc)
440 remap_path_prefix: Vec<(PathBuf, PathBuf)> [UNTRACKED],
442 edition: Edition [TRACKED],
446 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
447 pub enum PrintRequest {
462 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
463 pub enum BorrowckMode {
469 /// Should we run the MIR-based borrow check, but also fall back
470 /// on the AST borrow check if the MIR-based one errors.
471 pub fn migrate(self) -> bool {
473 BorrowckMode::Mir => false,
474 BorrowckMode::Migrate => true,
478 /// Should we emit the AST-based borrow checker errors?
479 pub fn use_ast(self) -> bool {
481 BorrowckMode::Mir => false,
482 BorrowckMode::Migrate => false,
488 /// Loads source from file
491 /// String that is shown in place of a filename
493 /// Anonymous source string
499 pub fn filestem(&self) -> &str {
501 Input::File(ref ifile) => ifile.file_stem().unwrap().to_str().unwrap(),
502 Input::Str { .. } => "rust_out",
506 pub fn get_input(&mut self) -> Option<&mut String> {
508 Input::File(_) => None,
509 Input::Str { ref mut input, .. } => Some(input),
513 pub fn source_name(&self) -> FileName {
515 Input::File(ref ifile) => ifile.clone().into(),
516 Input::Str { ref name, .. } => name.clone(),
521 #[derive(Clone, Hash)]
522 pub struct OutputFilenames {
523 pub out_directory: PathBuf,
524 pub out_filestem: String,
525 pub single_output_file: Option<PathBuf>,
527 pub outputs: OutputTypes,
530 impl_stable_hash_via_hash!(OutputFilenames);
532 pub const RUST_CGU_EXT: &str = "rcgu";
534 impl OutputFilenames {
535 pub fn path(&self, flavor: OutputType) -> PathBuf {
538 .and_then(|p| p.to_owned())
539 .or_else(|| self.single_output_file.clone())
540 .unwrap_or_else(|| self.temp_path(flavor, None))
543 /// Gets the path where a compilation artifact of the given type for the
544 /// given codegen unit should be placed on disk. If codegen_unit_name is
545 /// None, a path distinct from those of any codegen unit will be generated.
546 pub fn temp_path(&self, flavor: OutputType, codegen_unit_name: Option<&str>) -> PathBuf {
547 let extension = flavor.extension();
548 self.temp_path_ext(extension, codegen_unit_name)
551 /// Like temp_path, but also supports things where there is no corresponding
552 /// OutputType, like noopt-bitcode or lto-bitcode.
553 pub fn temp_path_ext(&self, ext: &str, codegen_unit_name: Option<&str>) -> PathBuf {
554 let base = self.out_directory.join(&self.filestem());
556 let mut extension = String::new();
558 if let Some(codegen_unit_name) = codegen_unit_name {
559 extension.push_str(codegen_unit_name);
563 if !extension.is_empty() {
564 extension.push_str(".");
565 extension.push_str(RUST_CGU_EXT);
566 extension.push_str(".");
569 extension.push_str(ext);
572 let path = base.with_extension(&extension[..]);
576 pub fn with_extension(&self, extension: &str) -> PathBuf {
578 .join(&self.filestem())
579 .with_extension(extension)
582 pub fn filestem(&self) -> String {
583 format!("{}{}", self.out_filestem, self.extra)
587 pub fn host_triple() -> &'static str {
588 // Get the host triple out of the build environment. This ensures that our
589 // idea of the host triple is the same as for the set of libraries we've
590 // actually built. We can't just take LLVM's host triple because they
591 // normalize all ix86 architectures to i386.
593 // Instead of grabbing the host triple (for the current host), we grab (at
594 // compile time) the target triple that this rustc is built with and
595 // calling that (at runtime) the host triple.
596 (option_env!("CFG_COMPILER_HOST_TRIPLE")).expect("CFG_COMPILER_HOST_TRIPLE")
599 impl Default for Options {
600 fn default() -> Options {
602 crate_types: Vec::new(),
603 optimize: OptLevel::No,
604 debuginfo: DebugInfo::None,
605 lint_opts: Vec::new(),
607 describe_lints: false,
608 output_types: OutputTypes(BTreeMap::new()),
609 search_paths: vec![],
611 target_triple: TargetTriple::from_triple(host_triple()),
614 debugging_opts: basic_debugging_options(),
616 borrowck_mode: BorrowckMode::Migrate,
617 cg: basic_codegen_options(),
618 error_format: ErrorOutputType::default(),
619 externs: Externs(BTreeMap::new()),
623 unstable_features: UnstableFeatures::Disallow,
624 debug_assertions: true,
625 actually_rustdoc: false,
626 cli_forced_codegen_units: None,
627 cli_forced_thinlto_off: false,
628 remap_path_prefix: Vec::new(),
629 edition: DEFAULT_EDITION,
635 /// Returns `true` if there is a reason to build the dep graph.
636 pub fn build_dep_graph(&self) -> bool {
637 self.incremental.is_some() || self.debugging_opts.dump_dep_graph
638 || self.debugging_opts.query_dep_graph
642 pub fn enable_dep_node_debug_strs(&self) -> bool {
643 cfg!(debug_assertions)
644 && (self.debugging_opts.query_dep_graph || self.debugging_opts.incremental_info)
647 pub fn file_path_mapping(&self) -> FilePathMapping {
648 FilePathMapping::new(self.remap_path_prefix.clone())
651 /// Returns `true` if there will be an output file generated
652 pub fn will_create_output_file(&self) -> bool {
653 !self.debugging_opts.parse_only && // The file is just being parsed
654 !self.debugging_opts.ls // The file is just being queried
658 pub fn share_generics(&self) -> bool {
659 match self.debugging_opts.share_generics {
660 Some(setting) => setting,
662 match self.optimize {
666 OptLevel::SizeMin => true,
668 OptLevel::Aggressive => false,
675 // The type of entry function, so users can have their own entry functions
676 #[derive(Copy, Clone, PartialEq, Hash, Debug)]
677 pub enum EntryFnType {
682 impl_stable_hash_via_hash!(EntryFnType);
684 #[derive(Copy, PartialEq, PartialOrd, Clone, Ord, Eq, Hash, Debug)]
694 #[derive(Clone, Hash)]
701 pub fn is_empty(&self) -> bool {
703 Passes::Some(ref v) => v.is_empty(),
704 Passes::All => false,
709 /// Declare a macro that will define all CodegenOptions/DebuggingOptions fields and parsers all
710 /// at once. The goal of this macro is to define an interface that can be
711 /// programmatically used by the option parser in order to initialize the struct
712 /// without hardcoding field names all over the place.
714 /// The goal is to invoke this macro once with the correct fields, and then this
715 /// macro generates all necessary code. The main gotcha of this macro is the
716 /// cgsetters module which is a bunch of generated code to parse an option into
717 /// its respective field in the struct. There are a few hand-written parsers for
718 /// parsing specific types of values in this module.
719 macro_rules! options {
720 ($struct_name:ident, $setter_name:ident, $defaultfn:ident,
721 $buildfn:ident, $prefix:expr, $outputname:expr,
722 $stat:ident, $mod_desc:ident, $mod_set:ident,
723 $($opt:ident : $t:ty = (
726 [$dep_tracking_marker:ident $(($dep_warn_val:expr, $dep_warn_text:expr))*],
731 pub struct $struct_name { $(pub $opt: $t),* }
733 pub fn $defaultfn() -> $struct_name {
734 $struct_name { $($opt: $init),* }
737 pub fn $buildfn(matches: &getopts::Matches, error_format: ErrorOutputType) -> $struct_name
739 let mut op = $defaultfn();
740 for option in matches.opt_strs($prefix) {
741 let mut iter = option.splitn(2, '=');
742 let key = iter.next().unwrap();
743 let value = iter.next();
744 let option_to_lookup = key.replace("-", "_");
745 let mut found = false;
746 for &(candidate, setter, opt_type_desc, _) in $stat {
747 if option_to_lookup != candidate { continue }
748 if !setter(&mut op, value) {
749 match (value, opt_type_desc) {
750 (Some(..), None) => {
751 early_error(error_format, &format!("{} option `{}` takes no \
752 value", $outputname, key))
754 (None, Some(type_desc)) => {
755 early_error(error_format, &format!("{0} option `{1}` requires \
756 {2} ({3} {1}=<value>)",
760 (Some(value), Some(type_desc)) => {
761 early_error(error_format, &format!("incorrect value `{}` for {} \
762 option `{}` - {} was expected",
766 (None, None) => bug!()
773 early_error(error_format, &format!("unknown {} option: `{}`",
780 impl<'a> dep_tracking::DepTrackingHash for $struct_name {
781 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
782 let mut sub_hashes = BTreeMap::new();
787 [$dep_tracking_marker $($dep_warn_val,
791 dep_tracking::stable_hash(sub_hashes, hasher, error_format);
795 pub type $setter_name = fn(&mut $struct_name, v: Option<&str>) -> bool;
796 pub const $stat: &[(&str, $setter_name, Option<&str>, &str)] =
797 &[ $( (stringify!($opt), $mod_set::$opt, $mod_desc::$parse, $desc) ),* ];
799 #[allow(non_upper_case_globals, dead_code)]
801 pub const parse_bool: Option<&str> = None;
802 pub const parse_opt_bool: Option<&str> =
803 Some("one of: `y`, `yes`, `on`, `n`, `no`, or `off`");
804 pub const parse_string: Option<&str> = Some("a string");
805 pub const parse_string_push: Option<&str> = Some("a string");
806 pub const parse_pathbuf_push: Option<&str> = Some("a path");
807 pub const parse_opt_string: Option<&str> = Some("a string");
808 pub const parse_opt_pathbuf: Option<&str> = Some("a path");
809 pub const parse_list: Option<&str> = Some("a space-separated list of strings");
810 pub const parse_opt_list: Option<&str> = Some("a space-separated list of strings");
811 pub const parse_opt_comma_list: Option<&str> = Some("a comma-separated list of strings");
812 pub const parse_uint: Option<&str> = Some("a number");
813 pub const parse_passes: Option<&str> =
814 Some("a space-separated list of passes, or `all`");
815 pub const parse_opt_uint: Option<&str> =
817 pub const parse_panic_strategy: Option<&str> =
818 Some("either `unwind` or `abort`");
819 pub const parse_relro_level: Option<&str> =
820 Some("one of: `full`, `partial`, or `off`");
821 pub const parse_sanitizer: Option<&str> =
822 Some("one of: `address`, `leak`, `memory` or `thread`");
823 pub const parse_linker_flavor: Option<&str> =
824 Some(::rustc_target::spec::LinkerFlavor::one_of());
825 pub const parse_optimization_fuel: Option<&str> =
826 Some("crate=integer");
827 pub const parse_unpretty: Option<&str> =
828 Some("`string` or `string=string`");
829 pub const parse_treat_err_as_bug: Option<&str> =
830 Some("either no value or a number bigger than 0");
831 pub const parse_lto: Option<&str> =
832 Some("either a boolean (`yes`, `no`, `on`, `off`, etc), `thin`, \
834 pub const parse_linker_plugin_lto: Option<&str> =
835 Some("either a boolean (`yes`, `no`, `on`, `off`, etc), \
836 or the path to the linker plugin");
837 pub const parse_pgo_generate: Option<&str> =
838 Some("an optional path to the profiling data output directory");
839 pub const parse_merge_functions: Option<&str> =
840 Some("one of: `disabled`, `trampolines`, or `aliases`");
845 use super::{$struct_name, Passes, Sanitizer, LtoCli, LinkerPluginLto, PgoGenerate};
846 use rustc_target::spec::{LinkerFlavor, MergeFunctions, PanicStrategy, RelroLevel};
847 use std::path::PathBuf;
848 use std::str::FromStr;
851 pub fn $opt(cg: &mut $struct_name, v: Option<&str>) -> bool {
852 $parse(&mut cg.$opt, v)
856 fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
859 None => { *slot = true; true }
863 fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
867 "n" | "no" | "off" => {
870 "y" | "yes" | "on" => {
873 _ => { return false; }
878 None => { *slot = Some(true); true }
882 fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
884 Some(s) => { *slot = Some(s.to_string()); true },
889 fn parse_opt_pathbuf(slot: &mut Option<PathBuf>, v: Option<&str>) -> bool {
891 Some(s) => { *slot = Some(PathBuf::from(s)); true },
896 fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
898 Some(s) => { *slot = s.to_string(); true },
903 fn parse_string_push(slot: &mut Vec<String>, v: Option<&str>) -> bool {
905 Some(s) => { slot.push(s.to_string()); true },
910 fn parse_pathbuf_push(slot: &mut Vec<PathBuf>, v: Option<&str>) -> bool {
912 Some(s) => { slot.push(PathBuf::from(s)); true },
917 fn parse_list(slot: &mut Vec<String>, v: Option<&str>)
921 slot.extend(s.split_whitespace().map(|s| s.to_string()));
928 fn parse_opt_list(slot: &mut Option<Vec<String>>, v: Option<&str>)
932 let v = s.split_whitespace().map(|s| s.to_string()).collect();
940 fn parse_opt_comma_list(slot: &mut Option<Vec<String>>, v: Option<&str>)
944 let v = s.split(',').map(|s| s.to_string()).collect();
952 fn parse_uint(slot: &mut usize, v: Option<&str>) -> bool {
953 match v.and_then(|s| s.parse().ok()) {
954 Some(i) => { *slot = i; true },
959 fn parse_opt_uint(slot: &mut Option<usize>, v: Option<&str>) -> bool {
961 Some(s) => { *slot = s.parse().ok(); slot.is_some() }
962 None => { *slot = None; false }
966 fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
973 let mut passes = vec![];
974 if parse_list(&mut passes, v) {
975 *slot = Passes::Some(passes);
984 fn parse_panic_strategy(slot: &mut Option<PanicStrategy>, v: Option<&str>) -> bool {
986 Some("unwind") => *slot = Some(PanicStrategy::Unwind),
987 Some("abort") => *slot = Some(PanicStrategy::Abort),
993 fn parse_relro_level(slot: &mut Option<RelroLevel>, v: Option<&str>) -> bool {
996 match s.parse::<RelroLevel>() {
997 Ok(level) => *slot = Some(level),
1006 fn parse_sanitizer(slote: &mut Option<Sanitizer>, v: Option<&str>) -> bool {
1008 Some("address") => *slote = Some(Sanitizer::Address),
1009 Some("leak") => *slote = Some(Sanitizer::Leak),
1010 Some("memory") => *slote = Some(Sanitizer::Memory),
1011 Some("thread") => *slote = Some(Sanitizer::Thread),
1017 fn parse_linker_flavor(slote: &mut Option<LinkerFlavor>, v: Option<&str>) -> bool {
1018 match v.and_then(LinkerFlavor::from_str) {
1019 Some(lf) => *slote = Some(lf),
1025 fn parse_optimization_fuel(slot: &mut Option<(String, u64)>, v: Option<&str>) -> bool {
1029 let parts = s.split('=').collect::<Vec<_>>();
1030 if parts.len() != 2 { return false; }
1031 let crate_name = parts[0].to_string();
1032 let fuel = parts[1].parse::<u64>();
1033 if fuel.is_err() { return false; }
1034 *slot = Some((crate_name, fuel.unwrap()));
1040 fn parse_unpretty(slot: &mut Option<String>, v: Option<&str>) -> bool {
1043 Some(s) if s.split('=').count() <= 2 => {
1044 *slot = Some(s.to_string());
1051 fn parse_treat_err_as_bug(slot: &mut Option<usize>, v: Option<&str>) -> bool {
1053 Some(s) => { *slot = s.parse().ok().filter(|&x| x != 0); slot.unwrap_or(0) != 0 }
1054 None => { *slot = Some(1); true }
1058 fn parse_lto(slot: &mut LtoCli, v: Option<&str>) -> bool {
1060 let mut bool_arg = None;
1061 if parse_opt_bool(&mut bool_arg, v) {
1062 *slot = if bool_arg.unwrap() {
1072 None => LtoCli::NoParam,
1073 Some("thin") => LtoCli::Thin,
1074 Some("fat") => LtoCli::Fat,
1075 Some(_) => return false,
1080 fn parse_linker_plugin_lto(slot: &mut LinkerPluginLto, v: Option<&str>) -> bool {
1082 let mut bool_arg = None;
1083 if parse_opt_bool(&mut bool_arg, v) {
1084 *slot = if bool_arg.unwrap() {
1085 LinkerPluginLto::LinkerPluginAuto
1087 LinkerPluginLto::Disabled
1094 None => LinkerPluginLto::LinkerPluginAuto,
1095 Some(path) => LinkerPluginLto::LinkerPlugin(PathBuf::from(path)),
1100 fn parse_pgo_generate(slot: &mut PgoGenerate, v: Option<&str>) -> bool {
1102 None => PgoGenerate::Enabled(None),
1103 Some(path) => PgoGenerate::Enabled(Some(PathBuf::from(path))),
1108 fn parse_merge_functions(slot: &mut Option<MergeFunctions>, v: Option<&str>) -> bool {
1109 match v.and_then(|s| MergeFunctions::from_str(s).ok()) {
1110 Some(mergefunc) => *slot = Some(mergefunc),
1118 options! {CodegenOptions, CodegenSetter, basic_codegen_options,
1119 build_codegen_options, "C", "codegen",
1120 CG_OPTIONS, cg_type_desc, cgsetters,
1121 ar: Option<String> = (None, parse_opt_string, [UNTRACKED],
1122 "this option is deprecated and does nothing"),
1123 linker: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1124 "system linker to link outputs with"),
1125 link_arg: Vec<String> = (vec![], parse_string_push, [UNTRACKED],
1126 "a single extra argument to append to the linker invocation (can be used several times)"),
1127 link_args: Option<Vec<String>> = (None, parse_opt_list, [UNTRACKED],
1128 "extra arguments to append to the linker invocation (space separated)"),
1129 link_dead_code: bool = (false, parse_bool, [UNTRACKED],
1130 "don't let linker strip dead code (turning it on can be used for code coverage)"),
1131 lto: LtoCli = (LtoCli::Unspecified, parse_lto, [TRACKED],
1132 "perform LLVM link-time optimizations"),
1133 target_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1134 "select target processor (rustc --print target-cpus for details)"),
1135 target_feature: String = (String::new(), parse_string, [TRACKED],
1136 "target specific attributes (rustc --print target-features for details)"),
1137 passes: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1138 "a list of extra LLVM passes to run (space separated)"),
1139 llvm_args: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1140 "a list of arguments to pass to llvm (space separated)"),
1141 save_temps: bool = (false, parse_bool, [UNTRACKED_WITH_WARNING(true,
1142 "`-C save-temps` might not produce all requested temporary products \
1143 when incremental compilation is enabled.")],
1144 "save all temporary output files during compilation"),
1145 rpath: bool = (false, parse_bool, [UNTRACKED],
1146 "set rpath values in libs/exes"),
1147 overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1148 "use overflow checks for integer arithmetic"),
1149 no_prepopulate_passes: bool = (false, parse_bool, [TRACKED],
1150 "don't pre-populate the pass manager with a list of passes"),
1151 no_vectorize_loops: bool = (false, parse_bool, [TRACKED],
1152 "don't run the loop vectorization optimization passes"),
1153 no_vectorize_slp: bool = (false, parse_bool, [TRACKED],
1154 "don't run LLVM's SLP vectorization pass"),
1155 soft_float: bool = (false, parse_bool, [TRACKED],
1156 "use soft float ABI (*eabihf targets only)"),
1157 prefer_dynamic: bool = (false, parse_bool, [TRACKED],
1158 "prefer dynamic linking to static linking"),
1159 no_integrated_as: bool = (false, parse_bool, [TRACKED],
1160 "use an external assembler rather than LLVM's integrated one"),
1161 no_redzone: Option<bool> = (None, parse_opt_bool, [TRACKED],
1162 "disable the use of the redzone"),
1163 relocation_model: Option<String> = (None, parse_opt_string, [TRACKED],
1164 "choose the relocation model to use (rustc --print relocation-models for details)"),
1165 code_model: Option<String> = (None, parse_opt_string, [TRACKED],
1166 "choose the code model to use (rustc --print code-models for details)"),
1167 metadata: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1168 "metadata to mangle symbol names with"),
1169 extra_filename: String = (String::new(), parse_string, [UNTRACKED],
1170 "extra data to put in each output filename"),
1171 codegen_units: Option<usize> = (None, parse_opt_uint, [UNTRACKED],
1172 "divide crate into N units to optimize in parallel"),
1173 remark: Passes = (Passes::Some(Vec::new()), parse_passes, [UNTRACKED],
1174 "print remarks for these optimization passes (space separated, or \"all\")"),
1175 no_stack_check: bool = (false, parse_bool, [UNTRACKED],
1176 "the --no-stack-check flag is deprecated and does nothing"),
1177 debuginfo: Option<usize> = (None, parse_opt_uint, [TRACKED],
1178 "debug info emission level, 0 = no debug info, 1 = line tables only, \
1179 2 = full debug info with variable and type information"),
1180 opt_level: Option<String> = (None, parse_opt_string, [TRACKED],
1181 "optimize with possible levels 0-3, s, or z"),
1182 force_frame_pointers: Option<bool> = (None, parse_opt_bool, [TRACKED],
1183 "force use of the frame pointers"),
1184 debug_assertions: Option<bool> = (None, parse_opt_bool, [TRACKED],
1185 "explicitly enable the cfg(debug_assertions) directive"),
1186 inline_threshold: Option<usize> = (None, parse_opt_uint, [TRACKED],
1187 "set the threshold for inlining a function (default: 225)"),
1188 panic: Option<PanicStrategy> = (None, parse_panic_strategy,
1189 [TRACKED], "panic strategy to compile crate with"),
1190 incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
1191 "enable incremental compilation"),
1192 default_linker_libraries: Option<bool> = (None, parse_opt_bool, [UNTRACKED],
1193 "allow the linker to link its default libraries"),
1194 linker_flavor: Option<LinkerFlavor> = (None, parse_linker_flavor, [UNTRACKED],
1196 linker_plugin_lto: LinkerPluginLto = (LinkerPluginLto::Disabled,
1197 parse_linker_plugin_lto, [TRACKED],
1198 "generate build artifacts that are compatible with linker-based LTO."),
1202 options! {DebuggingOptions, DebuggingSetter, basic_debugging_options,
1203 build_debugging_options, "Z", "debugging",
1204 DB_OPTIONS, db_type_desc, dbsetters,
1205 codegen_backend: Option<String> = (None, parse_opt_string, [TRACKED],
1206 "the backend to use"),
1207 verbose: bool = (false, parse_bool, [UNTRACKED],
1208 "in general, enable more debug printouts"),
1209 span_free_formats: bool = (false, parse_bool, [UNTRACKED],
1210 "when debug-printing compiler state, do not include spans"), // o/w tests have closure@path
1211 identify_regions: bool = (false, parse_bool, [UNTRACKED],
1212 "make unnamed regions display as '# (where # is some non-ident unique id)"),
1213 borrowck: Option<String> = (None, parse_opt_string, [UNTRACKED],
1214 "select which borrowck is used (`mir` or `migrate`)"),
1215 time_passes: bool = (false, parse_bool, [UNTRACKED],
1216 "measure time of each rustc pass"),
1217 time: bool = (false, parse_bool, [UNTRACKED],
1218 "measure time of rustc processes"),
1219 count_llvm_insns: bool = (false, parse_bool,
1220 [UNTRACKED_WITH_WARNING(true,
1221 "The output generated by `-Z count_llvm_insns` might not be reliable \
1222 when used with incremental compilation")],
1223 "count where LLVM instrs originate"),
1224 time_llvm_passes: bool = (false, parse_bool, [UNTRACKED_WITH_WARNING(true,
1225 "The output of `-Z time-llvm-passes` will only reflect timings of \
1226 re-codegened modules when used with incremental compilation" )],
1227 "measure time of each LLVM pass"),
1228 input_stats: bool = (false, parse_bool, [UNTRACKED],
1229 "gather statistics about the input"),
1230 codegen_stats: bool = (false, parse_bool, [UNTRACKED_WITH_WARNING(true,
1231 "The output of `-Z codegen-stats` might not be accurate when incremental \
1232 compilation is enabled")],
1233 "gather codegen statistics"),
1234 asm_comments: bool = (false, parse_bool, [TRACKED],
1235 "generate comments into the assembly (may change behavior)"),
1236 verify_llvm_ir: bool = (false, parse_bool, [TRACKED],
1238 borrowck_stats: bool = (false, parse_bool, [UNTRACKED],
1239 "gather borrowck statistics"),
1240 no_landing_pads: bool = (false, parse_bool, [TRACKED],
1241 "omit landing pads for unwinding"),
1242 fewer_names: bool = (false, parse_bool, [TRACKED],
1243 "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR)"),
1244 meta_stats: bool = (false, parse_bool, [UNTRACKED],
1245 "gather metadata statistics"),
1246 print_link_args: bool = (false, parse_bool, [UNTRACKED],
1247 "print the arguments passed to the linker"),
1248 print_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1249 "prints the llvm optimization passes being run"),
1250 ast_json: bool = (false, parse_bool, [UNTRACKED],
1251 "print the AST as JSON and halt"),
1252 threads: Option<usize> = (None, parse_opt_uint, [UNTRACKED],
1253 "use a thread pool with N threads"),
1254 ast_json_noexpand: bool = (false, parse_bool, [UNTRACKED],
1255 "print the pre-expansion AST as JSON and halt"),
1256 ls: bool = (false, parse_bool, [UNTRACKED],
1257 "list the symbols defined by a library crate"),
1258 save_analysis: bool = (false, parse_bool, [UNTRACKED],
1259 "write syntax and type analysis (in JSON format) information, in \
1260 addition to normal output"),
1261 flowgraph_print_loans: bool = (false, parse_bool, [UNTRACKED],
1262 "include loan analysis data in -Z unpretty flowgraph output"),
1263 flowgraph_print_moves: bool = (false, parse_bool, [UNTRACKED],
1264 "include move analysis data in -Z unpretty flowgraph output"),
1265 flowgraph_print_assigns: bool = (false, parse_bool, [UNTRACKED],
1266 "include assignment analysis data in -Z unpretty flowgraph output"),
1267 flowgraph_print_all: bool = (false, parse_bool, [UNTRACKED],
1268 "include all dataflow analysis data in -Z unpretty flowgraph output"),
1269 print_region_graph: bool = (false, parse_bool, [UNTRACKED],
1270 "prints region inference graph. \
1271 Use with RUST_REGION_GRAPH=help for more info"),
1272 parse_only: bool = (false, parse_bool, [UNTRACKED],
1273 "parse only; do not compile, assemble, or link"),
1274 dual_proc_macros: bool = (false, parse_bool, [TRACKED],
1275 "load proc macros for both target and host, but only link to the target"),
1276 no_codegen: bool = (false, parse_bool, [TRACKED],
1277 "run all passes except codegen; no output"),
1278 treat_err_as_bug: Option<usize> = (None, parse_treat_err_as_bug, [TRACKED],
1279 "treat error number `val` that occurs as bug"),
1280 report_delayed_bugs: bool = (false, parse_bool, [TRACKED],
1281 "immediately print bugs registered with `delay_span_bug`"),
1282 external_macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1283 "show macro backtraces even for non-local macros"),
1284 teach: bool = (false, parse_bool, [TRACKED],
1285 "show extended diagnostic help"),
1286 continue_parse_after_error: bool = (false, parse_bool, [TRACKED],
1287 "attempt to recover from parse errors (experimental)"),
1288 dep_tasks: bool = (false, parse_bool, [UNTRACKED],
1289 "print tasks that execute and the color their dep node gets (requires debug build)"),
1290 incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
1291 "enable incremental compilation (experimental)"),
1292 incremental_queries: bool = (true, parse_bool, [UNTRACKED],
1293 "enable incremental compilation support for queries (experimental)"),
1294 incremental_info: bool = (false, parse_bool, [UNTRACKED],
1295 "print high-level information about incremental reuse (or the lack thereof)"),
1296 incremental_dump_hash: bool = (false, parse_bool, [UNTRACKED],
1297 "dump hash information in textual format to stdout"),
1298 incremental_verify_ich: bool = (false, parse_bool, [UNTRACKED],
1299 "verify incr. comp. hashes of green query instances"),
1300 incremental_ignore_spans: bool = (false, parse_bool, [UNTRACKED],
1301 "ignore spans during ICH computation -- used for testing"),
1302 instrument_mcount: bool = (false, parse_bool, [TRACKED],
1303 "insert function instrument code for mcount-based tracing"),
1304 dump_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1305 "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv)"),
1306 query_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1307 "enable queries of the dependency graph for regression testing"),
1308 profile_queries: bool = (false, parse_bool, [UNTRACKED],
1309 "trace and profile the queries of the incremental compilation framework"),
1310 profile_queries_and_keys: bool = (false, parse_bool, [UNTRACKED],
1311 "trace and profile the queries and keys of the incremental compilation framework"),
1312 no_analysis: bool = (false, parse_bool, [UNTRACKED],
1313 "parse and expand the source, but run no analysis"),
1314 extra_plugins: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1315 "load extra plugins"),
1316 unstable_options: bool = (false, parse_bool, [UNTRACKED],
1317 "adds unstable command line options to rustc interface"),
1318 force_overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1319 "force overflow checks on or off"),
1320 trace_macros: bool = (false, parse_bool, [UNTRACKED],
1321 "for every macro invocation, print its name and arguments"),
1322 debug_macros: bool = (false, parse_bool, [TRACKED],
1323 "emit line numbers debug info inside macros"),
1324 keep_hygiene_data: bool = (false, parse_bool, [UNTRACKED],
1325 "don't clear the hygiene data after analysis"),
1326 keep_ast: bool = (false, parse_bool, [UNTRACKED],
1327 "keep the AST after lowering it to HIR"),
1328 show_span: Option<String> = (None, parse_opt_string, [TRACKED],
1329 "show spans for compiler debugging (expr|pat|ty)"),
1330 print_type_sizes: bool = (false, parse_bool, [UNTRACKED],
1331 "print layout information for each type encountered"),
1332 print_mono_items: Option<String> = (None, parse_opt_string, [UNTRACKED],
1333 "print the result of the monomorphization collection pass"),
1334 mir_opt_level: usize = (1, parse_uint, [TRACKED],
1335 "set the MIR optimization level (0-3, default: 1)"),
1336 mutable_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1337 "emit noalias metadata for mutable references (default: yes on LLVM >= 6)"),
1338 dump_mir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1339 "dump MIR state to file.
1340 `val` is used to select which passes and functions to dump. For example:
1341 `all` matches all passes and functions,
1342 `foo` matches all passes for functions whose name contains 'foo',
1343 `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
1344 `foo | bar` all passes for function names containing 'foo' or 'bar'."),
1346 dump_mir_dir: String = (String::from("mir_dump"), parse_string, [UNTRACKED],
1347 "the directory the MIR is dumped into"),
1348 dump_mir_graphviz: bool = (false, parse_bool, [UNTRACKED],
1349 "in addition to `.mir` files, create graphviz `.dot` files"),
1350 dump_mir_exclude_pass_number: bool = (false, parse_bool, [UNTRACKED],
1351 "if set, exclude the pass number when dumping MIR (used in tests)"),
1352 mir_emit_retag: bool = (false, parse_bool, [TRACKED],
1353 "emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0"),
1354 perf_stats: bool = (false, parse_bool, [UNTRACKED],
1355 "print some performance-related statistics"),
1356 query_stats: bool = (false, parse_bool, [UNTRACKED],
1357 "print some statistics about the query system"),
1358 hir_stats: bool = (false, parse_bool, [UNTRACKED],
1359 "print some statistics about AST and HIR"),
1360 always_encode_mir: bool = (false, parse_bool, [TRACKED],
1361 "encode MIR of all functions into the crate metadata"),
1362 json_rendered: Option<String> = (None, parse_opt_string, [UNTRACKED],
1363 "describes how to render the `rendered` field of json diagnostics"),
1364 unleash_the_miri_inside_of_you: bool = (false, parse_bool, [TRACKED],
1365 "take the breaks off const evaluation. NOTE: this is unsound"),
1366 osx_rpath_install_name: bool = (false, parse_bool, [TRACKED],
1367 "pass `-install_name @rpath/...` to the macOS linker"),
1368 sanitizer: Option<Sanitizer> = (None, parse_sanitizer, [TRACKED],
1370 fuel: Option<(String, u64)> = (None, parse_optimization_fuel, [TRACKED],
1371 "set the optimization fuel quota for a crate"),
1372 print_fuel: Option<String> = (None, parse_opt_string, [TRACKED],
1373 "make Rustc print the total optimization fuel used by a crate"),
1374 force_unstable_if_unmarked: bool = (false, parse_bool, [TRACKED],
1375 "force all crates to be `rustc_private` unstable"),
1376 pre_link_arg: Vec<String> = (vec![], parse_string_push, [UNTRACKED],
1377 "a single extra argument to prepend the linker invocation (can be used several times)"),
1378 pre_link_args: Option<Vec<String>> = (None, parse_opt_list, [UNTRACKED],
1379 "extra arguments to prepend to the linker invocation (space separated)"),
1380 profile: bool = (false, parse_bool, [TRACKED],
1381 "insert profiling code"),
1382 pgo_gen: PgoGenerate = (PgoGenerate::Disabled, parse_pgo_generate, [TRACKED],
1383 "Generate PGO profile data, to a given file, or to the default location if it's empty."),
1384 pgo_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1385 "Use PGO profile data from the given profile file."),
1386 disable_instrumentation_preinliner: bool = (false, parse_bool, [TRACKED],
1387 "Disable the instrumentation pre-inliner, useful for profiling / PGO."),
1388 relro_level: Option<RelroLevel> = (None, parse_relro_level, [TRACKED],
1389 "choose which RELRO level to use"),
1390 nll_facts: bool = (false, parse_bool, [UNTRACKED],
1391 "dump facts from NLL analysis into side files"),
1392 nll_dont_emit_read_for_match: bool = (false, parse_bool, [UNTRACKED],
1393 "in match codegen, do not include FakeRead statements (used by mir-borrowck)"),
1394 dont_buffer_diagnostics: bool = (false, parse_bool, [UNTRACKED],
1395 "emit diagnostics rather than buffering (breaks NLL error downgrading, sorting)."),
1396 polonius: bool = (false, parse_bool, [UNTRACKED],
1397 "enable polonius-based borrow-checker"),
1398 codegen_time_graph: bool = (false, parse_bool, [UNTRACKED],
1399 "generate a graphical HTML report of time spent in codegen and LLVM"),
1400 thinlto: Option<bool> = (None, parse_opt_bool, [TRACKED],
1401 "enable ThinLTO when possible"),
1402 inline_in_all_cgus: Option<bool> = (None, parse_opt_bool, [TRACKED],
1403 "control whether #[inline] functions are in all cgus"),
1404 tls_model: Option<String> = (None, parse_opt_string, [TRACKED],
1405 "choose the TLS model to use (rustc --print tls-models for details)"),
1406 saturating_float_casts: bool = (false, parse_bool, [TRACKED],
1407 "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
1408 the max/min integer respectively, and NaN is mapped to 0"),
1409 lower_128bit_ops: Option<bool> = (None, parse_opt_bool, [TRACKED],
1410 "rewrite operators on i128 and u128 into lang item calls (typically provided \
1411 by compiler-builtins) so codegen doesn't need to support them,
1412 overriding the default for the current target"),
1413 human_readable_cgu_names: bool = (false, parse_bool, [TRACKED],
1414 "generate human-readable, predictable names for codegen units"),
1415 dep_info_omit_d_target: bool = (false, parse_bool, [TRACKED],
1416 "in dep-info output, omit targets for tracking dependencies of the dep-info files \
1418 unpretty: Option<String> = (None, parse_unpretty, [UNTRACKED],
1419 "Present the input source, unstable (and less-pretty) variants;
1420 valid types are any of the types for `--pretty`, as well as:
1421 `expanded`, `expanded,identified`,
1422 `expanded,hygiene` (with internal representations),
1423 `flowgraph=<nodeid>` (graphviz formatted flowgraph for node),
1424 `flowgraph,unlabelled=<nodeid>` (unlabelled graphviz formatted flowgraph for node),
1425 `everybody_loops` (all function bodies replaced with `loop {}`),
1426 `hir` (the HIR), `hir,identified`,
1427 `hir,typed` (HIR with types for each node),
1428 `hir-tree` (dump the raw HIR),
1429 `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)"),
1430 run_dsymutil: Option<bool> = (None, parse_opt_bool, [TRACKED],
1431 "run `dsymutil` and delete intermediate object files"),
1432 ui_testing: bool = (false, parse_bool, [UNTRACKED],
1433 "format compiler diagnostics in a way that's better suitable for UI testing"),
1434 embed_bitcode: bool = (false, parse_bool, [TRACKED],
1435 "embed LLVM bitcode in object files"),
1436 strip_debuginfo_if_disabled: Option<bool> = (None, parse_opt_bool, [TRACKED],
1437 "tell the linker to strip debuginfo when building without debuginfo enabled."),
1438 share_generics: Option<bool> = (None, parse_opt_bool, [TRACKED],
1439 "make the current crate share its generic instantiations"),
1440 chalk: bool = (false, parse_bool, [TRACKED],
1441 "enable the experimental Chalk-based trait solving engine"),
1442 no_parallel_llvm: bool = (false, parse_bool, [UNTRACKED],
1443 "don't run LLVM in parallel (while keeping codegen-units and ThinLTO)"),
1444 no_leak_check: bool = (false, parse_bool, [UNTRACKED],
1445 "disables the 'leak check' for subtyping; unsound, but useful for tests"),
1446 no_interleave_lints: bool = (false, parse_bool, [UNTRACKED],
1447 "don't interleave execution of lints; allows benchmarking individual lints"),
1448 crate_attr: Vec<String> = (Vec::new(), parse_string_push, [TRACKED],
1449 "inject the given attribute in the crate"),
1450 self_profile: bool = (false, parse_bool, [UNTRACKED],
1451 "run the self profiler and output the raw event data"),
1452 self_profile_events: Option<Vec<String>> = (None, parse_opt_comma_list, [UNTRACKED],
1453 "specifies which kinds of events get recorded by the self profiler"),
1454 emit_stack_sizes: bool = (false, parse_bool, [UNTRACKED],
1455 "emits a section containing stack size metadata"),
1456 plt: Option<bool> = (None, parse_opt_bool, [TRACKED],
1457 "whether to use the PLT when calling into shared libraries;
1458 only has effect for PIC code on systems with ELF binaries
1459 (default: PLT is disabled if full relro is enabled)"),
1460 merge_functions: Option<MergeFunctions> = (None, parse_merge_functions, [TRACKED],
1461 "control the operation of the MergeFunctions LLVM pass, taking
1462 the same values as the target option of the same name"),
1463 allow_features: Option<Vec<String>> = (None, parse_opt_comma_list, [TRACKED],
1464 "only allow the listed language features to be enabled in code (space separated)"),
1465 emit_artifact_notifications: bool = (false, parse_bool, [UNTRACKED],
1466 "emit notifications after each artifact has been output (only in the JSON format)"),
1469 pub fn default_lib_output() -> CrateType {
1473 pub fn default_configuration(sess: &Session) -> ast::CrateConfig {
1474 let end = &sess.target.target.target_endian;
1475 let arch = &sess.target.target.arch;
1476 let wordsz = &sess.target.target.target_pointer_width;
1477 let os = &sess.target.target.target_os;
1478 let env = &sess.target.target.target_env;
1479 let vendor = &sess.target.target.target_vendor;
1480 let min_atomic_width = sess.target.target.min_atomic_width();
1481 let max_atomic_width = sess.target.target.max_atomic_width();
1482 let atomic_cas = sess.target.target.options.atomic_cas;
1484 let mut ret = FxHashSet::default();
1485 ret.reserve(6); // the minimum number of insertions
1487 ret.insert((Symbol::intern("target_os"), Some(Symbol::intern(os))));
1488 if let Some(ref fam) = sess.target.target.options.target_family {
1489 ret.insert((Symbol::intern("target_family"), Some(Symbol::intern(fam))));
1490 if fam == "windows" || fam == "unix" {
1491 ret.insert((Symbol::intern(fam), None));
1494 ret.insert((Symbol::intern("target_arch"), Some(Symbol::intern(arch))));
1495 ret.insert((Symbol::intern("target_endian"), Some(Symbol::intern(end))));
1497 Symbol::intern("target_pointer_width"),
1498 Some(Symbol::intern(wordsz)),
1500 ret.insert((Symbol::intern("target_env"), Some(Symbol::intern(env))));
1502 Symbol::intern("target_vendor"),
1503 Some(Symbol::intern(vendor)),
1505 if sess.target.target.options.has_elf_tls {
1506 ret.insert((sym::target_thread_local, None));
1508 for &i in &[8, 16, 32, 64, 128] {
1509 if i >= min_atomic_width && i <= max_atomic_width {
1510 let s = i.to_string();
1512 sym::target_has_atomic,
1513 Some(Symbol::intern(&s)),
1517 sym::target_has_atomic,
1518 Some(Symbol::intern("ptr")),
1524 ret.insert((sym::target_has_atomic, Some(Symbol::intern("cas"))));
1526 if sess.opts.debug_assertions {
1527 ret.insert((Symbol::intern("debug_assertions"), None));
1529 if sess.opts.crate_types.contains(&CrateType::ProcMacro) {
1530 ret.insert((sym::proc_macro, None));
1535 /// Converts the crate cfg! configuration from String to Symbol.
1536 /// `rustc_interface::interface::Config` accepts this in the compiler configuration,
1537 /// but the symbol interner is not yet set up then, so we must convert it later.
1538 pub fn to_crate_config(cfg: FxHashSet<(String, Option<String>)>) -> ast::CrateConfig {
1540 .map(|(a, b)| (Symbol::intern(&a), b.map(|b| Symbol::intern(&b))))
1544 pub fn build_configuration(sess: &Session, mut user_cfg: ast::CrateConfig) -> ast::CrateConfig {
1545 // Combine the configuration requested by the session (command line) with
1546 // some default and generated configuration items
1547 let default_cfg = default_configuration(sess);
1548 // If the user wants a test runner, then add the test cfg
1550 user_cfg.insert((sym::test, None));
1552 user_cfg.extend(default_cfg.iter().cloned());
1556 pub fn build_target_config(opts: &Options, sp: &Handler) -> Config {
1557 let target = Target::search(&opts.target_triple).unwrap_or_else(|e| {
1558 sp.struct_fatal(&format!("Error loading target specification: {}", e))
1559 .help("Use `--print target-list` for a list of built-in targets")
1564 let (isize_ty, usize_ty) = match &target.target_pointer_width[..] {
1565 "16" => (ast::IntTy::I16, ast::UintTy::U16),
1566 "32" => (ast::IntTy::I32, ast::UintTy::U32),
1567 "64" => (ast::IntTy::I64, ast::UintTy::U64),
1568 w => sp.fatal(&format!(
1569 "target specification was invalid: \
1570 unrecognized target-pointer-width {}",
1582 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
1583 pub enum OptionStability {
1588 pub struct RustcOptGroup {
1589 pub apply: Box<dyn Fn(&mut getopts::Options) -> &mut getopts::Options>,
1590 pub name: &'static str,
1591 pub stability: OptionStability,
1594 impl RustcOptGroup {
1595 pub fn is_stable(&self) -> bool {
1596 self.stability == OptionStability::Stable
1599 pub fn stable<F>(name: &'static str, f: F) -> RustcOptGroup
1601 F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1606 stability: OptionStability::Stable,
1610 pub fn unstable<F>(name: &'static str, f: F) -> RustcOptGroup
1612 F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1617 stability: OptionStability::Unstable,
1622 // The `opt` local module holds wrappers around the `getopts` API that
1623 // adds extra rustc-specific metadata to each option; such metadata
1624 // is exposed by . The public
1625 // functions below ending with `_u` are the functions that return
1626 // *unstable* options, i.e., options that are only enabled when the
1627 // user also passes the `-Z unstable-options` debugging flag.
1629 // The `fn opt_u` etc below are written so that we can use them
1630 // in the future; do not warn about them not being used right now.
1631 #![allow(dead_code)]
1634 use super::RustcOptGroup;
1636 pub type R = RustcOptGroup;
1637 pub type S = &'static str;
1639 fn stable<F>(name: S, f: F) -> R
1641 F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1643 RustcOptGroup::stable(name, f)
1646 fn unstable<F>(name: S, f: F) -> R
1648 F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1650 RustcOptGroup::unstable(name, f)
1653 fn longer(a: S, b: S) -> S {
1654 if a.len() > b.len() {
1661 pub fn opt_s(a: S, b: S, c: S, d: S) -> R {
1662 stable(longer(a, b), move |opts| opts.optopt(a, b, c, d))
1664 pub fn multi_s(a: S, b: S, c: S, d: S) -> R {
1665 stable(longer(a, b), move |opts| opts.optmulti(a, b, c, d))
1667 pub fn flag_s(a: S, b: S, c: S) -> R {
1668 stable(longer(a, b), move |opts| opts.optflag(a, b, c))
1670 pub fn flagopt_s(a: S, b: S, c: S, d: S) -> R {
1671 stable(longer(a, b), move |opts| opts.optflagopt(a, b, c, d))
1673 pub fn flagmulti_s(a: S, b: S, c: S) -> R {
1674 stable(longer(a, b), move |opts| opts.optflagmulti(a, b, c))
1677 pub fn opt(a: S, b: S, c: S, d: S) -> R {
1678 unstable(longer(a, b), move |opts| opts.optopt(a, b, c, d))
1680 pub fn multi(a: S, b: S, c: S, d: S) -> R {
1681 unstable(longer(a, b), move |opts| opts.optmulti(a, b, c, d))
1683 pub fn flag(a: S, b: S, c: S) -> R {
1684 unstable(longer(a, b), move |opts| opts.optflag(a, b, c))
1686 pub fn flagopt(a: S, b: S, c: S, d: S) -> R {
1687 unstable(longer(a, b), move |opts| opts.optflagopt(a, b, c, d))
1689 pub fn flagmulti(a: S, b: S, c: S) -> R {
1690 unstable(longer(a, b), move |opts| opts.optflagmulti(a, b, c))
1694 /// Returns the "short" subset of the rustc command line options,
1695 /// including metadata for each option, such as whether the option is
1696 /// part of the stable long-term interface for rustc.
1697 pub fn rustc_short_optgroups() -> Vec<RustcOptGroup> {
1699 opt::flag_s("h", "help", "Display this message"),
1700 opt::multi_s("", "cfg", "Configure the compilation environment", "SPEC"),
1704 "Add a directory to the library search path. The
1705 optional KIND can be one of dependency, crate, native,
1706 framework or all (the default).",
1712 "Link the generated crate(s) to the specified native
1713 library NAME. The optional KIND can be one of
1714 static, dylib, or framework. If omitted, dylib is
1721 "Comma separated list of types of crates
1722 for the compiler to emit",
1723 "[bin|lib|rlib|dylib|cdylib|staticlib|proc-macro]",
1728 "Specify the name of the crate being built",
1734 "Specify which edition of the compiler to use when compiling code.",
1740 "Comma separated list of types of output for \
1741 the compiler to emit",
1742 "[asm|llvm-bc|llvm-ir|obj|metadata|link|dep-info|mir]",
1747 "Compiler information to print on stdout",
1748 "[crate-name|file-names|sysroot|cfg|target-list|\
1749 target-cpus|target-features|relocation-models|\
1750 code-models|tls-models|target-spec-json|native-static-libs]",
1752 opt::flagmulti_s("g", "", "Equivalent to -C debuginfo=2"),
1753 opt::flagmulti_s("O", "", "Equivalent to -C opt-level=2"),
1754 opt::opt_s("o", "", "Write output to <filename>", "FILENAME"),
1758 "Write output to compiler-chosen filename \
1765 "Provide a detailed explanation of an error \
1769 opt::flag_s("", "test", "Build a test harness"),
1773 "Target triple for which the code is compiled",
1776 opt::multi_s("W", "warn", "Set lint warnings", "OPT"),
1777 opt::multi_s("A", "allow", "Set lint allowed", "OPT"),
1778 opt::multi_s("D", "deny", "Set lint denied", "OPT"),
1779 opt::multi_s("F", "forbid", "Set lint forbidden", "OPT"),
1783 "Set the most restrictive lint level. \
1784 More restrictive lints are capped at this \
1788 opt::multi_s("C", "codegen", "Set a codegen option", "OPT[=VALUE]"),
1789 opt::flag_s("V", "version", "Print version info and exit"),
1790 opt::flag_s("v", "verbose", "Use verbose output"),
1794 /// Returns all rustc command line options, including metadata for
1795 /// each option, such as whether the option is part of the stable
1796 /// long-term interface for rustc.
1797 pub fn rustc_optgroups() -> Vec<RustcOptGroup> {
1798 let mut opts = rustc_short_optgroups();
1803 "Specify where an external rust library is located",
1809 "Specify where an extern rust library is located, marking it as a private dependency",
1812 opt::opt_s("", "sysroot", "Override the system root", "PATH"),
1813 opt::multi("Z", "", "Set internal debugging options", "FLAG"),
1817 "How errors and other messages are produced",
1823 "Choose `rendered` field of json diagnostics render scheme",
1829 "Configure coloring of output:
1830 auto = colorize, if output goes to a tty (default);
1831 always = always colorize output;
1832 never = never colorize output",
1833 "auto|always|never",
1838 "Pretty-print the input instead of compiling;
1839 valid types are: `normal` (un-annotated source),
1840 `expanded` (crates expanded), or
1841 `expanded,identified` (fully parenthesized, AST nodes with IDs).",
1846 "remap-path-prefix",
1847 "Remap source names in all output (compiler messages and output files)",
1854 // Convert strings provided as --cfg [cfgspec] into a crate_cfg
1855 pub fn parse_cfgspecs(cfgspecs: Vec<String>) -> FxHashSet<(String, Option<String>)> {
1856 syntax::with_default_globals(move || {
1857 let cfg = cfgspecs.into_iter().map(|s| {
1858 let sess = parse::ParseSess::new(FilePathMapping::empty());
1859 let filename = FileName::cfg_spec_source_code(&s);
1860 let mut parser = parse::new_parser_from_source_str(&sess, filename, s.to_string());
1862 macro_rules! error {($reason: expr) => {
1863 early_error(ErrorOutputType::default(),
1864 &format!(concat!("invalid `--cfg` argument: `{}` (", $reason, ")"), s));
1867 match &mut parser.parse_meta_item() {
1868 Ok(meta_item) if parser.token == token::Eof => {
1869 if meta_item.path.segments.len() != 1 {
1870 error!("argument key must be an identifier");
1872 match &meta_item.node {
1873 MetaItemKind::List(..) => {
1874 error!(r#"expected `key` or `key="value"`"#);
1876 MetaItemKind::NameValue(lit) if !lit.node.is_str() => {
1877 error!("argument value must be a string");
1879 MetaItemKind::NameValue(..) | MetaItemKind::Word => {
1880 let ident = meta_item.ident().expect("multi-segment cfg key");
1881 return (ident.name, meta_item.value_str());
1886 Err(err) => err.cancel(),
1889 error!(r#"expected `key` or `key="value"`"#);
1890 }).collect::<ast::CrateConfig>();
1891 cfg.into_iter().map(|(a, b)| {
1892 (a.to_string(), b.map(|b| b.to_string()))
1897 pub fn get_cmd_lint_options(matches: &getopts::Matches,
1898 error_format: ErrorOutputType)
1899 -> (Vec<(String, lint::Level)>, bool, Option<lint::Level>) {
1900 let mut lint_opts = vec![];
1901 let mut describe_lints = false;
1903 for &level in &[lint::Allow, lint::Warn, lint::Deny, lint::Forbid] {
1904 for lint_name in matches.opt_strs(level.as_str()) {
1905 if lint_name == "help" {
1906 describe_lints = true;
1908 lint_opts.push((lint_name.replace("-", "_"), level));
1913 let lint_cap = matches.opt_str("cap-lints").map(|cap| {
1914 lint::Level::from_str(&cap)
1915 .unwrap_or_else(|| early_error(error_format, &format!("unknown lint level: `{}`", cap)))
1917 (lint_opts, describe_lints, lint_cap)
1920 pub fn build_session_options_and_crate_config(
1921 matches: &getopts::Matches,
1922 ) -> (Options, FxHashSet<(String, Option<String>)>) {
1923 let color = match matches.opt_str("color").as_ref().map(|s| &s[..]) {
1924 Some("auto") => ColorConfig::Auto,
1925 Some("always") => ColorConfig::Always,
1926 Some("never") => ColorConfig::Never,
1928 None => ColorConfig::Auto,
1930 Some(arg) => early_error(
1931 ErrorOutputType::default(),
1933 "argument for --color must be auto, \
1934 always or never (instead was `{}`)",
1940 let edition = match matches.opt_str("edition") {
1941 Some(arg) => Edition::from_str(&arg).unwrap_or_else(|_|
1943 ErrorOutputType::default(),
1945 "argument for --edition must be one of: \
1946 {}. (instead was `{}`)",
1952 None => DEFAULT_EDITION,
1955 if !edition.is_stable() && !nightly_options::is_nightly_build() {
1957 ErrorOutputType::default(),
1959 "Edition {} is unstable and only \
1960 available for nightly builds of rustc.",
1966 let json_rendered = matches.opt_str("json-rendered").and_then(|s| match s.as_str() {
1968 "termcolor" => Some(HumanReadableErrorType::Default(ColorConfig::Always)),
1970 ErrorOutputType::default(),
1972 "argument for --json-rendered must be `plain` or `termcolor` (instead was `{}`)",
1976 }).unwrap_or(HumanReadableErrorType::Default(ColorConfig::Never));
1978 // We need the opts_present check because the driver will send us Matches
1979 // with only stable options if no unstable options are used. Since error-format
1980 // is unstable, it will not be present. We have to use opts_present not
1981 // opt_present because the latter will panic.
1982 let error_format = if matches.opts_present(&["error-format".to_owned()]) {
1983 match matches.opt_str("error-format").as_ref().map(|s| &s[..]) {
1985 Some("human") => ErrorOutputType::HumanReadable(HumanReadableErrorType::Default(color)),
1986 Some("json") => ErrorOutputType::Json { pretty: false, json_rendered },
1987 Some("pretty-json") => ErrorOutputType::Json { pretty: true, json_rendered },
1988 Some("short") => ErrorOutputType::HumanReadable(HumanReadableErrorType::Short(color)),
1990 Some(arg) => early_error(
1991 ErrorOutputType::HumanReadable(HumanReadableErrorType::Default(color)),
1993 "argument for --error-format must be `human`, `json` or \
1994 `short` (instead was `{}`)",
2000 ErrorOutputType::HumanReadable(HumanReadableErrorType::Default(color))
2003 let unparsed_crate_types = matches.opt_strs("crate-type");
2004 let crate_types = parse_crate_types_from_list(unparsed_crate_types)
2005 .unwrap_or_else(|e| early_error(error_format, &e[..]));
2008 let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
2010 let mut debugging_opts = build_debugging_options(matches, error_format);
2012 if !debugging_opts.unstable_options {
2013 if matches.opt_str("json-rendered").is_some() {
2014 early_error(error_format, "`--json-rendered=x` is unstable");
2016 if let ErrorOutputType::Json { pretty: true, json_rendered } = error_format {
2018 ErrorOutputType::Json { pretty: false, json_rendered },
2019 "--error-format=pretty-json is unstable",
2024 if debugging_opts.pgo_gen.enabled() && debugging_opts.pgo_use.is_some() {
2027 "options `-Z pgo-gen` and `-Z pgo-use` are exclusive",
2031 let mut output_types = BTreeMap::new();
2032 if !debugging_opts.parse_only {
2033 for list in matches.opt_strs("emit") {
2034 for output_type in list.split(',') {
2035 let mut parts = output_type.splitn(2, '=');
2036 let shorthand = parts.next().unwrap();
2037 let output_type = OutputType::from_shorthand(shorthand).unwrap_or_else(||
2041 "unknown emission type: `{}` - expected one of: {}",
2043 OutputType::shorthands_display(),
2047 let path = parts.next().map(PathBuf::from);
2048 output_types.insert(output_type, path);
2052 if output_types.is_empty() {
2053 output_types.insert(OutputType::Exe, None);
2056 let mut cg = build_codegen_options(matches, error_format);
2057 let mut codegen_units = cg.codegen_units;
2058 let mut disable_thinlto = false;
2060 // Issue #30063: if user requests llvm-related output to one
2061 // particular path, disable codegen-units.
2062 let incompatible: Vec<_> = output_types
2064 .map(|ot_path| ot_path.0)
2065 .filter(|ot| !ot.is_compatible_with_codegen_units_and_single_output_file())
2066 .map(|ot| ot.shorthand())
2068 if !incompatible.is_empty() {
2069 match codegen_units {
2070 Some(n) if n > 1 => {
2071 if matches.opt_present("o") {
2072 for ot in &incompatible {
2076 "--emit={} with -o incompatible with \
2077 -C codegen-units=N for N > 1",
2082 early_warn(error_format, "resetting to default -C codegen-units=1");
2083 codegen_units = Some(1);
2084 disable_thinlto = true;
2088 codegen_units = Some(1);
2089 disable_thinlto = true;
2094 if debugging_opts.threads == Some(0) {
2097 "Value for threads must be a positive nonzero integer",
2101 if debugging_opts.threads.unwrap_or(1) > 1 && debugging_opts.fuel.is_some() {
2104 "Optimization fuel is incompatible with multiple threads",
2108 if codegen_units == Some(0) {
2111 "Value for codegen units must be a positive nonzero integer",
2115 let incremental = match (&debugging_opts.incremental, &cg.incremental) {
2116 (&Some(ref path1), &Some(ref path2)) => {
2121 "conflicting paths for `-Z incremental` and \
2122 `-C incremental` specified: {} versus {}",
2130 (&Some(ref path), &None) => Some(path),
2131 (&None, &Some(ref path)) => Some(path),
2132 (&None, &None) => None,
2133 }.map(|m| PathBuf::from(m));
2135 if debugging_opts.profile && incremental.is_some() {
2138 "can't instrument with gcov profiling when compiling incrementally",
2142 let mut prints = Vec::<PrintRequest>::new();
2143 if cg.target_cpu.as_ref().map_or(false, |s| s == "help") {
2144 prints.push(PrintRequest::TargetCPUs);
2145 cg.target_cpu = None;
2147 if cg.target_feature == "help" {
2148 prints.push(PrintRequest::TargetFeatures);
2149 cg.target_feature = String::new();
2151 if cg.relocation_model.as_ref().map_or(false, |s| s == "help") {
2152 prints.push(PrintRequest::RelocationModels);
2153 cg.relocation_model = None;
2155 if cg.code_model.as_ref().map_or(false, |s| s == "help") {
2156 prints.push(PrintRequest::CodeModels);
2157 cg.code_model = None;
2162 .map_or(false, |s| s == "help")
2164 prints.push(PrintRequest::TlsModels);
2165 debugging_opts.tls_model = None;
2170 let sysroot_opt = matches.opt_str("sysroot").map(|m| PathBuf::from(&m));
2171 let target_triple = if let Some(target) = matches.opt_str("target") {
2172 if target.ends_with(".json") {
2173 let path = Path::new(&target);
2174 TargetTriple::from_path(&path).unwrap_or_else(|_|
2175 early_error(error_format, &format!("target file {:?} does not exist", path)))
2177 TargetTriple::TargetTriple(target)
2180 TargetTriple::from_triple(host_triple())
2183 // The `-O` and `-C opt-level` flags specify the same setting, so we want to be able
2184 // to use them interchangeably. However, because they're technically different flags,
2185 // we need to work out manually which should take precedence if both are supplied (i.e.
2186 // the rightmost flag). We do this by finding the (rightmost) position of both flags and
2187 // comparing them. Note that if a flag is not found, its position will be `None`, which
2188 // always compared less than `Some(_)`.
2189 let max_o = matches.opt_positions("O").into_iter().max();
2190 let max_c = matches.opt_strs_pos("C").into_iter().flat_map(|(i, s)| {
2191 if let Some("opt-level") = s.splitn(2, '=').next() {
2200 match cg.opt_level.as_ref().map(String::as_ref) {
2201 None => OptLevel::No,
2202 Some("0") => OptLevel::No,
2203 Some("1") => OptLevel::Less,
2204 Some("2") => OptLevel::Default,
2205 Some("3") => OptLevel::Aggressive,
2206 Some("s") => OptLevel::Size,
2207 Some("z") => OptLevel::SizeMin,
2212 "optimization level needs to be \
2213 between 0-3, s or z (instead was `{}`)",
2221 // The `-g` and `-C debuginfo` flags specify the same setting, so we want to be able
2222 // to use them interchangeably. See the note above (regarding `-O` and `-C opt-level`)
2223 // for more details.
2224 let debug_assertions = cg.debug_assertions.unwrap_or(opt_level == OptLevel::No);
2225 let max_g = matches.opt_positions("g").into_iter().max();
2226 let max_c = matches.opt_strs_pos("C").into_iter().flat_map(|(i, s)| {
2227 if let Some("debuginfo") = s.splitn(2, '=').next() {
2233 let debuginfo = if max_g > max_c {
2236 match cg.debuginfo {
2237 None | Some(0) => DebugInfo::None,
2238 Some(1) => DebugInfo::Limited,
2239 Some(2) => DebugInfo::Full,
2244 "debug info level needs to be between \
2245 0-2 (instead was `{}`)",
2253 let mut search_paths = vec![];
2254 for s in &matches.opt_strs("L") {
2255 search_paths.push(SearchPath::from_cli_opt(&s[..], error_format));
2262 // Parse string of the form "[KIND=]lib[:new_name]",
2263 // where KIND is one of "dylib", "framework", "static".
2264 let mut parts = s.splitn(2, '=');
2265 let kind = parts.next().unwrap();
2266 let (name, kind) = match (parts.next(), kind) {
2267 (None, name) => (name, None),
2268 (Some(name), "dylib") => (name, Some(cstore::NativeUnknown)),
2269 (Some(name), "framework") => (name, Some(cstore::NativeFramework)),
2270 (Some(name), "static") => (name, Some(cstore::NativeStatic)),
2271 (Some(name), "static-nobundle") => (name, Some(cstore::NativeStaticNobundle)),
2276 "unknown library kind `{}`, expected \
2277 one of dylib, framework, or static",
2283 if kind == Some(cstore::NativeStaticNobundle) && !nightly_options::is_nightly_build() {
2287 "the library kind 'static-nobundle' is only \
2288 accepted on the nightly compiler"
2292 let mut name_parts = name.splitn(2, ':');
2293 let name = name_parts.next().unwrap();
2294 let new_name = name_parts.next();
2295 (name.to_owned(), new_name.map(|n| n.to_owned()), kind)
2299 let cfg = parse_cfgspecs(matches.opt_strs("cfg"));
2300 let test = matches.opt_present("test");
2302 let is_unstable_enabled = nightly_options::is_unstable_enabled(matches);
2304 prints.extend(matches.opt_strs("print").into_iter().map(|s| match &*s {
2305 "crate-name" => PrintRequest::CrateName,
2306 "file-names" => PrintRequest::FileNames,
2307 "sysroot" => PrintRequest::Sysroot,
2308 "cfg" => PrintRequest::Cfg,
2309 "target-list" => PrintRequest::TargetList,
2310 "target-cpus" => PrintRequest::TargetCPUs,
2311 "target-features" => PrintRequest::TargetFeatures,
2312 "relocation-models" => PrintRequest::RelocationModels,
2313 "code-models" => PrintRequest::CodeModels,
2314 "tls-models" => PrintRequest::TlsModels,
2315 "native-static-libs" => PrintRequest::NativeStaticLibs,
2316 "target-spec-json" => {
2317 if is_unstable_enabled {
2318 PrintRequest::TargetSpec
2322 "the `-Z unstable-options` flag must also be passed to \
2323 enable the target-spec-json print option",
2327 req => early_error(error_format, &format!("unknown print request `{}`", req)),
2330 let borrowck_mode = match debugging_opts.borrowck.as_ref().map(|s| &s[..]) {
2331 None | Some("migrate") => BorrowckMode::Migrate,
2332 Some("mir") => BorrowckMode::Mir,
2333 Some(m) => early_error(error_format, &format!("unknown borrowck mode `{}`", m)),
2336 if !cg.remark.is_empty() && debuginfo == DebugInfo::None {
2339 "-C remark requires \"-C debuginfo=n\" to show source locations",
2343 if matches.opt_present("extern-private") && !debugging_opts.unstable_options {
2345 ErrorOutputType::default(),
2346 "'--extern-private' is unstable and only \
2347 available for nightly builds of rustc."
2351 // We start out with a Vec<(Option<String>, bool)>>,
2352 // and later convert it into a BTreeSet<(Option<String>, bool)>
2353 // This allows to modify entries in-place to set their correct
2355 let mut externs: BTreeMap<String, ExternEntry> = BTreeMap::new();
2356 for (arg, private) in matches.opt_strs("extern").into_iter().map(|v| (v, false))
2357 .chain(matches.opt_strs("extern-private").into_iter().map(|v| (v, true))) {
2359 let mut parts = arg.splitn(2, '=');
2360 let name = parts.next().unwrap_or_else(||
2361 early_error(error_format, "--extern value must not be empty"));
2362 let location = parts.next().map(|s| s.to_string());
2363 if location.is_none() && !is_unstable_enabled {
2366 "the `-Z unstable-options` flag must also be passed to \
2367 enable `--extern crate_name` without `=path`",
2372 .entry(name.to_owned())
2376 entry.locations.insert(location.clone());
2378 // Crates start out being not private,
2379 // and go to being private if we see an '--extern-private'
2381 entry.is_private_dep |= private;
2384 let crate_name = matches.opt_str("crate-name");
2386 let remap_path_prefix = matches
2387 .opt_strs("remap-path-prefix")
2390 let mut parts = remap.rsplitn(2, '='); // reverse iterator
2391 let to = parts.next();
2392 let from = parts.next();
2394 (Some(from), Some(to)) => (PathBuf::from(from), PathBuf::from(to)),
2397 "--remap-path-prefix must contain '=' between FROM and TO",
2406 optimize: opt_level,
2411 output_types: OutputTypes(output_types),
2413 maybe_sysroot: sysroot_opt,
2422 externs: Externs(externs),
2426 unstable_features: UnstableFeatures::from_environment(),
2428 actually_rustdoc: false,
2429 cli_forced_codegen_units: codegen_units,
2430 cli_forced_thinlto_off: disable_thinlto,
2438 pub fn parse_crate_types_from_list(list_list: Vec<String>) -> Result<Vec<CrateType>, String> {
2439 let mut crate_types: Vec<CrateType> = Vec::new();
2440 for unparsed_crate_type in &list_list {
2441 for part in unparsed_crate_type.split(',') {
2442 let new_part = match part {
2443 "lib" => default_lib_output(),
2444 "rlib" => CrateType::Rlib,
2445 "staticlib" => CrateType::Staticlib,
2446 "dylib" => CrateType::Dylib,
2447 "cdylib" => CrateType::Cdylib,
2448 "bin" => CrateType::Executable,
2449 "proc-macro" => CrateType::ProcMacro,
2450 _ => return Err(format!("unknown crate type: `{}`", part))
2452 if !crate_types.contains(&new_part) {
2453 crate_types.push(new_part)
2461 pub mod nightly_options {
2463 use syntax::feature_gate::UnstableFeatures;
2464 use super::{ErrorOutputType, OptionStability, RustcOptGroup};
2465 use crate::session::early_error;
2467 pub fn is_unstable_enabled(matches: &getopts::Matches) -> bool {
2472 .any(|x| *x == "unstable-options")
2475 pub fn is_nightly_build() -> bool {
2476 UnstableFeatures::from_environment().is_nightly_build()
2479 pub fn check_nightly_options(matches: &getopts::Matches, flags: &[RustcOptGroup]) {
2480 let has_z_unstable_option = matches
2483 .any(|x| *x == "unstable-options");
2484 let really_allows_unstable_options =
2485 UnstableFeatures::from_environment().is_nightly_build();
2487 for opt in flags.iter() {
2488 if opt.stability == OptionStability::Stable {
2491 if !matches.opt_present(opt.name) {
2494 if opt.name != "Z" && !has_z_unstable_option {
2496 ErrorOutputType::default(),
2498 "the `-Z unstable-options` flag must also be passed to enable \
2504 if really_allows_unstable_options {
2507 match opt.stability {
2508 OptionStability::Unstable => {
2510 "the option `{}` is only accepted on the \
2514 early_error(ErrorOutputType::default(), &msg);
2516 OptionStability::Stable => {}
2522 impl fmt::Display for CrateType {
2523 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2525 CrateType::Executable => "bin".fmt(f),
2526 CrateType::Dylib => "dylib".fmt(f),
2527 CrateType::Rlib => "rlib".fmt(f),
2528 CrateType::Staticlib => "staticlib".fmt(f),
2529 CrateType::Cdylib => "cdylib".fmt(f),
2530 CrateType::ProcMacro => "proc-macro".fmt(f),
2535 /// Command-line arguments passed to the compiler have to be incorporated with
2536 /// the dependency tracking system for incremental compilation. This module
2537 /// provides some utilities to make this more convenient.
2539 /// The values of all command-line arguments that are relevant for dependency
2540 /// tracking are hashed into a single value that determines whether the
2541 /// incremental compilation cache can be re-used or not. This hashing is done
2542 /// via the DepTrackingHash trait defined below, since the standard Hash
2543 /// implementation might not be suitable (e.g., arguments are stored in a Vec,
2544 /// the hash of which is order dependent, but we might not want the order of
2545 /// arguments to make a difference for the hash).
2547 /// However, since the value provided by Hash::hash often *is* suitable,
2548 /// especially for primitive types, there is the
2549 /// impl_dep_tracking_hash_via_hash!() macro that allows to simply reuse the
2550 /// Hash implementation for DepTrackingHash. It's important though that
2551 /// we have an opt-in scheme here, so one is hopefully forced to think about
2552 /// how the hash should be calculated when adding a new command-line argument.
2555 use crate::middle::cstore;
2556 use std::collections::BTreeMap;
2557 use std::hash::Hash;
2558 use std::path::PathBuf;
2559 use std::collections::hash_map::DefaultHasher;
2560 use super::{CrateType, DebugInfo, ErrorOutputType, OptLevel, OutputTypes,
2561 Passes, Sanitizer, LtoCli, LinkerPluginLto, PgoGenerate};
2562 use syntax::feature_gate::UnstableFeatures;
2563 use rustc_target::spec::{MergeFunctions, PanicStrategy, RelroLevel, TargetTriple};
2564 use syntax::edition::Edition;
2566 pub trait DepTrackingHash {
2567 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType);
2570 macro_rules! impl_dep_tracking_hash_via_hash {
2572 impl DepTrackingHash for $t {
2573 fn hash(&self, hasher: &mut DefaultHasher, _: ErrorOutputType) {
2574 Hash::hash(self, hasher);
2580 macro_rules! impl_dep_tracking_hash_for_sortable_vec_of {
2582 impl DepTrackingHash for Vec<$t> {
2583 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
2584 let mut elems: Vec<&$t> = self.iter().collect();
2586 Hash::hash(&elems.len(), hasher);
2587 for (index, elem) in elems.iter().enumerate() {
2588 Hash::hash(&index, hasher);
2589 DepTrackingHash::hash(*elem, hasher, error_format);
2596 impl_dep_tracking_hash_via_hash!(bool);
2597 impl_dep_tracking_hash_via_hash!(usize);
2598 impl_dep_tracking_hash_via_hash!(u64);
2599 impl_dep_tracking_hash_via_hash!(String);
2600 impl_dep_tracking_hash_via_hash!(PathBuf);
2601 impl_dep_tracking_hash_via_hash!(lint::Level);
2602 impl_dep_tracking_hash_via_hash!(Option<bool>);
2603 impl_dep_tracking_hash_via_hash!(Option<usize>);
2604 impl_dep_tracking_hash_via_hash!(Option<String>);
2605 impl_dep_tracking_hash_via_hash!(Option<(String, u64)>);
2606 impl_dep_tracking_hash_via_hash!(Option<Vec<String>>);
2607 impl_dep_tracking_hash_via_hash!(Option<MergeFunctions>);
2608 impl_dep_tracking_hash_via_hash!(Option<PanicStrategy>);
2609 impl_dep_tracking_hash_via_hash!(Option<RelroLevel>);
2610 impl_dep_tracking_hash_via_hash!(Option<lint::Level>);
2611 impl_dep_tracking_hash_via_hash!(Option<PathBuf>);
2612 impl_dep_tracking_hash_via_hash!(Option<cstore::NativeLibraryKind>);
2613 impl_dep_tracking_hash_via_hash!(CrateType);
2614 impl_dep_tracking_hash_via_hash!(MergeFunctions);
2615 impl_dep_tracking_hash_via_hash!(PanicStrategy);
2616 impl_dep_tracking_hash_via_hash!(RelroLevel);
2617 impl_dep_tracking_hash_via_hash!(Passes);
2618 impl_dep_tracking_hash_via_hash!(OptLevel);
2619 impl_dep_tracking_hash_via_hash!(LtoCli);
2620 impl_dep_tracking_hash_via_hash!(DebugInfo);
2621 impl_dep_tracking_hash_via_hash!(UnstableFeatures);
2622 impl_dep_tracking_hash_via_hash!(OutputTypes);
2623 impl_dep_tracking_hash_via_hash!(cstore::NativeLibraryKind);
2624 impl_dep_tracking_hash_via_hash!(Sanitizer);
2625 impl_dep_tracking_hash_via_hash!(Option<Sanitizer>);
2626 impl_dep_tracking_hash_via_hash!(TargetTriple);
2627 impl_dep_tracking_hash_via_hash!(Edition);
2628 impl_dep_tracking_hash_via_hash!(LinkerPluginLto);
2629 impl_dep_tracking_hash_via_hash!(PgoGenerate);
2631 impl_dep_tracking_hash_for_sortable_vec_of!(String);
2632 impl_dep_tracking_hash_for_sortable_vec_of!(PathBuf);
2633 impl_dep_tracking_hash_for_sortable_vec_of!(CrateType);
2634 impl_dep_tracking_hash_for_sortable_vec_of!((String, lint::Level));
2635 impl_dep_tracking_hash_for_sortable_vec_of!((
2638 Option<cstore::NativeLibraryKind>
2640 impl_dep_tracking_hash_for_sortable_vec_of!((String, u64));
2642 impl<T1, T2> DepTrackingHash for (T1, T2)
2644 T1: DepTrackingHash,
2645 T2: DepTrackingHash,
2647 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
2648 Hash::hash(&0, hasher);
2649 DepTrackingHash::hash(&self.0, hasher, error_format);
2650 Hash::hash(&1, hasher);
2651 DepTrackingHash::hash(&self.1, hasher, error_format);
2655 impl<T1, T2, T3> DepTrackingHash for (T1, T2, T3)
2657 T1: DepTrackingHash,
2658 T2: DepTrackingHash,
2659 T3: DepTrackingHash,
2661 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
2662 Hash::hash(&0, hasher);
2663 DepTrackingHash::hash(&self.0, hasher, error_format);
2664 Hash::hash(&1, hasher);
2665 DepTrackingHash::hash(&self.1, hasher, error_format);
2666 Hash::hash(&2, hasher);
2667 DepTrackingHash::hash(&self.2, hasher, error_format);
2671 // This is a stable hash because BTreeMap is a sorted container
2673 sub_hashes: BTreeMap<&'static str, &dyn DepTrackingHash>,
2674 hasher: &mut DefaultHasher,
2675 error_format: ErrorOutputType,
2677 for (key, sub_hash) in sub_hashes {
2678 // Using Hash::hash() instead of DepTrackingHash::hash() is fine for
2679 // the keys, as they are just plain strings
2680 Hash::hash(&key.len(), hasher);
2681 Hash::hash(key, hasher);
2682 sub_hash.hash(hasher, error_format);
2691 use crate::middle::cstore;
2692 use crate::session::config::{
2693 build_configuration,
2694 build_session_options_and_crate_config,
2697 use crate::session::config::{LtoCli, LinkerPluginLto, PgoGenerate, ExternEntry};
2698 use crate::session::build_session;
2699 use crate::session::search_paths::SearchPath;
2700 use std::collections::{BTreeMap, BTreeSet};
2701 use std::iter::FromIterator;
2702 use std::path::PathBuf;
2703 use super::{Externs, OutputType, OutputTypes};
2704 use rustc_target::spec::{MergeFunctions, PanicStrategy, RelroLevel};
2705 use syntax::symbol::sym;
2706 use syntax::edition::{Edition, DEFAULT_EDITION};
2711 fn new_public<S: Into<String>,
2712 I: IntoIterator<Item = Option<S>>>(locations: I) -> ExternEntry {
2713 let locations: BTreeSet<_> = locations.into_iter().map(|o| o.map(|s| s.into()))
2718 is_private_dep: false
2723 fn optgroups() -> getopts::Options {
2724 let mut opts = getopts::Options::new();
2725 for group in super::rustc_optgroups() {
2726 (group.apply)(&mut opts);
2731 fn mk_map<K: Ord, V>(entries: Vec<(K, V)>) -> BTreeMap<K, V> {
2732 BTreeMap::from_iter(entries.into_iter())
2735 // When the user supplies --test we should implicitly supply --cfg test
2737 fn test_switch_implies_cfg_test() {
2738 syntax::with_default_globals(|| {
2739 let matches = &match optgroups().parse(&["--test".to_string()]) {
2741 Err(f) => panic!("test_switch_implies_cfg_test: {}", f),
2743 let registry = errors::registry::Registry::new(&[]);
2744 let (sessopts, cfg) = build_session_options_and_crate_config(matches);
2745 let sess = build_session(sessopts, None, registry);
2746 let cfg = build_configuration(&sess, to_crate_config(cfg));
2747 assert!(cfg.contains(&(sym::test, None)));
2751 // When the user supplies --test and --cfg test, don't implicitly add
2752 // another --cfg test
2754 fn test_switch_implies_cfg_test_unless_cfg_test() {
2755 syntax::with_default_globals(|| {
2756 let matches = &match optgroups().parse(&["--test".to_string(),
2757 "--cfg=test".to_string()]) {
2759 Err(f) => panic!("test_switch_implies_cfg_test_unless_cfg_test: {}", f),
2761 let registry = errors::registry::Registry::new(&[]);
2762 let (sessopts, cfg) = build_session_options_and_crate_config(matches);
2763 let sess = build_session(sessopts, None, registry);
2764 let cfg = build_configuration(&sess, to_crate_config(cfg));
2765 let mut test_items = cfg.iter().filter(|&&(name, _)| name == sym::test);
2766 assert!(test_items.next().is_some());
2767 assert!(test_items.next().is_none());
2772 fn test_can_print_warnings() {
2773 syntax::with_default_globals(|| {
2774 let matches = optgroups().parse(&["-Awarnings".to_string()]).unwrap();
2775 let registry = errors::registry::Registry::new(&[]);
2776 let (sessopts, _) = build_session_options_and_crate_config(&matches);
2777 let sess = build_session(sessopts, None, registry);
2778 assert!(!sess.diagnostic().flags.can_emit_warnings);
2781 syntax::with_default_globals(|| {
2782 let matches = optgroups()
2783 .parse(&["-Awarnings".to_string(), "-Dwarnings".to_string()])
2785 let registry = errors::registry::Registry::new(&[]);
2786 let (sessopts, _) = build_session_options_and_crate_config(&matches);
2787 let sess = build_session(sessopts, None, registry);
2788 assert!(sess.diagnostic().flags.can_emit_warnings);
2791 syntax::with_default_globals(|| {
2792 let matches = optgroups().parse(&["-Adead_code".to_string()]).unwrap();
2793 let registry = errors::registry::Registry::new(&[]);
2794 let (sessopts, _) = build_session_options_and_crate_config(&matches);
2795 let sess = build_session(sessopts, None, registry);
2796 assert!(sess.diagnostic().flags.can_emit_warnings);
2801 fn test_output_types_tracking_hash_different_paths() {
2802 let mut v1 = Options::default();
2803 let mut v2 = Options::default();
2804 let mut v3 = Options::default();
2807 OutputTypes::new(&[(OutputType::Exe, Some(PathBuf::from("./some/thing")))]);
2809 OutputTypes::new(&[(OutputType::Exe, Some(PathBuf::from("/some/thing")))]);
2810 v3.output_types = OutputTypes::new(&[(OutputType::Exe, None)]);
2812 assert!(v1.dep_tracking_hash() != v2.dep_tracking_hash());
2813 assert!(v1.dep_tracking_hash() != v3.dep_tracking_hash());
2814 assert!(v2.dep_tracking_hash() != v3.dep_tracking_hash());
2817 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2818 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2819 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2823 fn test_output_types_tracking_hash_different_construction_order() {
2824 let mut v1 = Options::default();
2825 let mut v2 = Options::default();
2827 v1.output_types = OutputTypes::new(&[
2828 (OutputType::Exe, Some(PathBuf::from("./some/thing"))),
2829 (OutputType::Bitcode, Some(PathBuf::from("./some/thing.bc"))),
2832 v2.output_types = OutputTypes::new(&[
2833 (OutputType::Bitcode, Some(PathBuf::from("./some/thing.bc"))),
2834 (OutputType::Exe, Some(PathBuf::from("./some/thing"))),
2837 assert_eq!(v1.dep_tracking_hash(), v2.dep_tracking_hash());
2840 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2844 fn test_externs_tracking_hash_different_construction_order() {
2845 let mut v1 = Options::default();
2846 let mut v2 = Options::default();
2847 let mut v3 = Options::default();
2849 v1.externs = Externs::new(mk_map(vec![
2852 ExternEntry::new_public(vec![Some("b"), Some("c")])
2856 ExternEntry::new_public(vec![Some("e"), Some("f")])
2860 v2.externs = Externs::new(mk_map(vec![
2863 ExternEntry::new_public(vec![Some("e"), Some("f")])
2867 ExternEntry::new_public(vec![Some("b"), Some("c")])
2871 v3.externs = Externs::new(mk_map(vec![
2874 ExternEntry::new_public(vec![Some("b"), Some("c")])
2878 ExternEntry::new_public(vec![Some("f"), Some("e")])
2882 assert_eq!(v1.dep_tracking_hash(), v2.dep_tracking_hash());
2883 assert_eq!(v1.dep_tracking_hash(), v3.dep_tracking_hash());
2884 assert_eq!(v2.dep_tracking_hash(), v3.dep_tracking_hash());
2887 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2888 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2889 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2893 fn test_lints_tracking_hash_different_values() {
2894 let mut v1 = Options::default();
2895 let mut v2 = Options::default();
2896 let mut v3 = Options::default();
2898 v1.lint_opts = vec![
2899 (String::from("a"), lint::Allow),
2900 (String::from("b"), lint::Warn),
2901 (String::from("c"), lint::Deny),
2902 (String::from("d"), lint::Forbid),
2905 v2.lint_opts = vec![
2906 (String::from("a"), lint::Allow),
2907 (String::from("b"), lint::Warn),
2908 (String::from("X"), lint::Deny),
2909 (String::from("d"), lint::Forbid),
2912 v3.lint_opts = vec![
2913 (String::from("a"), lint::Allow),
2914 (String::from("b"), lint::Warn),
2915 (String::from("c"), lint::Forbid),
2916 (String::from("d"), lint::Deny),
2919 assert!(v1.dep_tracking_hash() != v2.dep_tracking_hash());
2920 assert!(v1.dep_tracking_hash() != v3.dep_tracking_hash());
2921 assert!(v2.dep_tracking_hash() != v3.dep_tracking_hash());
2924 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2925 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2926 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2930 fn test_lints_tracking_hash_different_construction_order() {
2931 let mut v1 = Options::default();
2932 let mut v2 = Options::default();
2934 v1.lint_opts = vec![
2935 (String::from("a"), lint::Allow),
2936 (String::from("b"), lint::Warn),
2937 (String::from("c"), lint::Deny),
2938 (String::from("d"), lint::Forbid),
2941 v2.lint_opts = vec![
2942 (String::from("a"), lint::Allow),
2943 (String::from("c"), lint::Deny),
2944 (String::from("b"), lint::Warn),
2945 (String::from("d"), lint::Forbid),
2948 assert_eq!(v1.dep_tracking_hash(), v2.dep_tracking_hash());
2951 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2952 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2956 fn test_search_paths_tracking_hash_different_order() {
2957 let mut v1 = Options::default();
2958 let mut v2 = Options::default();
2959 let mut v3 = Options::default();
2960 let mut v4 = Options::default();
2962 const JSON: super::ErrorOutputType = super::ErrorOutputType::Json {
2964 json_rendered: super::HumanReadableErrorType::Default(super::ColorConfig::Never),
2969 .push(SearchPath::from_cli_opt("native=abc", JSON));
2971 .push(SearchPath::from_cli_opt("crate=def", JSON));
2973 .push(SearchPath::from_cli_opt("dependency=ghi", JSON));
2975 .push(SearchPath::from_cli_opt("framework=jkl", JSON));
2977 .push(SearchPath::from_cli_opt("all=mno", JSON));
2980 .push(SearchPath::from_cli_opt("native=abc", JSON));
2982 .push(SearchPath::from_cli_opt("dependency=ghi", JSON));
2984 .push(SearchPath::from_cli_opt("crate=def", JSON));
2986 .push(SearchPath::from_cli_opt("framework=jkl", JSON));
2988 .push(SearchPath::from_cli_opt("all=mno", JSON));
2991 .push(SearchPath::from_cli_opt("crate=def", JSON));
2993 .push(SearchPath::from_cli_opt("framework=jkl", JSON));
2995 .push(SearchPath::from_cli_opt("native=abc", JSON));
2997 .push(SearchPath::from_cli_opt("dependency=ghi", JSON));
2999 .push(SearchPath::from_cli_opt("all=mno", JSON));
3002 .push(SearchPath::from_cli_opt("all=mno", JSON));
3004 .push(SearchPath::from_cli_opt("native=abc", JSON));
3006 .push(SearchPath::from_cli_opt("crate=def", JSON));
3008 .push(SearchPath::from_cli_opt("dependency=ghi", JSON));
3010 .push(SearchPath::from_cli_opt("framework=jkl", JSON));
3012 assert!(v1.dep_tracking_hash() == v2.dep_tracking_hash());
3013 assert!(v1.dep_tracking_hash() == v3.dep_tracking_hash());
3014 assert!(v1.dep_tracking_hash() == v4.dep_tracking_hash());
3017 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
3018 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
3019 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
3020 assert_eq!(v4.dep_tracking_hash(), v4.clone().dep_tracking_hash());
3024 fn test_native_libs_tracking_hash_different_values() {
3025 let mut v1 = Options::default();
3026 let mut v2 = Options::default();
3027 let mut v3 = Options::default();
3028 let mut v4 = Options::default();
3032 (String::from("a"), None, Some(cstore::NativeStatic)),
3033 (String::from("b"), None, Some(cstore::NativeFramework)),
3034 (String::from("c"), None, Some(cstore::NativeUnknown)),
3039 (String::from("a"), None, Some(cstore::NativeStatic)),
3040 (String::from("X"), None, Some(cstore::NativeFramework)),
3041 (String::from("c"), None, Some(cstore::NativeUnknown)),
3046 (String::from("a"), None, Some(cstore::NativeStatic)),
3047 (String::from("b"), None, Some(cstore::NativeStatic)),
3048 (String::from("c"), None, Some(cstore::NativeUnknown)),
3053 (String::from("a"), None, Some(cstore::NativeStatic)),
3056 Some(String::from("X")),
3057 Some(cstore::NativeFramework),
3059 (String::from("c"), None, Some(cstore::NativeUnknown)),
3062 assert!(v1.dep_tracking_hash() != v2.dep_tracking_hash());
3063 assert!(v1.dep_tracking_hash() != v3.dep_tracking_hash());
3064 assert!(v1.dep_tracking_hash() != v4.dep_tracking_hash());
3067 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
3068 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
3069 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
3070 assert_eq!(v4.dep_tracking_hash(), v4.clone().dep_tracking_hash());
3074 fn test_native_libs_tracking_hash_different_order() {
3075 let mut v1 = Options::default();
3076 let mut v2 = Options::default();
3077 let mut v3 = Options::default();
3081 (String::from("a"), None, Some(cstore::NativeStatic)),
3082 (String::from("b"), None, Some(cstore::NativeFramework)),
3083 (String::from("c"), None, Some(cstore::NativeUnknown)),
3087 (String::from("b"), None, Some(cstore::NativeFramework)),
3088 (String::from("a"), None, Some(cstore::NativeStatic)),
3089 (String::from("c"), None, Some(cstore::NativeUnknown)),
3093 (String::from("c"), None, Some(cstore::NativeUnknown)),
3094 (String::from("a"), None, Some(cstore::NativeStatic)),
3095 (String::from("b"), None, Some(cstore::NativeFramework)),
3098 assert!(v1.dep_tracking_hash() == v2.dep_tracking_hash());
3099 assert!(v1.dep_tracking_hash() == v3.dep_tracking_hash());
3100 assert!(v2.dep_tracking_hash() == v3.dep_tracking_hash());
3103 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
3104 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
3105 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
3109 fn test_codegen_options_tracking_hash() {
3110 let reference = Options::default();
3111 let mut opts = Options::default();
3113 // Make sure the changing an [UNTRACKED] option leaves the hash unchanged
3114 opts.cg.ar = Some(String::from("abc"));
3115 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3117 opts.cg.linker = Some(PathBuf::from("linker"));
3118 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3120 opts.cg.link_args = Some(vec![String::from("abc"), String::from("def")]);
3121 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3123 opts.cg.link_dead_code = true;
3124 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3126 opts.cg.rpath = true;
3127 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3129 opts.cg.extra_filename = String::from("extra-filename");
3130 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3132 opts.cg.codegen_units = Some(42);
3133 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3135 opts.cg.remark = super::Passes::Some(vec![String::from("pass1"), String::from("pass2")]);
3136 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3138 opts.cg.save_temps = true;
3139 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3141 opts.cg.incremental = Some(String::from("abc"));
3142 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3144 // Make sure changing a [TRACKED] option changes the hash
3145 opts = reference.clone();
3146 opts.cg.lto = LtoCli::Fat;
3147 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3149 opts = reference.clone();
3150 opts.cg.target_cpu = Some(String::from("abc"));
3151 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3153 opts = reference.clone();
3154 opts.cg.target_feature = String::from("all the features, all of them");
3155 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3157 opts = reference.clone();
3158 opts.cg.passes = vec![String::from("1"), String::from("2")];
3159 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3161 opts = reference.clone();
3162 opts.cg.llvm_args = vec![String::from("1"), String::from("2")];
3163 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3165 opts = reference.clone();
3166 opts.cg.overflow_checks = Some(true);
3167 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3169 opts = reference.clone();
3170 opts.cg.no_prepopulate_passes = true;
3171 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3173 opts = reference.clone();
3174 opts.cg.no_vectorize_loops = true;
3175 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3177 opts = reference.clone();
3178 opts.cg.no_vectorize_slp = true;
3179 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3181 opts = reference.clone();
3182 opts.cg.soft_float = true;
3183 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3185 opts = reference.clone();
3186 opts.cg.prefer_dynamic = true;
3187 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3189 opts = reference.clone();
3190 opts.cg.no_integrated_as = true;
3191 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3193 opts = reference.clone();
3194 opts.cg.no_redzone = Some(true);
3195 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3197 opts = reference.clone();
3198 opts.cg.relocation_model = Some(String::from("relocation model"));
3199 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3201 opts = reference.clone();
3202 opts.cg.code_model = Some(String::from("code model"));
3203 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3205 opts = reference.clone();
3206 opts.debugging_opts.tls_model = Some(String::from("tls model"));
3207 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3209 opts = reference.clone();
3210 opts.debugging_opts.pgo_gen = PgoGenerate::Enabled(None);
3211 assert_ne!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3213 opts = reference.clone();
3214 opts.debugging_opts.pgo_use = Some(PathBuf::from("abc"));
3215 assert_ne!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3217 opts = reference.clone();
3218 opts.cg.metadata = vec![String::from("A"), String::from("B")];
3219 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3221 opts = reference.clone();
3222 opts.cg.debuginfo = Some(0xdeadbeef);
3223 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3225 opts = reference.clone();
3226 opts.cg.debuginfo = Some(0xba5eba11);
3227 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3229 opts = reference.clone();
3230 opts.cg.force_frame_pointers = Some(false);
3231 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3233 opts = reference.clone();
3234 opts.cg.debug_assertions = Some(true);
3235 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3237 opts = reference.clone();
3238 opts.cg.inline_threshold = Some(0xf007ba11);
3239 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3241 opts = reference.clone();
3242 opts.cg.panic = Some(PanicStrategy::Abort);
3243 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3245 opts = reference.clone();
3246 opts.cg.linker_plugin_lto = LinkerPluginLto::LinkerPluginAuto;
3247 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3251 fn test_debugging_options_tracking_hash() {
3252 let reference = Options::default();
3253 let mut opts = Options::default();
3255 // Make sure the changing an [UNTRACKED] option leaves the hash unchanged
3256 opts.debugging_opts.verbose = true;
3257 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3258 opts.debugging_opts.time_passes = true;
3259 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3260 opts.debugging_opts.count_llvm_insns = true;
3261 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3262 opts.debugging_opts.time_llvm_passes = true;
3263 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3264 opts.debugging_opts.input_stats = true;
3265 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3266 opts.debugging_opts.codegen_stats = true;
3267 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3268 opts.debugging_opts.borrowck_stats = true;
3269 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3270 opts.debugging_opts.meta_stats = true;
3271 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3272 opts.debugging_opts.print_link_args = true;
3273 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3274 opts.debugging_opts.print_llvm_passes = true;
3275 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3276 opts.debugging_opts.ast_json = true;
3277 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3278 opts.debugging_opts.ast_json_noexpand = true;
3279 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3280 opts.debugging_opts.ls = true;
3281 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3282 opts.debugging_opts.save_analysis = true;
3283 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3284 opts.debugging_opts.flowgraph_print_loans = true;
3285 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3286 opts.debugging_opts.flowgraph_print_moves = true;
3287 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3288 opts.debugging_opts.flowgraph_print_assigns = true;
3289 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3290 opts.debugging_opts.flowgraph_print_all = true;
3291 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3292 opts.debugging_opts.print_region_graph = true;
3293 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3294 opts.debugging_opts.parse_only = true;
3295 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3296 opts.debugging_opts.incremental = Some(String::from("abc"));
3297 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3298 opts.debugging_opts.dump_dep_graph = true;
3299 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3300 opts.debugging_opts.query_dep_graph = true;
3301 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3302 opts.debugging_opts.no_analysis = true;
3303 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3304 opts.debugging_opts.unstable_options = true;
3305 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3306 opts.debugging_opts.trace_macros = true;
3307 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3308 opts.debugging_opts.keep_hygiene_data = true;
3309 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3310 opts.debugging_opts.keep_ast = true;
3311 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3312 opts.debugging_opts.print_mono_items = Some(String::from("abc"));
3313 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3314 opts.debugging_opts.dump_mir = Some(String::from("abc"));
3315 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3316 opts.debugging_opts.dump_mir_dir = String::from("abc");
3317 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3318 opts.debugging_opts.dump_mir_graphviz = true;
3319 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3321 // Make sure changing a [TRACKED] option changes the hash
3322 opts = reference.clone();
3323 opts.debugging_opts.asm_comments = true;
3324 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3326 opts = reference.clone();
3327 opts.debugging_opts.verify_llvm_ir = true;
3328 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3330 opts = reference.clone();
3331 opts.debugging_opts.no_landing_pads = true;
3332 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3334 opts = reference.clone();
3335 opts.debugging_opts.fewer_names = true;
3336 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3338 opts = reference.clone();
3339 opts.debugging_opts.no_codegen = true;
3340 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3342 opts = reference.clone();
3343 opts.debugging_opts.treat_err_as_bug = Some(1);
3344 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3346 opts = reference.clone();
3347 opts.debugging_opts.report_delayed_bugs = true;
3348 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3350 opts = reference.clone();
3351 opts.debugging_opts.continue_parse_after_error = true;
3352 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3354 opts = reference.clone();
3355 opts.debugging_opts.extra_plugins = vec![String::from("plugin1"), String::from("plugin2")];
3356 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3358 opts = reference.clone();
3359 opts.debugging_opts.force_overflow_checks = Some(true);
3360 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3362 opts = reference.clone();
3363 opts.debugging_opts.show_span = Some(String::from("abc"));
3364 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3366 opts = reference.clone();
3367 opts.debugging_opts.mir_opt_level = 3;
3368 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3370 opts = reference.clone();
3371 opts.debugging_opts.relro_level = Some(RelroLevel::Full);
3372 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3374 opts = reference.clone();
3375 opts.debugging_opts.merge_functions = Some(MergeFunctions::Disabled);
3376 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3378 opts = reference.clone();
3379 opts.debugging_opts.allow_features = Some(vec![String::from("lang_items")]);
3380 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3384 fn test_edition_parsing() {
3385 // test default edition
3386 let options = Options::default();
3387 assert!(options.edition == DEFAULT_EDITION);
3389 let matches = optgroups()
3390 .parse(&["--edition=2018".to_string()])
3392 let (sessopts, _) = build_session_options_and_crate_config(&matches);
3393 assert!(sessopts.edition == Edition::Edition2018)