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::OptLevel::*;
18 pub use self::OutputType::*;
19 pub use self::DebugInfoLevel::*;
21 use session::{early_error, early_warn, Session};
22 use session::search_paths::SearchPaths;
24 use rustc_back::target::Target;
29 use syntax::ast::{IntTy, UintTy};
31 use syntax::attr::AttrMetaMethods;
32 use syntax::diagnostic::{ColorConfig, Auto, Always, Never, SpanHandler};
34 use syntax::parse::token::InternedString;
36 use std::collections::HashMap;
37 use std::collections::hash_map::Entry::{Occupied, Vacant};
46 pub uint_type: UintTy,
49 #[derive(Clone, Copy, PartialEq)]
57 #[derive(Clone, Copy, PartialEq)]
58 pub enum DebugInfoLevel {
64 #[derive(Clone, Copy, PartialEq, PartialOrd, Ord, Eq)]
68 OutputTypeLlvmAssembly,
76 // The crate config requested for the session, which may be combined
77 // with additional crate configurations during the compile process
78 pub crate_types: Vec<CrateType>,
81 pub optimize: OptLevel,
82 pub debuginfo: DebugInfoLevel,
83 pub lint_opts: Vec<(String, lint::Level)>,
84 pub describe_lints: bool,
85 pub output_types: Vec<OutputType> ,
86 // This was mutable for rustpkg, which updates search paths based on the
87 // parsed code. It remains mutable in case its replacements wants to use
89 pub search_paths: SearchPaths,
90 pub libs: Vec<(String, cstore::NativeLibraryKind)>,
91 pub maybe_sysroot: Option<Path>,
92 pub target_triple: String,
93 // User-specified cfg meta items. The compiler itself will add additional
94 // items to the crate config, and during parsing the entire crate config
95 // will be added to the crate AST node. This should not be used for
96 // anything except building the full crate config prior to parsing.
97 pub cfg: ast::CrateConfig,
101 pub no_analysis: bool,
102 pub debugging_opts: u64,
103 /// Whether to write dependency files. It's (enabled, optional filename).
104 pub write_dependency_info: (bool, Option<Path>),
105 pub prints: Vec<PrintRequest>,
106 pub cg: CodegenOptions,
107 pub color: ColorConfig,
108 pub show_span: Option<String>,
109 pub externs: HashMap<String, Vec<String>>,
110 pub crate_name: Option<String>,
111 /// An optional name to use as the crate for std during std injection,
112 /// written `extern crate std = "name"`. Default to "std". Used by
113 /// out-of-tree drivers.
114 pub alt_std_name: Option<String>
117 #[derive(Clone, PartialEq, Eq)]
118 #[allow(missing_copy_implementations)]
119 pub enum PrintRequest {
126 /// Load source from file
128 /// The string is the source
133 pub fn filestem(&self) -> String {
135 Input::File(ref ifile) => ifile.filestem_str().unwrap().to_string(),
136 Input::Str(_) => "rust_out".to_string(),
142 pub struct OutputFilenames {
143 pub out_directory: Path,
144 pub out_filestem: String,
145 pub single_output_file: Option<Path>,
149 impl OutputFilenames {
150 pub fn path(&self, flavor: OutputType) -> Path {
151 match self.single_output_file {
152 Some(ref path) => return path.clone(),
155 self.temp_path(flavor)
158 pub fn temp_path(&self, flavor: OutputType) -> Path {
159 let base = self.out_directory.join(self.filestem());
161 OutputTypeBitcode => base.with_extension("bc"),
162 OutputTypeAssembly => base.with_extension("s"),
163 OutputTypeLlvmAssembly => base.with_extension("ll"),
164 OutputTypeObject => base.with_extension("o"),
165 OutputTypeDepInfo => base.with_extension("d"),
166 OutputTypeExe => base,
170 pub fn with_extension(&self, extension: &str) -> Path {
171 self.out_directory.join(self.filestem()).with_extension(extension)
174 pub fn filestem(&self) -> String {
175 format!("{}{}", self.out_filestem, self.extra)
179 pub fn host_triple() -> &'static str {
180 // Get the host triple out of the build environment. This ensures that our
181 // idea of the host triple is the same as for the set of libraries we've
182 // actually built. We can't just take LLVM's host triple because they
183 // normalize all ix86 architectures to i386.
185 // Instead of grabbing the host triple (for the current host), we grab (at
186 // compile time) the target triple that this rustc is built with and
187 // calling that (at runtime) the host triple.
188 (option_env!("CFG_COMPILER_HOST_TRIPLE")).
189 expect("CFG_COMPILER_HOST_TRIPLE")
192 /// Some reasonable defaults
193 pub fn basic_options() -> Options {
195 crate_types: Vec::new(),
198 debuginfo: NoDebugInfo,
199 lint_opts: Vec::new(),
200 describe_lints: false,
201 output_types: Vec::new(),
202 search_paths: SearchPaths::new(),
204 target_triple: host_triple().to_string(),
211 write_dependency_info: (false, None),
213 cg: basic_codegen_options(),
216 externs: HashMap::new(),
223 // The type of entry function, so
224 // users can have their own entry
225 // functions that don't start a
227 #[derive(Copy, PartialEq)]
228 pub enum EntryFnType {
234 #[derive(Copy, PartialEq, PartialOrd, Clone, Ord, Eq, Hash)]
242 macro_rules! debugging_opts {
243 ([ $opt:ident ] $cnt:expr ) => (
244 pub const $opt: u64 = 1 << $cnt;
246 ([ $opt:ident, $($rest:ident),* ] $cnt:expr ) => (
247 pub const $opt: u64 = 1 << $cnt;
248 debugging_opts! { [ $($rest),* ] $cnt + 1 }
273 PRINT_MOVE_FRAGMENTS,
274 FLOWGRAPH_PRINT_LOANS,
275 FLOWGRAPH_PRINT_MOVES,
276 FLOWGRAPH_PRINT_ASSIGNS,
288 pub fn debugging_opts_map() -> Vec<(&'static str, &'static str, u64)> {
289 vec![("verbose", "in general, enable more debug printouts", VERBOSE),
290 ("time-passes", "measure time of each rustc pass", TIME_PASSES),
291 ("count-llvm-insns", "count where LLVM \
292 instrs originate", COUNT_LLVM_INSNS),
293 ("time-llvm-passes", "measure time of each LLVM pass",
295 ("trans-stats", "gather trans statistics", TRANS_STATS),
296 ("asm-comments", "generate comments into the assembly (may change behavior)",
298 ("no-verify", "skip LLVM verification", NO_VERIFY),
299 ("borrowck-stats", "gather borrowck statistics", BORROWCK_STATS),
300 ("no-landing-pads", "omit landing pads for unwinding",
302 ("debug-llvm", "enable debug output from LLVM", DEBUG_LLVM),
303 ("count-type-sizes", "count the sizes of aggregate types",
305 ("meta-stats", "gather metadata statistics", META_STATS),
306 ("print-link-args", "Print the arguments passed to the linker",
308 ("gc", "Garbage collect shared data (experimental)", GC),
309 ("print-llvm-passes",
310 "Prints the llvm optimization passes being run",
312 ("ast-json", "Print the AST as JSON and halt", AST_JSON),
313 ("ast-json-noexpand", "Print the pre-expansion AST as JSON and halt", AST_JSON_NOEXPAND),
314 ("ls", "List the symbols defined by a library crate", LS),
315 ("save-analysis", "Write syntax and type analysis information \
316 in addition to normal output", SAVE_ANALYSIS),
317 ("print-move-fragments", "Print out move-fragment data for every fn",
318 PRINT_MOVE_FRAGMENTS),
319 ("flowgraph-print-loans", "Include loan analysis data in \
320 --pretty flowgraph output", FLOWGRAPH_PRINT_LOANS),
321 ("flowgraph-print-moves", "Include move analysis data in \
322 --pretty flowgraph output", FLOWGRAPH_PRINT_MOVES),
323 ("flowgraph-print-assigns", "Include assignment analysis data in \
324 --pretty flowgraph output", FLOWGRAPH_PRINT_ASSIGNS),
325 ("flowgraph-print-all", "Include all dataflow analysis data in \
326 --pretty flowgraph output", FLOWGRAPH_PRINT_ALL),
327 ("print-region-graph", "Prints region inference graph. \
328 Use with RUST_REGION_GRAPH=help for more info",
330 ("parse-only", "Parse only; do not compile, assemble, or link", PARSE_ONLY),
331 ("no-trans", "Run all passes except translation; no output", NO_TRANS),
332 ("no-analysis", "Parse and expand the source, but run no analysis and",
334 ("unstable-options", "Adds unstable command line options to rustc interface",
336 ("print-enum-sizes", "Print the size of enums and their variants", PRINT_ENUM_SIZES),
342 SomePasses(Vec<String>),
347 pub fn is_empty(&self) -> bool {
349 SomePasses(ref v) => v.is_empty(),
355 /// Declare a macro that will define all CodegenOptions fields and parsers all
356 /// at once. The goal of this macro is to define an interface that can be
357 /// programmatically used by the option parser in order to initialize the struct
358 /// without hardcoding field names all over the place.
360 /// The goal is to invoke this macro once with the correct fields, and then this
361 /// macro generates all necessary code. The main gotcha of this macro is the
362 /// cgsetters module which is a bunch of generated code to parse an option into
363 /// its respective field in the struct. There are a few hand-written parsers for
364 /// parsing specific types of values in this module.
365 macro_rules! cgoptions {
366 ($($opt:ident : $t:ty = ($init:expr, $parse:ident, $desc:expr)),* ,) =>
369 pub struct CodegenOptions { $(pub $opt: $t),* }
371 pub fn basic_codegen_options() -> CodegenOptions {
372 CodegenOptions { $($opt: $init),* }
375 pub type CodegenSetter = fn(&mut CodegenOptions, v: Option<&str>) -> bool;
376 pub const CG_OPTIONS: &'static [(&'static str, CodegenSetter,
377 Option<&'static str>, &'static str)] =
378 &[ $( (stringify!($opt), cgsetters::$opt, cg_type_descs::$parse, $desc) ),* ];
380 #[allow(non_upper_case_globals)]
382 pub const parse_bool: Option<&'static str> = None;
383 pub const parse_opt_bool: Option<&'static str> = None;
384 pub const parse_string: Option<&'static str> = Some("a string");
385 pub const parse_opt_string: Option<&'static str> = Some("a string");
386 pub const parse_list: Option<&'static str> = Some("a space-separated list of strings");
387 pub const parse_opt_list: Option<&'static str> = Some("a space-separated list of strings");
388 pub const parse_uint: Option<&'static str> = Some("a number");
389 pub const parse_passes: Option<&'static str> =
390 Some("a space-separated list of passes, or `all`");
391 pub const parse_opt_uint: Option<&'static str> =
396 use super::{CodegenOptions, Passes, SomePasses, AllPasses};
399 pub fn $opt(cg: &mut CodegenOptions, v: Option<&str>) -> bool {
400 $parse(&mut cg.$opt, v)
404 fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
407 None => { *slot = true; true }
411 fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
414 None => { *slot = Some(true); true }
418 fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
420 Some(s) => { *slot = Some(s.to_string()); true },
425 fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
427 Some(s) => { *slot = s.to_string(); true },
432 fn parse_list(slot: &mut Vec<String>, v: Option<&str>)
437 slot.push(s.to_string());
445 fn parse_opt_list(slot: &mut Option<Vec<String>>, v: Option<&str>)
449 let v = s.words().map(|s| s.to_string()).collect();
457 fn parse_uint(slot: &mut uint, v: Option<&str>) -> bool {
458 match v.and_then(|s| s.parse()) {
459 Some(i) => { *slot = i; true },
464 fn parse_opt_uint(slot: &mut Option<uint>, v: Option<&str>) -> bool {
466 Some(s) => { *slot = s.parse(); slot.is_some() }
467 None => { *slot = None; true }
471 fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
478 let mut passes = vec!();
479 if parse_list(&mut passes, v) {
480 *slot = SomePasses(passes);
492 ar: Option<String> = (None, parse_opt_string,
493 "tool to assemble archives with"),
494 linker: Option<String> = (None, parse_opt_string,
495 "system linker to link outputs with"),
496 link_args: Option<Vec<String>> = (None, parse_opt_list,
497 "extra arguments to pass to the linker (space separated)"),
498 lto: bool = (false, parse_bool,
499 "perform LLVM link-time optimizations"),
500 target_cpu: Option<String> = (None, parse_opt_string,
501 "select target processor (llc -mcpu=help for details)"),
502 target_feature: String = ("".to_string(), parse_string,
503 "target specific attributes (llc -mattr=help for details)"),
504 passes: Vec<String> = (Vec::new(), parse_list,
505 "a list of extra LLVM passes to run (space separated)"),
506 llvm_args: Vec<String> = (Vec::new(), parse_list,
507 "a list of arguments to pass to llvm (space separated)"),
508 save_temps: bool = (false, parse_bool,
509 "save all temporary output files during compilation"),
510 rpath: bool = (false, parse_bool,
511 "set rpath values in libs/exes"),
512 no_prepopulate_passes: bool = (false, parse_bool,
513 "don't pre-populate the pass manager with a list of passes"),
514 no_vectorize_loops: bool = (false, parse_bool,
515 "don't run the loop vectorization optimization passes"),
516 no_vectorize_slp: bool = (false, parse_bool,
517 "don't run LLVM's SLP vectorization pass"),
518 soft_float: bool = (false, parse_bool,
519 "generate software floating point library calls"),
520 prefer_dynamic: bool = (false, parse_bool,
521 "prefer dynamic linking to static linking"),
522 no_integrated_as: bool = (false, parse_bool,
523 "use an external assembler rather than LLVM's integrated one"),
524 no_redzone: Option<bool> = (None, parse_opt_bool,
525 "disable the use of the redzone"),
526 relocation_model: Option<String> = (None, parse_opt_string,
527 "choose the relocation model to use (llc -relocation-model for details)"),
528 code_model: Option<String> = (None, parse_opt_string,
529 "choose the code model to use (llc -code-model for details)"),
530 metadata: Vec<String> = (Vec::new(), parse_list,
531 "metadata to mangle symbol names with"),
532 extra_filename: String = ("".to_string(), parse_string,
533 "extra data to put in each output filename"),
534 codegen_units: uint = (1, parse_uint,
535 "divide crate into N units to optimize in parallel"),
536 remark: Passes = (SomePasses(Vec::new()), parse_passes,
537 "print remarks for these optimization passes (space separated, or \"all\")"),
538 no_stack_check: bool = (false, parse_bool,
539 "disable checks for stack exhaustion (a memory-safety hazard!)"),
540 debuginfo: Option<uint> = (None, parse_opt_uint,
541 "debug info emission level, 0 = no debug info, 1 = line tables only, \
542 2 = full debug info with variable and type information"),
543 opt_level: Option<uint> = (None, parse_opt_uint,
544 "Optimize with possible levels 0-3"),
547 pub fn build_codegen_options(matches: &getopts::Matches) -> CodegenOptions
549 let mut cg = basic_codegen_options();
550 for option in matches.opt_strs("C").into_iter() {
551 let mut iter = option.splitn(1, '=');
552 let key = iter.next().unwrap();
553 let value = iter.next();
554 let option_to_lookup = key.replace("-", "_");
555 let mut found = false;
556 for &(candidate, setter, opt_type_desc, _) in CG_OPTIONS.iter() {
557 if option_to_lookup != candidate { continue }
558 if !setter(&mut cg, value) {
559 match (value, opt_type_desc) {
560 (Some(..), None) => {
561 early_error(format!("codegen option `{}` takes no \
562 value", key).index(&FullRange))
564 (None, Some(type_desc)) => {
565 early_error(format!("codegen option `{0}` requires \
566 {1} (-C {0}=<value>)",
567 key, type_desc).index(&FullRange))
569 (Some(value), Some(type_desc)) => {
570 early_error(format!("incorrect value `{}` for codegen \
571 option `{}` - {} was expected",
572 value, key, type_desc).index(&FullRange))
574 (None, None) => unreachable!()
581 early_error(format!("unknown codegen option: `{}`",
582 key).index(&FullRange));
588 pub fn default_lib_output() -> CrateType {
592 pub fn default_configuration(sess: &Session) -> ast::CrateConfig {
593 use syntax::parse::token::intern_and_get_ident as intern;
595 let end = sess.target.target.target_endian.index(&FullRange);
596 let arch = sess.target.target.arch.index(&FullRange);
597 let wordsz = sess.target.target.target_word_size.index(&FullRange);
598 let os = sess.target.target.target_os.index(&FullRange);
600 let fam = match sess.target.target.options.is_like_windows {
601 true => InternedString::new("windows"),
602 false => InternedString::new("unix")
605 let mk = attr::mk_name_value_item_str;
606 return vec!(// Target bindings.
607 attr::mk_word_item(fam.clone()),
608 mk(InternedString::new("target_os"), intern(os)),
609 mk(InternedString::new("target_family"), fam),
610 mk(InternedString::new("target_arch"), intern(arch)),
611 mk(InternedString::new("target_endian"), intern(end)),
612 mk(InternedString::new("target_word_size"),
617 pub fn append_configuration(cfg: &mut ast::CrateConfig,
618 name: InternedString) {
619 if !cfg.iter().any(|mi| mi.name() == name) {
620 cfg.push(attr::mk_word_item(name))
624 pub fn build_configuration(sess: &Session) -> ast::CrateConfig {
625 // Combine the configuration requested by the session (command line) with
626 // some default and generated configuration items
627 let default_cfg = default_configuration(sess);
628 let mut user_cfg = sess.opts.cfg.clone();
629 // If the user wants a test runner, then add the test cfg
631 append_configuration(&mut user_cfg, InternedString::new("test"))
633 let mut v = user_cfg.into_iter().collect::<Vec<_>>();
634 v.push_all(default_cfg.index(&FullRange));
638 pub fn build_target_config(opts: &Options, sp: &SpanHandler) -> Config {
639 let target = match Target::search(opts.target_triple.index(&FullRange)) {
642 sp.handler().fatal((format!("Error loading target specification: {}", e)).as_slice());
646 let (int_type, uint_type) = match target.target_word_size.index(&FullRange) {
647 "32" => (ast::TyI32, ast::TyU32),
648 "64" => (ast::TyI64, ast::TyU64),
649 w => sp.handler().fatal((format!("target specification was invalid: unrecognized \
650 target-word-size {}", w)).index(&FullRange))
656 uint_type: uint_type,
660 /// Returns the "short" subset of the stable rustc command line options.
661 pub fn short_optgroups() -> Vec<getopts::OptGroup> {
662 rustc_short_optgroups().into_iter()
663 .filter(|g|g.is_stable())
668 /// Returns all of the stable rustc command line options.
669 pub fn optgroups() -> Vec<getopts::OptGroup> {
670 rustc_optgroups().into_iter()
671 .filter(|g|g.is_stable())
676 #[derive(Copy, Clone, PartialEq, Eq, Show)]
677 pub enum OptionStability { Stable, Unstable }
679 #[derive(Clone, PartialEq, Eq)]
680 pub struct RustcOptGroup {
681 pub opt_group: getopts::OptGroup,
682 pub stability: OptionStability,
686 pub fn is_stable(&self) -> bool {
687 self.stability == OptionStability::Stable
690 fn stable(g: getopts::OptGroup) -> RustcOptGroup {
691 RustcOptGroup { opt_group: g, stability: OptionStability::Stable }
694 fn unstable(g: getopts::OptGroup) -> RustcOptGroup {
695 RustcOptGroup { opt_group: g, stability: OptionStability::Unstable }
699 // The `opt` local module holds wrappers around the `getopts` API that
700 // adds extra rustc-specific metadata to each option; such metadata
701 // is exposed by . The public
702 // functions below ending with `_u` are the functions that return
703 // *unstable* options, i.e. options that are only enabled when the
704 // user also passes the `-Z unstable-options` debugging flag.
706 // The `fn opt_u` etc below are written so that we can use them
707 // in the future; do not warn about them not being used right now.
711 use super::RustcOptGroup;
713 type R = RustcOptGroup;
714 type S<'a> = &'a str;
716 fn stable(g: getopts::OptGroup) -> R { RustcOptGroup::stable(g) }
717 fn unstable(g: getopts::OptGroup) -> R { RustcOptGroup::unstable(g) }
719 // FIXME (pnkfelix): We default to stable since the current set of
720 // options is defacto stable. However, it would be good to revise the
721 // code so that a stable option is the thing that takes extra effort
724 pub fn opt(a: S, b: S, c: S, d: S) -> R { stable(getopts::optopt(a, b, c, d)) }
725 pub fn multi(a: S, b: S, c: S, d: S) -> R { stable(getopts::optmulti(a, b, c, d)) }
726 pub fn flag(a: S, b: S, c: S) -> R { stable(getopts::optflag(a, b, c)) }
727 pub fn flagopt(a: S, b: S, c: S, d: S) -> R { stable(getopts::optflagopt(a, b, c, d)) }
729 pub fn opt_u(a: S, b: S, c: S, d: S) -> R { unstable(getopts::optopt(a, b, c, d)) }
730 pub fn multi_u(a: S, b: S, c: S, d: S) -> R { unstable(getopts::optmulti(a, b, c, d)) }
731 pub fn flag_u(a: S, b: S, c: S) -> R { unstable(getopts::optflag(a, b, c)) }
732 pub fn flagopt_u(a: S, b: S, c: S, d: S) -> R { unstable(getopts::optflagopt(a, b, c, d)) }
735 /// Returns the "short" subset of the rustc command line options,
736 /// including metadata for each option, such as whether the option is
737 /// part of the stable long-term interface for rustc.
738 pub fn rustc_short_optgroups() -> Vec<RustcOptGroup> {
740 opt::flag("h", "help", "Display this message"),
741 opt::multi("", "cfg", "Configure the compilation environment", "SPEC"),
742 opt::multi("L", "", "Add a directory to the library search path", "PATH"),
743 opt::multi("l", "", "Link the generated crate(s) to the specified native
744 library NAME. The optional KIND can be one of,
745 static, dylib, or framework. If omitted, dylib is
746 assumed.", "[KIND=]NAME"),
747 opt::multi("", "crate-type", "Comma separated list of types of crates
748 for the compiler to emit",
749 "[bin|lib|rlib|dylib|staticlib]"),
750 opt::opt("", "crate-name", "Specify the name of the crate being built",
752 opt::multi("", "emit", "Comma separated list of types of output for \
753 the compiler to emit",
754 "[asm|llvm-bc|llvm-ir|obj|link|dep-info]"),
755 opt::multi("", "print", "Comma separated list of compiler information to \
757 "[crate-name|file-names|sysroot]"),
758 opt::flag("g", "", "Equivalent to -C debuginfo=2"),
759 opt::flag("O", "", "Equivalent to -C opt-level=2"),
760 opt::opt("o", "", "Write output to <filename>", "FILENAME"),
761 opt::opt("", "out-dir", "Write output to compiler-chosen filename \
763 opt::opt("", "explain", "Provide a detailed explanation of an error \
765 opt::flag("", "test", "Build a test harness"),
766 opt::opt("", "target", "Target triple cpu-manufacturer-kernel[-os] \
767 to compile for (see chapter 3.4 of \
768 http://www.sourceware.org/autobook/
771 opt::multi("W", "warn", "Set lint warnings", "OPT"),
772 opt::multi("A", "allow", "Set lint allowed", "OPT"),
773 opt::multi("D", "deny", "Set lint denied", "OPT"),
774 opt::multi("F", "forbid", "Set lint forbidden", "OPT"),
775 opt::multi("C", "codegen", "Set a codegen option", "OPT[=VALUE]"),
776 opt::flag("V", "version", "Print version info and exit"),
777 opt::flag("v", "verbose", "Use verbose output"),
781 /// Returns all rustc command line options, including metadata for
782 /// each option, such as whether the option is part of the stable
783 /// long-term interface for rustc.
784 pub fn rustc_optgroups() -> Vec<RustcOptGroup> {
785 let mut opts = rustc_short_optgroups();
787 opt::multi("", "extern", "Specify where an external rust library is \
790 opt::opt("", "opt-level", "Optimize with possible levels 0-3", "LEVEL"),
791 opt::opt("", "sysroot", "Override the system root", "PATH"),
792 opt::multi("Z", "", "Set internal debugging options", "FLAG"),
793 opt::opt("", "color", "Configure coloring of output:
794 auto = colorize, if output goes to a tty (default);
795 always = always colorize output;
796 never = never colorize output", "auto|always|never"),
799 opt::flag("", "print-crate-name", "Output the crate name and exit"),
800 opt::flag("", "print-file-name", "Output the file(s) that would be \
801 written if compilation \
802 continued and exit"),
803 opt::opt("", "debuginfo", "Emit DWARF debug info to the objects created:
805 1 = line-tables only (for stacktraces and breakpoints),
806 2 = full debug info with variable and type information \
807 (same as -g)", "LEVEL"),
808 opt::flag("", "no-trans", "Run all passes except translation; no output"),
809 opt::flag("", "no-analysis", "Parse and expand the source, but run no \
810 analysis and produce no output"),
811 opt::flag("", "parse-only", "Parse only; do not compile, assemble, \
813 opt::flagopt("", "pretty",
814 "Pretty-print the input instead of compiling;
815 valid types are: `normal` (un-annotated source),
816 `expanded` (crates expanded),
817 `typed` (crates expanded, with type annotations), or
818 `expanded,identified` (fully parenthesized, AST nodes with IDs).",
820 opt::flagopt_u("", "xpretty",
821 "Pretty-print the input instead of compiling, unstable variants;
822 valid types are any of the types for `--pretty`, as well as:
823 `flowgraph=<nodeid>` (graphviz formatted flowgraph for node), or
824 `everybody_loops` (all function bodies replaced with `loop {}`).",
826 opt::opt_u("", "show-span", "Show spans for compiler debugging", "expr|pat|ty"),
827 opt::flagopt("", "dep-info",
828 "Output dependency info to <filename> after compiling, \
829 in a format suitable for use by Makefiles", "FILENAME"),
834 // Convert strings provided as --cfg [cfgspec] into a crate_cfg
835 pub fn parse_cfgspecs(cfgspecs: Vec<String> ) -> ast::CrateConfig {
836 cfgspecs.into_iter().map(|s| {
837 parse::parse_meta_from_source_str("cfgspec".to_string(),
840 &parse::new_parse_sess())
841 }).collect::<ast::CrateConfig>()
844 pub fn build_session_options(matches: &getopts::Matches) -> Options {
846 let unparsed_crate_types = matches.opt_strs("crate-type");
847 let crate_types = parse_crate_types_from_list(unparsed_crate_types)
848 .unwrap_or_else(|e| early_error(e.index(&FullRange)));
850 let mut lint_opts = vec!();
851 let mut describe_lints = false;
853 for &level in [lint::Allow, lint::Warn, lint::Deny, lint::Forbid].iter() {
854 for lint_name in matches.opt_strs(level.as_str()).into_iter() {
855 if lint_name == "help" {
856 describe_lints = true;
858 lint_opts.push((lint_name.replace("-", "_"), level));
863 let mut debugging_opts = 0;
864 let debug_flags = matches.opt_strs("Z");
865 let debug_map = debugging_opts_map();
866 for debug_flag in debug_flags.iter() {
867 let mut this_bit = 0;
868 for &(name, _, bit) in debug_map.iter() {
869 if name == *debug_flag {
875 early_error(format!("unknown debug flag: {}",
876 *debug_flag).index(&FullRange))
878 debugging_opts |= this_bit;
881 let parse_only = if matches.opt_present("parse-only") {
882 // FIXME(acrichto) remove this eventually
883 early_warn("--parse-only is deprecated in favor of -Z parse-only");
886 debugging_opts & PARSE_ONLY != 0
888 let no_trans = if matches.opt_present("no-trans") {
889 // FIXME(acrichto) remove this eventually
890 early_warn("--no-trans is deprecated in favor of -Z no-trans");
893 debugging_opts & NO_TRANS != 0
895 let no_analysis = if matches.opt_present("no-analysis") {
896 // FIXME(acrichto) remove this eventually
897 early_warn("--no-analysis is deprecated in favor of -Z no-analysis");
900 debugging_opts & NO_ANALYSIS != 0
903 if debugging_opts & DEBUG_LLVM != 0 {
904 unsafe { llvm::LLVMSetDebug(1); }
907 let mut output_types = Vec::new();
908 if !parse_only && !no_trans {
909 let unparsed_output_types = matches.opt_strs("emit");
910 for unparsed_output_type in unparsed_output_types.iter() {
911 for part in unparsed_output_type.split(',') {
912 let output_type = match part.as_slice() {
913 "asm" => OutputTypeAssembly,
914 "llvm-ir" => OutputTypeLlvmAssembly,
915 "llvm-bc" => OutputTypeBitcode,
916 "obj" => OutputTypeObject,
917 "link" => OutputTypeExe,
918 "dep-info" => OutputTypeDepInfo,
920 early_error(format!("unknown emission type: `{}`",
921 part).index(&FullRange))
924 output_types.push(output_type)
929 output_types.dedup();
930 if output_types.len() == 0 {
931 output_types.push(OutputTypeExe);
934 let cg = build_codegen_options(matches);
936 let sysroot_opt = matches.opt_str("sysroot").map(|m| Path::new(m));
937 let target = matches.opt_str("target").unwrap_or(
938 host_triple().to_string());
940 if matches.opt_present("O") {
941 if matches.opt_present("opt-level") {
942 early_error("-O and --opt-level both provided");
944 if cg.opt_level.is_some() {
945 early_error("-O and -C opt-level both provided");
948 } else if matches.opt_present("opt-level") {
949 // FIXME(acrichto) remove this eventually
950 early_warn("--opt-level=N is deprecated in favor of -C opt-level=N");
951 match matches.opt_str("opt-level").as_ref().map(|s| s.as_slice()) {
955 Some("2") => Default,
956 Some("3") => Aggressive,
958 early_error(format!("optimization level needs to be \
959 between 0-3 (instead was `{}`)",
960 arg).index(&FullRange));
969 Some(3) => Aggressive,
971 early_error(format!("optimization level needs to be \
972 between 0-3 (instead was `{}`)",
978 let gc = debugging_opts & GC != 0;
979 let debuginfo = if matches.opt_present("g") {
980 if matches.opt_present("debuginfo") {
981 early_error("-g and --debuginfo both provided");
983 if cg.debuginfo.is_some() {
984 early_error("-g and -C debuginfo both provided");
987 } else if matches.opt_present("debuginfo") {
988 // FIXME(acrichto) remove this eventually
989 early_warn("--debuginfo=N is deprecated in favor of -C debuginfo=N");
990 match matches.opt_str("debuginfo").as_ref().map(|s| s.as_slice()) {
991 Some("0") => NoDebugInfo,
992 Some("1") => LimitedDebugInfo,
994 Some("2") => FullDebugInfo,
996 early_error(format!("debug info level needs to be between \
997 0-2 (instead was `{}`)",
998 arg).index(&FullRange));
1002 match cg.debuginfo {
1003 None | Some(0) => NoDebugInfo,
1004 Some(1) => LimitedDebugInfo,
1005 Some(2) => FullDebugInfo,
1007 early_error(format!("debug info level needs to be between \
1008 0-2 (instead was `{}`)",
1014 let mut search_paths = SearchPaths::new();
1015 for s in matches.opt_strs("L").iter() {
1016 search_paths.add_path(s.index(&FullRange));
1019 let libs = matches.opt_strs("l").into_iter().map(|s| {
1020 let mut parts = s.splitn(1, '=');
1021 let kind = parts.next().unwrap();
1022 if let Some(name) = parts.next() {
1023 let kind = match kind {
1024 "dylib" => cstore::NativeUnknown,
1025 "framework" => cstore::NativeFramework,
1026 "static" => cstore::NativeStatic,
1028 early_error(format!("unknown library kind `{}`, expected \
1029 one of dylib, framework, or static",
1033 return (name.to_string(), kind)
1036 // FIXME(acrichto) remove this once crates have stopped using it, this
1037 // is deprecated behavior now.
1038 let mut parts = s.rsplitn(1, ':');
1039 let kind = parts.next().unwrap();
1040 let (name, kind) = match (parts.next(), kind) {
1042 (Some(name), "dylib") => (name, cstore::NativeUnknown),
1043 (Some(name), "framework") => (name, cstore::NativeFramework),
1044 (Some(name), "static") => (name, cstore::NativeStatic),
1046 early_error(format!("unknown library kind `{}`, expected \
1047 one of dylib, framework, or static",
1048 s).index(&FullRange));
1051 (name.to_string(), kind)
1054 let cfg = parse_cfgspecs(matches.opt_strs("cfg"));
1055 let test = matches.opt_present("test");
1056 let write_dependency_info = if matches.opt_present("dep-info") {
1057 // FIXME(acrichto) remove this eventually
1058 early_warn("--dep-info has been deprecated in favor of --emit");
1059 (true, matches.opt_str("dep-info").map(|p| Path::new(p)))
1061 (output_types.contains(&OutputTypeDepInfo), None)
1064 let mut prints = matches.opt_strs("print").into_iter().map(|s| {
1065 match s.as_slice() {
1066 "crate-name" => PrintRequest::CrateName,
1067 "file-names" => PrintRequest::FileNames,
1068 "sysroot" => PrintRequest::Sysroot,
1070 early_error(format!("unknown print request `{}`", req).as_slice())
1073 }).collect::<Vec<_>>();
1074 if matches.opt_present("print-crate-name") {
1075 // FIXME(acrichto) remove this eventually
1076 early_warn("--print-crate-name has been deprecated in favor of \
1077 --print crate-name");
1078 prints.push(PrintRequest::CrateName);
1080 if matches.opt_present("print-file-name") {
1081 // FIXME(acrichto) remove this eventually
1082 early_warn("--print-file-name has been deprecated in favor of \
1083 --print file-names");
1084 prints.push(PrintRequest::FileNames);
1087 if !cg.remark.is_empty() && debuginfo == NoDebugInfo {
1088 early_warn("-C remark will not show source locations without \
1092 let color = match matches.opt_str("color").as_ref().map(|s| s.index(&FullRange)) {
1093 Some("auto") => Auto,
1094 Some("always") => Always,
1095 Some("never") => Never,
1100 early_error(format!("argument for --color must be auto, always \
1101 or never (instead was `{}`)",
1102 arg).index(&FullRange))
1106 let mut externs = HashMap::new();
1107 for arg in matches.opt_strs("extern").iter() {
1108 let mut parts = arg.splitn(1, '=');
1109 let name = match parts.next() {
1111 None => early_error("--extern value must not be empty"),
1113 let location = match parts.next() {
1115 None => early_error("--extern value must be of the format `foo=bar`"),
1118 match externs.entry(&name.to_string()) {
1119 Vacant(entry) => { entry.insert(vec![location.to_string()]); },
1120 Occupied(mut entry) => { entry.get_mut().push(location.to_string()); },
1124 let crate_name = matches.opt_str("crate-name");
1127 crate_types: crate_types,
1129 optimize: opt_level,
1130 debuginfo: debuginfo,
1131 lint_opts: lint_opts,
1132 describe_lints: describe_lints,
1133 output_types: output_types,
1134 search_paths: search_paths,
1135 maybe_sysroot: sysroot_opt,
1136 target_triple: target,
1139 parse_only: parse_only,
1141 no_analysis: no_analysis,
1142 debugging_opts: debugging_opts,
1143 write_dependency_info: write_dependency_info,
1149 crate_name: crate_name,
1155 pub fn parse_crate_types_from_list(list_list: Vec<String>) -> Result<Vec<CrateType>, String> {
1157 let mut crate_types: Vec<CrateType> = Vec::new();
1158 for unparsed_crate_type in list_list.iter() {
1159 for part in unparsed_crate_type.split(',') {
1160 let new_part = match part {
1161 "lib" => default_lib_output(),
1162 "rlib" => CrateTypeRlib,
1163 "staticlib" => CrateTypeStaticlib,
1164 "dylib" => CrateTypeDylib,
1165 "bin" => CrateTypeExecutable,
1167 return Err(format!("unknown crate type: `{}`",
1171 crate_types.push(new_part)
1175 return Ok(crate_types);
1178 impl fmt::Show for CrateType {
1179 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1181 CrateTypeExecutable => "bin".fmt(f),
1182 CrateTypeDylib => "dylib".fmt(f),
1183 CrateTypeRlib => "rlib".fmt(f),
1184 CrateTypeStaticlib => "staticlib".fmt(f)
1192 use session::config::{build_configuration, optgroups, build_session_options};
1193 use session::build_session;
1195 use getopts::getopts;
1197 use syntax::attr::AttrMetaMethods;
1198 use syntax::diagnostics;
1200 // When the user supplies --test we should implicitly supply --cfg test
1202 fn test_switch_implies_cfg_test() {
1204 &match getopts(&["--test".to_string()], optgroups().index(&FullRange)) {
1206 Err(f) => panic!("test_switch_implies_cfg_test: {}", f)
1208 let registry = diagnostics::registry::Registry::new(&[]);
1209 let sessopts = build_session_options(matches);
1210 let sess = build_session(sessopts, None, registry);
1211 let cfg = build_configuration(&sess);
1212 assert!((attr::contains_name(cfg.index(&FullRange), "test")));
1215 // When the user supplies --test and --cfg test, don't implicitly add
1216 // another --cfg test
1218 fn test_switch_implies_cfg_test_unless_cfg_test() {
1220 &match getopts(&["--test".to_string(), "--cfg=test".to_string()],
1221 optgroups().index(&FullRange)) {
1224 panic!("test_switch_implies_cfg_test_unless_cfg_test: {}", f)
1227 let registry = diagnostics::registry::Registry::new(&[]);
1228 let sessopts = build_session_options(matches);
1229 let sess = build_session(sessopts, None, registry);
1230 let cfg = build_configuration(&sess);
1231 let mut test_items = cfg.iter().filter(|m| m.name() == "test");
1232 assert!(test_items.next().is_some());
1233 assert!(test_items.next().is_none());
1237 fn test_can_print_warnings() {
1239 let matches = getopts(&[
1240 "-Awarnings".to_string()
1241 ], optgroups().index(&FullRange)).unwrap();
1242 let registry = diagnostics::registry::Registry::new(&[]);
1243 let sessopts = build_session_options(&matches);
1244 let sess = build_session(sessopts, None, registry);
1245 assert!(!sess.can_print_warnings);
1249 let matches = getopts(&[
1250 "-Awarnings".to_string(),
1251 "-Dwarnings".to_string()
1252 ], optgroups().index(&FullRange)).unwrap();
1253 let registry = diagnostics::registry::Registry::new(&[]);
1254 let sessopts = build_session_options(&matches);
1255 let sess = build_session(sessopts, None, registry);
1256 assert!(sess.can_print_warnings);
1260 let matches = getopts(&[
1261 "-Adead_code".to_string()
1262 ], optgroups().index(&FullRange)).unwrap();
1263 let registry = diagnostics::registry::Registry::new(&[]);
1264 let sessopts = build_session_options(&matches);
1265 let sess = build_session(sessopts, None, registry);
1266 assert!(sess.can_print_warnings);