1 // Copyright 2012-2013 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 use rustc::session::Session;
12 use rustc::session::config::{mod, Input, OutputFilenames};
14 use rustc::metadata::creader;
15 use rustc::middle::{stability, ty, reachable};
16 use rustc::middle::dependency_format;
18 use rustc::plugin::load::Plugins;
19 use rustc::plugin::registry::Registry;
21 use rustc::util::common::time;
22 use rustc_trans::back::link;
23 use rustc_trans::back::write;
24 use rustc_trans::save;
25 use rustc_trans::trans;
26 use rustc_typeck as typeck;
28 use serialize::{json, Encodable};
33 use arena::TypedArena;
37 use syntax::attr::{AttrMetaMethods};
38 use syntax::diagnostics;
40 use syntax::parse::token;
43 pub fn compile_input(sess: Session,
44 cfg: ast::CrateConfig,
46 outdir: &Option<Path>,
47 output: &Option<Path>,
48 addl_plugins: Option<Plugins>) {
49 // These may be left in an incoherent state after a previous compile.
50 // `clear_tables` and `get_ident_interner().clear()` can be used to free
51 // memory, but they do not restore the initial state.
52 syntax::ext::mtwt::reset_tables();
53 token::reset_ident_interner();
55 // We need nested scopes here, because the intermediate results can keep
56 // large chunks of memory alive and we want to free them as soon as
57 // possible to keep the peak memory usage low
58 let (outputs, trans, sess) = {
59 let (outputs, expanded_crate, id) = {
60 let krate = phase_1_parse_input(&sess, cfg, input);
61 if stop_after_phase_1(&sess) { return; }
62 let outputs = build_output_filenames(input,
65 krate.attrs.as_slice(),
67 let id = link::find_crate_name(Some(&sess), krate.attrs.as_slice(),
70 = match phase_2_configure_and_expand(&sess, krate, id.as_slice(),
76 (outputs, expanded_crate, id)
79 let mut forest = ast_map::Forest::new(expanded_crate);
80 let ast_map = assign_node_ids_and_map(&sess, &mut forest);
82 write_out_deps(&sess, input, &outputs, id.as_slice());
84 if stop_after_phase_2(&sess) { return; }
86 let type_arena = TypedArena::new();
87 let analysis = phase_3_run_analysis_passes(sess, ast_map, &type_arena, id);
88 phase_save_analysis(&analysis.ty_cx.sess, analysis.ty_cx.map.krate(), &analysis, outdir);
89 if stop_after_phase_3(&analysis.ty_cx.sess) { return; }
90 let (tcx, trans) = phase_4_translate_to_llvm(analysis);
92 // Discard interned strings as they are no longer required.
93 token::get_ident_interner().clear();
95 (outputs, trans, tcx.sess)
97 phase_5_run_llvm_passes(&sess, &trans, &outputs);
98 if stop_after_phase_5(&sess) { return; }
99 phase_6_link_output(&sess, &trans, &outputs);
102 /// The name used for source code that doesn't originate in a file
103 /// (e.g. source from stdin or a string)
104 pub fn anon_src() -> String {
108 pub fn source_name(input: &Input) -> String {
110 // FIXME (#9639): This needs to handle non-utf8 paths
111 Input::File(ref ifile) => ifile.as_str().unwrap().to_string(),
112 Input::Str(_) => anon_src()
116 pub fn phase_1_parse_input(sess: &Session, cfg: ast::CrateConfig, input: &Input)
118 let krate = time(sess.time_passes(), "parsing", (), |_| {
120 Input::File(ref file) => {
121 parse::parse_crate_from_file(&(*file), cfg.clone(), &sess.parse_sess)
123 Input::Str(ref src) => {
124 parse::parse_crate_from_source_str(anon_src().to_string(),
132 if sess.opts.debugging_opts & config::AST_JSON_NOEXPAND != 0 {
133 let mut stdout = io::BufferedWriter::new(io::stdout());
134 let mut json = json::PrettyEncoder::new(&mut stdout);
135 // unwrapping so IoError isn't ignored
136 krate.encode(&mut json).unwrap();
139 if sess.show_span() {
140 syntax::show_span::run(sess.diagnostic(), &krate);
146 // For continuing compilation after a parsed crate has been
149 /// Run the "early phases" of the compiler: initial `cfg` processing,
150 /// loading compiler plugins (including those from `addl_plugins`),
151 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
152 /// harness if one is to be provided and injection of a dependency on the
153 /// standard library and prelude.
155 /// Returns `None` if we're aborting after handling -W help.
156 pub fn phase_2_configure_and_expand(sess: &Session,
157 mut krate: ast::Crate,
159 addl_plugins: Option<Plugins>)
160 -> Option<ast::Crate> {
161 let time_passes = sess.time_passes();
163 *sess.crate_types.borrow_mut() =
164 collect_crate_types(sess, krate.attrs.as_slice());
165 *sess.crate_metadata.borrow_mut() =
166 collect_crate_metadata(sess, krate.attrs.as_slice());
168 time(time_passes, "gated feature checking", (), |_| {
169 let (features, unknown_features) =
170 syntax::feature_gate::check_crate(&sess.parse_sess.span_diagnostic, &krate);
172 for uf in unknown_features.iter() {
173 sess.add_lint(lint::builtin::UNKNOWN_FEATURES,
176 "unknown feature".to_string());
179 sess.abort_if_errors();
180 *sess.features.borrow_mut() = features;
183 time(time_passes, "recursion limit", (), |_| {
184 middle::recursion_limit::update_recursion_limit(sess, &krate);
187 // strip before expansion to allow macros to depend on
188 // configuration variables e.g/ in
190 // #[macro_escape] #[cfg(foo)]
191 // mod bar { macro_rules! baz!(() => {{}}) }
193 // baz! should not use this definition unless foo is enabled.
195 krate = time(time_passes, "configuration 1", krate, |krate|
196 syntax::config::strip_unconfigured_items(sess.diagnostic(), krate));
198 krate = time(time_passes, "crate injection", krate, |krate|
199 syntax::std_inject::maybe_inject_crates_ref(krate,
200 sess.opts.alt_std_name.clone()));
202 let mut addl_plugins = Some(addl_plugins);
203 let Plugins { macros, registrars }
204 = time(time_passes, "plugin loading", (), |_|
205 plugin::load::load_plugins(sess, &krate, addl_plugins.take().unwrap()));
207 let mut registry = Registry::new(&krate);
209 time(time_passes, "plugin registration", (), |_| {
210 if sess.features.borrow().rustc_diagnostic_macros {
211 registry.register_macro("__diagnostic_used",
212 diagnostics::plugin::expand_diagnostic_used);
213 registry.register_macro("__register_diagnostic",
214 diagnostics::plugin::expand_register_diagnostic);
215 registry.register_macro("__build_diagnostic_array",
216 diagnostics::plugin::expand_build_diagnostic_array);
219 for ®istrar in registrars.iter() {
220 registrar(&mut registry);
224 let Registry { syntax_exts, lint_passes, lint_groups, .. } = registry;
227 let mut ls = sess.lint_store.borrow_mut();
228 for pass in lint_passes.into_iter() {
229 ls.register_pass(Some(sess), true, pass);
232 for (name, to) in lint_groups.into_iter() {
233 ls.register_group(Some(sess), true, name, to);
237 // Lint plugins are registered; now we can process command line flags.
238 if sess.opts.describe_lints {
239 super::describe_lints(&*sess.lint_store.borrow(), true);
242 sess.lint_store.borrow_mut().process_command_line(sess);
244 // Abort if there are errors from lint processing or a plugin registrar.
245 sess.abort_if_errors();
247 krate = time(time_passes, "expansion", (krate, macros, syntax_exts),
248 |(krate, macros, syntax_exts)| {
249 // Windows dlls do not have rpaths, so they don't know how to find their
250 // dependencies. It's up to us to tell the system where to find all the
251 // dependent dlls. Note that this uses cfg!(windows) as opposed to
252 // targ_cfg because syntax extensions are always loaded for the host
253 // compiler, not for the target.
254 let mut _old_path = String::new();
256 _old_path = os::getenv("PATH").unwrap_or(_old_path);
257 let mut new_path = sess.host_filesearch().get_dylib_search_paths();
258 new_path.extend(os::split_paths(_old_path.as_slice()).into_iter());
259 os::setenv("PATH", os::join_paths(new_path.as_slice()).unwrap());
261 let cfg = syntax::ext::expand::ExpansionConfig {
262 crate_name: crate_name.to_string(),
263 deriving_hash_type_parameter: sess.features.borrow().default_type_params,
264 enable_quotes: sess.features.borrow().quote,
265 recursion_limit: sess.recursion_limit.get(),
267 let ret = syntax::ext::expand::expand_crate(&sess.parse_sess,
273 os::setenv("PATH", _old_path);
279 // JBC: make CFG processing part of expansion to avoid this problem:
281 // strip again, in case expansion added anything with a #[cfg].
282 krate = time(time_passes, "configuration 2", krate, |krate|
283 syntax::config::strip_unconfigured_items(sess.diagnostic(), krate));
285 krate = time(time_passes, "maybe building test harness", krate, |krate|
286 syntax::test::modify_for_testing(&sess.parse_sess,
291 krate = time(time_passes, "prelude injection", krate, |krate|
292 syntax::std_inject::maybe_inject_prelude(krate));
294 time(time_passes, "checking that all macro invocations are gone", &krate, |krate|
295 syntax::ext::expand::check_for_macros(&sess.parse_sess, krate));
300 pub fn assign_node_ids_and_map<'ast>(sess: &Session,
301 forest: &'ast mut ast_map::Forest)
302 -> ast_map::Map<'ast> {
303 struct NodeIdAssigner<'a> {
307 impl<'a> ast_map::FoldOps for NodeIdAssigner<'a> {
308 fn new_id(&self, old_id: ast::NodeId) -> ast::NodeId {
309 assert_eq!(old_id, ast::DUMMY_NODE_ID);
310 self.sess.next_node_id()
314 let map = time(sess.time_passes(), "assigning node ids and indexing ast", forest, |forest|
315 ast_map::map_crate(forest, NodeIdAssigner { sess: sess }));
317 if sess.opts.debugging_opts & config::AST_JSON != 0 {
318 let mut stdout = io::BufferedWriter::new(io::stdout());
319 let mut json = json::PrettyEncoder::new(&mut stdout);
320 // unwrapping so IoError isn't ignored
321 map.krate().encode(&mut json).unwrap();
327 /// Run the resolution, typechecking, region checking and other
328 /// miscellaneous analysis passes on the crate. Return various
329 /// structures carrying the results of the analysis.
330 pub fn phase_3_run_analysis_passes<'tcx>(sess: Session,
331 ast_map: ast_map::Map<'tcx>,
332 type_arena: &'tcx TypedArena<ty::TyS<'tcx>>,
333 name: String) -> ty::CrateAnalysis<'tcx> {
334 let time_passes = sess.time_passes();
335 let krate = ast_map.krate();
337 time(time_passes, "external crate/lib resolution", (), |_|
338 creader::read_crates(&sess, krate));
340 let lang_items = time(time_passes, "language item collection", (), |_|
341 middle::lang_items::collect_language_items(krate, &sess));
343 let middle::resolve::CrateMap {
352 time(time_passes, "resolution", (), |_|
353 middle::resolve::resolve_crate(&sess, &lang_items, krate));
355 // Discard MTWT tables that aren't required past resolution.
356 syntax::ext::mtwt::clear_tables();
358 let named_region_map = time(time_passes, "lifetime resolution", (),
359 |_| middle::resolve_lifetime::krate(&sess, krate, &def_map));
361 time(time_passes, "looking for entry point", (),
362 |_| middle::entry::find_entry_point(&sess, &ast_map));
364 sess.plugin_registrar_fn.set(
365 time(time_passes, "looking for plugin registrar", (), |_|
366 plugin::build::find_plugin_registrar(
367 sess.diagnostic(), krate)));
369 let region_map = time(time_passes, "region resolution", (), |_|
370 middle::region::resolve_crate(&sess, krate));
372 time(time_passes, "loop checking", (), |_|
373 middle::check_loop::check_crate(&sess, krate));
375 let stability_index = time(time_passes, "stability index", (), |_|
376 stability::Index::build(krate));
378 time(time_passes, "static item recursion checking", (), |_|
379 middle::check_static_recursion::check_crate(&sess, krate, &def_map, &ast_map));
381 let ty_cx = ty::mk_ctxt(sess,
392 // passes are timed inside typeck
393 typeck::check_crate(&ty_cx, trait_map);
395 time(time_passes, "check static items", (), |_|
396 middle::check_static::check_crate(&ty_cx));
398 // These next two const passes can probably be merged
399 time(time_passes, "const marking", (), |_|
400 middle::const_eval::process_crate(&ty_cx));
402 time(time_passes, "const checking", (), |_|
403 middle::check_const::check_crate(&ty_cx));
405 let maps = (external_exports, last_private_map);
406 let (exported_items, public_items) =
407 time(time_passes, "privacy checking", maps, |(a, b)|
408 middle::privacy::check_crate(&ty_cx, &exp_map2, a, b));
410 time(time_passes, "intrinsic checking", (), |_|
411 middle::intrinsicck::check_crate(&ty_cx));
413 time(time_passes, "effect checking", (), |_|
414 middle::effect::check_crate(&ty_cx));
416 time(time_passes, "match checking", (), |_|
417 middle::check_match::check_crate(&ty_cx));
419 time(time_passes, "liveness checking", (), |_|
420 middle::liveness::check_crate(&ty_cx));
422 time(time_passes, "borrow checking", (), |_|
423 middle::borrowck::check_crate(&ty_cx));
425 time(time_passes, "rvalue checking", (), |_|
426 middle::check_rvalues::check_crate(&ty_cx, krate));
428 // Avoid overwhelming user with errors if type checking failed.
429 // I'm not sure how helpful this is, to be honest, but it avoids a
430 // lot of annoying errors in the compile-fail tests (basically,
431 // lint warnings and so on -- kindck used to do this abort, but
432 // kindck is gone now). -nmatsakis
433 ty_cx.sess.abort_if_errors();
436 time(time_passes, "reachability checking", (), |_|
437 reachable::find_reachable(&ty_cx, &exported_items));
439 time(time_passes, "death checking", (), |_| {
440 middle::dead::check_crate(&ty_cx,
445 time(time_passes, "lint checking", (), |_|
446 lint::check_crate(&ty_cx, &exported_items));
451 exported_items: exported_items,
452 public_items: public_items,
453 reachable: reachable_map,
458 pub fn phase_save_analysis(sess: &Session,
460 analysis: &ty::CrateAnalysis,
461 odir: &Option<Path>) {
462 if (sess.opts.debugging_opts & config::SAVE_ANALYSIS) == 0 {
465 time(sess.time_passes(), "save analysis", krate, |krate|
466 save::process_crate(sess, krate, analysis, odir));
469 /// Run the translation phase to LLVM, after which the AST and analysis can
471 pub fn phase_4_translate_to_llvm<'tcx>(analysis: ty::CrateAnalysis<'tcx>)
472 -> (ty::ctxt<'tcx>, trans::CrateTranslation) {
473 let time_passes = analysis.ty_cx.sess.time_passes();
475 time(time_passes, "resolving dependency formats", (), |_|
476 dependency_format::calculate(&analysis.ty_cx));
478 // Option dance to work around the lack of stack once closures.
479 time(time_passes, "translation", analysis, |analysis|
480 trans::trans_crate(analysis))
483 /// Run LLVM itself, producing a bitcode file, assembly file or object file
484 /// as a side effect.
485 pub fn phase_5_run_llvm_passes(sess: &Session,
486 trans: &trans::CrateTranslation,
487 outputs: &OutputFilenames) {
488 if sess.opts.cg.no_integrated_as {
489 let output_type = config::OutputTypeAssembly;
491 time(sess.time_passes(), "LLVM passes", (), |_|
492 write::run_passes(sess, trans, &[output_type], outputs));
494 write::run_assembler(sess, outputs);
496 // Remove assembly source, unless --save-temps was specified
497 if !sess.opts.cg.save_temps {
498 fs::unlink(&outputs.temp_path(config::OutputTypeAssembly)).unwrap();
501 time(sess.time_passes(), "LLVM passes", (), |_|
502 write::run_passes(sess,
504 sess.opts.output_types.as_slice(),
508 sess.abort_if_errors();
511 /// Run the linker on any artifacts that resulted from the LLVM run.
512 /// This should produce either a finished executable or library.
513 pub fn phase_6_link_output(sess: &Session,
514 trans: &trans::CrateTranslation,
515 outputs: &OutputFilenames) {
516 let old_path = os::getenv("PATH").unwrap_or_else(||String::new());
517 let mut new_path = sess.host_filesearch().get_tools_search_paths();
518 new_path.extend(os::split_paths(old_path.as_slice()).into_iter());
519 os::setenv("PATH", os::join_paths(new_path.as_slice()).unwrap());
521 time(sess.time_passes(), "linking", (), |_|
522 link::link_binary(sess,
525 trans.link.crate_name.as_slice()));
527 os::setenv("PATH", old_path);
530 pub fn stop_after_phase_3(sess: &Session) -> bool {
531 if sess.opts.no_trans {
532 debug!("invoked with --no-trans, returning early from compile_input");
538 pub fn stop_after_phase_1(sess: &Session) -> bool {
539 if sess.opts.parse_only {
540 debug!("invoked with --parse-only, returning early from compile_input");
543 if sess.show_span() {
546 return sess.opts.debugging_opts & config::AST_JSON_NOEXPAND != 0;
549 pub fn stop_after_phase_2(sess: &Session) -> bool {
550 if sess.opts.no_analysis {
551 debug!("invoked with --no-analysis, returning early from compile_input");
554 return sess.opts.debugging_opts & config::AST_JSON != 0;
557 pub fn stop_after_phase_5(sess: &Session) -> bool {
558 if !sess.opts.output_types.iter().any(|&i| i == config::OutputTypeExe) {
559 debug!("not building executable, returning early from compile_input");
565 fn escape_dep_filename(filename: &str) -> String {
566 // Apparently clang and gcc *only* escape spaces:
567 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
568 filename.replace(" ", "\\ ")
571 fn write_out_deps(sess: &Session,
573 outputs: &OutputFilenames,
576 let mut out_filenames = Vec::new();
577 for output_type in sess.opts.output_types.iter() {
578 let file = outputs.path(*output_type);
580 config::OutputTypeExe => {
581 for output in sess.crate_types.borrow().iter() {
582 let p = link::filename_for_input(sess, *output,
584 out_filenames.push(p);
587 _ => { out_filenames.push(file); }
591 // Write out dependency rules to the dep-info file if requested with
593 let deps_filename = match sess.opts.write_dependency_info {
594 // Use filename from --dep-file argument if given
595 (true, Some(ref filename)) => filename.clone(),
596 // Use default filename: crate source filename with extension replaced
598 (true, None) => match *input {
599 Input::File(..) => outputs.with_extension("d"),
601 sess.warn("can not write --dep-info without a filename \
602 when compiling stdin.");
609 let result = (|| -> io::IoResult<()> {
610 // Build a list of files used to compile the output and
611 // write Makefile-compatible dependency rules
612 let files: Vec<String> = sess.codemap().files.borrow()
613 .iter().filter(|fmap| fmap.is_real_file())
614 .map(|fmap| escape_dep_filename(fmap.name.as_slice()))
616 let mut file = try!(io::File::create(&deps_filename));
617 for path in out_filenames.iter() {
618 try!(write!(&mut file as &mut Writer,
619 "{}: {}\n\n", path.display(), files.connect(" ")));
627 sess.fatal(format!("error writing dependencies to `{}`: {}",
628 deps_filename.display(), e).as_slice());
633 pub fn collect_crate_types(session: &Session,
634 attrs: &[ast::Attribute]) -> Vec<config::CrateType> {
635 // Unconditionally collect crate types from attributes to make them used
636 let attr_types: Vec<config::CrateType> = attrs.iter().filter_map(|a| {
637 if a.check_name("crate_type") {
638 match a.value_str() {
639 Some(ref n) if *n == "rlib" => {
640 Some(config::CrateTypeRlib)
642 Some(ref n) if *n == "dylib" => {
643 Some(config::CrateTypeDylib)
645 Some(ref n) if *n == "lib" => {
646 Some(config::default_lib_output())
648 Some(ref n) if *n == "staticlib" => {
649 Some(config::CrateTypeStaticlib)
651 Some(ref n) if *n == "bin" => Some(config::CrateTypeExecutable),
653 session.add_lint(lint::builtin::UNKNOWN_CRATE_TYPES,
656 "invalid `crate_type` \
661 session.add_lint(lint::builtin::UNKNOWN_CRATE_TYPES,
664 "`crate_type` requires a \
674 // If we're generating a test executable, then ignore all other output
675 // styles at all other locations
676 if session.opts.test {
677 return vec!(config::CrateTypeExecutable)
680 // Only check command line flags if present. If no types are specified by
681 // command line, then reuse the empty `base` Vec to hold the types that
682 // will be found in crate attributes.
683 let mut base = session.opts.crate_types.clone();
685 base.extend(attr_types.into_iter());
687 base.push(link::default_output_for_target(session));
693 base.into_iter().filter(|crate_type| {
694 let res = !link::invalid_output_for_target(session, *crate_type);
697 session.warn(format!("dropping unsupported crate type `{}` \
699 *crate_type, session.opts.target_triple).as_slice());
706 pub fn collect_crate_metadata(session: &Session,
707 _attrs: &[ast::Attribute]) -> Vec<String> {
708 session.opts.cg.metadata.clone()
711 pub fn build_output_filenames(input: &Input,
713 ofile: &Option<Path>,
714 attrs: &[ast::Attribute],
719 // "-" as input file will cause the parser to read from stdin so we
720 // have to make up a name
721 // We want to toss everything after the final '.'
722 let dirpath = match *odir {
723 Some(ref d) => d.clone(),
724 None => Path::new(".")
727 // If a crate name is present, we use it as the link name
728 let stem = sess.opts.crate_name.clone().or_else(|| {
729 attr::find_crate_name(attrs).map(|n| n.get().to_string())
730 }).unwrap_or(input.filestem());
733 out_directory: dirpath,
735 single_output_file: None,
736 extra: sess.opts.cg.extra_filename.clone(),
740 Some(ref out_file) => {
741 let ofile = if sess.opts.output_types.len() > 1 {
742 sess.warn("ignoring specified output filename because multiple \
743 outputs were requested");
746 Some(out_file.clone())
749 sess.warn("ignoring --out-dir flag due to -o flag.");
752 out_directory: out_file.dir_path(),
753 out_filestem: out_file.filestem_str().unwrap().to_string(),
754 single_output_file: ofile,
755 extra: sess.opts.cg.extra_filename.clone(),