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: DebuggingOptions,
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>,
115 /// Indicates how the compiler should treat unstable features
116 pub unstable_features: UnstableFeatures
119 #[derive(Clone, Copy)]
120 pub enum UnstableFeatures {
121 /// Hard errors for unstable features are active, as on
122 /// beta/stable channels.
124 /// Use the default lint levels
126 /// Errors are bypassed for bootstrapping. This is required any time
127 /// during the build that feature-related lints are set to warn or above
128 /// because the build turns on warnings-as-errors and uses lots of unstable
129 /// features. As a result, this this is always required for building Rust
134 #[derive(Clone, PartialEq, Eq)]
135 #[allow(missing_copy_implementations)]
136 pub enum PrintRequest {
143 /// Load source from file
145 /// The string is the source
150 pub fn filestem(&self) -> String {
152 Input::File(ref ifile) => ifile.filestem_str().unwrap().to_string(),
153 Input::Str(_) => "rust_out".to_string(),
159 pub struct OutputFilenames {
160 pub out_directory: Path,
161 pub out_filestem: String,
162 pub single_output_file: Option<Path>,
166 impl OutputFilenames {
167 pub fn path(&self, flavor: OutputType) -> Path {
168 match self.single_output_file {
169 Some(ref path) => return path.clone(),
172 self.temp_path(flavor)
175 pub fn temp_path(&self, flavor: OutputType) -> Path {
176 let base = self.out_directory.join(self.filestem());
178 OutputTypeBitcode => base.with_extension("bc"),
179 OutputTypeAssembly => base.with_extension("s"),
180 OutputTypeLlvmAssembly => base.with_extension("ll"),
181 OutputTypeObject => base.with_extension("o"),
182 OutputTypeDepInfo => base.with_extension("d"),
183 OutputTypeExe => base,
187 pub fn with_extension(&self, extension: &str) -> Path {
188 self.out_directory.join(self.filestem()).with_extension(extension)
191 pub fn filestem(&self) -> String {
192 format!("{}{}", self.out_filestem, self.extra)
196 pub fn host_triple() -> &'static str {
197 // Get the host triple out of the build environment. This ensures that our
198 // idea of the host triple is the same as for the set of libraries we've
199 // actually built. We can't just take LLVM's host triple because they
200 // normalize all ix86 architectures to i386.
202 // Instead of grabbing the host triple (for the current host), we grab (at
203 // compile time) the target triple that this rustc is built with and
204 // calling that (at runtime) the host triple.
205 (option_env!("CFG_COMPILER_HOST_TRIPLE")).
206 expect("CFG_COMPILER_HOST_TRIPLE")
209 /// Some reasonable defaults
210 pub fn basic_options() -> Options {
212 crate_types: Vec::new(),
215 debuginfo: NoDebugInfo,
216 lint_opts: Vec::new(),
217 describe_lints: false,
218 output_types: Vec::new(),
219 search_paths: SearchPaths::new(),
221 target_triple: host_triple().to_string(),
227 debugging_opts: basic_debugging_options(),
228 write_dependency_info: (false, None),
230 cg: basic_codegen_options(),
233 externs: HashMap::new(),
237 unstable_features: UnstableFeatures::Disallow
241 // The type of entry function, so
242 // users can have their own entry
243 // functions that don't start a
245 #[derive(Copy, PartialEq)]
246 pub enum EntryFnType {
252 #[derive(Copy, PartialEq, PartialOrd, Clone, Ord, Eq, Hash)]
263 SomePasses(Vec<String>),
268 pub fn is_empty(&self) -> bool {
270 SomePasses(ref v) => v.is_empty(),
276 /// Declare a macro that will define all CodegenOptions/DebuggingOptions fields and parsers all
277 /// at once. The goal of this macro is to define an interface that can be
278 /// programmatically used by the option parser in order to initialize the struct
279 /// without hardcoding field names all over the place.
281 /// The goal is to invoke this macro once with the correct fields, and then this
282 /// macro generates all necessary code. The main gotcha of this macro is the
283 /// cgsetters module which is a bunch of generated code to parse an option into
284 /// its respective field in the struct. There are a few hand-written parsers for
285 /// parsing specific types of values in this module.
286 macro_rules! options {
287 ($struct_name:ident, $setter_name:ident, $defaultfn:ident,
288 $buildfn:ident, $prefix:expr, $outputname:expr,
289 $stat:ident, $mod_desc:ident, $mod_set:ident,
290 $($opt:ident : $t:ty = ($init:expr, $parse:ident, $desc:expr)),* ,) =>
293 #[allow(missing_copy_implementations)]
294 pub struct $struct_name { $(pub $opt: $t),* }
296 pub fn $defaultfn() -> $struct_name {
297 $struct_name { $($opt: $init),* }
300 pub fn $buildfn(matches: &getopts::Matches) -> $struct_name
302 let mut op = $defaultfn();
303 for option in matches.opt_strs($prefix).into_iter() {
304 let mut iter = option.splitn(1, '=');
305 let key = iter.next().unwrap();
306 let value = iter.next();
307 let option_to_lookup = key.replace("-", "_");
308 let mut found = false;
309 for &(candidate, setter, opt_type_desc, _) in $stat.iter() {
310 if option_to_lookup != candidate { continue }
311 if !setter(&mut op, value) {
312 match (value, opt_type_desc) {
313 (Some(..), None) => {
314 early_error(format!("{} option `{}` takes no \
315 value", $outputname, key)[])
317 (None, Some(type_desc)) => {
318 early_error(format!("{0} option `{1}` requires \
319 {2} ({3} {1}=<value>)",
320 $outputname, key, type_desc, $prefix)[])
322 (Some(value), Some(type_desc)) => {
323 early_error(format!("incorrect value `{}` for {} \
324 option `{}` - {} was expected",
325 value, $outputname, key, type_desc)[])
327 (None, None) => unreachable!()
334 early_error(format!("unknown codegen option: `{}`",
341 pub type $setter_name = fn(&mut $struct_name, v: Option<&str>) -> bool;
342 pub const $stat: &'static [(&'static str, $setter_name,
343 Option<&'static str>, &'static str)] =
344 &[ $( (stringify!($opt), $mod_set::$opt, $mod_desc::$parse, $desc) ),* ];
346 #[allow(non_upper_case_globals, dead_code)]
348 pub const parse_bool: Option<&'static str> = None;
349 pub const parse_opt_bool: Option<&'static str> = None;
350 pub const parse_string: Option<&'static str> = Some("a string");
351 pub const parse_opt_string: Option<&'static str> = Some("a string");
352 pub const parse_list: Option<&'static str> = Some("a space-separated list of strings");
353 pub const parse_opt_list: Option<&'static str> = Some("a space-separated list of strings");
354 pub const parse_uint: Option<&'static str> = Some("a number");
355 pub const parse_passes: Option<&'static str> =
356 Some("a space-separated list of passes, or `all`");
357 pub const parse_opt_uint: Option<&'static str> =
363 use super::{$struct_name, Passes, SomePasses, AllPasses};
366 pub fn $opt(cg: &mut $struct_name, v: Option<&str>) -> bool {
367 $parse(&mut cg.$opt, v)
371 fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
374 None => { *slot = true; true }
378 fn parse_opt_bool(slot: &mut Option<bool>, v: Option<&str>) -> bool {
381 None => { *slot = Some(true); true }
385 fn parse_opt_string(slot: &mut Option<String>, v: Option<&str>) -> bool {
387 Some(s) => { *slot = Some(s.to_string()); true },
392 fn parse_string(slot: &mut String, v: Option<&str>) -> bool {
394 Some(s) => { *slot = s.to_string(); true },
399 fn parse_list(slot: &mut Vec<String>, v: Option<&str>)
404 slot.push(s.to_string());
412 fn parse_opt_list(slot: &mut Option<Vec<String>>, v: Option<&str>)
416 let v = s.words().map(|s| s.to_string()).collect();
424 fn parse_uint(slot: &mut uint, v: Option<&str>) -> bool {
425 match v.and_then(|s| s.parse()) {
426 Some(i) => { *slot = i; true },
431 fn parse_opt_uint(slot: &mut Option<uint>, v: Option<&str>) -> bool {
433 Some(s) => { *slot = s.parse(); slot.is_some() }
434 None => { *slot = None; true }
438 fn parse_passes(slot: &mut Passes, v: Option<&str>) -> bool {
445 let mut passes = vec!();
446 if parse_list(&mut passes, v) {
447 *slot = SomePasses(passes);
458 options! {CodegenOptions, CodegenSetter, basic_codegen_options,
459 build_codegen_options, "C", "codegen",
460 CG_OPTIONS, cg_type_desc, cgsetters,
461 ar: Option<String> = (None, parse_opt_string,
462 "tool to assemble archives with"),
463 linker: Option<String> = (None, parse_opt_string,
464 "system linker to link outputs with"),
465 link_args: Option<Vec<String>> = (None, parse_opt_list,
466 "extra arguments to pass to the linker (space separated)"),
467 lto: bool = (false, parse_bool,
468 "perform LLVM link-time optimizations"),
469 target_cpu: Option<String> = (None, parse_opt_string,
470 "select target processor (llc -mcpu=help for details)"),
471 target_feature: String = ("".to_string(), parse_string,
472 "target specific attributes (llc -mattr=help for details)"),
473 passes: Vec<String> = (Vec::new(), parse_list,
474 "a list of extra LLVM passes to run (space separated)"),
475 llvm_args: Vec<String> = (Vec::new(), parse_list,
476 "a list of arguments to pass to llvm (space separated)"),
477 save_temps: bool = (false, parse_bool,
478 "save all temporary output files during compilation"),
479 rpath: bool = (false, parse_bool,
480 "set rpath values in libs/exes"),
481 no_prepopulate_passes: bool = (false, parse_bool,
482 "don't pre-populate the pass manager with a list of passes"),
483 no_vectorize_loops: bool = (false, parse_bool,
484 "don't run the loop vectorization optimization passes"),
485 no_vectorize_slp: bool = (false, parse_bool,
486 "don't run LLVM's SLP vectorization pass"),
487 soft_float: bool = (false, parse_bool,
488 "generate software floating point library calls"),
489 prefer_dynamic: bool = (false, parse_bool,
490 "prefer dynamic linking to static linking"),
491 no_integrated_as: bool = (false, parse_bool,
492 "use an external assembler rather than LLVM's integrated one"),
493 no_redzone: Option<bool> = (None, parse_opt_bool,
494 "disable the use of the redzone"),
495 relocation_model: Option<String> = (None, parse_opt_string,
496 "choose the relocation model to use (llc -relocation-model for details)"),
497 code_model: Option<String> = (None, parse_opt_string,
498 "choose the code model to use (llc -code-model for details)"),
499 metadata: Vec<String> = (Vec::new(), parse_list,
500 "metadata to mangle symbol names with"),
501 extra_filename: String = ("".to_string(), parse_string,
502 "extra data to put in each output filename"),
503 codegen_units: uint = (1, parse_uint,
504 "divide crate into N units to optimize in parallel"),
505 remark: Passes = (SomePasses(Vec::new()), parse_passes,
506 "print remarks for these optimization passes (space separated, or \"all\")"),
507 no_stack_check: bool = (false, parse_bool,
508 "disable checks for stack exhaustion (a memory-safety hazard!)"),
509 debuginfo: Option<uint> = (None, parse_opt_uint,
510 "debug info emission level, 0 = no debug info, 1 = line tables only, \
511 2 = full debug info with variable and type information"),
512 opt_level: Option<uint> = (None, parse_opt_uint,
513 "Optimize with possible levels 0-3"),
517 options! {DebuggingOptions, DebuggingSetter, basic_debugging_options,
518 build_debugging_options, "Z", "debugging",
519 DB_OPTIONS, db_type_desc, dbsetters,
520 verbose: bool = (false, parse_bool,
521 "in general, enable more debug printouts"),
522 time_passes: bool = (false, parse_bool,
523 "measure time of each rustc pass"),
524 count_llvm_insns: bool = (false, parse_bool,
525 "count where LLVM instrs originate"),
526 time_llvm_passes: bool = (false, parse_bool,
527 "measure time of each LLVM pass"),
528 trans_stats: bool = (false, parse_bool,
529 "gather trans statistics"),
530 asm_comments: bool = (false, parse_bool,
531 "generate comments into the assembly (may change behavior)"),
532 no_verify: bool = (false, parse_bool,
533 "skip LLVM verification"),
534 borrowck_stats: bool = (false, parse_bool,
535 "gather borrowck statistics"),
536 no_landing_pads: bool = (false, parse_bool,
537 "omit landing pads for unwinding"),
538 debug_llvm: bool = (false, parse_bool,
539 "enable debug output from LLVM"),
540 count_type_sizes: bool = (false, parse_bool,
541 "count the sizes of aggregate types"),
542 meta_stats: bool = (false, parse_bool,
543 "gather metadata statistics"),
544 print_link_args: bool = (false, parse_bool,
545 "Print the arguments passed to the linker"),
546 gc: bool = (false, parse_bool,
547 "Garbage collect shared data (experimental)"),
548 print_llvm_passes: bool = (false, parse_bool,
549 "Prints the llvm optimization passes being run"),
550 ast_json: bool = (false, parse_bool,
551 "Print the AST as JSON and halt"),
552 ast_json_noexpand: bool = (false, parse_bool,
553 "Print the pre-expansion AST as JSON and halt"),
554 ls: bool = (false, parse_bool,
555 "List the symbols defined by a library crate"),
556 save_analysis: bool = (false, parse_bool,
557 "Write syntax and type analysis information in addition to normal output"),
558 print_move_fragments: bool = (false, parse_bool,
559 "Print out move-fragment data for every fn"),
560 flowgraph_print_loans: bool = (false, parse_bool,
561 "Include loan analysis data in --pretty flowgraph output"),
562 flowgraph_print_moves: bool = (false, parse_bool,
563 "Include move analysis data in --pretty flowgraph output"),
564 flowgraph_print_assigns: bool = (false, parse_bool,
565 "Include assignment analysis data in --pretty flowgraph output"),
566 flowgraph_print_all: bool = (false, parse_bool,
567 "Include all dataflow analysis data in --pretty flowgraph output"),
568 print_region_graph: bool = (false, parse_bool,
569 "Prints region inference graph. \
570 Use with RUST_REGION_GRAPH=help for more info"),
571 parse_only: bool = (false, parse_bool,
572 "Parse only; do not compile, assemble, or link"),
573 no_trans: bool = (false, parse_bool,
574 "Run all passes except translation; no output"),
575 no_analysis: bool = (false, parse_bool,
576 "Parse and expand the source, but run no analysis"),
577 extra_plugins: Vec<String> = (Vec::new(), parse_list,
578 "load extra plugins"),
579 unstable_options: bool = (false, parse_bool,
580 "Adds unstable command line options to rustc interface"),
581 print_enum_sizes: bool = (false, parse_bool,
582 "Print the size of enums and their variants"),
585 pub fn default_lib_output() -> CrateType {
589 pub fn default_configuration(sess: &Session) -> ast::CrateConfig {
590 use syntax::parse::token::intern_and_get_ident as intern;
592 let end = &sess.target.target.target_endian[];
593 let arch = &sess.target.target.arch[];
594 let wordsz = &sess.target.target.target_pointer_width[];
595 let os = &sess.target.target.target_os[];
597 let fam = match sess.target.target.options.is_like_windows {
598 true => InternedString::new("windows"),
599 false => InternedString::new("unix")
602 let mk = attr::mk_name_value_item_str;
603 return vec!(// Target bindings.
604 attr::mk_word_item(fam.clone()),
605 mk(InternedString::new("target_os"), intern(os)),
606 mk(InternedString::new("target_family"), fam),
607 mk(InternedString::new("target_arch"), intern(arch)),
608 mk(InternedString::new("target_endian"), intern(end)),
609 mk(InternedString::new("target_pointer_width"),
614 pub fn append_configuration(cfg: &mut ast::CrateConfig,
615 name: InternedString) {
616 if !cfg.iter().any(|mi| mi.name() == name) {
617 cfg.push(attr::mk_word_item(name))
621 pub fn build_configuration(sess: &Session) -> ast::CrateConfig {
622 // Combine the configuration requested by the session (command line) with
623 // some default and generated configuration items
624 let default_cfg = default_configuration(sess);
625 let mut user_cfg = sess.opts.cfg.clone();
626 // If the user wants a test runner, then add the test cfg
628 append_configuration(&mut user_cfg, InternedString::new("test"))
630 let mut v = user_cfg.into_iter().collect::<Vec<_>>();
631 v.push_all(&default_cfg[]);
635 pub fn build_target_config(opts: &Options, sp: &SpanHandler) -> Config {
636 let target = match Target::search(&opts.target_triple[]) {
639 sp.handler().fatal((format!("Error loading target specification: {}", e)).as_slice());
643 let (int_type, uint_type) = match &target.target_pointer_width[] {
644 "32" => (ast::TyI32, ast::TyU32),
645 "64" => (ast::TyI64, ast::TyU64),
646 w => sp.handler().fatal(&format!("target specification was invalid: unrecognized \
647 target-word-size {}", w)[])
653 uint_type: uint_type,
657 /// Returns the "short" subset of the stable rustc command line options.
658 pub fn short_optgroups() -> Vec<getopts::OptGroup> {
659 rustc_short_optgroups().into_iter()
660 .filter(|g|g.is_stable())
665 /// Returns all of the stable rustc command line options.
666 pub fn optgroups() -> Vec<getopts::OptGroup> {
667 rustc_optgroups().into_iter()
668 .filter(|g|g.is_stable())
673 #[derive(Copy, Clone, PartialEq, Eq, Show)]
674 pub enum OptionStability { Stable, Unstable }
676 #[derive(Clone, PartialEq, Eq)]
677 pub struct RustcOptGroup {
678 pub opt_group: getopts::OptGroup,
679 pub stability: OptionStability,
683 pub fn is_stable(&self) -> bool {
684 self.stability == OptionStability::Stable
687 fn stable(g: getopts::OptGroup) -> RustcOptGroup {
688 RustcOptGroup { opt_group: g, stability: OptionStability::Stable }
691 fn unstable(g: getopts::OptGroup) -> RustcOptGroup {
692 RustcOptGroup { opt_group: g, stability: OptionStability::Unstable }
696 // The `opt` local module holds wrappers around the `getopts` API that
697 // adds extra rustc-specific metadata to each option; such metadata
698 // is exposed by . The public
699 // functions below ending with `_u` are the functions that return
700 // *unstable* options, i.e. options that are only enabled when the
701 // user also passes the `-Z unstable-options` debugging flag.
703 // The `fn opt_u` etc below are written so that we can use them
704 // in the future; do not warn about them not being used right now.
708 use super::RustcOptGroup;
710 type R = RustcOptGroup;
711 type S<'a> = &'a str;
713 fn stable(g: getopts::OptGroup) -> R { RustcOptGroup::stable(g) }
714 fn unstable(g: getopts::OptGroup) -> R { RustcOptGroup::unstable(g) }
716 // FIXME (pnkfelix): We default to stable since the current set of
717 // options is defacto stable. However, it would be good to revise the
718 // code so that a stable option is the thing that takes extra effort
721 pub fn opt(a: S, b: S, c: S, d: S) -> R { stable(getopts::optopt(a, b, c, d)) }
722 pub fn multi(a: S, b: S, c: S, d: S) -> R { stable(getopts::optmulti(a, b, c, d)) }
723 pub fn flag(a: S, b: S, c: S) -> R { stable(getopts::optflag(a, b, c)) }
724 pub fn flagopt(a: S, b: S, c: S, d: S) -> R { stable(getopts::optflagopt(a, b, c, d)) }
726 pub fn opt_u(a: S, b: S, c: S, d: S) -> R { unstable(getopts::optopt(a, b, c, d)) }
727 pub fn multi_u(a: S, b: S, c: S, d: S) -> R { unstable(getopts::optmulti(a, b, c, d)) }
728 pub fn flag_u(a: S, b: S, c: S) -> R { unstable(getopts::optflag(a, b, c)) }
729 pub fn flagopt_u(a: S, b: S, c: S, d: S) -> R { unstable(getopts::optflagopt(a, b, c, d)) }
732 /// Returns the "short" subset of the rustc command line options,
733 /// including metadata for each option, such as whether the option is
734 /// part of the stable long-term interface for rustc.
735 pub fn rustc_short_optgroups() -> Vec<RustcOptGroup> {
737 opt::flag("h", "help", "Display this message"),
738 opt::multi("", "cfg", "Configure the compilation environment", "SPEC"),
739 opt::multi("L", "", "Add a directory to the library search path", "PATH"),
740 opt::multi("l", "", "Link the generated crate(s) to the specified native
741 library NAME. The optional KIND can be one of,
742 static, dylib, or framework. If omitted, dylib is
743 assumed.", "[KIND=]NAME"),
744 opt::multi("", "crate-type", "Comma separated list of types of crates
745 for the compiler to emit",
746 "[bin|lib|rlib|dylib|staticlib]"),
747 opt::opt("", "crate-name", "Specify the name of the crate being built",
749 opt::multi("", "emit", "Comma separated list of types of output for \
750 the compiler to emit",
751 "[asm|llvm-bc|llvm-ir|obj|link|dep-info]"),
752 opt::multi("", "print", "Comma separated list of compiler information to \
754 "[crate-name|file-names|sysroot]"),
755 opt::flag("g", "", "Equivalent to -C debuginfo=2"),
756 opt::flag("O", "", "Equivalent to -C opt-level=2"),
757 opt::opt("o", "", "Write output to <filename>", "FILENAME"),
758 opt::opt("", "out-dir", "Write output to compiler-chosen filename \
760 opt::opt("", "explain", "Provide a detailed explanation of an error \
762 opt::flag("", "test", "Build a test harness"),
763 opt::opt("", "target", "Target triple cpu-manufacturer-kernel[-os] \
764 to compile for (see chapter 3.4 of \
765 http://www.sourceware.org/autobook/
768 opt::multi("W", "warn", "Set lint warnings", "OPT"),
769 opt::multi("A", "allow", "Set lint allowed", "OPT"),
770 opt::multi("D", "deny", "Set lint denied", "OPT"),
771 opt::multi("F", "forbid", "Set lint forbidden", "OPT"),
772 opt::multi("C", "codegen", "Set a codegen option", "OPT[=VALUE]"),
773 opt::flag("V", "version", "Print version info and exit"),
774 opt::flag("v", "verbose", "Use verbose output"),
778 /// Returns all rustc command line options, including metadata for
779 /// each option, such as whether the option is part of the stable
780 /// long-term interface for rustc.
781 pub fn rustc_optgroups() -> Vec<RustcOptGroup> {
782 let mut opts = rustc_short_optgroups();
784 opt::multi("", "extern", "Specify where an external rust library is \
787 opt::opt("", "opt-level", "Optimize with possible levels 0-3", "LEVEL"),
788 opt::opt("", "sysroot", "Override the system root", "PATH"),
789 opt::multi("Z", "", "Set internal debugging options", "FLAG"),
790 opt::opt("", "color", "Configure coloring of output:
791 auto = colorize, if output goes to a tty (default);
792 always = always colorize output;
793 never = never colorize output", "auto|always|never"),
796 opt::flag("", "print-crate-name", "Output the crate name and exit"),
797 opt::flag("", "print-file-name", "Output the file(s) that would be \
798 written if compilation \
799 continued and exit"),
800 opt::opt("", "debuginfo", "Emit DWARF debug info to the objects created:
802 1 = line-tables only (for stacktraces and breakpoints),
803 2 = full debug info with variable and type information \
804 (same as -g)", "LEVEL"),
805 opt::flag("", "no-trans", "Run all passes except translation; no output"),
806 opt::flag("", "no-analysis", "Parse and expand the source, but run no \
807 analysis and produce no output"),
808 opt::flag("", "parse-only", "Parse only; do not compile, assemble, \
810 opt::flagopt("", "pretty",
811 "Pretty-print the input instead of compiling;
812 valid types are: `normal` (un-annotated source),
813 `expanded` (crates expanded),
814 `typed` (crates expanded, with type annotations), or
815 `expanded,identified` (fully parenthesized, AST nodes with IDs).",
817 opt::flagopt_u("", "xpretty",
818 "Pretty-print the input instead of compiling, unstable variants;
819 valid types are any of the types for `--pretty`, as well as:
820 `flowgraph=<nodeid>` (graphviz formatted flowgraph for node), or
821 `everybody_loops` (all function bodies replaced with `loop {}`).",
823 opt::opt_u("", "show-span", "Show spans for compiler debugging", "expr|pat|ty"),
824 opt::flagopt("", "dep-info",
825 "Output dependency info to <filename> after compiling, \
826 in a format suitable for use by Makefiles", "FILENAME"),
831 // Convert strings provided as --cfg [cfgspec] into a crate_cfg
832 pub fn parse_cfgspecs(cfgspecs: Vec<String> ) -> ast::CrateConfig {
833 cfgspecs.into_iter().map(|s| {
834 parse::parse_meta_from_source_str("cfgspec".to_string(),
837 &parse::new_parse_sess())
838 }).collect::<ast::CrateConfig>()
841 pub fn build_session_options(matches: &getopts::Matches) -> Options {
843 let unparsed_crate_types = matches.opt_strs("crate-type");
844 let crate_types = parse_crate_types_from_list(unparsed_crate_types)
845 .unwrap_or_else(|e| early_error(&e[]));
847 let mut lint_opts = vec!();
848 let mut describe_lints = false;
850 for &level in [lint::Allow, lint::Warn, lint::Deny, lint::Forbid].iter() {
851 for lint_name in matches.opt_strs(level.as_str()).into_iter() {
852 if lint_name == "help" {
853 describe_lints = true;
855 lint_opts.push((lint_name.replace("-", "_"), level));
860 let debugging_opts = build_debugging_options(matches);
862 let parse_only = if matches.opt_present("parse-only") {
863 // FIXME(acrichto) remove this eventually
864 early_warn("--parse-only is deprecated in favor of -Z parse-only");
867 debugging_opts.parse_only
869 let no_trans = if matches.opt_present("no-trans") {
870 // FIXME(acrichto) remove this eventually
871 early_warn("--no-trans is deprecated in favor of -Z no-trans");
874 debugging_opts.no_trans
876 let no_analysis = if matches.opt_present("no-analysis") {
877 // FIXME(acrichto) remove this eventually
878 early_warn("--no-analysis is deprecated in favor of -Z no-analysis");
881 debugging_opts.no_analysis
884 if debugging_opts.debug_llvm {
885 unsafe { llvm::LLVMSetDebug(1); }
888 let mut output_types = Vec::new();
889 if !debugging_opts.parse_only && !no_trans {
890 let unparsed_output_types = matches.opt_strs("emit");
891 for unparsed_output_type in unparsed_output_types.iter() {
892 for part in unparsed_output_type.split(',') {
893 let output_type = match part.as_slice() {
894 "asm" => OutputTypeAssembly,
895 "llvm-ir" => OutputTypeLlvmAssembly,
896 "llvm-bc" => OutputTypeBitcode,
897 "obj" => OutputTypeObject,
898 "link" => OutputTypeExe,
899 "dep-info" => OutputTypeDepInfo,
901 early_error(&format!("unknown emission type: `{}`",
905 output_types.push(output_type)
910 output_types.dedup();
911 if output_types.len() == 0 {
912 output_types.push(OutputTypeExe);
915 let cg = build_codegen_options(matches);
917 let sysroot_opt = matches.opt_str("sysroot").map(|m| Path::new(m));
918 let target = matches.opt_str("target").unwrap_or(
919 host_triple().to_string());
921 if matches.opt_present("O") {
922 if matches.opt_present("opt-level") {
923 early_error("-O and --opt-level both provided");
925 if cg.opt_level.is_some() {
926 early_error("-O and -C opt-level both provided");
929 } else if matches.opt_present("opt-level") {
930 // FIXME(acrichto) remove this eventually
931 early_warn("--opt-level=N is deprecated in favor of -C opt-level=N");
932 match matches.opt_str("opt-level").as_ref().map(|s| s.as_slice()) {
936 Some("2") => Default,
937 Some("3") => Aggressive,
939 early_error(&format!("optimization level needs to be \
940 between 0-3 (instead was `{}`)",
950 Some(3) => Aggressive,
952 early_error(format!("optimization level needs to be \
953 between 0-3 (instead was `{}`)",
959 let gc = debugging_opts.gc;
960 let debuginfo = if matches.opt_present("g") {
961 if matches.opt_present("debuginfo") {
962 early_error("-g and --debuginfo both provided");
964 if cg.debuginfo.is_some() {
965 early_error("-g and -C debuginfo both provided");
968 } else if matches.opt_present("debuginfo") {
969 // FIXME(acrichto) remove this eventually
970 early_warn("--debuginfo=N is deprecated in favor of -C debuginfo=N");
971 match matches.opt_str("debuginfo").as_ref().map(|s| s.as_slice()) {
972 Some("0") => NoDebugInfo,
973 Some("1") => LimitedDebugInfo,
975 Some("2") => FullDebugInfo,
977 early_error(&format!("debug info level needs to be between \
978 0-2 (instead was `{}`)",
984 None | Some(0) => NoDebugInfo,
985 Some(1) => LimitedDebugInfo,
986 Some(2) => FullDebugInfo,
988 early_error(format!("debug info level needs to be between \
989 0-2 (instead was `{}`)",
995 let mut search_paths = SearchPaths::new();
996 for s in matches.opt_strs("L").iter() {
997 search_paths.add_path(&s[]);
1000 let libs = matches.opt_strs("l").into_iter().map(|s| {
1001 let mut parts = s.splitn(1, '=');
1002 let kind = parts.next().unwrap();
1003 if let Some(name) = parts.next() {
1004 let kind = match kind {
1005 "dylib" => cstore::NativeUnknown,
1006 "framework" => cstore::NativeFramework,
1007 "static" => cstore::NativeStatic,
1009 early_error(format!("unknown library kind `{}`, expected \
1010 one of dylib, framework, or static",
1014 return (name.to_string(), kind)
1017 // FIXME(acrichto) remove this once crates have stopped using it, this
1018 // is deprecated behavior now.
1019 let mut parts = s.rsplitn(1, ':');
1020 let kind = parts.next().unwrap();
1021 let (name, kind) = match (parts.next(), kind) {
1023 (Some(name), "dylib") => (name, cstore::NativeUnknown),
1024 (Some(name), "framework") => (name, cstore::NativeFramework),
1025 (Some(name), "static") => (name, cstore::NativeStatic),
1027 early_error(&format!("unknown library kind `{}`, expected \
1028 one of dylib, framework, or static",
1032 (name.to_string(), kind)
1035 let cfg = parse_cfgspecs(matches.opt_strs("cfg"));
1036 let test = matches.opt_present("test");
1037 let write_dependency_info = if matches.opt_present("dep-info") {
1038 // FIXME(acrichto) remove this eventually
1039 early_warn("--dep-info has been deprecated in favor of --emit");
1040 (true, matches.opt_str("dep-info").map(|p| Path::new(p)))
1042 (output_types.contains(&OutputTypeDepInfo), None)
1045 let mut prints = matches.opt_strs("print").into_iter().map(|s| {
1046 match s.as_slice() {
1047 "crate-name" => PrintRequest::CrateName,
1048 "file-names" => PrintRequest::FileNames,
1049 "sysroot" => PrintRequest::Sysroot,
1051 early_error(format!("unknown print request `{}`", req).as_slice())
1054 }).collect::<Vec<_>>();
1055 if matches.opt_present("print-crate-name") {
1056 // FIXME(acrichto) remove this eventually
1057 early_warn("--print-crate-name has been deprecated in favor of \
1058 --print crate-name");
1059 prints.push(PrintRequest::CrateName);
1061 if matches.opt_present("print-file-name") {
1062 // FIXME(acrichto) remove this eventually
1063 early_warn("--print-file-name has been deprecated in favor of \
1064 --print file-names");
1065 prints.push(PrintRequest::FileNames);
1068 if !cg.remark.is_empty() && debuginfo == NoDebugInfo {
1069 early_warn("-C remark will not show source locations without \
1073 let color = match matches.opt_str("color").as_ref().map(|s| &s[]) {
1074 Some("auto") => Auto,
1075 Some("always") => Always,
1076 Some("never") => Never,
1081 early_error(&format!("argument for --color must be auto, always \
1082 or never (instead was `{}`)",
1087 let mut externs = HashMap::new();
1088 for arg in matches.opt_strs("extern").iter() {
1089 let mut parts = arg.splitn(1, '=');
1090 let name = match parts.next() {
1092 None => early_error("--extern value must not be empty"),
1094 let location = match parts.next() {
1096 None => early_error("--extern value must be of the format `foo=bar`"),
1099 match externs.entry(name.to_string()) {
1100 Vacant(entry) => { entry.insert(vec![location.to_string()]); },
1101 Occupied(mut entry) => { entry.get_mut().push(location.to_string()); },
1105 let crate_name = matches.opt_str("crate-name");
1108 crate_types: crate_types,
1110 optimize: opt_level,
1111 debuginfo: debuginfo,
1112 lint_opts: lint_opts,
1113 describe_lints: describe_lints,
1114 output_types: output_types,
1115 search_paths: search_paths,
1116 maybe_sysroot: sysroot_opt,
1117 target_triple: target,
1120 parse_only: parse_only,
1122 no_analysis: no_analysis,
1123 debugging_opts: debugging_opts,
1124 write_dependency_info: write_dependency_info,
1130 crate_name: crate_name,
1133 unstable_features: UnstableFeatures::Disallow
1137 pub fn parse_crate_types_from_list(list_list: Vec<String>) -> Result<Vec<CrateType>, String> {
1139 let mut crate_types: Vec<CrateType> = Vec::new();
1140 for unparsed_crate_type in list_list.iter() {
1141 for part in unparsed_crate_type.split(',') {
1142 let new_part = match part {
1143 "lib" => default_lib_output(),
1144 "rlib" => CrateTypeRlib,
1145 "staticlib" => CrateTypeStaticlib,
1146 "dylib" => CrateTypeDylib,
1147 "bin" => CrateTypeExecutable,
1149 return Err(format!("unknown crate type: `{}`",
1153 crate_types.push(new_part)
1157 return Ok(crate_types);
1160 impl fmt::Show for CrateType {
1161 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1163 CrateTypeExecutable => "bin".fmt(f),
1164 CrateTypeDylib => "dylib".fmt(f),
1165 CrateTypeRlib => "rlib".fmt(f),
1166 CrateTypeStaticlib => "staticlib".fmt(f)
1174 use session::config::{build_configuration, optgroups, build_session_options};
1175 use session::build_session;
1177 use getopts::getopts;
1179 use syntax::attr::AttrMetaMethods;
1180 use syntax::diagnostics;
1182 // When the user supplies --test we should implicitly supply --cfg test
1184 fn test_switch_implies_cfg_test() {
1186 &match getopts(&["--test".to_string()], &optgroups()[]) {
1188 Err(f) => panic!("test_switch_implies_cfg_test: {}", f)
1190 let registry = diagnostics::registry::Registry::new(&[]);
1191 let sessopts = build_session_options(matches);
1192 let sess = build_session(sessopts, None, registry);
1193 let cfg = build_configuration(&sess);
1194 assert!((attr::contains_name(&cfg[], "test")));
1197 // When the user supplies --test and --cfg test, don't implicitly add
1198 // another --cfg test
1200 fn test_switch_implies_cfg_test_unless_cfg_test() {
1202 &match getopts(&["--test".to_string(), "--cfg=test".to_string()],
1206 panic!("test_switch_implies_cfg_test_unless_cfg_test: {}", f)
1209 let registry = diagnostics::registry::Registry::new(&[]);
1210 let sessopts = build_session_options(matches);
1211 let sess = build_session(sessopts, None, registry);
1212 let cfg = build_configuration(&sess);
1213 let mut test_items = cfg.iter().filter(|m| m.name() == "test");
1214 assert!(test_items.next().is_some());
1215 assert!(test_items.next().is_none());
1219 fn test_can_print_warnings() {
1221 let matches = getopts(&[
1222 "-Awarnings".to_string()
1223 ], &optgroups()[]).unwrap();
1224 let registry = diagnostics::registry::Registry::new(&[]);
1225 let sessopts = build_session_options(&matches);
1226 let sess = build_session(sessopts, None, registry);
1227 assert!(!sess.can_print_warnings);
1231 let matches = getopts(&[
1232 "-Awarnings".to_string(),
1233 "-Dwarnings".to_string()
1234 ], &optgroups()[]).unwrap();
1235 let registry = diagnostics::registry::Registry::new(&[]);
1236 let sessopts = build_session_options(&matches);
1237 let sess = build_session(sessopts, None, registry);
1238 assert!(sess.can_print_warnings);
1242 let matches = getopts(&[
1243 "-Adead_code".to_string()
1244 ], &optgroups()[]).unwrap();
1245 let registry = diagnostics::registry::Registry::new(&[]);
1246 let sessopts = build_session_options(&matches);
1247 let sess = build_session(sessopts, None, registry);
1248 assert!(sess.can_print_warnings);