]> git.lizzy.rs Git - rust.git/blob - src/librustc/session/mod.rs
introing one-time diagnostics: only emit "lint level defined here" once
[rust.git] / src / librustc / session / mod.rs
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.
4 //
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.
10
11 use dep_graph::DepGraph;
12 use hir::def_id::{CrateNum, DefIndex};
13 use hir::svh::Svh;
14 use lint;
15 use middle::cstore::CrateStore;
16 use middle::dependency_format;
17 use session::search_paths::PathKind;
18 use session::config::DebugInfoLevel;
19 use ty::tls;
20 use util::nodemap::{NodeMap, FnvHashMap, FnvHashSet};
21 use util::common::duration_to_secs_str;
22 use mir::transform as mir_pass;
23
24 use syntax::ast::NodeId;
25 use errors::{self, DiagnosticBuilder};
26 use errors::emitter::{Emitter, EmitterWriter};
27 use syntax::json::JsonEmitter;
28 use syntax::feature_gate;
29 use syntax::parse;
30 use syntax::parse::ParseSess;
31 use syntax::parse::token;
32 use syntax::{ast, codemap};
33 use syntax::feature_gate::AttributeType;
34 use syntax_pos::{Span, MultiSpan};
35
36 use rustc_back::PanicStrategy;
37 use rustc_back::target::Target;
38 use rustc_data_structures::flock;
39 use llvm;
40
41 use std::path::{Path, PathBuf};
42 use std::cell::{self, Cell, RefCell};
43 use std::collections::HashMap;
44 use std::env;
45 use std::ffi::CString;
46 use std::io::Write;
47 use std::rc::Rc;
48 use std::fmt;
49 use std::time::Duration;
50 use libc::c_int;
51
52 pub mod config;
53 pub mod filesearch;
54 pub mod search_paths;
55
56 // Represents the data associated with a compilation
57 // session for a single crate.
58 pub struct Session {
59     pub dep_graph: DepGraph,
60     pub target: config::Config,
61     pub host: Target,
62     pub opts: config::Options,
63     pub cstore: Rc<for<'a> CrateStore<'a>>,
64     pub parse_sess: ParseSess,
65     // For a library crate, this is always none
66     pub entry_fn: RefCell<Option<(NodeId, Span)>>,
67     pub entry_type: Cell<Option<config::EntryFnType>>,
68     pub plugin_registrar_fn: Cell<Option<ast::NodeId>>,
69     pub derive_registrar_fn: Cell<Option<ast::NodeId>>,
70     pub default_sysroot: Option<PathBuf>,
71     // The name of the root source file of the crate, in the local file system.
72     // The path is always expected to be absolute. `None` means that there is no
73     // source file.
74     pub local_crate_source_file: Option<PathBuf>,
75     pub working_dir: PathBuf,
76     pub lint_store: RefCell<lint::LintStore>,
77     pub lints: RefCell<NodeMap<Vec<(lint::LintId, Span, String)>>>,
78     /// Set of (span, message) tuples tracking lint (sub)diagnostics that have
79     /// been set once, but should not be set again, in order to avoid
80     /// redundantly verbose output (Issue #24690).
81     pub one_time_diagnostics: RefCell<FnvHashSet<(Span, String)>>,
82     pub plugin_llvm_passes: RefCell<Vec<String>>,
83     pub mir_passes: RefCell<mir_pass::Passes>,
84     pub plugin_attributes: RefCell<Vec<(String, AttributeType)>>,
85     pub crate_types: RefCell<Vec<config::CrateType>>,
86     pub dependency_formats: RefCell<dependency_format::Dependencies>,
87     // The crate_disambiguator is constructed out of all the `-C metadata`
88     // arguments passed to the compiler. Its value together with the crate-name
89     // forms a unique global identifier for the crate. It is used to allow
90     // multiple crates with the same name to coexist. See the
91     // trans::back::symbol_names module for more information.
92     pub crate_disambiguator: RefCell<token::InternedString>,
93     pub features: RefCell<feature_gate::Features>,
94
95     /// The maximum recursion limit for potentially infinitely recursive
96     /// operations such as auto-dereference and monomorphization.
97     pub recursion_limit: Cell<usize>,
98
99     /// The metadata::creader module may inject an allocator/panic_runtime
100     /// dependency if it didn't already find one, and this tracks what was
101     /// injected.
102     pub injected_allocator: Cell<Option<CrateNum>>,
103     pub injected_panic_runtime: Cell<Option<CrateNum>>,
104
105     /// Map from imported macro spans (which consist of
106     /// the localized span for the macro body) to the
107     /// macro name and defintion span in the source crate.
108     pub imported_macro_spans: RefCell<HashMap<Span, (String, Span)>>,
109
110     incr_comp_session: RefCell<IncrCompSession>,
111
112     /// Some measurements that are being gathered during compilation.
113     pub perf_stats: PerfStats,
114
115     next_node_id: Cell<ast::NodeId>,
116 }
117
118 pub struct PerfStats {
119     // The accumulated time needed for computing the SVH of the crate
120     pub svh_time: Cell<Duration>,
121     // The accumulated time spent on computing incr. comp. hashes
122     pub incr_comp_hashes_time: Cell<Duration>,
123     // The number of incr. comp. hash computations performed
124     pub incr_comp_hashes_count: Cell<u64>,
125     // The number of bytes hashed when computing ICH values
126     pub incr_comp_bytes_hashed: Cell<u64>,
127     // The accumulated time spent on computing symbol hashes
128     pub symbol_hash_time: Cell<Duration>,
129 }
130
131 impl Session {
132     pub fn local_crate_disambiguator(&self) -> token::InternedString {
133         self.crate_disambiguator.borrow().clone()
134     }
135     pub fn struct_span_warn<'a, S: Into<MultiSpan>>(&'a self,
136                                                     sp: S,
137                                                     msg: &str)
138                                                     -> DiagnosticBuilder<'a>  {
139         self.diagnostic().struct_span_warn(sp, msg)
140     }
141     pub fn struct_span_warn_with_code<'a, S: Into<MultiSpan>>(&'a self,
142                                                               sp: S,
143                                                               msg: &str,
144                                                               code: &str)
145                                                               -> DiagnosticBuilder<'a>  {
146         self.diagnostic().struct_span_warn_with_code(sp, msg, code)
147     }
148     pub fn struct_warn<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a>  {
149         self.diagnostic().struct_warn(msg)
150     }
151     pub fn struct_span_err<'a, S: Into<MultiSpan>>(&'a self,
152                                                    sp: S,
153                                                    msg: &str)
154                                                    -> DiagnosticBuilder<'a>  {
155         self.diagnostic().struct_span_err(sp, msg)
156     }
157     pub fn struct_span_err_with_code<'a, S: Into<MultiSpan>>(&'a self,
158                                                              sp: S,
159                                                              msg: &str,
160                                                              code: &str)
161                                                              -> DiagnosticBuilder<'a>  {
162         self.diagnostic().struct_span_err_with_code(sp, msg, code)
163     }
164     pub fn struct_err<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a>  {
165         self.diagnostic().struct_err(msg)
166     }
167     pub fn struct_span_fatal<'a, S: Into<MultiSpan>>(&'a self,
168                                                      sp: S,
169                                                      msg: &str)
170                                                      -> DiagnosticBuilder<'a>  {
171         self.diagnostic().struct_span_fatal(sp, msg)
172     }
173     pub fn struct_span_fatal_with_code<'a, S: Into<MultiSpan>>(&'a self,
174                                                                sp: S,
175                                                                msg: &str,
176                                                                code: &str)
177                                                                -> DiagnosticBuilder<'a>  {
178         self.diagnostic().struct_span_fatal_with_code(sp, msg, code)
179     }
180     pub fn struct_fatal<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a>  {
181         self.diagnostic().struct_fatal(msg)
182     }
183
184     pub fn span_fatal<S: Into<MultiSpan>>(&self, sp: S, msg: &str) -> ! {
185         panic!(self.diagnostic().span_fatal(sp, msg))
186     }
187     pub fn span_fatal_with_code<S: Into<MultiSpan>>(&self, sp: S, msg: &str, code: &str) -> ! {
188         panic!(self.diagnostic().span_fatal_with_code(sp, msg, code))
189     }
190     pub fn fatal(&self, msg: &str) -> ! {
191         panic!(self.diagnostic().fatal(msg))
192     }
193     pub fn span_err_or_warn<S: Into<MultiSpan>>(&self, is_warning: bool, sp: S, msg: &str) {
194         if is_warning {
195             self.span_warn(sp, msg);
196         } else {
197             self.span_err(sp, msg);
198         }
199     }
200     pub fn span_err<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
201         self.diagnostic().span_err(sp, msg)
202     }
203     pub fn span_err_with_code<S: Into<MultiSpan>>(&self, sp: S, msg: &str, code: &str) {
204         self.diagnostic().span_err_with_code(sp, &msg, code)
205     }
206     pub fn err(&self, msg: &str) {
207         self.diagnostic().err(msg)
208     }
209     pub fn err_count(&self) -> usize {
210         self.diagnostic().err_count()
211     }
212     pub fn has_errors(&self) -> bool {
213         self.diagnostic().has_errors()
214     }
215     pub fn abort_if_errors(&self) {
216         self.diagnostic().abort_if_errors();
217     }
218     pub fn track_errors<F, T>(&self, f: F) -> Result<T, usize>
219         where F: FnOnce() -> T
220     {
221         let old_count = self.err_count();
222         let result = f();
223         let errors = self.err_count() - old_count;
224         if errors == 0 {
225             Ok(result)
226         } else {
227             Err(errors)
228         }
229     }
230     pub fn span_warn<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
231         self.diagnostic().span_warn(sp, msg)
232     }
233     pub fn span_warn_with_code<S: Into<MultiSpan>>(&self, sp: S, msg: &str, code: &str) {
234         self.diagnostic().span_warn_with_code(sp, msg, code)
235     }
236     pub fn warn(&self, msg: &str) {
237         self.diagnostic().warn(msg)
238     }
239     pub fn opt_span_warn<S: Into<MultiSpan>>(&self, opt_sp: Option<S>, msg: &str) {
240         match opt_sp {
241             Some(sp) => self.span_warn(sp, msg),
242             None => self.warn(msg),
243         }
244     }
245     /// Delay a span_bug() call until abort_if_errors()
246     pub fn delay_span_bug<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
247         self.diagnostic().delay_span_bug(sp, msg)
248     }
249     pub fn note_without_error(&self, msg: &str) {
250         self.diagnostic().note_without_error(msg)
251     }
252     pub fn span_note_without_error<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
253         self.diagnostic().span_note_without_error(sp, msg)
254     }
255     pub fn span_unimpl<S: Into<MultiSpan>>(&self, sp: S, msg: &str) -> ! {
256         self.diagnostic().span_unimpl(sp, msg)
257     }
258     pub fn unimpl(&self, msg: &str) -> ! {
259         self.diagnostic().unimpl(msg)
260     }
261     pub fn add_lint(&self,
262                     lint: &'static lint::Lint,
263                     id: ast::NodeId,
264                     sp: Span,
265                     msg: String) {
266         let lint_id = lint::LintId::of(lint);
267         let mut lints = self.lints.borrow_mut();
268         if let Some(arr) = lints.get_mut(&id) {
269             let tuple = (lint_id, sp, msg);
270             if !arr.contains(&tuple) {
271                 arr.push(tuple);
272             }
273             return;
274         }
275         lints.insert(id, vec!((lint_id, sp, msg)));
276     }
277     pub fn reserve_node_ids(&self, count: usize) -> ast::NodeId {
278         let id = self.next_node_id.get();
279
280         match id.as_usize().checked_add(count) {
281             Some(next) => {
282                 self.next_node_id.set(ast::NodeId::new(next));
283             }
284             None => bug!("Input too large, ran out of node ids!")
285         }
286
287         id
288     }
289     pub fn next_node_id(&self) -> NodeId {
290         self.reserve_node_ids(1)
291     }
292     pub fn diagnostic<'a>(&'a self) -> &'a errors::Handler {
293         &self.parse_sess.span_diagnostic
294     }
295
296     /// Analogous to calling `.span_note` on the given DiagnosticBuilder, but
297     /// deduplicates on span and message for this `Session`.
298     //
299     // FIXME: if the need arises for one-time diagnostics other than
300     // `span_note`, we almost certainly want to generalize this "check the
301     // one-time diagnostics map, then set message if it's not already there"
302     // code to accomodate all of them
303     pub fn diag_span_note_once<'a, 'b>(&'a self,
304                                        diag_builder: &'b mut DiagnosticBuilder<'a>,
305                                        span: Span, message: &str) {
306         let span_message = (span, message.to_owned());
307         let already_noted: bool = self.one_time_diagnostics.borrow()
308             .contains(&span_message);
309         if !already_noted {
310             diag_builder.span_note(span, &message);
311             self.one_time_diagnostics.borrow_mut().insert(span_message);
312         }
313     }
314
315     pub fn codemap<'a>(&'a self) -> &'a codemap::CodeMap {
316         self.parse_sess.codemap()
317     }
318     pub fn verbose(&self) -> bool { self.opts.debugging_opts.verbose }
319     pub fn time_passes(&self) -> bool { self.opts.debugging_opts.time_passes }
320     pub fn count_llvm_insns(&self) -> bool {
321         self.opts.debugging_opts.count_llvm_insns
322     }
323     pub fn time_llvm_passes(&self) -> bool {
324         self.opts.debugging_opts.time_llvm_passes
325     }
326     pub fn trans_stats(&self) -> bool { self.opts.debugging_opts.trans_stats }
327     pub fn meta_stats(&self) -> bool { self.opts.debugging_opts.meta_stats }
328     pub fn asm_comments(&self) -> bool { self.opts.debugging_opts.asm_comments }
329     pub fn no_verify(&self) -> bool { self.opts.debugging_opts.no_verify }
330     pub fn borrowck_stats(&self) -> bool { self.opts.debugging_opts.borrowck_stats }
331     pub fn print_llvm_passes(&self) -> bool {
332         self.opts.debugging_opts.print_llvm_passes
333     }
334     pub fn lto(&self) -> bool {
335         self.opts.cg.lto
336     }
337     /// Returns the panic strategy for this compile session. If the user explicitly selected one
338     /// using '-C panic', use that, otherwise use the panic strategy defined by the target.
339     pub fn panic_strategy(&self) -> PanicStrategy {
340         self.opts.cg.panic.unwrap_or(self.target.target.options.panic_strategy)
341     }
342     pub fn no_landing_pads(&self) -> bool {
343         self.opts.debugging_opts.no_landing_pads || self.panic_strategy() == PanicStrategy::Abort
344     }
345     pub fn unstable_options(&self) -> bool {
346         self.opts.debugging_opts.unstable_options
347     }
348     pub fn nonzeroing_move_hints(&self) -> bool {
349         self.opts.debugging_opts.enable_nonzeroing_move_hints
350     }
351
352     pub fn must_not_eliminate_frame_pointers(&self) -> bool {
353         self.opts.debuginfo != DebugInfoLevel::NoDebugInfo ||
354         !self.target.target.options.eliminate_frame_pointer
355     }
356
357     /// Returns the symbol name for the registrar function,
358     /// given the crate Svh and the function DefIndex.
359     pub fn generate_plugin_registrar_symbol(&self, svh: &Svh, index: DefIndex)
360                                             -> String {
361         format!("__rustc_plugin_registrar__{}_{}", svh, index.as_usize())
362     }
363
364     pub fn generate_derive_registrar_symbol(&self,
365                                             svh: &Svh,
366                                             index: DefIndex) -> String {
367         format!("__rustc_derive_registrar__{}_{}", svh, index.as_usize())
368     }
369
370     pub fn sysroot<'a>(&'a self) -> &'a Path {
371         match self.opts.maybe_sysroot {
372             Some (ref sysroot) => sysroot,
373             None => self.default_sysroot.as_ref()
374                         .expect("missing sysroot and default_sysroot in Session")
375         }
376     }
377     pub fn target_filesearch(&self, kind: PathKind) -> filesearch::FileSearch {
378         filesearch::FileSearch::new(self.sysroot(),
379                                     &self.opts.target_triple,
380                                     &self.opts.search_paths,
381                                     kind)
382     }
383     pub fn host_filesearch(&self, kind: PathKind) -> filesearch::FileSearch {
384         filesearch::FileSearch::new(
385             self.sysroot(),
386             config::host_triple(),
387             &self.opts.search_paths,
388             kind)
389     }
390
391     pub fn init_incr_comp_session(&self,
392                                   session_dir: PathBuf,
393                                   lock_file: flock::Lock) {
394         let mut incr_comp_session = self.incr_comp_session.borrow_mut();
395
396         if let IncrCompSession::NotInitialized = *incr_comp_session { } else {
397             bug!("Trying to initialize IncrCompSession `{:?}`", *incr_comp_session)
398         }
399
400         *incr_comp_session = IncrCompSession::Active {
401             session_directory: session_dir,
402             lock_file: lock_file,
403         };
404     }
405
406     pub fn finalize_incr_comp_session(&self, new_directory_path: PathBuf) {
407         let mut incr_comp_session = self.incr_comp_session.borrow_mut();
408
409         if let IncrCompSession::Active { .. } = *incr_comp_session { } else {
410             bug!("Trying to finalize IncrCompSession `{:?}`", *incr_comp_session)
411         }
412
413         // Note: This will also drop the lock file, thus unlocking the directory
414         *incr_comp_session = IncrCompSession::Finalized {
415             session_directory: new_directory_path,
416         };
417     }
418
419     pub fn mark_incr_comp_session_as_invalid(&self) {
420         let mut incr_comp_session = self.incr_comp_session.borrow_mut();
421
422         let session_directory = match *incr_comp_session {
423             IncrCompSession::Active { ref session_directory, .. } => {
424                 session_directory.clone()
425             }
426             _ => bug!("Trying to invalidate IncrCompSession `{:?}`",
427                       *incr_comp_session),
428         };
429
430         // Note: This will also drop the lock file, thus unlocking the directory
431         *incr_comp_session = IncrCompSession::InvalidBecauseOfErrors {
432             session_directory: session_directory
433         };
434     }
435
436     pub fn incr_comp_session_dir(&self) -> cell::Ref<PathBuf> {
437         let incr_comp_session = self.incr_comp_session.borrow();
438         cell::Ref::map(incr_comp_session, |incr_comp_session| {
439             match *incr_comp_session {
440                 IncrCompSession::NotInitialized => {
441                     bug!("Trying to get session directory from IncrCompSession `{:?}`",
442                         *incr_comp_session)
443                 }
444                 IncrCompSession::Active { ref session_directory, .. } |
445                 IncrCompSession::Finalized { ref session_directory } |
446                 IncrCompSession::InvalidBecauseOfErrors { ref session_directory } => {
447                     session_directory
448                 }
449             }
450         })
451     }
452
453     pub fn incr_comp_session_dir_opt(&self) -> Option<cell::Ref<PathBuf>> {
454         if self.opts.incremental.is_some() {
455             Some(self.incr_comp_session_dir())
456         } else {
457             None
458         }
459     }
460
461     pub fn print_perf_stats(&self) {
462         println!("Total time spent computing SVHs:               {}",
463                  duration_to_secs_str(self.perf_stats.svh_time.get()));
464         println!("Total time spent computing incr. comp. hashes: {}",
465                  duration_to_secs_str(self.perf_stats.incr_comp_hashes_time.get()));
466         println!("Total number of incr. comp. hashes computed:   {}",
467                  self.perf_stats.incr_comp_hashes_count.get());
468         println!("Total number of bytes hashed for incr. comp.:  {}",
469                  self.perf_stats.incr_comp_bytes_hashed.get());
470         println!("Average bytes hashed per incr. comp. HIR node: {}",
471                  self.perf_stats.incr_comp_bytes_hashed.get() /
472                  self.perf_stats.incr_comp_hashes_count.get());
473         println!("Total time spent computing symbol hashes:      {}",
474                  duration_to_secs_str(self.perf_stats.symbol_hash_time.get()));
475     }
476 }
477
478 pub fn build_session(sopts: config::Options,
479                      dep_graph: &DepGraph,
480                      local_crate_source_file: Option<PathBuf>,
481                      registry: errors::registry::Registry,
482                      cstore: Rc<for<'a> CrateStore<'a>>)
483                      -> Session {
484     build_session_with_codemap(sopts,
485                                dep_graph,
486                                local_crate_source_file,
487                                registry,
488                                cstore,
489                                Rc::new(codemap::CodeMap::new()),
490                                None)
491 }
492
493 pub fn build_session_with_codemap(sopts: config::Options,
494                                   dep_graph: &DepGraph,
495                                   local_crate_source_file: Option<PathBuf>,
496                                   registry: errors::registry::Registry,
497                                   cstore: Rc<for<'a> CrateStore<'a>>,
498                                   codemap: Rc<codemap::CodeMap>,
499                                   emitter_dest: Option<Box<Write + Send>>)
500                                   -> Session {
501     // FIXME: This is not general enough to make the warning lint completely override
502     // normal diagnostic warnings, since the warning lint can also be denied and changed
503     // later via the source code.
504     let can_print_warnings = sopts.lint_opts
505         .iter()
506         .filter(|&&(ref key, _)| *key == "warnings")
507         .map(|&(_, ref level)| *level != lint::Allow)
508         .last()
509         .unwrap_or(true);
510     let treat_err_as_bug = sopts.debugging_opts.treat_err_as_bug;
511
512     let emitter: Box<Emitter> = match (sopts.error_format, emitter_dest) {
513         (config::ErrorOutputType::HumanReadable(color_config), None) => {
514             Box::new(EmitterWriter::stderr(color_config,
515                                            Some(codemap.clone())))
516         }
517         (config::ErrorOutputType::HumanReadable(_), Some(dst)) => {
518             Box::new(EmitterWriter::new(dst,
519                                         Some(codemap.clone())))
520         }
521         (config::ErrorOutputType::Json, None) => {
522             Box::new(JsonEmitter::stderr(Some(registry), codemap.clone()))
523         }
524         (config::ErrorOutputType::Json, Some(dst)) => {
525             Box::new(JsonEmitter::new(dst, Some(registry), codemap.clone()))
526         }
527     };
528
529     let diagnostic_handler =
530         errors::Handler::with_emitter(can_print_warnings,
531                                       treat_err_as_bug,
532                                       emitter);
533
534     build_session_(sopts,
535                    dep_graph,
536                    local_crate_source_file,
537                    diagnostic_handler,
538                    codemap,
539                    cstore)
540 }
541
542 pub fn build_session_(sopts: config::Options,
543                       dep_graph: &DepGraph,
544                       local_crate_source_file: Option<PathBuf>,
545                       span_diagnostic: errors::Handler,
546                       codemap: Rc<codemap::CodeMap>,
547                       cstore: Rc<for<'a> CrateStore<'a>>)
548                       -> Session {
549     let host = match Target::search(config::host_triple()) {
550         Ok(t) => t,
551         Err(e) => {
552             panic!(span_diagnostic.fatal(&format!("Error loading host specification: {}", e)));
553     }
554     };
555     let target_cfg = config::build_target_config(&sopts, &span_diagnostic);
556     let p_s = parse::ParseSess::with_span_handler(span_diagnostic, codemap);
557     let default_sysroot = match sopts.maybe_sysroot {
558         Some(_) => None,
559         None => Some(filesearch::get_or_default_sysroot())
560     };
561
562     // Make the path absolute, if necessary
563     let local_crate_source_file = local_crate_source_file.map(|path|
564         if path.is_absolute() {
565             path.clone()
566         } else {
567             env::current_dir().unwrap().join(&path)
568         }
569     );
570
571     let sess = Session {
572         dep_graph: dep_graph.clone(),
573         target: target_cfg,
574         host: host,
575         opts: sopts,
576         cstore: cstore,
577         parse_sess: p_s,
578         // For a library crate, this is always none
579         entry_fn: RefCell::new(None),
580         entry_type: Cell::new(None),
581         plugin_registrar_fn: Cell::new(None),
582         derive_registrar_fn: Cell::new(None),
583         default_sysroot: default_sysroot,
584         local_crate_source_file: local_crate_source_file,
585         working_dir: env::current_dir().unwrap(),
586         lint_store: RefCell::new(lint::LintStore::new()),
587         lints: RefCell::new(NodeMap()),
588         one_time_diagnostics: RefCell::new(FnvHashSet()),
589         plugin_llvm_passes: RefCell::new(Vec::new()),
590         mir_passes: RefCell::new(mir_pass::Passes::new()),
591         plugin_attributes: RefCell::new(Vec::new()),
592         crate_types: RefCell::new(Vec::new()),
593         dependency_formats: RefCell::new(FnvHashMap()),
594         crate_disambiguator: RefCell::new(token::intern("").as_str()),
595         features: RefCell::new(feature_gate::Features::new()),
596         recursion_limit: Cell::new(64),
597         next_node_id: Cell::new(NodeId::new(1)),
598         injected_allocator: Cell::new(None),
599         injected_panic_runtime: Cell::new(None),
600         imported_macro_spans: RefCell::new(HashMap::new()),
601         incr_comp_session: RefCell::new(IncrCompSession::NotInitialized),
602         perf_stats: PerfStats {
603             svh_time: Cell::new(Duration::from_secs(0)),
604             incr_comp_hashes_time: Cell::new(Duration::from_secs(0)),
605             incr_comp_hashes_count: Cell::new(0),
606             incr_comp_bytes_hashed: Cell::new(0),
607             symbol_hash_time: Cell::new(Duration::from_secs(0)),
608         }
609     };
610
611     init_llvm(&sess);
612
613     sess
614 }
615
616 /// Holds data on the current incremental compilation session, if there is one.
617 #[derive(Debug)]
618 pub enum IncrCompSession {
619     // This is the state the session will be in until the incr. comp. dir is
620     // needed.
621     NotInitialized,
622     // This is the state during which the session directory is private and can
623     // be modified.
624     Active {
625         session_directory: PathBuf,
626         lock_file: flock::Lock,
627     },
628     // This is the state after the session directory has been finalized. In this
629     // state, the contents of the directory must not be modified any more.
630     Finalized {
631         session_directory: PathBuf,
632     },
633     // This is an error state that is reached when some compilation error has
634     // occurred. It indicates that the contents of the session directory must
635     // not be used, since they might be invalid.
636     InvalidBecauseOfErrors {
637         session_directory: PathBuf,
638     }
639 }
640
641 fn init_llvm(sess: &Session) {
642     unsafe {
643         // Before we touch LLVM, make sure that multithreading is enabled.
644         use std::sync::Once;
645         static INIT: Once = Once::new();
646         static mut POISONED: bool = false;
647         INIT.call_once(|| {
648             if llvm::LLVMStartMultithreaded() != 1 {
649                 // use an extra bool to make sure that all future usage of LLVM
650                 // cannot proceed despite the Once not running more than once.
651                 POISONED = true;
652             }
653
654             configure_llvm(sess);
655         });
656
657         if POISONED {
658             bug!("couldn't enable multi-threaded LLVM");
659         }
660     }
661 }
662
663 unsafe fn configure_llvm(sess: &Session) {
664     let mut llvm_c_strs = Vec::new();
665     let mut llvm_args = Vec::new();
666
667     {
668         let mut add = |arg: &str| {
669             let s = CString::new(arg).unwrap();
670             llvm_args.push(s.as_ptr());
671             llvm_c_strs.push(s);
672         };
673         add("rustc"); // fake program name
674         if sess.time_llvm_passes() { add("-time-passes"); }
675         if sess.print_llvm_passes() { add("-debug-pass=Structure"); }
676
677         for arg in &sess.opts.cg.llvm_args {
678             add(&(*arg));
679         }
680     }
681
682     llvm::LLVMInitializePasses();
683
684     llvm::initialize_available_targets();
685
686     llvm::LLVMRustSetLLVMOptions(llvm_args.len() as c_int,
687                                  llvm_args.as_ptr());
688 }
689
690 pub fn early_error(output: config::ErrorOutputType, msg: &str) -> ! {
691     let emitter: Box<Emitter> = match output {
692         config::ErrorOutputType::HumanReadable(color_config) => {
693             Box::new(EmitterWriter::stderr(color_config,
694                                            None))
695         }
696         config::ErrorOutputType::Json => Box::new(JsonEmitter::basic()),
697     };
698     let handler = errors::Handler::with_emitter(true, false, emitter);
699     handler.emit(&MultiSpan::new(), msg, errors::Level::Fatal);
700     panic!(errors::FatalError);
701 }
702
703 pub fn early_warn(output: config::ErrorOutputType, msg: &str) {
704     let emitter: Box<Emitter> = match output {
705         config::ErrorOutputType::HumanReadable(color_config) => {
706             Box::new(EmitterWriter::stderr(color_config,
707                                            None))
708         }
709         config::ErrorOutputType::Json => Box::new(JsonEmitter::basic()),
710     };
711     let handler = errors::Handler::with_emitter(true, false, emitter);
712     handler.emit(&MultiSpan::new(), msg, errors::Level::Warning);
713 }
714
715 // Err(0) means compilation was stopped, but no errors were found.
716 // This would be better as a dedicated enum, but using try! is so convenient.
717 pub type CompileResult = Result<(), usize>;
718
719 pub fn compile_result_from_err_count(err_count: usize) -> CompileResult {
720     if err_count == 0 {
721         Ok(())
722     } else {
723         Err(err_count)
724     }
725 }
726
727 #[cold]
728 #[inline(never)]
729 pub fn bug_fmt(file: &'static str, line: u32, args: fmt::Arguments) -> ! {
730     // this wrapper mostly exists so I don't have to write a fully
731     // qualified path of None::<Span> inside the bug!() macro defintion
732     opt_span_bug_fmt(file, line, None::<Span>, args);
733 }
734
735 #[cold]
736 #[inline(never)]
737 pub fn span_bug_fmt<S: Into<MultiSpan>>(file: &'static str,
738                                         line: u32,
739                                         span: S,
740                                         args: fmt::Arguments) -> ! {
741     opt_span_bug_fmt(file, line, Some(span), args);
742 }
743
744 fn opt_span_bug_fmt<S: Into<MultiSpan>>(file: &'static str,
745                                         line: u32,
746                                         span: Option<S>,
747                                         args: fmt::Arguments) -> ! {
748     tls::with_opt(move |tcx| {
749         let msg = format!("{}:{}: {}", file, line, args);
750         match (tcx, span) {
751             (Some(tcx), Some(span)) => tcx.sess.diagnostic().span_bug(span, &msg),
752             (Some(tcx), None) => tcx.sess.diagnostic().bug(&msg),
753             (None, _) => panic!(msg)
754         }
755     });
756     unreachable!();
757 }