1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Contains infrastructure for configuring the compiler, including parsing
12 //! command line options.
14 pub use self::EntryFnType::*;
15 pub use self::CrateType::*;
16 pub use self::Passes::*;
17 pub use self::DebugInfoLevel::*;
19 use std::str::FromStr;
21 use session::{early_error, early_warn, Session};
22 use session::search_paths::SearchPaths;
24 use ich::StableHashingContext;
25 use rustc_target::spec::{LinkerFlavor, PanicStrategy, RelroLevel};
26 use rustc_target::spec::{Target, TargetTriple};
27 use rustc_data_structures::stable_hasher::ToStableHashKey;
31 use syntax::ast::{self, IntTy, UintTy};
32 use syntax::codemap::{FileName, FilePathMapping};
33 use syntax::edition::{Edition, EDITION_NAME_LIST, DEFAULT_EDITION};
34 use syntax::parse::token;
36 use syntax::symbol::Symbol;
37 use syntax::feature_gate::UnstableFeatures;
39 use errors::{ColorConfig, FatalError, Handler};
42 use std::collections::{BTreeMap, BTreeSet};
43 use std::collections::btree_map::Iter as BTreeMapIter;
44 use std::collections::btree_map::Keys as BTreeMapKeysIter;
45 use std::collections::btree_map::Values as BTreeMapValuesIter;
48 use std::hash::Hasher;
49 use std::collections::hash_map::DefaultHasher;
50 use std::collections::HashSet;
51 use std::iter::FromIterator;
52 use std::path::{Path, PathBuf};
60 #[derive(Clone, Hash, Debug)]
68 #[derive(Clone, Copy, PartialEq, Hash)]
78 #[derive(Clone, Copy, PartialEq, Hash)]
80 /// Don't do any LTO whatsoever
83 /// Do a full crate graph LTO. The flavor is determined by the compiler
84 /// (currently the default is "fat").
87 /// Do a full crate graph LTO with ThinLTO
90 /// Do a local graph LTO with ThinLTO (only relevant for multiple codegen
94 /// Do a full crate graph LTO with "fat" LTO
98 #[derive(Clone, PartialEq, Hash)]
99 pub enum CrossLangLto {
100 LinkerPlugin(PathBuf),
106 pub fn embed_bitcode(&self) -> bool {
108 CrossLangLto::LinkerPlugin(_) |
109 CrossLangLto::NoLink => true,
110 CrossLangLto::Disabled => false,
115 #[derive(Clone, Copy, PartialEq, Hash)]
116 pub enum DebugInfoLevel {
122 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, PartialOrd, Ord, RustcEncodable, RustcDecodable)]
123 pub enum OutputType {
135 impl_stable_hash_for!(enum self::OutputType {
146 impl<'a, 'tcx> ToStableHashKey<StableHashingContext<'a>> for OutputType {
147 type KeyType = OutputType;
149 fn to_stable_hash_key(&self, _: &StableHashingContext<'a>) -> Self::KeyType {
155 fn is_compatible_with_codegen_units_and_single_output_file(&self) -> bool {
157 OutputType::Exe | OutputType::DepInfo => true,
159 | OutputType::Assembly
160 | OutputType::LlvmAssembly
163 | OutputType::Metadata => 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(ColorConfig),
229 impl Default for ErrorOutputType {
230 fn default() -> ErrorOutputType {
231 ErrorOutputType::HumanReadable(ColorConfig::Auto)
235 // Use tree-based collections to cheaply get a deterministic Hash implementation.
236 // DO NOT switch BTreeMap out for an unsorted container type! That would break
237 // dependency tracking for commandline arguments.
238 #[derive(Clone, Hash)]
239 pub struct OutputTypes(BTreeMap<OutputType, Option<PathBuf>>);
241 impl_stable_hash_for!(tuple_struct self::OutputTypes {
246 pub fn new(entries: &[(OutputType, Option<PathBuf>)]) -> OutputTypes {
247 OutputTypes(BTreeMap::from_iter(
248 entries.iter().map(|&(k, ref v)| (k, v.clone())),
252 pub fn get(&self, key: &OutputType) -> Option<&Option<PathBuf>> {
256 pub fn contains_key(&self, key: &OutputType) -> bool {
257 self.0.contains_key(key)
260 pub fn keys<'a>(&'a self) -> BTreeMapKeysIter<'a, OutputType, Option<PathBuf>> {
264 pub fn values<'a>(&'a self) -> BTreeMapValuesIter<'a, OutputType, Option<PathBuf>> {
268 pub fn len(&self) -> usize {
272 // True if any of the output types require codegen or linking.
273 pub fn should_codegen(&self) -> bool {
274 self.0.keys().any(|k| match *k {
276 | OutputType::Assembly
277 | OutputType::LlvmAssembly
280 | OutputType::Exe => true,
281 OutputType::Metadata | OutputType::DepInfo => false,
286 // Use tree-based collections to cheaply get a deterministic Hash implementation.
287 // DO NOT switch BTreeMap or BTreeSet out for an unsorted container type! That
288 // would break dependency tracking for commandline arguments.
289 #[derive(Clone, Hash)]
290 pub struct Externs(BTreeMap<String, BTreeSet<String>>);
293 pub fn new(data: BTreeMap<String, BTreeSet<String>>) -> Externs {
297 pub fn get(&self, key: &str) -> Option<&BTreeSet<String>> {
301 pub fn iter<'a>(&'a self) -> BTreeMapIter<'a, String, BTreeSet<String>> {
306 macro_rules! hash_option {
307 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, [UNTRACKED]) => ({});
308 ($opt_name:ident, $opt_expr:expr, $sub_hashes:expr, [TRACKED]) => ({
309 if $sub_hashes.insert(stringify!($opt_name),
310 $opt_expr as &dyn dep_tracking::DepTrackingHash).is_some() {
311 bug!("Duplicate key in CLI DepTrackingHash: {}", stringify!($opt_name))
317 [UNTRACKED_WITH_WARNING $warn_val:expr, $warn_text:expr, $error_format:expr]) => ({
318 if *$opt_expr == $warn_val {
319 early_warn($error_format, $warn_text)
324 macro_rules! top_level_options {
325 (pub struct Options { $(
326 $opt:ident : $t:ty [$dep_tracking_marker:ident $($warn_val:expr, $warn_text:expr)*],
334 pub fn dep_tracking_hash(&self) -> u64 {
335 let mut sub_hashes = BTreeMap::new();
340 [$dep_tracking_marker $($warn_val,
342 self.error_format)*]);
344 let mut hasher = DefaultHasher::new();
345 dep_tracking::stable_hash(sub_hashes,
354 // The top-level commandline options struct
356 // For each option, one has to specify how it behaves with regard to the
357 // dependency tracking system of incremental compilation. This is done via the
358 // square-bracketed directive after the field type. The options are:
361 // A change in the given field will cause the compiler to completely clear the
362 // incremental compilation cache before proceeding.
365 // Incremental compilation is not influenced by this option.
367 // [UNTRACKED_WITH_WARNING(val, warning)]
368 // The option is incompatible with incremental compilation in some way. If it
369 // has the value `val`, the string `warning` is emitted as a warning.
371 // If you add a new option to this struct or one of the sub-structs like
372 // CodegenOptions, think about how it influences incremental compilation. If in
373 // doubt, specify [TRACKED], which is always "correct" but might lead to
374 // unnecessary re-compilation.
377 // The crate config requested for the session, which may be combined
378 // with additional crate configurations during the compile process
379 crate_types: Vec<CrateType> [TRACKED],
380 optimize: OptLevel [TRACKED],
381 // Include the debug_assertions flag into dependency tracking, since it
382 // can influence whether overflow checks are done or not.
383 debug_assertions: bool [TRACKED],
384 debuginfo: DebugInfoLevel [TRACKED],
385 lint_opts: Vec<(String, lint::Level)> [TRACKED],
386 lint_cap: Option<lint::Level> [TRACKED],
387 describe_lints: bool [UNTRACKED],
388 output_types: OutputTypes [TRACKED],
389 search_paths: SearchPaths [UNTRACKED],
390 libs: Vec<(String, Option<String>, Option<cstore::NativeLibraryKind>)> [TRACKED],
391 maybe_sysroot: Option<PathBuf> [TRACKED],
393 target_triple: TargetTriple [TRACKED],
395 test: bool [TRACKED],
396 error_format: ErrorOutputType [UNTRACKED],
398 // if Some, enable incremental compilation, using the given
399 // directory to store intermediate results
400 incremental: Option<PathBuf> [UNTRACKED],
402 debugging_opts: DebuggingOptions [TRACKED],
403 prints: Vec<PrintRequest> [UNTRACKED],
404 // Determines which borrow checker(s) to run. This is the parsed, sanitized
405 // version of `debugging_opts.borrowck`, which is just a plain string.
406 borrowck_mode: BorrowckMode [UNTRACKED],
407 cg: CodegenOptions [TRACKED],
408 externs: Externs [UNTRACKED],
409 crate_name: Option<String> [TRACKED],
410 // An optional name to use as the crate for std during std injection,
411 // written `extern crate name as std`. Defaults to `std`. Used by
412 // out-of-tree drivers.
413 alt_std_name: Option<String> [TRACKED],
414 // Indicates how the compiler should treat unstable features
415 unstable_features: UnstableFeatures [TRACKED],
417 // Indicates whether this run of the compiler is actually rustdoc. This
418 // is currently just a hack and will be removed eventually, so please
419 // try to not rely on this too much.
420 actually_rustdoc: bool [TRACKED],
422 // Specifications of codegen units / ThinLTO which are forced as a
423 // result of parsing command line options. These are not necessarily
424 // what rustc was invoked with, but massaged a bit to agree with
425 // commands like `--emit llvm-ir` which they're often incompatible with
426 // if we otherwise use the defaults of rustc.
427 cli_forced_codegen_units: Option<usize> [UNTRACKED],
428 cli_forced_thinlto_off: bool [UNTRACKED],
430 // Remap source path prefixes in all output (messages, object files, debug, etc)
431 remap_path_prefix: Vec<(PathBuf, PathBuf)> [UNTRACKED],
433 edition: Edition [TRACKED],
437 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
438 pub enum PrintRequest {
453 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
454 pub enum BorrowckMode {
461 /// Should we emit the AST-based borrow checker errors?
462 pub fn use_ast(self) -> bool {
464 BorrowckMode::Ast => true,
465 BorrowckMode::Compare => true,
466 BorrowckMode::Mir => false,
469 /// Should we emit the MIR-based borrow checker errors?
470 pub fn use_mir(self) -> bool {
472 BorrowckMode::Ast => false,
473 BorrowckMode::Compare => true,
474 BorrowckMode::Mir => true,
480 /// Load source from file
483 /// String that is shown in place of a filename
485 /// Anonymous source string
491 pub fn filestem(&self) -> String {
493 Input::File(ref ifile) => ifile.file_stem().unwrap().to_str().unwrap().to_string(),
494 Input::Str { .. } => "rust_out".to_string(),
498 pub fn get_input(&mut self) -> Option<&mut String> {
500 Input::File(_) => None,
501 Input::Str { ref mut input, .. } => Some(input),
507 pub struct OutputFilenames {
508 pub out_directory: PathBuf,
509 pub out_filestem: String,
510 pub single_output_file: Option<PathBuf>,
512 pub outputs: OutputTypes,
515 impl_stable_hash_for!(struct self::OutputFilenames {
523 pub const RUST_CGU_EXT: &str = "rcgu";
525 impl OutputFilenames {
526 pub fn path(&self, flavor: OutputType) -> PathBuf {
529 .and_then(|p| p.to_owned())
530 .or_else(|| self.single_output_file.clone())
531 .unwrap_or_else(|| self.temp_path(flavor, None))
534 /// Get the path where a compilation artifact of the given type for the
535 /// given codegen unit should be placed on disk. If codegen_unit_name is
536 /// None, a path distinct from those of any codegen unit will be generated.
537 pub fn temp_path(&self, flavor: OutputType, codegen_unit_name: Option<&str>) -> PathBuf {
538 let extension = flavor.extension();
539 self.temp_path_ext(extension, codegen_unit_name)
542 /// Like temp_path, but also supports things where there is no corresponding
543 /// OutputType, like no-opt-bitcode or lto-bitcode.
544 pub fn temp_path_ext(&self, ext: &str, codegen_unit_name: Option<&str>) -> PathBuf {
545 let base = self.out_directory.join(&self.filestem());
547 let mut extension = String::new();
549 if let Some(codegen_unit_name) = codegen_unit_name {
550 extension.push_str(codegen_unit_name);
554 if !extension.is_empty() {
555 extension.push_str(".");
556 extension.push_str(RUST_CGU_EXT);
557 extension.push_str(".");
560 extension.push_str(ext);
563 let path = base.with_extension(&extension[..]);
567 pub fn with_extension(&self, extension: &str) -> PathBuf {
569 .join(&self.filestem())
570 .with_extension(extension)
573 pub fn filestem(&self) -> String {
574 format!("{}{}", self.out_filestem, self.extra)
578 pub fn host_triple() -> &'static str {
579 // Get the host triple out of the build environment. This ensures that our
580 // idea of the host triple is the same as for the set of libraries we've
581 // actually built. We can't just take LLVM's host triple because they
582 // normalize all ix86 architectures to i386.
584 // Instead of grabbing the host triple (for the current host), we grab (at
585 // compile time) the target triple that this rustc is built with and
586 // calling that (at runtime) the host triple.
587 (option_env!("CFG_COMPILER_HOST_TRIPLE")).expect("CFG_COMPILER_HOST_TRIPLE")
590 /// Some reasonable defaults
591 pub fn basic_options() -> Options {
593 crate_types: Vec::new(),
594 optimize: OptLevel::No,
595 debuginfo: NoDebugInfo,
596 lint_opts: Vec::new(),
598 describe_lints: false,
599 output_types: OutputTypes(BTreeMap::new()),
600 search_paths: SearchPaths::new(),
602 target_triple: TargetTriple::from_triple(host_triple()),
605 debugging_opts: basic_debugging_options(),
607 borrowck_mode: BorrowckMode::Ast,
608 cg: basic_codegen_options(),
609 error_format: ErrorOutputType::default(),
610 externs: Externs(BTreeMap::new()),
614 unstable_features: UnstableFeatures::Disallow,
615 debug_assertions: true,
616 actually_rustdoc: false,
617 cli_forced_codegen_units: None,
618 cli_forced_thinlto_off: false,
619 remap_path_prefix: Vec::new(),
620 edition: DEFAULT_EDITION,
625 /// True if there is a reason to build the dep graph.
626 pub fn build_dep_graph(&self) -> bool {
627 self.incremental.is_some() || self.debugging_opts.dump_dep_graph
628 || self.debugging_opts.query_dep_graph
632 pub fn enable_dep_node_debug_strs(&self) -> bool {
633 cfg!(debug_assertions)
634 && (self.debugging_opts.query_dep_graph || self.debugging_opts.incremental_info)
637 pub fn file_path_mapping(&self) -> FilePathMapping {
638 FilePathMapping::new(self.remap_path_prefix.clone())
641 /// True if there will be an output file generated
642 pub fn will_create_output_file(&self) -> bool {
643 !self.debugging_opts.parse_only && // The file is just being parsed
644 !self.debugging_opts.ls // The file is just being queried
648 // The type of entry function, so
649 // users can have their own entry
651 #[derive(Copy, Clone, PartialEq)]
652 pub enum EntryFnType {
657 #[derive(Copy, PartialEq, PartialOrd, Clone, Ord, Eq, Hash, Debug)]
667 #[derive(Clone, Hash)]
669 SomePasses(Vec<String>),
674 pub fn is_empty(&self) -> bool {
676 SomePasses(ref v) => v.is_empty(),
682 /// Declare a macro that will define all CodegenOptions/DebuggingOptions fields and parsers all
683 /// at once. The goal of this macro is to define an interface that can be
684 /// programmatically used by the option parser in order to initialize the struct
685 /// without hardcoding field names all over the place.
687 /// The goal is to invoke this macro once with the correct fields, and then this
688 /// macro generates all necessary code. The main gotcha of this macro is the
689 /// cgsetters module which is a bunch of generated code to parse an option into
690 /// its respective field in the struct. There are a few hand-written parsers for
691 /// parsing specific types of values in this module.
692 macro_rules! options {
693 ($struct_name:ident, $setter_name:ident, $defaultfn:ident,
694 $buildfn:ident, $prefix:expr, $outputname:expr,
695 $stat:ident, $mod_desc:ident, $mod_set:ident,
696 $($opt:ident : $t:ty = (
699 [$dep_tracking_marker:ident $(($dep_warn_val:expr, $dep_warn_text:expr))*],
704 pub struct $struct_name { $(pub $opt: $t),* }
706 pub fn $defaultfn() -> $struct_name {
707 $struct_name { $($opt: $init),* }
710 pub fn $buildfn(matches: &getopts::Matches, error_format: ErrorOutputType) -> $struct_name
712 let mut op = $defaultfn();
713 for option in matches.opt_strs($prefix) {
714 let mut iter = option.splitn(2, '=');
715 let key = iter.next().unwrap();
716 let value = iter.next();
717 let option_to_lookup = key.replace("-", "_");
718 let mut found = false;
719 for &(candidate, setter, opt_type_desc, _) in $stat {
720 if option_to_lookup != candidate { continue }
721 if !setter(&mut op, value) {
722 match (value, opt_type_desc) {
723 (Some(..), None) => {
724 early_error(error_format, &format!("{} option `{}` takes no \
725 value", $outputname, key))
727 (None, Some(type_desc)) => {
728 early_error(error_format, &format!("{0} option `{1}` requires \
729 {2} ({3} {1}=<value>)",
733 (Some(value), Some(type_desc)) => {
734 early_error(error_format, &format!("incorrect value `{}` for {} \
735 option `{}` - {} was expected",
739 (None, None) => bug!()
746 early_error(error_format, &format!("unknown {} option: `{}`",
753 impl<'a> dep_tracking::DepTrackingHash for $struct_name {
755 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
756 let mut sub_hashes = BTreeMap::new();
761 [$dep_tracking_marker $($dep_warn_val,
765 dep_tracking::stable_hash(sub_hashes, hasher, error_format);
769 pub type $setter_name = fn(&mut $struct_name, v: Option<&str>) -> bool;
770 pub const $stat: &'static [(&'static str, $setter_name,
771 Option<&'static str>, &'static str)] =
772 &[ $( (stringify!($opt), $mod_set::$opt, $mod_desc::$parse, $desc) ),* ];
774 #[allow(non_upper_case_globals, dead_code)]
776 pub const parse_bool: Option<&'static str> = None;
777 pub const parse_opt_bool: Option<&'static str> =
778 Some("one of: `y`, `yes`, `on`, `n`, `no`, or `off`");
779 pub const parse_string: Option<&'static str> = Some("a string");
780 pub const parse_string_push: Option<&'static str> = Some("a string");
781 pub const parse_pathbuf_push: Option<&'static str> = Some("a path");
782 pub const parse_opt_string: Option<&'static str> = Some("a string");
783 pub const parse_opt_pathbuf: Option<&'static str> = Some("a path");
784 pub const parse_list: Option<&'static str> = Some("a space-separated list of strings");
785 pub const parse_opt_list: Option<&'static str> = Some("a space-separated list of strings");
786 pub const parse_uint: Option<&'static str> = Some("a number");
787 pub const parse_passes: Option<&'static str> =
788 Some("a space-separated list of passes, or `all`");
789 pub const parse_opt_uint: Option<&'static str> =
791 pub const parse_panic_strategy: Option<&'static str> =
792 Some("either `panic` or `abort`");
793 pub const parse_relro_level: Option<&'static str> =
794 Some("one of: `full`, `partial`, or `off`");
795 pub const parse_sanitizer: Option<&'static str> =
796 Some("one of: `address`, `leak`, `memory` or `thread`");
797 pub const parse_linker_flavor: Option<&'static str> =
798 Some(::rustc_target::spec::LinkerFlavor::one_of());
799 pub const parse_optimization_fuel: Option<&'static str> =
800 Some("crate=integer");
801 pub const parse_unpretty: Option<&'static str> =
802 Some("`string` or `string=string`");
803 pub const parse_lto: Option<&'static str> =
804 Some("one of `thin`, `fat`, or omitted");
805 pub const parse_cross_lang_lto: Option<&'static str> =
806 Some("either a boolean (`yes`, `no`, `on`, `off`, etc), `no-link`, \
807 or the path to the linker plugin");
812 use super::{$struct_name, Passes, SomePasses, AllPasses, Sanitizer, Lto,
814 use rustc_target::spec::{LinkerFlavor, PanicStrategy, RelroLevel};
815 use std::path::PathBuf;
818 pub fn $opt(cg: &mut $struct_name, v: Option<&str>) -> bool {
819 $parse(&mut cg.$opt, v)
823 fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
826 None => { *slot = true; true }
830 fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
834 "n" | "no" | "off" => {
837 "y" | "yes" | "on" => {
840 _ => { return false; }
845 None => { *slot = Some(true); true }
849 fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
851 Some(s) => { *slot = Some(s.to_string()); true },
856 fn parse_opt_pathbuf(slot: &mut Option<PathBuf>, v: Option<&str>) -> bool {
858 Some(s) => { *slot = Some(PathBuf::from(s)); true },
863 fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
865 Some(s) => { *slot = s.to_string(); true },
870 fn parse_string_push(slot: &mut Vec<String>, v: Option<&str>) -> bool {
872 Some(s) => { slot.push(s.to_string()); true },
877 fn parse_pathbuf_push(slot: &mut Vec<PathBuf>, v: Option<&str>) -> bool {
879 Some(s) => { slot.push(PathBuf::from(s)); true },
884 fn parse_list(slot: &mut Vec<String>, v: Option<&str>)
888 for s in s.split_whitespace() {
889 slot.push(s.to_string());
897 fn parse_opt_list(slot: &mut Option<Vec<String>>, v: Option<&str>)
901 let v = s.split_whitespace().map(|s| s.to_string()).collect();
909 fn parse_uint(slot: &mut usize, v: Option<&str>) -> bool {
910 match v.and_then(|s| s.parse().ok()) {
911 Some(i) => { *slot = i; true },
916 fn parse_opt_uint(slot: &mut Option<usize>, v: Option<&str>) -> bool {
918 Some(s) => { *slot = s.parse().ok(); slot.is_some() }
919 None => { *slot = None; false }
923 fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
930 let mut passes = vec![];
931 if parse_list(&mut passes, v) {
932 *slot = SomePasses(passes);
941 fn parse_panic_strategy(slot: &mut Option<PanicStrategy>, v: Option<&str>) -> bool {
943 Some("unwind") => *slot = Some(PanicStrategy::Unwind),
944 Some("abort") => *slot = Some(PanicStrategy::Abort),
950 fn parse_relro_level(slot: &mut Option<RelroLevel>, v: Option<&str>) -> bool {
953 match s.parse::<RelroLevel>() {
954 Ok(level) => *slot = Some(level),
963 fn parse_sanitizer(slote: &mut Option<Sanitizer>, v: Option<&str>) -> bool {
965 Some("address") => *slote = Some(Sanitizer::Address),
966 Some("leak") => *slote = Some(Sanitizer::Leak),
967 Some("memory") => *slote = Some(Sanitizer::Memory),
968 Some("thread") => *slote = Some(Sanitizer::Thread),
974 fn parse_linker_flavor(slote: &mut Option<LinkerFlavor>, v: Option<&str>) -> bool {
975 match v.and_then(LinkerFlavor::from_str) {
976 Some(lf) => *slote = Some(lf),
982 fn parse_optimization_fuel(slot: &mut Option<(String, u64)>, v: Option<&str>) -> bool {
986 let parts = s.split('=').collect::<Vec<_>>();
987 if parts.len() != 2 { return false; }
988 let crate_name = parts[0].to_string();
989 let fuel = parts[1].parse::<u64>();
990 if fuel.is_err() { return false; }
991 *slot = Some((crate_name, fuel.unwrap()));
997 fn parse_unpretty(slot: &mut Option<String>, v: Option<&str>) -> bool {
1000 Some(s) if s.split('=').count() <= 2 => {
1001 *slot = Some(s.to_string());
1008 fn parse_lto(slot: &mut Lto, v: Option<&str>) -> bool {
1011 Some("thin") => Lto::Thin,
1012 Some("fat") => Lto::Fat,
1013 Some(_) => return false,
1018 fn parse_cross_lang_lto(slot: &mut CrossLangLto, v: Option<&str>) -> bool {
1020 let mut bool_arg = None;
1021 if parse_opt_bool(&mut bool_arg, v) {
1022 *slot = if bool_arg.unwrap() {
1023 CrossLangLto::NoLink
1025 CrossLangLto::Disabled
1033 Some("no-link") => CrossLangLto::NoLink,
1034 Some(path) => CrossLangLto::LinkerPlugin(PathBuf::from(path)),
1041 options! {CodegenOptions, CodegenSetter, basic_codegen_options,
1042 build_codegen_options, "C", "codegen",
1043 CG_OPTIONS, cg_type_desc, cgsetters,
1044 ar: Option<String> = (None, parse_opt_string, [UNTRACKED],
1045 "this option is deprecated and does nothing"),
1046 linker: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED],
1047 "system linker to link outputs with"),
1048 link_arg: Vec<String> = (vec![], parse_string_push, [UNTRACKED],
1049 "a single extra argument to append to the linker invocation (can be used several times)"),
1050 link_args: Option<Vec<String>> = (None, parse_opt_list, [UNTRACKED],
1051 "extra arguments to append to the linker invocation (space separated)"),
1052 link_dead_code: bool = (false, parse_bool, [UNTRACKED],
1053 "don't let linker strip dead code (turning it on can be used for code coverage)"),
1054 lto: Lto = (Lto::No, parse_lto, [TRACKED],
1055 "perform LLVM link-time optimizations"),
1056 target_cpu: Option<String> = (None, parse_opt_string, [TRACKED],
1057 "select target processor (rustc --print target-cpus for details)"),
1058 target_feature: String = ("".to_string(), parse_string, [TRACKED],
1059 "target specific attributes (rustc --print target-features for details)"),
1060 passes: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1061 "a list of extra LLVM passes to run (space separated)"),
1062 llvm_args: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1063 "a list of arguments to pass to llvm (space separated)"),
1064 save_temps: bool = (false, parse_bool, [UNTRACKED_WITH_WARNING(true,
1065 "`-C save-temps` might not produce all requested temporary products \
1066 when incremental compilation is enabled.")],
1067 "save all temporary output files during compilation"),
1068 rpath: bool = (false, parse_bool, [UNTRACKED],
1069 "set rpath values in libs/exes"),
1070 overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1071 "use overflow checks for integer arithmetic"),
1072 no_prepopulate_passes: bool = (false, parse_bool, [TRACKED],
1073 "don't pre-populate the pass manager with a list of passes"),
1074 no_vectorize_loops: bool = (false, parse_bool, [TRACKED],
1075 "don't run the loop vectorization optimization passes"),
1076 no_vectorize_slp: bool = (false, parse_bool, [TRACKED],
1077 "don't run LLVM's SLP vectorization pass"),
1078 soft_float: bool = (false, parse_bool, [TRACKED],
1079 "use soft float ABI (*eabihf targets only)"),
1080 prefer_dynamic: bool = (false, parse_bool, [TRACKED],
1081 "prefer dynamic linking to static linking"),
1082 no_integrated_as: bool = (false, parse_bool, [TRACKED],
1083 "use an external assembler rather than LLVM's integrated one"),
1084 no_redzone: Option<bool> = (None, parse_opt_bool, [TRACKED],
1085 "disable the use of the redzone"),
1086 relocation_model: Option<String> = (None, parse_opt_string, [TRACKED],
1087 "choose the relocation model to use (rustc --print relocation-models for details)"),
1088 code_model: Option<String> = (None, parse_opt_string, [TRACKED],
1089 "choose the code model to use (rustc --print code-models for details)"),
1090 metadata: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1091 "metadata to mangle symbol names with"),
1092 extra_filename: String = ("".to_string(), parse_string, [UNTRACKED],
1093 "extra data to put in each output filename"),
1094 codegen_units: Option<usize> = (None, parse_opt_uint, [UNTRACKED],
1095 "divide crate into N units to optimize in parallel"),
1096 remark: Passes = (SomePasses(Vec::new()), parse_passes, [UNTRACKED],
1097 "print remarks for these optimization passes (space separated, or \"all\")"),
1098 no_stack_check: bool = (false, parse_bool, [UNTRACKED],
1099 "the --no-stack-check flag is deprecated and does nothing"),
1100 debuginfo: Option<usize> = (None, parse_opt_uint, [TRACKED],
1101 "debug info emission level, 0 = no debug info, 1 = line tables only, \
1102 2 = full debug info with variable and type information"),
1103 opt_level: Option<String> = (None, parse_opt_string, [TRACKED],
1104 "optimize with possible levels 0-3, s, or z"),
1105 force_frame_pointers: Option<bool> = (None, parse_opt_bool, [TRACKED],
1106 "force use of the frame pointers"),
1107 debug_assertions: Option<bool> = (None, parse_opt_bool, [TRACKED],
1108 "explicitly enable the cfg(debug_assertions) directive"),
1109 inline_threshold: Option<usize> = (None, parse_opt_uint, [TRACKED],
1110 "set the threshold for inlining a function (default: 225)"),
1111 panic: Option<PanicStrategy> = (None, parse_panic_strategy,
1112 [TRACKED], "panic strategy to compile crate with"),
1113 incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
1114 "enable incremental compilation"),
1117 options! {DebuggingOptions, DebuggingSetter, basic_debugging_options,
1118 build_debugging_options, "Z", "debugging",
1119 DB_OPTIONS, db_type_desc, dbsetters,
1120 codegen_backend: Option<String> = (None, parse_opt_string, [TRACKED],
1121 "the backend to use"),
1122 verbose: bool = (false, parse_bool, [UNTRACKED],
1123 "in general, enable more debug printouts"),
1124 span_free_formats: bool = (false, parse_bool, [UNTRACKED],
1125 "when debug-printing compiler state, do not include spans"), // o/w tests have closure@path
1126 identify_regions: bool = (false, parse_bool, [UNTRACKED],
1127 "make unnamed regions display as '# (where # is some non-ident unique id)"),
1128 emit_end_regions: bool = (false, parse_bool, [UNTRACKED],
1129 "emit EndRegion as part of MIR; enable transforms that solely process EndRegion"),
1130 borrowck: Option<String> = (None, parse_opt_string, [UNTRACKED],
1131 "select which borrowck is used (`ast`, `mir`, or `compare`)"),
1132 two_phase_borrows: bool = (false, parse_bool, [UNTRACKED],
1133 "use two-phase reserved/active distinction for `&mut` borrows in MIR borrowck"),
1134 two_phase_beyond_autoref: bool = (false, parse_bool, [UNTRACKED],
1135 "when using two-phase-borrows, allow two phases even for non-autoref `&mut` borrows"),
1136 time_passes: bool = (false, parse_bool, [UNTRACKED],
1137 "measure time of each rustc pass"),
1138 count_llvm_insns: bool = (false, parse_bool,
1139 [UNTRACKED_WITH_WARNING(true,
1140 "The output generated by `-Z count_llvm_insns` might not be reliable \
1141 when used with incremental compilation")],
1142 "count where LLVM instrs originate"),
1143 time_llvm_passes: bool = (false, parse_bool, [UNTRACKED_WITH_WARNING(true,
1144 "The output of `-Z time-llvm-passes` will only reflect timings of \
1145 re-codegened modules when used with incremental compilation" )],
1146 "measure time of each LLVM pass"),
1147 input_stats: bool = (false, parse_bool, [UNTRACKED],
1148 "gather statistics about the input"),
1149 codegen_stats: bool = (false, parse_bool, [UNTRACKED_WITH_WARNING(true,
1150 "The output of `-Z codegen-stats` might not be accurate when incremental \
1151 compilation is enabled")],
1152 "gather codegen statistics"),
1153 asm_comments: bool = (false, parse_bool, [TRACKED],
1154 "generate comments into the assembly (may change behavior)"),
1155 no_verify: bool = (false, parse_bool, [TRACKED],
1156 "skip LLVM verification"),
1157 borrowck_stats: bool = (false, parse_bool, [UNTRACKED],
1158 "gather borrowck statistics"),
1159 no_landing_pads: bool = (false, parse_bool, [TRACKED],
1160 "omit landing pads for unwinding"),
1161 fewer_names: bool = (false, parse_bool, [TRACKED],
1162 "reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR)"),
1163 meta_stats: bool = (false, parse_bool, [UNTRACKED],
1164 "gather metadata statistics"),
1165 print_link_args: bool = (false, parse_bool, [UNTRACKED],
1166 "print the arguments passed to the linker"),
1167 print_llvm_passes: bool = (false, parse_bool, [UNTRACKED],
1168 "prints the llvm optimization passes being run"),
1169 ast_json: bool = (false, parse_bool, [UNTRACKED],
1170 "print the AST as JSON and halt"),
1171 query_threads: Option<usize> = (None, parse_opt_uint, [UNTRACKED],
1172 "execute queries on a thread pool with N threads"),
1173 ast_json_noexpand: bool = (false, parse_bool, [UNTRACKED],
1174 "print the pre-expansion AST as JSON and halt"),
1175 ls: bool = (false, parse_bool, [UNTRACKED],
1176 "list the symbols defined by a library crate"),
1177 save_analysis: bool = (false, parse_bool, [UNTRACKED],
1178 "write syntax and type analysis (in JSON format) information, in \
1179 addition to normal output"),
1180 flowgraph_print_loans: bool = (false, parse_bool, [UNTRACKED],
1181 "include loan analysis data in -Z unpretty flowgraph output"),
1182 flowgraph_print_moves: bool = (false, parse_bool, [UNTRACKED],
1183 "include move analysis data in -Z unpretty flowgraph output"),
1184 flowgraph_print_assigns: bool = (false, parse_bool, [UNTRACKED],
1185 "include assignment analysis data in -Z unpretty flowgraph output"),
1186 flowgraph_print_all: bool = (false, parse_bool, [UNTRACKED],
1187 "include all dataflow analysis data in -Z unpretty flowgraph output"),
1188 print_region_graph: bool = (false, parse_bool, [UNTRACKED],
1189 "prints region inference graph. \
1190 Use with RUST_REGION_GRAPH=help for more info"),
1191 parse_only: bool = (false, parse_bool, [UNTRACKED],
1192 "parse only; do not compile, assemble, or link"),
1193 no_codegen: bool = (false, parse_bool, [TRACKED],
1194 "run all passes except codegen; no output"),
1195 treat_err_as_bug: bool = (false, parse_bool, [TRACKED],
1196 "treat all errors that occur as bugs"),
1197 external_macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
1198 "show macro backtraces even for non-local macros"),
1199 teach: bool = (false, parse_bool, [TRACKED],
1200 "show extended diagnostic help"),
1201 continue_parse_after_error: bool = (false, parse_bool, [TRACKED],
1202 "attempt to recover from parse errors (experimental)"),
1203 incremental: Option<String> = (None, parse_opt_string, [UNTRACKED],
1204 "enable incremental compilation (experimental)"),
1205 incremental_queries: bool = (true, parse_bool, [UNTRACKED],
1206 "enable incremental compilation support for queries (experimental)"),
1207 incremental_info: bool = (false, parse_bool, [UNTRACKED],
1208 "print high-level information about incremental reuse (or the lack thereof)"),
1209 incremental_dump_hash: bool = (false, parse_bool, [UNTRACKED],
1210 "dump hash information in textual format to stdout"),
1211 incremental_verify_ich: bool = (false, parse_bool, [UNTRACKED],
1212 "verify incr. comp. hashes of green query instances"),
1213 incremental_ignore_spans: bool = (false, parse_bool, [UNTRACKED],
1214 "ignore spans during ICH computation -- used for testing"),
1215 dump_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1216 "dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv)"),
1217 query_dep_graph: bool = (false, parse_bool, [UNTRACKED],
1218 "enable queries of the dependency graph for regression testing"),
1219 profile_queries: bool = (false, parse_bool, [UNTRACKED],
1220 "trace and profile the queries of the incremental compilation framework"),
1221 profile_queries_and_keys: bool = (false, parse_bool, [UNTRACKED],
1222 "trace and profile the queries and keys of the incremental compilation framework"),
1223 no_analysis: bool = (false, parse_bool, [UNTRACKED],
1224 "parse and expand the source, but run no analysis"),
1225 extra_plugins: Vec<String> = (Vec::new(), parse_list, [TRACKED],
1226 "load extra plugins"),
1227 unstable_options: bool = (false, parse_bool, [UNTRACKED],
1228 "adds unstable command line options to rustc interface"),
1229 force_overflow_checks: Option<bool> = (None, parse_opt_bool, [TRACKED],
1230 "force overflow checks on or off"),
1231 trace_macros: bool = (false, parse_bool, [UNTRACKED],
1232 "for every macro invocation, print its name and arguments"),
1233 debug_macros: bool = (false, parse_bool, [TRACKED],
1234 "emit line numbers debug info inside macros"),
1235 enable_nonzeroing_move_hints: bool = (false, parse_bool, [TRACKED],
1236 "force nonzeroing move optimization on"),
1237 keep_hygiene_data: bool = (false, parse_bool, [UNTRACKED],
1238 "don't clear the hygiene data after analysis"),
1239 keep_ast: bool = (false, parse_bool, [UNTRACKED],
1240 "keep the AST after lowering it to HIR"),
1241 show_span: Option<String> = (None, parse_opt_string, [TRACKED],
1242 "show spans for compiler debugging (expr|pat|ty)"),
1243 print_type_sizes: bool = (false, parse_bool, [UNTRACKED],
1244 "print layout information for each type encountered"),
1245 print_mono_items: Option<String> = (None, parse_opt_string, [UNTRACKED],
1246 "print the result of the monomorphization collection pass"),
1247 mir_opt_level: usize = (1, parse_uint, [TRACKED],
1248 "set the MIR optimization level (0-3, default: 1)"),
1249 mutable_noalias: Option<bool> = (None, parse_opt_bool, [TRACKED],
1250 "emit noalias metadata for mutable references (default: yes on LLVM >= 6)"),
1251 arg_align_attributes: bool = (false, parse_bool, [TRACKED],
1252 "emit align metadata for reference arguments"),
1253 dump_mir: Option<String> = (None, parse_opt_string, [UNTRACKED],
1254 "dump MIR state at various points in transforms"),
1255 dump_mir_dir: String = (String::from("mir_dump"), parse_string, [UNTRACKED],
1256 "the directory the MIR is dumped into"),
1257 dump_mir_graphviz: bool = (false, parse_bool, [UNTRACKED],
1258 "in addition to `.mir` files, create graphviz `.dot` files"),
1259 dump_mir_exclude_pass_number: bool = (false, parse_bool, [UNTRACKED],
1260 "if set, exclude the pass number when dumping MIR (used in tests)"),
1261 mir_emit_validate: usize = (0, parse_uint, [TRACKED],
1262 "emit Validate MIR statements, interpreted e.g. by miri (0: do not emit; 1: if function \
1263 contains unsafe block, only validate arguments; 2: always emit full validation)"),
1264 perf_stats: bool = (false, parse_bool, [UNTRACKED],
1265 "print some performance-related statistics"),
1266 hir_stats: bool = (false, parse_bool, [UNTRACKED],
1267 "print some statistics about AST and HIR"),
1268 mir_stats: bool = (false, parse_bool, [UNTRACKED],
1269 "print some statistics about MIR"),
1270 always_encode_mir: bool = (false, parse_bool, [TRACKED],
1271 "encode MIR of all functions into the crate metadata"),
1272 osx_rpath_install_name: bool = (false, parse_bool, [TRACKED],
1273 "pass `-install_name @rpath/...` to the macOS linker"),
1274 sanitizer: Option<Sanitizer> = (None, parse_sanitizer, [TRACKED],
1276 linker_flavor: Option<LinkerFlavor> = (None, parse_linker_flavor, [UNTRACKED],
1278 fuel: Option<(String, u64)> = (None, parse_optimization_fuel, [TRACKED],
1279 "set the optimization fuel quota for a crate"),
1280 print_fuel: Option<String> = (None, parse_opt_string, [TRACKED],
1281 "make Rustc print the total optimization fuel used by a crate"),
1282 force_unstable_if_unmarked: bool = (false, parse_bool, [TRACKED],
1283 "force all crates to be `rustc_private` unstable"),
1284 pre_link_arg: Vec<String> = (vec![], parse_string_push, [UNTRACKED],
1285 "a single extra argument to prepend the linker invocation (can be used several times)"),
1286 pre_link_args: Option<Vec<String>> = (None, parse_opt_list, [UNTRACKED],
1287 "extra arguments to prepend to the linker invocation (space separated)"),
1288 profile: bool = (false, parse_bool, [TRACKED],
1289 "insert profiling code"),
1290 pgo_gen: Option<String> = (None, parse_opt_string, [TRACKED],
1291 "Generate PGO profile data, to a given file, or to the default \
1292 location if it's empty."),
1293 pgo_use: String = (String::new(), parse_string, [TRACKED],
1294 "Use PGO profile data from the given profile file."),
1295 disable_instrumentation_preinliner: bool =
1296 (false, parse_bool, [TRACKED], "Disable the instrumentation pre-inliner, \
1297 useful for profiling / PGO."),
1298 relro_level: Option<RelroLevel> = (None, parse_relro_level, [TRACKED],
1299 "choose which RELRO level to use"),
1300 disable_ast_check_for_mutation_in_guard: bool = (false, parse_bool, [UNTRACKED],
1301 "skip AST-based mutation-in-guard check (mir-borrowck provides more precise check)"),
1302 nll_subminimal_causes: bool = (false, parse_bool, [UNTRACKED],
1303 "when tracking region error causes, accept subminimal results for faster execution."),
1304 nll_facts: bool = (false, parse_bool, [UNTRACKED],
1305 "dump facts from NLL analysis into side files"),
1306 disable_nll_user_type_assert: bool = (false, parse_bool, [UNTRACKED],
1307 "disable user provided type assertion in NLL"),
1308 nll_dont_emit_read_for_match: bool = (false, parse_bool, [UNTRACKED],
1309 "in match codegen, do not include ReadForMatch statements (used by mir-borrowck)"),
1310 polonius: bool = (false, parse_bool, [UNTRACKED],
1311 "enable polonius-based borrow-checker"),
1312 codegen_time_graph: bool = (false, parse_bool, [UNTRACKED],
1313 "generate a graphical HTML report of time spent in codegen and LLVM"),
1314 thinlto: Option<bool> = (None, parse_opt_bool, [TRACKED],
1315 "enable ThinLTO when possible"),
1316 inline_in_all_cgus: Option<bool> = (None, parse_opt_bool, [TRACKED],
1317 "control whether #[inline] functions are in all cgus"),
1318 tls_model: Option<String> = (None, parse_opt_string, [TRACKED],
1319 "choose the TLS model to use (rustc --print tls-models for details)"),
1320 saturating_float_casts: bool = (false, parse_bool, [TRACKED],
1321 "make float->int casts UB-free: numbers outside the integer type's range are clipped to \
1322 the max/min integer respectively, and NaN is mapped to 0"),
1323 lower_128bit_ops: Option<bool> = (None, parse_opt_bool, [TRACKED],
1324 "rewrite operators on i128 and u128 into lang item calls (typically provided \
1325 by compiler-builtins) so codegen doesn't need to support them,
1326 overriding the default for the current target"),
1327 human_readable_cgu_names: bool = (false, parse_bool, [TRACKED],
1328 "generate human-readable, predictable names for codegen units"),
1329 dep_info_omit_d_target: bool = (false, parse_bool, [TRACKED],
1330 "in dep-info output, omit targets for tracking dependencies of the dep-info files \
1332 unpretty: Option<String> = (None, parse_unpretty, [UNTRACKED],
1333 "Present the input source, unstable (and less-pretty) variants;
1334 valid types are any of the types for `--pretty`, as well as:
1335 `flowgraph=<nodeid>` (graphviz formatted flowgraph for node),
1336 `everybody_loops` (all function bodies replaced with `loop {}`),
1337 `hir` (the HIR), `hir,identified`, or
1338 `hir,typed` (HIR with types for each node)."),
1339 run_dsymutil: Option<bool> = (None, parse_opt_bool, [TRACKED],
1340 "run `dsymutil` and delete intermediate object files"),
1341 ui_testing: bool = (false, parse_bool, [UNTRACKED],
1342 "format compiler diagnostics in a way that's better suitable for UI testing"),
1343 embed_bitcode: bool = (false, parse_bool, [TRACKED],
1344 "embed LLVM bitcode in object files"),
1345 strip_debuginfo_if_disabled: Option<bool> = (None, parse_opt_bool, [TRACKED],
1346 "tell the linker to strip debuginfo when building without debuginfo enabled."),
1347 share_generics: Option<bool> = (None, parse_opt_bool, [TRACKED],
1348 "make the current crate share its generic instantiations"),
1349 chalk: bool = (false, parse_bool, [TRACKED],
1350 "enable the experimental Chalk-based trait solving engine"),
1351 cross_lang_lto: CrossLangLto = (CrossLangLto::Disabled, parse_cross_lang_lto, [TRACKED],
1352 "generate build artifacts that are compatible with linker-based LTO."),
1353 no_parallel_llvm: bool = (false, parse_bool, [UNTRACKED],
1354 "don't run LLVM in parallel (while keeping codegen-units and ThinLTO)"),
1357 pub fn default_lib_output() -> CrateType {
1361 pub fn default_configuration(sess: &Session) -> ast::CrateConfig {
1362 let end = &sess.target.target.target_endian;
1363 let arch = &sess.target.target.arch;
1364 let wordsz = &sess.target.target.target_pointer_width;
1365 let os = &sess.target.target.target_os;
1366 let env = &sess.target.target.target_env;
1367 let vendor = &sess.target.target.target_vendor;
1368 let min_atomic_width = sess.target.target.min_atomic_width();
1369 let max_atomic_width = sess.target.target.max_atomic_width();
1370 let atomic_cas = sess.target.target.options.atomic_cas;
1372 let mut ret = HashSet::new();
1374 ret.insert((Symbol::intern("target_os"), Some(Symbol::intern(os))));
1375 if let Some(ref fam) = sess.target.target.options.target_family {
1376 ret.insert((Symbol::intern("target_family"), Some(Symbol::intern(fam))));
1377 if fam == "windows" || fam == "unix" {
1378 ret.insert((Symbol::intern(fam), None));
1381 ret.insert((Symbol::intern("target_arch"), Some(Symbol::intern(arch))));
1382 ret.insert((Symbol::intern("target_endian"), Some(Symbol::intern(end))));
1384 Symbol::intern("target_pointer_width"),
1385 Some(Symbol::intern(wordsz)),
1387 ret.insert((Symbol::intern("target_env"), Some(Symbol::intern(env))));
1389 Symbol::intern("target_vendor"),
1390 Some(Symbol::intern(vendor)),
1392 if sess.target.target.options.has_elf_tls {
1393 ret.insert((Symbol::intern("target_thread_local"), None));
1395 for &i in &[8, 16, 32, 64, 128] {
1396 if i >= min_atomic_width && i <= max_atomic_width {
1397 let s = i.to_string();
1399 Symbol::intern("target_has_atomic"),
1400 Some(Symbol::intern(&s)),
1404 Symbol::intern("target_has_atomic"),
1405 Some(Symbol::intern("ptr")),
1411 ret.insert((Symbol::intern("target_has_atomic"), Some(Symbol::intern("cas"))));
1413 if sess.opts.debug_assertions {
1414 ret.insert((Symbol::intern("debug_assertions"), None));
1416 if sess.opts.crate_types.contains(&CrateTypeProcMacro) {
1417 ret.insert((Symbol::intern("proc_macro"), None));
1422 pub fn build_configuration(sess: &Session, mut user_cfg: ast::CrateConfig) -> ast::CrateConfig {
1423 // Combine the configuration requested by the session (command line) with
1424 // some default and generated configuration items
1425 let default_cfg = default_configuration(sess);
1426 // If the user wants a test runner, then add the test cfg
1428 user_cfg.insert((Symbol::intern("test"), None));
1430 user_cfg.extend(default_cfg.iter().cloned());
1434 pub fn build_target_config(opts: &Options, sp: &Handler) -> Config {
1435 let target = match Target::search(&opts.target_triple) {
1438 sp.struct_fatal(&format!("Error loading target specification: {}", e))
1439 .help("Use `--print target-list` for a list of built-in targets")
1445 let (isize_ty, usize_ty) = match &target.target_pointer_width[..] {
1446 "16" => (ast::IntTy::I16, ast::UintTy::U16),
1447 "32" => (ast::IntTy::I32, ast::UintTy::U32),
1448 "64" => (ast::IntTy::I64, ast::UintTy::U64),
1449 w => sp.fatal(&format!(
1450 "target specification was invalid: \
1451 unrecognized target-pointer-width {}",
1463 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
1464 pub enum OptionStability {
1470 pub struct RustcOptGroup {
1471 pub apply: Box<dyn Fn(&mut getopts::Options) -> &mut getopts::Options>,
1472 pub name: &'static str,
1473 pub stability: OptionStability,
1476 impl RustcOptGroup {
1477 pub fn is_stable(&self) -> bool {
1478 self.stability == OptionStability::Stable
1481 pub fn stable<F>(name: &'static str, f: F) -> RustcOptGroup
1483 F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1488 stability: OptionStability::Stable,
1492 pub fn unstable<F>(name: &'static str, f: F) -> RustcOptGroup
1494 F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1499 stability: OptionStability::Unstable,
1504 // The `opt` local module holds wrappers around the `getopts` API that
1505 // adds extra rustc-specific metadata to each option; such metadata
1506 // is exposed by . The public
1507 // functions below ending with `_u` are the functions that return
1508 // *unstable* options, i.e. options that are only enabled when the
1509 // user also passes the `-Z unstable-options` debugging flag.
1511 // The `fn opt_u` etc below are written so that we can use them
1512 // in the future; do not warn about them not being used right now.
1513 #![allow(dead_code)]
1516 use super::RustcOptGroup;
1518 pub type R = RustcOptGroup;
1519 pub type S = &'static str;
1521 fn stable<F>(name: S, f: F) -> R
1523 F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1525 RustcOptGroup::stable(name, f)
1528 fn unstable<F>(name: S, f: F) -> R
1530 F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
1532 RustcOptGroup::unstable(name, f)
1535 fn longer(a: S, b: S) -> S {
1536 if a.len() > b.len() {
1543 pub fn opt_s(a: S, b: S, c: S, d: S) -> R {
1544 stable(longer(a, b), move |opts| opts.optopt(a, b, c, d))
1546 pub fn multi_s(a: S, b: S, c: S, d: S) -> R {
1547 stable(longer(a, b), move |opts| opts.optmulti(a, b, c, d))
1549 pub fn flag_s(a: S, b: S, c: S) -> R {
1550 stable(longer(a, b), move |opts| opts.optflag(a, b, c))
1552 pub fn flagopt_s(a: S, b: S, c: S, d: S) -> R {
1553 stable(longer(a, b), move |opts| opts.optflagopt(a, b, c, d))
1555 pub fn flagmulti_s(a: S, b: S, c: S) -> R {
1556 stable(longer(a, b), move |opts| opts.optflagmulti(a, b, c))
1559 pub fn opt(a: S, b: S, c: S, d: S) -> R {
1560 unstable(longer(a, b), move |opts| opts.optopt(a, b, c, d))
1562 pub fn multi(a: S, b: S, c: S, d: S) -> R {
1563 unstable(longer(a, b), move |opts| opts.optmulti(a, b, c, d))
1565 pub fn flag(a: S, b: S, c: S) -> R {
1566 unstable(longer(a, b), move |opts| opts.optflag(a, b, c))
1568 pub fn flagopt(a: S, b: S, c: S, d: S) -> R {
1569 unstable(longer(a, b), move |opts| opts.optflagopt(a, b, c, d))
1571 pub fn flagmulti(a: S, b: S, c: S) -> R {
1572 unstable(longer(a, b), move |opts| opts.optflagmulti(a, b, c))
1576 /// Returns the "short" subset of the rustc command line options,
1577 /// including metadata for each option, such as whether the option is
1578 /// part of the stable long-term interface for rustc.
1579 pub fn rustc_short_optgroups() -> Vec<RustcOptGroup> {
1581 opt::flag_s("h", "help", "Display this message"),
1582 opt::multi_s("", "cfg", "Configure the compilation environment", "SPEC"),
1586 "Add a directory to the library search path. The
1587 optional KIND can be one of dependency, crate, native,
1588 framework or all (the default).",
1594 "Link the generated crate(s) to the specified native
1595 library NAME. The optional KIND can be one of
1596 static, dylib, or framework. If omitted, dylib is
1603 "Comma separated list of types of crates
1604 for the compiler to emit",
1605 "[bin|lib|rlib|dylib|cdylib|staticlib|proc-macro]",
1610 "Specify the name of the crate being built",
1616 "Comma separated list of types of output for \
1617 the compiler to emit",
1618 "[asm|llvm-bc|llvm-ir|obj|metadata|link|dep-info|mir]",
1623 "Comma separated list of compiler information to \
1625 "[crate-name|file-names|sysroot|cfg|target-list|\
1626 target-cpus|target-features|relocation-models|\
1627 code-models|tls-models|target-spec-json|native-static-libs]",
1629 opt::flagmulti_s("g", "", "Equivalent to -C debuginfo=2"),
1630 opt::flagmulti_s("O", "", "Equivalent to -C opt-level=2"),
1631 opt::opt_s("o", "", "Write output to <filename>", "FILENAME"),
1635 "Write output to compiler-chosen filename \
1642 "Provide a detailed explanation of an error \
1646 opt::flag_s("", "test", "Build a test harness"),
1650 "Target triple for which the code is compiled",
1653 opt::multi_s("W", "warn", "Set lint warnings", "OPT"),
1654 opt::multi_s("A", "allow", "Set lint allowed", "OPT"),
1655 opt::multi_s("D", "deny", "Set lint denied", "OPT"),
1656 opt::multi_s("F", "forbid", "Set lint forbidden", "OPT"),
1660 "Set the most restrictive lint level. \
1661 More restrictive lints are capped at this \
1665 opt::multi_s("C", "codegen", "Set a codegen option", "OPT[=VALUE]"),
1666 opt::flag_s("V", "version", "Print version info and exit"),
1667 opt::flag_s("v", "verbose", "Use verbose output"),
1671 /// Returns all rustc command line options, including metadata for
1672 /// each option, such as whether the option is part of the stable
1673 /// long-term interface for rustc.
1674 pub fn rustc_optgroups() -> Vec<RustcOptGroup> {
1675 let mut opts = rustc_short_optgroups();
1680 "Specify where an external rust library is located",
1683 opt::opt_s("", "sysroot", "Override the system root", "PATH"),
1684 opt::multi("Z", "", "Set internal debugging options", "FLAG"),
1688 "How errors and other messages are produced",
1694 "Configure coloring of output:
1695 auto = colorize, if output goes to a tty (default);
1696 always = always colorize output;
1697 never = never colorize output",
1698 "auto|always|never",
1703 "Pretty-print the input instead of compiling;
1704 valid types are: `normal` (un-annotated source),
1705 `expanded` (crates expanded), or
1706 `expanded,identified` (fully parenthesized, AST nodes with IDs).",
1712 "Specify which edition of the compiler to use when compiling code.",
1717 "remap-path-prefix",
1718 "Remap source names in all output (compiler messages and output files)",
1725 // Convert strings provided as --cfg [cfgspec] into a crate_cfg
1726 pub fn parse_cfgspecs(cfgspecs: Vec<String>) -> ast::CrateConfig {
1730 let sess = parse::ParseSess::new(FilePathMapping::empty());
1732 parse::new_parser_from_source_str(&sess, FileName::CfgSpec, s.to_string());
1734 let meta_item = panictry!(parser.parse_meta_item());
1736 if parser.token != token::Eof {
1738 ErrorOutputType::default(),
1739 &format!("invalid --cfg argument: {}", s),
1741 } else if meta_item.is_meta_item_list() {
1743 "invalid predicate in --cfg command line argument: `{}`",
1746 early_error(ErrorOutputType::default(), &msg)
1749 (meta_item.name(), meta_item.value_str())
1751 .collect::<ast::CrateConfig>()
1754 pub fn build_session_options_and_crate_config(
1755 matches: &getopts::Matches,
1756 ) -> (Options, ast::CrateConfig) {
1757 let color = match matches.opt_str("color").as_ref().map(|s| &s[..]) {
1758 Some("auto") => ColorConfig::Auto,
1759 Some("always") => ColorConfig::Always,
1760 Some("never") => ColorConfig::Never,
1762 None => ColorConfig::Auto,
1764 Some(arg) => early_error(
1765 ErrorOutputType::default(),
1767 "argument for --color must be auto, \
1768 always or never (instead was `{}`)",
1774 let edition = match matches.opt_str("edition") {
1775 Some(arg) => match Edition::from_str(&arg){
1776 Ok(edition) => edition,
1777 Err(_) => early_error(
1778 ErrorOutputType::default(),
1780 "argument for --edition must be one of: \
1781 {}. (instead was `{}`)",
1787 None => DEFAULT_EDITION,
1790 if !edition.is_stable() && !nightly_options::is_nightly_build() {
1792 ErrorOutputType::default(),
1794 "Edition {} is unstable an only\
1795 available for nightly builds of rustc.",
1802 // We need the opts_present check because the driver will send us Matches
1803 // with only stable options if no unstable options are used. Since error-format
1804 // is unstable, it will not be present. We have to use opts_present not
1805 // opt_present because the latter will panic.
1806 let error_format = if matches.opts_present(&["error-format".to_owned()]) {
1807 match matches.opt_str("error-format").as_ref().map(|s| &s[..]) {
1808 Some("human") => ErrorOutputType::HumanReadable(color),
1809 Some("json") => ErrorOutputType::Json(false),
1810 Some("pretty-json") => ErrorOutputType::Json(true),
1811 Some("short") => ErrorOutputType::Short(color),
1812 None => ErrorOutputType::HumanReadable(color),
1814 Some(arg) => early_error(
1815 ErrorOutputType::HumanReadable(color),
1817 "argument for --error-format must be `human`, `json` or \
1818 `short` (instead was `{}`)",
1824 ErrorOutputType::HumanReadable(color)
1827 let unparsed_crate_types = matches.opt_strs("crate-type");
1828 let crate_types = parse_crate_types_from_list(unparsed_crate_types)
1829 .unwrap_or_else(|e| early_error(error_format, &e[..]));
1831 let mut lint_opts = vec![];
1832 let mut describe_lints = false;
1834 for &level in &[lint::Allow, lint::Warn, lint::Deny, lint::Forbid] {
1835 for lint_name in matches.opt_strs(level.as_str()) {
1836 if lint_name == "help" {
1837 describe_lints = true;
1839 lint_opts.push((lint_name.replace("-", "_"), level));
1844 let lint_cap = matches.opt_str("cap-lints").map(|cap| {
1845 lint::Level::from_str(&cap)
1846 .unwrap_or_else(|| early_error(error_format, &format!("unknown lint level: `{}`", cap)))
1849 let mut debugging_opts = build_debugging_options(matches, error_format);
1851 if !debugging_opts.unstable_options && error_format == ErrorOutputType::Json(true) {
1853 ErrorOutputType::Json(false),
1854 "--error-format=pretty-json is unstable",
1858 if debugging_opts.pgo_gen.is_some() && !debugging_opts.pgo_use.is_empty() {
1861 "options `-Z pgo-gen` and `-Z pgo-use` are exclusive",
1865 let mut output_types = BTreeMap::new();
1866 if !debugging_opts.parse_only {
1867 for list in matches.opt_strs("emit") {
1868 for output_type in list.split(',') {
1869 let mut parts = output_type.splitn(2, '=');
1870 let shorthand = parts.next().unwrap();
1871 let output_type = match OutputType::from_shorthand(shorthand) {
1872 Some(output_type) => output_type,
1873 None => early_error(
1876 "unknown emission type: `{}` - expected one of: {}",
1878 OutputType::shorthands_display(),
1882 let path = parts.next().map(PathBuf::from);
1883 output_types.insert(output_type, path);
1887 if output_types.is_empty() {
1888 output_types.insert(OutputType::Exe, None);
1891 let mut cg = build_codegen_options(matches, error_format);
1892 let mut codegen_units = cg.codegen_units;
1893 let mut disable_thinlto = false;
1895 // Issue #30063: if user requests llvm-related output to one
1896 // particular path, disable codegen-units.
1897 let incompatible: Vec<_> = output_types
1899 .map(|ot_path| ot_path.0)
1900 .filter(|ot| !ot.is_compatible_with_codegen_units_and_single_output_file())
1901 .map(|ot| ot.shorthand())
1903 if !incompatible.is_empty() {
1904 match codegen_units {
1905 Some(n) if n > 1 => {
1906 if matches.opt_present("o") {
1907 for ot in &incompatible {
1911 "--emit={} with -o incompatible with \
1912 -C codegen-units=N for N > 1",
1917 early_warn(error_format, "resetting to default -C codegen-units=1");
1918 codegen_units = Some(1);
1919 disable_thinlto = true;
1923 codegen_units = Some(1);
1924 disable_thinlto = true;
1929 if debugging_opts.query_threads == Some(0) {
1932 "Value for query threads must be a positive nonzero integer",
1936 if debugging_opts.query_threads.unwrap_or(1) > 1 && debugging_opts.fuel.is_some() {
1939 "Optimization fuel is incompatible with multiple query threads",
1943 if codegen_units == Some(0) {
1946 "Value for codegen units must be a positive nonzero integer",
1950 let incremental = match (&debugging_opts.incremental, &cg.incremental) {
1951 (&Some(ref path1), &Some(ref path2)) => {
1956 "conflicting paths for `-Z incremental` and \
1957 `-C incremental` specified: {} versus {}",
1965 (&Some(ref path), &None) => Some(path),
1966 (&None, &Some(ref path)) => Some(path),
1967 (&None, &None) => None,
1968 }.map(|m| PathBuf::from(m));
1970 if cg.lto != Lto::No && incremental.is_some() {
1973 "can't perform LTO when compiling incrementally",
1977 if debugging_opts.profile && incremental.is_some() {
1980 "can't instrument with gcov profiling when compiling incrementally",
1984 let mut prints = Vec::<PrintRequest>::new();
1985 if cg.target_cpu.as_ref().map_or(false, |s| s == "help") {
1986 prints.push(PrintRequest::TargetCPUs);
1987 cg.target_cpu = None;
1989 if cg.target_feature == "help" {
1990 prints.push(PrintRequest::TargetFeatures);
1991 cg.target_feature = "".to_string();
1993 if cg.relocation_model.as_ref().map_or(false, |s| s == "help") {
1994 prints.push(PrintRequest::RelocationModels);
1995 cg.relocation_model = None;
1997 if cg.code_model.as_ref().map_or(false, |s| s == "help") {
1998 prints.push(PrintRequest::CodeModels);
1999 cg.code_model = None;
2004 .map_or(false, |s| s == "help")
2006 prints.push(PrintRequest::TlsModels);
2007 debugging_opts.tls_model = None;
2012 let sysroot_opt = matches.opt_str("sysroot").map(|m| PathBuf::from(&m));
2013 let target_triple = if let Some(target) = matches.opt_str("target") {
2014 if target.ends_with(".json") {
2015 let path = Path::new(&target);
2016 match TargetTriple::from_path(&path) {
2017 Ok(triple) => triple,
2019 early_error(error_format, &format!("target file {:?} does not exist", path))
2023 TargetTriple::TargetTriple(target)
2026 TargetTriple::from_triple(host_triple())
2029 if matches.opt_present("O") {
2030 if cg.opt_level.is_some() {
2031 early_error(error_format, "-O and -C opt-level both provided");
2035 match cg.opt_level.as_ref().map(String::as_ref) {
2036 None => OptLevel::No,
2037 Some("0") => OptLevel::No,
2038 Some("1") => OptLevel::Less,
2039 Some("2") => OptLevel::Default,
2040 Some("3") => OptLevel::Aggressive,
2041 Some("s") => OptLevel::Size,
2042 Some("z") => OptLevel::SizeMin,
2047 "optimization level needs to be \
2048 between 0-3 (instead was `{}`)",
2056 let debug_assertions = cg.debug_assertions.unwrap_or(opt_level == OptLevel::No);
2057 let debuginfo = if matches.opt_present("g") {
2058 if cg.debuginfo.is_some() {
2059 early_error(error_format, "-g and -C debuginfo both provided");
2063 match cg.debuginfo {
2064 None | Some(0) => NoDebugInfo,
2065 Some(1) => LimitedDebugInfo,
2066 Some(2) => FullDebugInfo,
2071 "debug info level needs to be between \
2072 0-2 (instead was `{}`)",
2080 let mut search_paths = SearchPaths::new();
2081 for s in &matches.opt_strs("L") {
2082 search_paths.add_path(&s[..], error_format);
2089 // Parse string of the form "[KIND=]lib[:new_name]",
2090 // where KIND is one of "dylib", "framework", "static".
2091 let mut parts = s.splitn(2, '=');
2092 let kind = parts.next().unwrap();
2093 let (name, kind) = match (parts.next(), kind) {
2094 (None, name) => (name, None),
2095 (Some(name), "dylib") => (name, Some(cstore::NativeUnknown)),
2096 (Some(name), "framework") => (name, Some(cstore::NativeFramework)),
2097 (Some(name), "static") => (name, Some(cstore::NativeStatic)),
2098 (Some(name), "static-nobundle") => (name, Some(cstore::NativeStaticNobundle)),
2103 "unknown library kind `{}`, expected \
2104 one of dylib, framework, or static",
2110 if kind == Some(cstore::NativeStaticNobundle) && !nightly_options::is_nightly_build() {
2114 "the library kind 'static-nobundle' is only \
2115 accepted on the nightly compiler"
2119 let mut name_parts = name.splitn(2, ':');
2120 let name = name_parts.next().unwrap();
2121 let new_name = name_parts.next();
2122 (name.to_string(), new_name.map(|n| n.to_string()), kind)
2126 let cfg = parse_cfgspecs(matches.opt_strs("cfg"));
2127 let test = matches.opt_present("test");
2129 prints.extend(matches.opt_strs("print").into_iter().map(|s| match &*s {
2130 "crate-name" => PrintRequest::CrateName,
2131 "file-names" => PrintRequest::FileNames,
2132 "sysroot" => PrintRequest::Sysroot,
2133 "cfg" => PrintRequest::Cfg,
2134 "target-list" => PrintRequest::TargetList,
2135 "target-cpus" => PrintRequest::TargetCPUs,
2136 "target-features" => PrintRequest::TargetFeatures,
2137 "relocation-models" => PrintRequest::RelocationModels,
2138 "code-models" => PrintRequest::CodeModels,
2139 "tls-models" => PrintRequest::TlsModels,
2140 "native-static-libs" => PrintRequest::NativeStaticLibs,
2141 "target-spec-json" => {
2142 if nightly_options::is_unstable_enabled(matches) {
2143 PrintRequest::TargetSpec
2148 "the `-Z unstable-options` flag must also be passed to \
2149 enable the target-spec-json print option"
2154 req => early_error(error_format, &format!("unknown print request `{}`", req)),
2157 let borrowck_mode = match debugging_opts.borrowck.as_ref().map(|s| &s[..]) {
2158 None | Some("ast") => BorrowckMode::Ast,
2159 Some("mir") => BorrowckMode::Mir,
2160 Some("compare") => BorrowckMode::Compare,
2161 Some(m) => early_error(error_format, &format!("unknown borrowck mode `{}`", m)),
2164 if !cg.remark.is_empty() && debuginfo == NoDebugInfo {
2167 "-C remark will not show source locations without \
2172 let mut externs = BTreeMap::new();
2173 for arg in &matches.opt_strs("extern") {
2174 let mut parts = arg.splitn(2, '=');
2175 let name = match parts.next() {
2177 None => early_error(error_format, "--extern value must not be empty"),
2179 let location = match parts.next() {
2181 None => early_error(
2183 "--extern value must be of the format `foo=bar`",
2188 .entry(name.to_string())
2189 .or_insert_with(BTreeSet::new)
2190 .insert(location.to_string());
2193 let crate_name = matches.opt_str("crate-name");
2195 let remap_path_prefix = matches
2196 .opt_strs("remap-path-prefix")
2199 let mut parts = remap.rsplitn(2, '='); // reverse iterator
2200 let to = parts.next();
2201 let from = parts.next();
2203 (Some(from), Some(to)) => (PathBuf::from(from), PathBuf::from(to)),
2206 "--remap-path-prefix must contain '=' between FROM and TO",
2215 optimize: opt_level,
2220 output_types: OutputTypes(output_types),
2222 maybe_sysroot: sysroot_opt,
2231 externs: Externs(externs),
2235 unstable_features: UnstableFeatures::from_environment(),
2237 actually_rustdoc: false,
2238 cli_forced_codegen_units: codegen_units,
2239 cli_forced_thinlto_off: disable_thinlto,
2247 pub fn parse_crate_types_from_list(list_list: Vec<String>) -> Result<Vec<CrateType>, String> {
2248 let mut crate_types: Vec<CrateType> = Vec::new();
2249 for unparsed_crate_type in &list_list {
2250 for part in unparsed_crate_type.split(',') {
2251 let new_part = match part {
2252 "lib" => default_lib_output(),
2253 "rlib" => CrateTypeRlib,
2254 "staticlib" => CrateTypeStaticlib,
2255 "dylib" => CrateTypeDylib,
2256 "cdylib" => CrateTypeCdylib,
2257 "bin" => CrateTypeExecutable,
2258 "proc-macro" => CrateTypeProcMacro,
2260 return Err(format!("unknown crate type: `{}`", part));
2263 if !crate_types.contains(&new_part) {
2264 crate_types.push(new_part)
2272 pub mod nightly_options {
2274 use syntax::feature_gate::UnstableFeatures;
2275 use super::{ErrorOutputType, OptionStability, RustcOptGroup};
2276 use session::early_error;
2278 pub fn is_unstable_enabled(matches: &getopts::Matches) -> bool {
2283 .any(|x| *x == "unstable-options")
2286 pub fn is_nightly_build() -> bool {
2287 UnstableFeatures::from_environment().is_nightly_build()
2290 pub fn check_nightly_options(matches: &getopts::Matches, flags: &[RustcOptGroup]) {
2291 let has_z_unstable_option = matches
2294 .any(|x| *x == "unstable-options");
2295 let really_allows_unstable_options =
2296 UnstableFeatures::from_environment().is_nightly_build();
2298 for opt in flags.iter() {
2299 if opt.stability == OptionStability::Stable {
2302 if !matches.opt_present(opt.name) {
2305 if opt.name != "Z" && !has_z_unstable_option {
2307 ErrorOutputType::default(),
2309 "the `-Z unstable-options` flag must also be passed to enable \
2315 if really_allows_unstable_options {
2318 match opt.stability {
2319 OptionStability::Unstable => {
2321 "the option `{}` is only accepted on the \
2325 early_error(ErrorOutputType::default(), &msg);
2327 OptionStability::Stable => {}
2333 impl fmt::Display for CrateType {
2334 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2336 CrateTypeExecutable => "bin".fmt(f),
2337 CrateTypeDylib => "dylib".fmt(f),
2338 CrateTypeRlib => "rlib".fmt(f),
2339 CrateTypeStaticlib => "staticlib".fmt(f),
2340 CrateTypeCdylib => "cdylib".fmt(f),
2341 CrateTypeProcMacro => "proc-macro".fmt(f),
2346 /// Commandline arguments passed to the compiler have to be incorporated with
2347 /// the dependency tracking system for incremental compilation. This module
2348 /// provides some utilities to make this more convenient.
2350 /// The values of all commandline arguments that are relevant for dependency
2351 /// tracking are hashed into a single value that determines whether the
2352 /// incremental compilation cache can be re-used or not. This hashing is done
2353 /// via the DepTrackingHash trait defined below, since the standard Hash
2354 /// implementation might not be suitable (e.g. arguments are stored in a Vec,
2355 /// the hash of which is order dependent, but we might not want the order of
2356 /// arguments to make a difference for the hash).
2358 /// However, since the value provided by Hash::hash often *is* suitable,
2359 /// especially for primitive types, there is the
2360 /// impl_dep_tracking_hash_via_hash!() macro that allows to simply reuse the
2361 /// Hash implementation for DepTrackingHash. It's important though that
2362 /// we have an opt-in scheme here, so one is hopefully forced to think about
2363 /// how the hash should be calculated when adding a new commandline argument.
2367 use std::collections::BTreeMap;
2368 use std::hash::Hash;
2369 use std::path::PathBuf;
2370 use std::collections::hash_map::DefaultHasher;
2371 use super::{CrateType, DebugInfoLevel, ErrorOutputType, Lto, OptLevel, OutputTypes,
2372 Passes, Sanitizer, CrossLangLto};
2373 use syntax::feature_gate::UnstableFeatures;
2374 use rustc_target::spec::{PanicStrategy, RelroLevel, TargetTriple};
2375 use syntax::edition::Edition;
2377 pub trait DepTrackingHash {
2378 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType);
2381 macro_rules! impl_dep_tracking_hash_via_hash {
2383 impl DepTrackingHash for $t {
2384 fn hash(&self, hasher: &mut DefaultHasher, _: ErrorOutputType) {
2385 Hash::hash(self, hasher);
2391 macro_rules! impl_dep_tracking_hash_for_sortable_vec_of {
2393 impl DepTrackingHash for Vec<$t> {
2394 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
2395 let mut elems: Vec<&$t> = self.iter().collect();
2397 Hash::hash(&elems.len(), hasher);
2398 for (index, elem) in elems.iter().enumerate() {
2399 Hash::hash(&index, hasher);
2400 DepTrackingHash::hash(*elem, hasher, error_format);
2407 impl_dep_tracking_hash_via_hash!(bool);
2408 impl_dep_tracking_hash_via_hash!(usize);
2409 impl_dep_tracking_hash_via_hash!(u64);
2410 impl_dep_tracking_hash_via_hash!(String);
2411 impl_dep_tracking_hash_via_hash!(PathBuf);
2412 impl_dep_tracking_hash_via_hash!(lint::Level);
2413 impl_dep_tracking_hash_via_hash!(Option<bool>);
2414 impl_dep_tracking_hash_via_hash!(Option<usize>);
2415 impl_dep_tracking_hash_via_hash!(Option<String>);
2416 impl_dep_tracking_hash_via_hash!(Option<(String, u64)>);
2417 impl_dep_tracking_hash_via_hash!(Option<PanicStrategy>);
2418 impl_dep_tracking_hash_via_hash!(Option<RelroLevel>);
2419 impl_dep_tracking_hash_via_hash!(Option<lint::Level>);
2420 impl_dep_tracking_hash_via_hash!(Option<PathBuf>);
2421 impl_dep_tracking_hash_via_hash!(Option<cstore::NativeLibraryKind>);
2422 impl_dep_tracking_hash_via_hash!(CrateType);
2423 impl_dep_tracking_hash_via_hash!(PanicStrategy);
2424 impl_dep_tracking_hash_via_hash!(RelroLevel);
2425 impl_dep_tracking_hash_via_hash!(Passes);
2426 impl_dep_tracking_hash_via_hash!(OptLevel);
2427 impl_dep_tracking_hash_via_hash!(Lto);
2428 impl_dep_tracking_hash_via_hash!(DebugInfoLevel);
2429 impl_dep_tracking_hash_via_hash!(UnstableFeatures);
2430 impl_dep_tracking_hash_via_hash!(OutputTypes);
2431 impl_dep_tracking_hash_via_hash!(cstore::NativeLibraryKind);
2432 impl_dep_tracking_hash_via_hash!(Sanitizer);
2433 impl_dep_tracking_hash_via_hash!(Option<Sanitizer>);
2434 impl_dep_tracking_hash_via_hash!(TargetTriple);
2435 impl_dep_tracking_hash_via_hash!(Edition);
2436 impl_dep_tracking_hash_via_hash!(CrossLangLto);
2438 impl_dep_tracking_hash_for_sortable_vec_of!(String);
2439 impl_dep_tracking_hash_for_sortable_vec_of!(PathBuf);
2440 impl_dep_tracking_hash_for_sortable_vec_of!(CrateType);
2441 impl_dep_tracking_hash_for_sortable_vec_of!((String, lint::Level));
2442 impl_dep_tracking_hash_for_sortable_vec_of!((
2445 Option<cstore::NativeLibraryKind>
2447 impl_dep_tracking_hash_for_sortable_vec_of!((String, u64));
2449 impl<T1, T2> DepTrackingHash for (T1, T2)
2451 T1: DepTrackingHash,
2452 T2: DepTrackingHash,
2454 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
2455 Hash::hash(&0, hasher);
2456 DepTrackingHash::hash(&self.0, hasher, error_format);
2457 Hash::hash(&1, hasher);
2458 DepTrackingHash::hash(&self.1, hasher, error_format);
2462 impl<T1, T2, T3> DepTrackingHash for (T1, T2, T3)
2464 T1: DepTrackingHash,
2465 T2: DepTrackingHash,
2466 T3: DepTrackingHash,
2468 fn hash(&self, hasher: &mut DefaultHasher, error_format: ErrorOutputType) {
2469 Hash::hash(&0, hasher);
2470 DepTrackingHash::hash(&self.0, hasher, error_format);
2471 Hash::hash(&1, hasher);
2472 DepTrackingHash::hash(&self.1, hasher, error_format);
2473 Hash::hash(&2, hasher);
2474 DepTrackingHash::hash(&self.2, hasher, error_format);
2478 // This is a stable hash because BTreeMap is a sorted container
2480 sub_hashes: BTreeMap<&'static str, &dyn DepTrackingHash>,
2481 hasher: &mut DefaultHasher,
2482 error_format: ErrorOutputType,
2484 for (key, sub_hash) in sub_hashes {
2485 // Using Hash::hash() instead of DepTrackingHash::hash() is fine for
2486 // the keys, as they are just plain strings
2487 Hash::hash(&key.len(), hasher);
2488 Hash::hash(key, hasher);
2489 sub_hash.hash(hasher, error_format);
2500 use session::config::{build_configuration, build_session_options_and_crate_config};
2501 use session::config::{Lto, CrossLangLto};
2502 use session::build_session;
2503 use std::collections::{BTreeMap, BTreeSet};
2504 use std::iter::FromIterator;
2505 use std::path::PathBuf;
2506 use super::{Externs, OutputType, OutputTypes};
2507 use rustc_target::spec::{PanicStrategy, RelroLevel};
2508 use syntax::symbol::Symbol;
2509 use syntax::edition::{Edition, DEFAULT_EDITION};
2512 fn optgroups() -> getopts::Options {
2513 let mut opts = getopts::Options::new();
2514 for group in super::rustc_optgroups() {
2515 (group.apply)(&mut opts);
2520 fn mk_map<K: Ord, V>(entries: Vec<(K, V)>) -> BTreeMap<K, V> {
2521 BTreeMap::from_iter(entries.into_iter())
2524 fn mk_set<V: Ord>(entries: Vec<V>) -> BTreeSet<V> {
2525 BTreeSet::from_iter(entries.into_iter())
2528 // When the user supplies --test we should implicitly supply --cfg test
2530 fn test_switch_implies_cfg_test() {
2531 syntax::with_globals(|| {
2532 let matches = &match optgroups().parse(&["--test".to_string()]) {
2534 Err(f) => panic!("test_switch_implies_cfg_test: {}", f),
2536 let registry = errors::registry::Registry::new(&[]);
2537 let (sessopts, cfg) = build_session_options_and_crate_config(matches);
2538 let sess = build_session(sessopts, None, registry);
2539 let cfg = build_configuration(&sess, cfg);
2540 assert!(cfg.contains(&(Symbol::intern("test"), None)));
2544 // When the user supplies --test and --cfg test, don't implicitly add
2545 // another --cfg test
2547 fn test_switch_implies_cfg_test_unless_cfg_test() {
2548 syntax::with_globals(|| {
2549 let matches = &match optgroups().parse(&["--test".to_string(),
2550 "--cfg=test".to_string()]) {
2552 Err(f) => panic!("test_switch_implies_cfg_test_unless_cfg_test: {}", f),
2554 let registry = errors::registry::Registry::new(&[]);
2555 let (sessopts, cfg) = build_session_options_and_crate_config(matches);
2556 let sess = build_session(sessopts, None, registry);
2557 let cfg = build_configuration(&sess, cfg);
2558 let mut test_items = cfg.iter().filter(|&&(name, _)| name == "test");
2559 assert!(test_items.next().is_some());
2560 assert!(test_items.next().is_none());
2565 fn test_can_print_warnings() {
2566 syntax::with_globals(|| {
2567 let matches = optgroups().parse(&["-Awarnings".to_string()]).unwrap();
2568 let registry = errors::registry::Registry::new(&[]);
2569 let (sessopts, _) = build_session_options_and_crate_config(&matches);
2570 let sess = build_session(sessopts, None, registry);
2571 assert!(!sess.diagnostic().flags.can_emit_warnings);
2574 syntax::with_globals(|| {
2575 let matches = optgroups()
2576 .parse(&["-Awarnings".to_string(), "-Dwarnings".to_string()])
2578 let registry = errors::registry::Registry::new(&[]);
2579 let (sessopts, _) = build_session_options_and_crate_config(&matches);
2580 let sess = build_session(sessopts, None, registry);
2581 assert!(sess.diagnostic().flags.can_emit_warnings);
2584 syntax::with_globals(|| {
2585 let matches = optgroups().parse(&["-Adead_code".to_string()]).unwrap();
2586 let registry = errors::registry::Registry::new(&[]);
2587 let (sessopts, _) = build_session_options_and_crate_config(&matches);
2588 let sess = build_session(sessopts, None, registry);
2589 assert!(sess.diagnostic().flags.can_emit_warnings);
2594 fn test_output_types_tracking_hash_different_paths() {
2595 let mut v1 = super::basic_options();
2596 let mut v2 = super::basic_options();
2597 let mut v3 = super::basic_options();
2600 OutputTypes::new(&[(OutputType::Exe, Some(PathBuf::from("./some/thing")))]);
2602 OutputTypes::new(&[(OutputType::Exe, Some(PathBuf::from("/some/thing")))]);
2603 v3.output_types = OutputTypes::new(&[(OutputType::Exe, None)]);
2605 assert!(v1.dep_tracking_hash() != v2.dep_tracking_hash());
2606 assert!(v1.dep_tracking_hash() != v3.dep_tracking_hash());
2607 assert!(v2.dep_tracking_hash() != v3.dep_tracking_hash());
2610 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2611 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2612 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2616 fn test_output_types_tracking_hash_different_construction_order() {
2617 let mut v1 = super::basic_options();
2618 let mut v2 = super::basic_options();
2620 v1.output_types = OutputTypes::new(&[
2621 (OutputType::Exe, Some(PathBuf::from("./some/thing"))),
2622 (OutputType::Bitcode, Some(PathBuf::from("./some/thing.bc"))),
2625 v2.output_types = OutputTypes::new(&[
2626 (OutputType::Bitcode, Some(PathBuf::from("./some/thing.bc"))),
2627 (OutputType::Exe, Some(PathBuf::from("./some/thing"))),
2630 assert_eq!(v1.dep_tracking_hash(), v2.dep_tracking_hash());
2633 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2637 fn test_externs_tracking_hash_different_construction_order() {
2638 let mut v1 = super::basic_options();
2639 let mut v2 = super::basic_options();
2640 let mut v3 = super::basic_options();
2642 v1.externs = Externs::new(mk_map(vec![
2645 mk_set(vec![String::from("b"), String::from("c")]),
2649 mk_set(vec![String::from("e"), String::from("f")]),
2653 v2.externs = Externs::new(mk_map(vec![
2656 mk_set(vec![String::from("e"), String::from("f")]),
2660 mk_set(vec![String::from("b"), String::from("c")]),
2664 v3.externs = Externs::new(mk_map(vec![
2667 mk_set(vec![String::from("b"), String::from("c")]),
2671 mk_set(vec![String::from("f"), String::from("e")]),
2675 assert_eq!(v1.dep_tracking_hash(), v2.dep_tracking_hash());
2676 assert_eq!(v1.dep_tracking_hash(), v3.dep_tracking_hash());
2677 assert_eq!(v2.dep_tracking_hash(), v3.dep_tracking_hash());
2680 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2681 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2682 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2686 fn test_lints_tracking_hash_different_values() {
2687 let mut v1 = super::basic_options();
2688 let mut v2 = super::basic_options();
2689 let mut v3 = super::basic_options();
2691 v1.lint_opts = vec![
2692 (String::from("a"), lint::Allow),
2693 (String::from("b"), lint::Warn),
2694 (String::from("c"), lint::Deny),
2695 (String::from("d"), lint::Forbid),
2698 v2.lint_opts = vec![
2699 (String::from("a"), lint::Allow),
2700 (String::from("b"), lint::Warn),
2701 (String::from("X"), lint::Deny),
2702 (String::from("d"), lint::Forbid),
2705 v3.lint_opts = vec![
2706 (String::from("a"), lint::Allow),
2707 (String::from("b"), lint::Warn),
2708 (String::from("c"), lint::Forbid),
2709 (String::from("d"), lint::Deny),
2712 assert!(v1.dep_tracking_hash() != v2.dep_tracking_hash());
2713 assert!(v1.dep_tracking_hash() != v3.dep_tracking_hash());
2714 assert!(v2.dep_tracking_hash() != v3.dep_tracking_hash());
2717 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2718 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2719 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2723 fn test_lints_tracking_hash_different_construction_order() {
2724 let mut v1 = super::basic_options();
2725 let mut v2 = super::basic_options();
2727 v1.lint_opts = vec![
2728 (String::from("a"), lint::Allow),
2729 (String::from("b"), lint::Warn),
2730 (String::from("c"), lint::Deny),
2731 (String::from("d"), lint::Forbid),
2734 v2.lint_opts = vec![
2735 (String::from("a"), lint::Allow),
2736 (String::from("c"), lint::Deny),
2737 (String::from("b"), lint::Warn),
2738 (String::from("d"), lint::Forbid),
2741 assert_eq!(v1.dep_tracking_hash(), v2.dep_tracking_hash());
2744 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2745 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2749 fn test_search_paths_tracking_hash_different_order() {
2750 let mut v1 = super::basic_options();
2751 let mut v2 = super::basic_options();
2752 let mut v3 = super::basic_options();
2753 let mut v4 = super::basic_options();
2757 .add_path("native=abc", super::ErrorOutputType::Json(false));
2759 .add_path("crate=def", super::ErrorOutputType::Json(false));
2761 .add_path("dependency=ghi", super::ErrorOutputType::Json(false));
2763 .add_path("framework=jkl", super::ErrorOutputType::Json(false));
2765 .add_path("all=mno", super::ErrorOutputType::Json(false));
2768 .add_path("native=abc", super::ErrorOutputType::Json(false));
2770 .add_path("dependency=ghi", super::ErrorOutputType::Json(false));
2772 .add_path("crate=def", super::ErrorOutputType::Json(false));
2774 .add_path("framework=jkl", super::ErrorOutputType::Json(false));
2776 .add_path("all=mno", super::ErrorOutputType::Json(false));
2779 .add_path("crate=def", super::ErrorOutputType::Json(false));
2781 .add_path("framework=jkl", super::ErrorOutputType::Json(false));
2783 .add_path("native=abc", super::ErrorOutputType::Json(false));
2785 .add_path("dependency=ghi", super::ErrorOutputType::Json(false));
2787 .add_path("all=mno", super::ErrorOutputType::Json(false));
2790 .add_path("all=mno", super::ErrorOutputType::Json(false));
2792 .add_path("native=abc", super::ErrorOutputType::Json(false));
2794 .add_path("crate=def", super::ErrorOutputType::Json(false));
2796 .add_path("dependency=ghi", super::ErrorOutputType::Json(false));
2798 .add_path("framework=jkl", super::ErrorOutputType::Json(false));
2800 assert!(v1.dep_tracking_hash() == v2.dep_tracking_hash());
2801 assert!(v1.dep_tracking_hash() == v3.dep_tracking_hash());
2802 assert!(v1.dep_tracking_hash() == v4.dep_tracking_hash());
2805 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2806 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2807 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2808 assert_eq!(v4.dep_tracking_hash(), v4.clone().dep_tracking_hash());
2812 fn test_native_libs_tracking_hash_different_values() {
2813 let mut v1 = super::basic_options();
2814 let mut v2 = super::basic_options();
2815 let mut v3 = super::basic_options();
2816 let mut v4 = super::basic_options();
2820 (String::from("a"), None, Some(cstore::NativeStatic)),
2821 (String::from("b"), None, Some(cstore::NativeFramework)),
2822 (String::from("c"), None, Some(cstore::NativeUnknown)),
2827 (String::from("a"), None, Some(cstore::NativeStatic)),
2828 (String::from("X"), None, Some(cstore::NativeFramework)),
2829 (String::from("c"), None, Some(cstore::NativeUnknown)),
2834 (String::from("a"), None, Some(cstore::NativeStatic)),
2835 (String::from("b"), None, Some(cstore::NativeStatic)),
2836 (String::from("c"), None, Some(cstore::NativeUnknown)),
2841 (String::from("a"), None, Some(cstore::NativeStatic)),
2844 Some(String::from("X")),
2845 Some(cstore::NativeFramework),
2847 (String::from("c"), None, Some(cstore::NativeUnknown)),
2850 assert!(v1.dep_tracking_hash() != v2.dep_tracking_hash());
2851 assert!(v1.dep_tracking_hash() != v3.dep_tracking_hash());
2852 assert!(v1.dep_tracking_hash() != v4.dep_tracking_hash());
2855 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2856 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2857 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2858 assert_eq!(v4.dep_tracking_hash(), v4.clone().dep_tracking_hash());
2862 fn test_native_libs_tracking_hash_different_order() {
2863 let mut v1 = super::basic_options();
2864 let mut v2 = super::basic_options();
2865 let mut v3 = super::basic_options();
2869 (String::from("a"), None, Some(cstore::NativeStatic)),
2870 (String::from("b"), None, Some(cstore::NativeFramework)),
2871 (String::from("c"), None, Some(cstore::NativeUnknown)),
2875 (String::from("b"), None, Some(cstore::NativeFramework)),
2876 (String::from("a"), None, Some(cstore::NativeStatic)),
2877 (String::from("c"), None, Some(cstore::NativeUnknown)),
2881 (String::from("c"), None, Some(cstore::NativeUnknown)),
2882 (String::from("a"), None, Some(cstore::NativeStatic)),
2883 (String::from("b"), None, Some(cstore::NativeFramework)),
2886 assert!(v1.dep_tracking_hash() == v2.dep_tracking_hash());
2887 assert!(v1.dep_tracking_hash() == v3.dep_tracking_hash());
2888 assert!(v2.dep_tracking_hash() == v3.dep_tracking_hash());
2891 assert_eq!(v1.dep_tracking_hash(), v1.clone().dep_tracking_hash());
2892 assert_eq!(v2.dep_tracking_hash(), v2.clone().dep_tracking_hash());
2893 assert_eq!(v3.dep_tracking_hash(), v3.clone().dep_tracking_hash());
2897 fn test_codegen_options_tracking_hash() {
2898 let reference = super::basic_options();
2899 let mut opts = super::basic_options();
2901 // Make sure the changing an [UNTRACKED] option leaves the hash unchanged
2902 opts.cg.ar = Some(String::from("abc"));
2903 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2905 opts.cg.linker = Some(PathBuf::from("linker"));
2906 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2908 opts.cg.link_args = Some(vec![String::from("abc"), String::from("def")]);
2909 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2911 opts.cg.link_dead_code = true;
2912 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2914 opts.cg.rpath = true;
2915 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2917 opts.cg.extra_filename = String::from("extra-filename");
2918 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2920 opts.cg.codegen_units = Some(42);
2921 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2923 opts.cg.remark = super::SomePasses(vec![String::from("pass1"), String::from("pass2")]);
2924 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2926 opts.cg.save_temps = true;
2927 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2929 opts.cg.incremental = Some(String::from("abc"));
2930 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
2932 // Make sure changing a [TRACKED] option changes the hash
2933 opts = reference.clone();
2934 opts.cg.lto = Lto::Fat;
2935 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2937 opts = reference.clone();
2938 opts.cg.target_cpu = Some(String::from("abc"));
2939 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2941 opts = reference.clone();
2942 opts.cg.target_feature = String::from("all the features, all of them");
2943 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2945 opts = reference.clone();
2946 opts.cg.passes = vec![String::from("1"), String::from("2")];
2947 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2949 opts = reference.clone();
2950 opts.cg.llvm_args = vec![String::from("1"), String::from("2")];
2951 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2953 opts = reference.clone();
2954 opts.cg.overflow_checks = Some(true);
2955 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2957 opts = reference.clone();
2958 opts.cg.no_prepopulate_passes = true;
2959 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2961 opts = reference.clone();
2962 opts.cg.no_vectorize_loops = true;
2963 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2965 opts = reference.clone();
2966 opts.cg.no_vectorize_slp = true;
2967 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2969 opts = reference.clone();
2970 opts.cg.soft_float = true;
2971 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2973 opts = reference.clone();
2974 opts.cg.prefer_dynamic = true;
2975 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2977 opts = reference.clone();
2978 opts.cg.no_integrated_as = true;
2979 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2981 opts = reference.clone();
2982 opts.cg.no_redzone = Some(true);
2983 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2985 opts = reference.clone();
2986 opts.cg.relocation_model = Some(String::from("relocation model"));
2987 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2989 opts = reference.clone();
2990 opts.cg.code_model = Some(String::from("code model"));
2991 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2993 opts = reference.clone();
2994 opts.debugging_opts.tls_model = Some(String::from("tls model"));
2995 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
2997 opts = reference.clone();
2998 opts.debugging_opts.pgo_gen = Some(String::from("abc"));
2999 assert_ne!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3001 opts = reference.clone();
3002 opts.debugging_opts.pgo_use = String::from("abc");
3003 assert_ne!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3005 opts = reference.clone();
3006 opts.cg.metadata = vec![String::from("A"), String::from("B")];
3007 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3009 opts = reference.clone();
3010 opts.cg.debuginfo = Some(0xdeadbeef);
3011 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3013 opts = reference.clone();
3014 opts.cg.debuginfo = Some(0xba5eba11);
3015 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3017 opts = reference.clone();
3018 opts.cg.force_frame_pointers = Some(false);
3019 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3021 opts = reference.clone();
3022 opts.cg.debug_assertions = Some(true);
3023 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3025 opts = reference.clone();
3026 opts.cg.inline_threshold = Some(0xf007ba11);
3027 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3029 opts = reference.clone();
3030 opts.cg.panic = Some(PanicStrategy::Abort);
3031 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3035 fn test_debugging_options_tracking_hash() {
3036 let reference = super::basic_options();
3037 let mut opts = super::basic_options();
3039 // Make sure the changing an [UNTRACKED] option leaves the hash unchanged
3040 opts.debugging_opts.verbose = true;
3041 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3042 opts.debugging_opts.time_passes = true;
3043 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3044 opts.debugging_opts.count_llvm_insns = true;
3045 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3046 opts.debugging_opts.time_llvm_passes = true;
3047 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3048 opts.debugging_opts.input_stats = true;
3049 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3050 opts.debugging_opts.codegen_stats = true;
3051 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3052 opts.debugging_opts.borrowck_stats = true;
3053 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3054 opts.debugging_opts.meta_stats = true;
3055 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3056 opts.debugging_opts.print_link_args = true;
3057 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3058 opts.debugging_opts.print_llvm_passes = true;
3059 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3060 opts.debugging_opts.ast_json = true;
3061 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3062 opts.debugging_opts.ast_json_noexpand = true;
3063 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3064 opts.debugging_opts.ls = true;
3065 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3066 opts.debugging_opts.save_analysis = true;
3067 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3068 opts.debugging_opts.flowgraph_print_loans = true;
3069 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3070 opts.debugging_opts.flowgraph_print_moves = true;
3071 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3072 opts.debugging_opts.flowgraph_print_assigns = true;
3073 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3074 opts.debugging_opts.flowgraph_print_all = true;
3075 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3076 opts.debugging_opts.print_region_graph = true;
3077 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3078 opts.debugging_opts.parse_only = true;
3079 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3080 opts.debugging_opts.incremental = Some(String::from("abc"));
3081 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3082 opts.debugging_opts.dump_dep_graph = true;
3083 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3084 opts.debugging_opts.query_dep_graph = true;
3085 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3086 opts.debugging_opts.no_analysis = true;
3087 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3088 opts.debugging_opts.unstable_options = true;
3089 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3090 opts.debugging_opts.trace_macros = true;
3091 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3092 opts.debugging_opts.keep_hygiene_data = true;
3093 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3094 opts.debugging_opts.keep_ast = true;
3095 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3096 opts.debugging_opts.print_mono_items = Some(String::from("abc"));
3097 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3098 opts.debugging_opts.dump_mir = Some(String::from("abc"));
3099 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3100 opts.debugging_opts.dump_mir_dir = String::from("abc");
3101 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3102 opts.debugging_opts.dump_mir_graphviz = true;
3103 assert_eq!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
3105 // Make sure changing a [TRACKED] option changes the hash
3106 opts = reference.clone();
3107 opts.debugging_opts.asm_comments = true;
3108 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3110 opts = reference.clone();
3111 opts.debugging_opts.no_verify = true;
3112 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3114 opts = reference.clone();
3115 opts.debugging_opts.no_landing_pads = true;
3116 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3118 opts = reference.clone();
3119 opts.debugging_opts.fewer_names = true;
3120 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3122 opts = reference.clone();
3123 opts.debugging_opts.no_codegen = true;
3124 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3126 opts = reference.clone();
3127 opts.debugging_opts.treat_err_as_bug = true;
3128 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3130 opts = reference.clone();
3131 opts.debugging_opts.continue_parse_after_error = true;
3132 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3134 opts = reference.clone();
3135 opts.debugging_opts.extra_plugins = vec![String::from("plugin1"), String::from("plugin2")];
3136 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3138 opts = reference.clone();
3139 opts.debugging_opts.force_overflow_checks = Some(true);
3140 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3142 opts = reference.clone();
3143 opts.debugging_opts.enable_nonzeroing_move_hints = true;
3144 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3146 opts = reference.clone();
3147 opts.debugging_opts.show_span = Some(String::from("abc"));
3148 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3150 opts = reference.clone();
3151 opts.debugging_opts.mir_opt_level = 3;
3152 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3154 opts = reference.clone();
3155 opts.debugging_opts.relro_level = Some(RelroLevel::Full);
3156 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3158 opts = reference.clone();
3159 opts.debugging_opts.cross_lang_lto = CrossLangLto::NoLink;
3160 assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
3164 fn test_edition_parsing() {
3165 // test default edition
3166 let options = super::basic_options();
3167 assert!(options.edition == DEFAULT_EDITION);
3169 let matches = optgroups()
3170 .parse(&["--edition=2018".to_string()])
3172 let (sessopts, _) = build_session_options_and_crate_config(&matches);
3173 assert!(sessopts.edition == Edition::Edition2018)