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 (LintId, span, message) tuples tracking lint (sub)diagnostics
  79     /// that have 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<(lint::LintId, 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 lint ID, span, and message for this `Session` if we're
 298     /// not outputting in JSON mode.
 299     //
 300     // FIXME: if the need arises for one-time diagnostics other than
 301     // `span_note`, we almost certainly want to generalize this
 302     // "check/insert-into the one-time diagnostics map, then set message if
 303     // it's not already there" code to accomodate all of them
 304     pub fn diag_span_note_once<'a, 'b>(&'a self,
 305                                        diag_builder: &'b mut DiagnosticBuilder<'a>,
 306                                        lint: &'static lint::Lint, span: Span, message: &str) {
 307         match self.opts.error_format {
 308             // when outputting JSON for tool consumption, the tool might want
 309             // the duplicates
 310             config::ErrorOutputType::Json => {
 311                 diag_builder.span_note(span, &message);
 312             },
 313             _ => {
 314                 let lint_id = lint::LintId::of(lint);
 315                 let id_span_message = (lint_id, span, message.to_owned());
 316                 let fresh = self.one_time_diagnostics.borrow_mut().insert(id_span_message);
 317                 if fresh {
 318                     diag_builder.span_note(span, &message);
 319                 }
 320             }
 321         }
 322     }
 323
 324     pub fn codemap<'a>(&'a self) -> &'a codemap::CodeMap {
 325         self.parse_sess.codemap()
 326     }
 327     pub fn verbose(&self) -> bool { self.opts.debugging_opts.verbose }
 328     pub fn time_passes(&self) -> bool { self.opts.debugging_opts.time_passes }
 329     pub fn count_llvm_insns(&self) -> bool {
 330         self.opts.debugging_opts.count_llvm_insns
 331     }
 332     pub fn time_llvm_passes(&self) -> bool {
 333         self.opts.debugging_opts.time_llvm_passes
 334     }
 335     pub fn trans_stats(&self) -> bool { self.opts.debugging_opts.trans_stats }
 336     pub fn meta_stats(&self) -> bool { self.opts.debugging_opts.meta_stats }
 337     pub fn asm_comments(&self) -> bool { self.opts.debugging_opts.asm_comments }
 338     pub fn no_verify(&self) -> bool { self.opts.debugging_opts.no_verify }
 339     pub fn borrowck_stats(&self) -> bool { self.opts.debugging_opts.borrowck_stats }
 340     pub fn print_llvm_passes(&self) -> bool {
 341         self.opts.debugging_opts.print_llvm_passes
 342     }
 343     pub fn lto(&self) -> bool {
 344         self.opts.cg.lto
 345     }
 346     /// Returns the panic strategy for this compile session. If the user explicitly selected one
 347     /// using '-C panic', use that, otherwise use the panic strategy defined by the target.
 348     pub fn panic_strategy(&self) -> PanicStrategy {
 349         self.opts.cg.panic.unwrap_or(self.target.target.options.panic_strategy)
 350     }
 351     pub fn no_landing_pads(&self) -> bool {
 352         self.opts.debugging_opts.no_landing_pads || self.panic_strategy() == PanicStrategy::Abort
 353     }
 354     pub fn unstable_options(&self) -> bool {
 355         self.opts.debugging_opts.unstable_options
 356     }
 357     pub fn nonzeroing_move_hints(&self) -> bool {
 358         self.opts.debugging_opts.enable_nonzeroing_move_hints
 359     }
 360
 361     pub fn must_not_eliminate_frame_pointers(&self) -> bool {
 362         self.opts.debuginfo != DebugInfoLevel::NoDebugInfo ||
 363         !self.target.target.options.eliminate_frame_pointer
 364     }
 365
 366     /// Returns the symbol name for the registrar function,
 367     /// given the crate Svh and the function DefIndex.
 368     pub fn generate_plugin_registrar_symbol(&self, svh: &Svh, index: DefIndex)
 369                                             -> String {
 370         format!("__rustc_plugin_registrar__{}_{}", svh, index.as_usize())
 371     }
 372
 373     pub fn generate_derive_registrar_symbol(&self,
 374                                             svh: &Svh,
 375                                             index: DefIndex) -> String {
 376         format!("__rustc_derive_registrar__{}_{}", svh, index.as_usize())
 377     }
 378
 379     pub fn sysroot<'a>(&'a self) -> &'a Path {
 380         match self.opts.maybe_sysroot {
 381             Some (ref sysroot) => sysroot,
 382             None => self.default_sysroot.as_ref()
 383                         .expect("missing sysroot and default_sysroot in Session")
 384         }
 385     }
 386     pub fn target_filesearch(&self, kind: PathKind) -> filesearch::FileSearch {
 387         filesearch::FileSearch::new(self.sysroot(),
 388                                     &self.opts.target_triple,
 389                                     &self.opts.search_paths,
 390                                     kind)
 391     }
 392     pub fn host_filesearch(&self, kind: PathKind) -> filesearch::FileSearch {
 393         filesearch::FileSearch::new(
 394             self.sysroot(),
 395             config::host_triple(),
 396             &self.opts.search_paths,
 397             kind)
 398     }
 399
 400     pub fn init_incr_comp_session(&self,
 401                                   session_dir: PathBuf,
 402                                   lock_file: flock::Lock) {
 403         let mut incr_comp_session = self.incr_comp_session.borrow_mut();
 404
 405         if let IncrCompSession::NotInitialized = *incr_comp_session { } else {
 406             bug!("Trying to initialize IncrCompSession `{:?}`", *incr_comp_session)
 407         }
 408
 409         *incr_comp_session = IncrCompSession::Active {
 410             session_directory: session_dir,
 411             lock_file: lock_file,
 412         };
 413     }
 414
 415     pub fn finalize_incr_comp_session(&self, new_directory_path: PathBuf) {
 416         let mut incr_comp_session = self.incr_comp_session.borrow_mut();
 417
 418         if let IncrCompSession::Active { .. } = *incr_comp_session { } else {
 419             bug!("Trying to finalize IncrCompSession `{:?}`", *incr_comp_session)
 420         }
 421
 422         // Note: This will also drop the lock file, thus unlocking the directory
 423         *incr_comp_session = IncrCompSession::Finalized {
 424             session_directory: new_directory_path,
 425         };
 426     }
 427
 428     pub fn mark_incr_comp_session_as_invalid(&self) {
 429         let mut incr_comp_session = self.incr_comp_session.borrow_mut();
 430
 431         let session_directory = match *incr_comp_session {
 432             IncrCompSession::Active { ref session_directory, .. } => {
 433                 session_directory.clone()
 434             }
 435             _ => bug!("Trying to invalidate IncrCompSession `{:?}`",
 436                       *incr_comp_session),
 437         };
 438
 439         // Note: This will also drop the lock file, thus unlocking the directory
 440         *incr_comp_session = IncrCompSession::InvalidBecauseOfErrors {
 441             session_directory: session_directory
 442         };
 443     }
 444
 445     pub fn incr_comp_session_dir(&self) -> cell::Ref<PathBuf> {
 446         let incr_comp_session = self.incr_comp_session.borrow();
 447         cell::Ref::map(incr_comp_session, |incr_comp_session| {
 448             match *incr_comp_session {
 449                 IncrCompSession::NotInitialized => {
 450                     bug!("Trying to get session directory from IncrCompSession `{:?}`",
 451                         *incr_comp_session)
 452                 }
 453                 IncrCompSession::Active { ref session_directory, .. } |
 454                 IncrCompSession::Finalized { ref session_directory } |
 455                 IncrCompSession::InvalidBecauseOfErrors { ref session_directory } => {
 456                     session_directory
 457                 }
 458             }
 459         })
 460     }
 461
 462     pub fn incr_comp_session_dir_opt(&self) -> Option<cell::Ref<PathBuf>> {
 463         if self.opts.incremental.is_some() {
 464             Some(self.incr_comp_session_dir())
 465         } else {
 466             None
 467         }
 468     }
 469
 470     pub fn print_perf_stats(&self) {
 471         println!("Total time spent computing SVHs:               {}",
 472                  duration_to_secs_str(self.perf_stats.svh_time.get()));
 473         println!("Total time spent computing incr. comp. hashes: {}",
 474                  duration_to_secs_str(self.perf_stats.incr_comp_hashes_time.get()));
 475         println!("Total number of incr. comp. hashes computed:   {}",
 476                  self.perf_stats.incr_comp_hashes_count.get());
 477         println!("Total number of bytes hashed for incr. comp.:  {}",
 478                  self.perf_stats.incr_comp_bytes_hashed.get());
 479         println!("Average bytes hashed per incr. comp. HIR node: {}",
 480                  self.perf_stats.incr_comp_bytes_hashed.get() /
 481                  self.perf_stats.incr_comp_hashes_count.get());
 482         println!("Total time spent computing symbol hashes:      {}",
 483                  duration_to_secs_str(self.perf_stats.symbol_hash_time.get()));
 484     }
 485 }
 486
 487 pub fn build_session(sopts: config::Options,
 488                      dep_graph: &DepGraph,
 489                      local_crate_source_file: Option<PathBuf>,
 490                      registry: errors::registry::Registry,
 491                      cstore: Rc<for<'a> CrateStore<'a>>)
 492                      -> Session {
 493     build_session_with_codemap(sopts,
 494                                dep_graph,
 495                                local_crate_source_file,
 496                                registry,
 497                                cstore,
 498                                Rc::new(codemap::CodeMap::new()),
 499                                None)
 500 }
 501
 502 pub fn build_session_with_codemap(sopts: config::Options,
 503                                   dep_graph: &DepGraph,
 504                                   local_crate_source_file: Option<PathBuf>,
 505                                   registry: errors::registry::Registry,
 506                                   cstore: Rc<for<'a> CrateStore<'a>>,
 507                                   codemap: Rc<codemap::CodeMap>,
 508                                   emitter_dest: Option<Box<Write + Send>>)
 509                                   -> Session {
 510     // FIXME: This is not general enough to make the warning lint completely override
 511     // normal diagnostic warnings, since the warning lint can also be denied and changed
 512     // later via the source code.
 513     let can_print_warnings = sopts.lint_opts
 514         .iter()
 515         .filter(|&&(ref key, _)| *key == "warnings")
 516         .map(|&(_, ref level)| *level != lint::Allow)
 517         .last()
 518         .unwrap_or(true);
 519     let treat_err_as_bug = sopts.debugging_opts.treat_err_as_bug;
 520
 521     let emitter: Box<Emitter> = match (sopts.error_format, emitter_dest) {
 522         (config::ErrorOutputType::HumanReadable(color_config), None) => {
 523             Box::new(EmitterWriter::stderr(color_config,
 524                                            Some(codemap.clone())))
 525         }
 526         (config::ErrorOutputType::HumanReadable(_), Some(dst)) => {
 527             Box::new(EmitterWriter::new(dst,
 528                                         Some(codemap.clone())))
 529         }
 530         (config::ErrorOutputType::Json, None) => {
 531             Box::new(JsonEmitter::stderr(Some(registry), codemap.clone()))
 532         }
 533         (config::ErrorOutputType::Json, Some(dst)) => {
 534             Box::new(JsonEmitter::new(dst, Some(registry), codemap.clone()))
 535         }
 536     };
 537
 538     let diagnostic_handler =
 539         errors::Handler::with_emitter(can_print_warnings,
 540                                       treat_err_as_bug,
 541                                       emitter);
 542
 543     build_session_(sopts,
 544                    dep_graph,
 545                    local_crate_source_file,
 546                    diagnostic_handler,
 547                    codemap,
 548                    cstore)
 549 }
 550
 551 pub fn build_session_(sopts: config::Options,
 552                       dep_graph: &DepGraph,
 553                       local_crate_source_file: Option<PathBuf>,
 554                       span_diagnostic: errors::Handler,
 555                       codemap: Rc<codemap::CodeMap>,
 556                       cstore: Rc<for<'a> CrateStore<'a>>)
 557                       -> Session {
 558     let host = match Target::search(config::host_triple()) {
 559         Ok(t) => t,
 560         Err(e) => {
 561             panic!(span_diagnostic.fatal(&format!("Error loading host specification: {}", e)));
 562     }
 563     };
 564     let target_cfg = config::build_target_config(&sopts, &span_diagnostic);
 565     let p_s = parse::ParseSess::with_span_handler(span_diagnostic, codemap);
 566     let default_sysroot = match sopts.maybe_sysroot {
 567         Some(_) => None,
 568         None => Some(filesearch::get_or_default_sysroot())
 569     };
 570
 571     // Make the path absolute, if necessary
 572     let local_crate_source_file = local_crate_source_file.map(|path|
 573         if path.is_absolute() {
 574             path.clone()
 575         } else {
 576             env::current_dir().unwrap().join(&path)
 577         }
 578     );
 579
 580     let sess = Session {
 581         dep_graph: dep_graph.clone(),
 582         target: target_cfg,
 583         host: host,
 584         opts: sopts,
 585         cstore: cstore,
 586         parse_sess: p_s,
 587         // For a library crate, this is always none
 588         entry_fn: RefCell::new(None),
 589         entry_type: Cell::new(None),
 590         plugin_registrar_fn: Cell::new(None),
 591         derive_registrar_fn: Cell::new(None),
 592         default_sysroot: default_sysroot,
 593         local_crate_source_file: local_crate_source_file,
 594         working_dir: env::current_dir().unwrap(),
 595         lint_store: RefCell::new(lint::LintStore::new()),
 596         lints: RefCell::new(NodeMap()),
 597         one_time_diagnostics: RefCell::new(FnvHashSet()),
 598         plugin_llvm_passes: RefCell::new(Vec::new()),
 599         mir_passes: RefCell::new(mir_pass::Passes::new()),
 600         plugin_attributes: RefCell::new(Vec::new()),
 601         crate_types: RefCell::new(Vec::new()),
 602         dependency_formats: RefCell::new(FnvHashMap()),
 603         crate_disambiguator: RefCell::new(token::intern("").as_str()),
 604         features: RefCell::new(feature_gate::Features::new()),
 605         recursion_limit: Cell::new(64),
 606         next_node_id: Cell::new(NodeId::new(1)),
 607         injected_allocator: Cell::new(None),
 608         injected_panic_runtime: Cell::new(None),
 609         imported_macro_spans: RefCell::new(HashMap::new()),
 610         incr_comp_session: RefCell::new(IncrCompSession::NotInitialized),
 611         perf_stats: PerfStats {
 612             svh_time: Cell::new(Duration::from_secs(0)),
 613             incr_comp_hashes_time: Cell::new(Duration::from_secs(0)),
 614             incr_comp_hashes_count: Cell::new(0),
 615             incr_comp_bytes_hashed: Cell::new(0),
 616             symbol_hash_time: Cell::new(Duration::from_secs(0)),
 617         }
 618     };
 619
 620     init_llvm(&sess);
 621
 622     sess
 623 }
 624
 625 /// Holds data on the current incremental compilation session, if there is one.
 626 #[derive(Debug)]
 627 pub enum IncrCompSession {
 628     // This is the state the session will be in until the incr. comp. dir is
 629     // needed.
 630     NotInitialized,
 631     // This is the state during which the session directory is private and can
 632     // be modified.
 633     Active {
 634         session_directory: PathBuf,
 635         lock_file: flock::Lock,
 636     },
 637     // This is the state after the session directory has been finalized. In this
 638     // state, the contents of the directory must not be modified any more.
 639     Finalized {
 640         session_directory: PathBuf,
 641     },
 642     // This is an error state that is reached when some compilation error has
 643     // occurred. It indicates that the contents of the session directory must
 644     // not be used, since they might be invalid.
 645     InvalidBecauseOfErrors {
 646         session_directory: PathBuf,
 647     }
 648 }
 649
 650 fn init_llvm(sess: &Session) {
 651     unsafe {
 652         // Before we touch LLVM, make sure that multithreading is enabled.
 653         use std::sync::Once;
 654         static INIT: Once = Once::new();
 655         static mut POISONED: bool = false;
 656         INIT.call_once(|| {
 657             if llvm::LLVMStartMultithreaded() != 1 {
 658                 // use an extra bool to make sure that all future usage of LLVM
 659                 // cannot proceed despite the Once not running more than once.
 660                 POISONED = true;
 661             }
 662
 663             configure_llvm(sess);
 664         });
 665
 666         if POISONED {
 667             bug!("couldn't enable multi-threaded LLVM");
 668         }
 669     }
 670 }
 671
 672 unsafe fn configure_llvm(sess: &Session) {
 673     let mut llvm_c_strs = Vec::new();
 674     let mut llvm_args = Vec::new();
 675
 676     {
 677         let mut add = |arg: &str| {
 678             let s = CString::new(arg).unwrap();
 679             llvm_args.push(s.as_ptr());
 680             llvm_c_strs.push(s);
 681         };
 682         add("rustc"); // fake program name
 683         if sess.time_llvm_passes() { add("-time-passes"); }
 684         if sess.print_llvm_passes() { add("-debug-pass=Structure"); }
 685
 686         for arg in &sess.opts.cg.llvm_args {
 687             add(&(*arg));
 688         }
 689     }
 690
 691     llvm::LLVMInitializePasses();
 692
 693     llvm::initialize_available_targets();
 694
 695     llvm::LLVMRustSetLLVMOptions(llvm_args.len() as c_int,
 696                                  llvm_args.as_ptr());
 697 }
 698
 699 pub fn early_error(output: config::ErrorOutputType, msg: &str) -> ! {
 700     let emitter: Box<Emitter> = match output {
 701         config::ErrorOutputType::HumanReadable(color_config) => {
 702             Box::new(EmitterWriter::stderr(color_config,
 703                                            None))
 704         }
 705         config::ErrorOutputType::Json => Box::new(JsonEmitter::basic()),
 706     };
 707     let handler = errors::Handler::with_emitter(true, false, emitter);
 708     handler.emit(&MultiSpan::new(), msg, errors::Level::Fatal);
 709     panic!(errors::FatalError);
 710 }
 711
 712 pub fn early_warn(output: config::ErrorOutputType, msg: &str) {
 713     let emitter: Box<Emitter> = match output {
 714         config::ErrorOutputType::HumanReadable(color_config) => {
 715             Box::new(EmitterWriter::stderr(color_config,
 716                                            None))
 717         }
 718         config::ErrorOutputType::Json => Box::new(JsonEmitter::basic()),
 719     };
 720     let handler = errors::Handler::with_emitter(true, false, emitter);
 721     handler.emit(&MultiSpan::new(), msg, errors::Level::Warning);
 722 }
 723
 724 // Err(0) means compilation was stopped, but no errors were found.
 725 // This would be better as a dedicated enum, but using try! is so convenient.
 726 pub type CompileResult = Result<(), usize>;
 727
 728 pub fn compile_result_from_err_count(err_count: usize) -> CompileResult {
 729     if err_count == 0 {
 730         Ok(())
 731     } else {
 732         Err(err_count)
 733     }
 734 }
 735
 736 #[cold]
 737 #[inline(never)]
 738 pub fn bug_fmt(file: &'static str, line: u32, args: fmt::Arguments) -> ! {
 739     // this wrapper mostly exists so I don't have to write a fully
 740     // qualified path of None::<Span> inside the bug!() macro defintion
 741     opt_span_bug_fmt(file, line, None::<Span>, args);
 742 }
 743
 744 #[cold]
 745 #[inline(never)]
 746 pub fn span_bug_fmt<S: Into<MultiSpan>>(file: &'static str,
 747                                         line: u32,
 748                                         span: S,
 749                                         args: fmt::Arguments) -> ! {
 750     opt_span_bug_fmt(file, line, Some(span), args);
 751 }
 752
 753 fn opt_span_bug_fmt<S: Into<MultiSpan>>(file: &'static str,
 754                                         line: u32,
 755                                         span: Option<S>,
 756                                         args: fmt::Arguments) -> ! {
 757     tls::with_opt(move |tcx| {
 758         let msg = format!("{}:{}: {}", file, line, args);
 759         match (tcx, span) {
 760             (Some(tcx), Some(span)) => tcx.sess.diagnostic().span_bug(span, &msg),
 761             (Some(tcx), None) => tcx.sess.diagnostic().bug(&msg),
 762             (None, _) => panic!(msg)
 763         }
 764     });
 765     unreachable!();
 766 }