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 pub use self::code_stats::{CodeStats, DataTypeKind, FieldInfo};
  12 pub use self::code_stats::{SizeKind, TypeSizeInfo, VariantInfo};
  13
  14 use hir::def_id::CrateNum;
  15 use ich::Fingerprint;
  16
  17 use ich;
  18 use lint;
  19 use lint::builtin::BuiltinLintDiagnostics;
  20 use middle::allocator::AllocatorKind;
  21 use middle::dependency_format;
  22 use session::search_paths::PathKind;
  23 use session::config::{DebugInfoLevel, OutputType};
  24 use ty::tls;
  25 use util::nodemap::{FxHashSet};
  26 use util::common::{duration_to_secs_str, ErrorReported};
  27 use util::common::ProfileQueriesMsg;
  28
  29 use rustc_data_structures::sync::{self, Lrc, Lock, LockCell, OneThread, Once, RwLock};
  30
  31 use syntax::ast::NodeId;
  32 use errors::{self, DiagnosticBuilder, DiagnosticId};
  33 use errors::emitter::{Emitter, EmitterWriter};
  34 use syntax::edition::Edition;
  35 use syntax::json::JsonEmitter;
  36 use syntax::feature_gate;
  37 use syntax::symbol::Symbol;
  38 use syntax::parse;
  39 use syntax::parse::ParseSess;
  40 use syntax::{ast, codemap};
  41 use syntax::feature_gate::AttributeType;
  42 use syntax_pos::{MultiSpan, Span};
  43
  44 use rustc_back::{LinkerFlavor, PanicStrategy};
  45 use rustc_back::target::{Target, TargetTriple};
  46 use rustc_data_structures::flock;
  47 use jobserver::Client;
  48
  49 use std;
  50 use std::cell::{self, Cell, RefCell};
  51 use std::collections::HashMap;
  52 use std::env;
  53 use std::fmt;
  54 use std::io::Write;
  55 use std::path::{Path, PathBuf};
  56 use std::time::Duration;
  57 use std::sync::mpsc;
  58 use std::sync::atomic::{AtomicUsize, Ordering};
  59
  60 mod code_stats;
  61 pub mod config;
  62 pub mod filesearch;
  63 pub mod search_paths;
  64
  65 /// Represents the data associated with a compilation
  66 /// session for a single crate.
  67 pub struct Session {
  68     pub target: config::Config,
  69     pub host: Target,
  70     pub opts: config::Options,
  71     pub parse_sess: ParseSess,
  72     /// For a library crate, this is always none
  73     pub entry_fn: Once<Option<(NodeId, Span, config::EntryFnType)>>,
  74     pub plugin_registrar_fn: Once<Option<ast::NodeId>>,
  75     pub derive_registrar_fn: Once<Option<ast::NodeId>>,
  76     pub default_sysroot: Option<PathBuf>,
  77     /// The name of the root source file of the crate, in the local file system.
  78     /// `None` means that there is no source file.
  79     pub local_crate_source_file: Option<PathBuf>,
  80     /// The directory the compiler has been executed in plus a flag indicating
  81     /// if the value stored here has been affected by path remapping.
  82     pub working_dir: (PathBuf, bool),
  83
  84     // FIXME: lint_store and buffered_lints are not thread-safe,
  85     // but are only used in a single thread
  86     pub lint_store: RwLock<lint::LintStore>,
  87     pub buffered_lints: Lock<Option<lint::LintBuffer>>,
  88
  89     /// Set of (DiagnosticId, Option<Span>, message) tuples tracking
  90     /// (sub)diagnostics that have been set once, but should not be set again,
  91     /// in order to avoid redundantly verbose output (Issue #24690, #44953).
  92     pub one_time_diagnostics: Lock<FxHashSet<(DiagnosticMessageId, Option<Span>, String)>>,
  93     pub plugin_llvm_passes: OneThread<RefCell<Vec<String>>>,
  94     pub plugin_attributes: OneThread<RefCell<Vec<(String, AttributeType)>>>,
  95     pub crate_types: Once<Vec<config::CrateType>>,
  96     pub dependency_formats: Once<dependency_format::Dependencies>,
  97     /// The crate_disambiguator is constructed out of all the `-C metadata`
  98     /// arguments passed to the compiler. Its value together with the crate-name
  99     /// forms a unique global identifier for the crate. It is used to allow
 100     /// multiple crates with the same name to coexist. See the
 101     /// trans::back::symbol_names module for more information.
 102     pub crate_disambiguator: Once<CrateDisambiguator>,
 103
 104     features: Once<feature_gate::Features>,
 105
 106     /// The maximum recursion limit for potentially infinitely recursive
 107     /// operations such as auto-dereference and monomorphization.
 108     pub recursion_limit: Once<usize>,
 109
 110     /// The maximum length of types during monomorphization.
 111     pub type_length_limit: Once<usize>,
 112
 113     /// The maximum number of stackframes allowed in const eval
 114     pub const_eval_stack_frame_limit: usize,
 115
 116     /// The metadata::creader module may inject an allocator/panic_runtime
 117     /// dependency if it didn't already find one, and this tracks what was
 118     /// injected.
 119     pub injected_allocator: Once<Option<CrateNum>>,
 120     pub allocator_kind: Once<Option<AllocatorKind>>,
 121     pub injected_panic_runtime: Once<Option<CrateNum>>,
 122
 123     /// Map from imported macro spans (which consist of
 124     /// the localized span for the macro body) to the
 125     /// macro name and definition span in the source crate.
 126     pub imported_macro_spans: OneThread<RefCell<HashMap<Span, (String, Span)>>>,
 127
 128     incr_comp_session: OneThread<RefCell<IncrCompSession>>,
 129
 130     /// A cache of attributes ignored by StableHashingContext
 131     pub ignored_attr_names: FxHashSet<Symbol>,
 132
 133     /// Used by -Z profile-queries in util::common
 134     pub profile_channel: Lock<Option<mpsc::Sender<ProfileQueriesMsg>>>,
 135
 136     /// Some measurements that are being gathered during compilation.
 137     pub perf_stats: PerfStats,
 138
 139     /// Data about code being compiled, gathered during compilation.
 140     pub code_stats: Lock<CodeStats>,
 141
 142     next_node_id: OneThread<Cell<ast::NodeId>>,
 143
 144     /// If -zfuel=crate=n is specified, Some(crate).
 145     optimization_fuel_crate: Option<String>,
 146     /// If -zfuel=crate=n is specified, initially set to n. Otherwise 0.
 147     optimization_fuel_limit: LockCell<u64>,
 148     /// We're rejecting all further optimizations.
 149     out_of_fuel: LockCell<bool>,
 150
 151     // The next two are public because the driver needs to read them.
 152     /// If -zprint-fuel=crate, Some(crate).
 153     pub print_fuel_crate: Option<String>,
 154     /// Always set to zero and incremented so that we can print fuel expended by a crate.
 155     pub print_fuel: LockCell<u64>,
 156
 157     /// Loaded up early on in the initialization of this `Session` to avoid
 158     /// false positives about a job server in our environment.
 159     pub jobserver: Client,
 160
 161     /// Metadata about the allocators for the current crate being compiled
 162     pub has_global_allocator: Once<bool>,
 163 }
 164
 165 pub struct PerfStats {
 166     /// The accumulated time spent on computing symbol hashes
 167     pub symbol_hash_time: Lock<Duration>,
 168     /// The accumulated time spent decoding def path tables from metadata
 169     pub decode_def_path_tables_time: Lock<Duration>,
 170     /// Total number of values canonicalized queries constructed.
 171     pub queries_canonicalized: AtomicUsize,
 172     /// Number of times this query is invoked.
 173     pub normalize_ty_after_erasing_regions: AtomicUsize,
 174     /// Number of times this query is invoked.
 175     pub normalize_projection_ty: AtomicUsize,
 176 }
 177
 178 /// Enum to support dispatch of one-time diagnostics (in Session.diag_once)
 179 enum DiagnosticBuilderMethod {
 180     Note,
 181     SpanNote,
 182     SpanSuggestion(String), // suggestion
 183                             // add more variants as needed to support one-time diagnostics
 184 }
 185
 186 /// Diagnostic message ID—used by `Session.one_time_diagnostics` to avoid
 187 /// emitting the same message more than once
 188 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 189 pub enum DiagnosticMessageId {
 190     ErrorId(u16), // EXXXX error code as integer
 191     LintId(lint::LintId),
 192     StabilityId(u32), // issue number
 193 }
 194
 195 impl From<&'static lint::Lint> for DiagnosticMessageId {
 196     fn from(lint: &'static lint::Lint) -> Self {
 197         DiagnosticMessageId::LintId(lint::LintId::of(lint))
 198     }
 199 }
 200
 201 impl Session {
 202     pub fn local_crate_disambiguator(&self) -> CrateDisambiguator {
 203         *self.crate_disambiguator.get()
 204     }
 205
 206     pub fn struct_span_warn<'a, S: Into<MultiSpan>>(
 207         &'a self,
 208         sp: S,
 209         msg: &str,
 210     ) -> DiagnosticBuilder<'a> {
 211         self.diagnostic().struct_span_warn(sp, msg)
 212     }
 213     pub fn struct_span_warn_with_code<'a, S: Into<MultiSpan>>(
 214         &'a self,
 215         sp: S,
 216         msg: &str,
 217         code: DiagnosticId,
 218     ) -> DiagnosticBuilder<'a> {
 219         self.diagnostic().struct_span_warn_with_code(sp, msg, code)
 220     }
 221     pub fn struct_warn<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a> {
 222         self.diagnostic().struct_warn(msg)
 223     }
 224     pub fn struct_span_err<'a, S: Into<MultiSpan>>(
 225         &'a self,
 226         sp: S,
 227         msg: &str,
 228     ) -> DiagnosticBuilder<'a> {
 229         self.diagnostic().struct_span_err(sp, msg)
 230     }
 231     pub fn struct_span_err_with_code<'a, S: Into<MultiSpan>>(
 232         &'a self,
 233         sp: S,
 234         msg: &str,
 235         code: DiagnosticId,
 236     ) -> DiagnosticBuilder<'a> {
 237         self.diagnostic().struct_span_err_with_code(sp, msg, code)
 238     }
 239     // FIXME: This method should be removed (every error should have an associated error code).
 240     pub fn struct_err<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a> {
 241         self.diagnostic().struct_err(msg)
 242     }
 243     pub fn struct_err_with_code<'a>(
 244         &'a self,
 245         msg: &str,
 246         code: DiagnosticId,
 247     ) -> DiagnosticBuilder<'a> {
 248         self.diagnostic().struct_err_with_code(msg, code)
 249     }
 250     pub fn struct_span_fatal<'a, S: Into<MultiSpan>>(
 251         &'a self,
 252         sp: S,
 253         msg: &str,
 254     ) -> DiagnosticBuilder<'a> {
 255         self.diagnostic().struct_span_fatal(sp, msg)
 256     }
 257     pub fn struct_span_fatal_with_code<'a, S: Into<MultiSpan>>(
 258         &'a self,
 259         sp: S,
 260         msg: &str,
 261         code: DiagnosticId,
 262     ) -> DiagnosticBuilder<'a> {
 263         self.diagnostic().struct_span_fatal_with_code(sp, msg, code)
 264     }
 265     pub fn struct_fatal<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a> {
 266         self.diagnostic().struct_fatal(msg)
 267     }
 268
 269     pub fn span_fatal<S: Into<MultiSpan>>(&self, sp: S, msg: &str) -> ! {
 270         self.diagnostic().span_fatal(sp, msg).raise()
 271     }
 272     pub fn span_fatal_with_code<S: Into<MultiSpan>>(
 273         &self,
 274         sp: S,
 275         msg: &str,
 276         code: DiagnosticId,
 277     ) -> ! {
 278         self.diagnostic()
 279             .span_fatal_with_code(sp, msg, code)
 280             .raise()
 281     }
 282     pub fn fatal(&self, msg: &str) -> ! {
 283         self.diagnostic().fatal(msg).raise()
 284     }
 285     pub fn span_err_or_warn<S: Into<MultiSpan>>(&self, is_warning: bool, sp: S, msg: &str) {
 286         if is_warning {
 287             self.span_warn(sp, msg);
 288         } else {
 289             self.span_err(sp, msg);
 290         }
 291     }
 292     pub fn span_err<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
 293         self.diagnostic().span_err(sp, msg)
 294     }
 295     pub fn span_err_with_code<S: Into<MultiSpan>>(&self, sp: S, msg: &str, code: DiagnosticId) {
 296         self.diagnostic().span_err_with_code(sp, &msg, code)
 297     }
 298     pub fn err(&self, msg: &str) {
 299         self.diagnostic().err(msg)
 300     }
 301     pub fn err_count(&self) -> usize {
 302         self.diagnostic().err_count()
 303     }
 304     pub fn has_errors(&self) -> bool {
 305         self.diagnostic().has_errors()
 306     }
 307     pub fn abort_if_errors(&self) {
 308         self.diagnostic().abort_if_errors();
 309     }
 310     pub fn compile_status(&self) -> Result<(), CompileIncomplete> {
 311         compile_result_from_err_count(self.err_count())
 312     }
 313     pub fn track_errors<F, T>(&self, f: F) -> Result<T, ErrorReported>
 314     where
 315         F: FnOnce() -> T,
 316     {
 317         let old_count = self.err_count();
 318         let result = f();
 319         let errors = self.err_count() - old_count;
 320         if errors == 0 {
 321             Ok(result)
 322         } else {
 323             Err(ErrorReported)
 324         }
 325     }
 326     pub fn span_warn<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
 327         self.diagnostic().span_warn(sp, msg)
 328     }
 329     pub fn span_warn_with_code<S: Into<MultiSpan>>(&self, sp: S, msg: &str, code: DiagnosticId) {
 330         self.diagnostic().span_warn_with_code(sp, msg, code)
 331     }
 332     pub fn warn(&self, msg: &str) {
 333         self.diagnostic().warn(msg)
 334     }
 335     pub fn opt_span_warn<S: Into<MultiSpan>>(&self, opt_sp: Option<S>, msg: &str) {
 336         match opt_sp {
 337             Some(sp) => self.span_warn(sp, msg),
 338             None => self.warn(msg),
 339         }
 340     }
 341     /// Delay a span_bug() call until abort_if_errors()
 342     pub fn delay_span_bug<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
 343         self.diagnostic().delay_span_bug(sp, msg)
 344     }
 345     pub fn note_without_error(&self, msg: &str) {
 346         self.diagnostic().note_without_error(msg)
 347     }
 348     pub fn span_note_without_error<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
 349         self.diagnostic().span_note_without_error(sp, msg)
 350     }
 351     pub fn span_unimpl<S: Into<MultiSpan>>(&self, sp: S, msg: &str) -> ! {
 352         self.diagnostic().span_unimpl(sp, msg)
 353     }
 354     pub fn unimpl(&self, msg: &str) -> ! {
 355         self.diagnostic().unimpl(msg)
 356     }
 357
 358     pub fn buffer_lint<S: Into<MultiSpan>>(
 359         &self,
 360         lint: &'static lint::Lint,
 361         id: ast::NodeId,
 362         sp: S,
 363         msg: &str,
 364     ) {
 365         match *self.buffered_lints.borrow_mut() {
 366             Some(ref mut buffer) => {
 367                 buffer.add_lint(lint, id, sp.into(), msg, BuiltinLintDiagnostics::Normal)
 368             }
 369             None => bug!("can't buffer lints after HIR lowering"),
 370         }
 371     }
 372
 373     pub fn buffer_lint_with_diagnostic<S: Into<MultiSpan>>(
 374         &self,
 375         lint: &'static lint::Lint,
 376         id: ast::NodeId,
 377         sp: S,
 378         msg: &str,
 379         diagnostic: BuiltinLintDiagnostics,
 380     ) {
 381         match *self.buffered_lints.borrow_mut() {
 382             Some(ref mut buffer) => buffer.add_lint(lint, id, sp.into(), msg, diagnostic),
 383             None => bug!("can't buffer lints after HIR lowering"),
 384         }
 385     }
 386
 387     pub fn reserve_node_ids(&self, count: usize) -> ast::NodeId {
 388         let id = self.next_node_id.get();
 389
 390         match id.as_usize().checked_add(count) {
 391             Some(next) => {
 392                 self.next_node_id.set(ast::NodeId::new(next));
 393             }
 394             None => bug!("Input too large, ran out of node ids!"),
 395         }
 396
 397         id
 398     }
 399     pub fn next_node_id(&self) -> NodeId {
 400         self.reserve_node_ids(1)
 401     }
 402     pub fn diagnostic<'a>(&'a self) -> &'a errors::Handler {
 403         &self.parse_sess.span_diagnostic
 404     }
 405
 406     /// Analogous to calling methods on the given `DiagnosticBuilder`, but
 407     /// deduplicates on lint ID, span (if any), and message for this `Session`
 408     fn diag_once<'a, 'b>(
 409         &'a self,
 410         diag_builder: &'b mut DiagnosticBuilder<'a>,
 411         method: DiagnosticBuilderMethod,
 412         msg_id: DiagnosticMessageId,
 413         message: &str,
 414         span_maybe: Option<Span>,
 415     ) {
 416         let id_span_message = (msg_id, span_maybe, message.to_owned());
 417         let fresh = self.one_time_diagnostics
 418             .borrow_mut()
 419             .insert(id_span_message);
 420         if fresh {
 421             match method {
 422                 DiagnosticBuilderMethod::Note => {
 423                     diag_builder.note(message);
 424                 }
 425                 DiagnosticBuilderMethod::SpanNote => {
 426                     let span = span_maybe.expect("span_note needs a span");
 427                     diag_builder.span_note(span, message);
 428                 }
 429                 DiagnosticBuilderMethod::SpanSuggestion(suggestion) => {
 430                     let span = span_maybe.expect("span_suggestion needs a span");
 431                     diag_builder.span_suggestion(span, message, suggestion);
 432                 }
 433             }
 434         }
 435     }
 436
 437     pub fn diag_span_note_once<'a, 'b>(
 438         &'a self,
 439         diag_builder: &'b mut DiagnosticBuilder<'a>,
 440         msg_id: DiagnosticMessageId,
 441         span: Span,
 442         message: &str,
 443     ) {
 444         self.diag_once(
 445             diag_builder,
 446             DiagnosticBuilderMethod::SpanNote,
 447             msg_id,
 448             message,
 449             Some(span),
 450         );
 451     }
 452
 453     pub fn diag_note_once<'a, 'b>(
 454         &'a self,
 455         diag_builder: &'b mut DiagnosticBuilder<'a>,
 456         msg_id: DiagnosticMessageId,
 457         message: &str,
 458     ) {
 459         self.diag_once(
 460             diag_builder,
 461             DiagnosticBuilderMethod::Note,
 462             msg_id,
 463             message,
 464             None,
 465         );
 466     }
 467
 468     pub fn diag_span_suggestion_once<'a, 'b>(
 469         &'a self,
 470         diag_builder: &'b mut DiagnosticBuilder<'a>,
 471         msg_id: DiagnosticMessageId,
 472         span: Span,
 473         message: &str,
 474         suggestion: String,
 475     ) {
 476         self.diag_once(
 477             diag_builder,
 478             DiagnosticBuilderMethod::SpanSuggestion(suggestion),
 479             msg_id,
 480             message,
 481             Some(span),
 482         );
 483     }
 484
 485     pub fn codemap<'a>(&'a self) -> &'a codemap::CodeMap {
 486         self.parse_sess.codemap()
 487     }
 488     pub fn verbose(&self) -> bool {
 489         self.opts.debugging_opts.verbose
 490     }
 491     pub fn time_passes(&self) -> bool {
 492         self.opts.debugging_opts.time_passes
 493     }
 494     pub fn profile_queries(&self) -> bool {
 495         self.opts.debugging_opts.profile_queries
 496             || self.opts.debugging_opts.profile_queries_and_keys
 497     }
 498     pub fn profile_queries_and_keys(&self) -> bool {
 499         self.opts.debugging_opts.profile_queries_and_keys
 500     }
 501     pub fn count_llvm_insns(&self) -> bool {
 502         self.opts.debugging_opts.count_llvm_insns
 503     }
 504     pub fn time_llvm_passes(&self) -> bool {
 505         self.opts.debugging_opts.time_llvm_passes
 506     }
 507     pub fn trans_stats(&self) -> bool {
 508         self.opts.debugging_opts.trans_stats
 509     }
 510     pub fn meta_stats(&self) -> bool {
 511         self.opts.debugging_opts.meta_stats
 512     }
 513     pub fn asm_comments(&self) -> bool {
 514         self.opts.debugging_opts.asm_comments
 515     }
 516     pub fn no_verify(&self) -> bool {
 517         self.opts.debugging_opts.no_verify
 518     }
 519     pub fn borrowck_stats(&self) -> bool {
 520         self.opts.debugging_opts.borrowck_stats
 521     }
 522     pub fn print_llvm_passes(&self) -> bool {
 523         self.opts.debugging_opts.print_llvm_passes
 524     }
 525
 526     /// Get the features enabled for the current compilation session.
 527     /// DO NOT USE THIS METHOD if there is a TyCtxt available, as it circumvents
 528     /// dependency tracking. Use tcx.features() instead.
 529     #[inline]
 530     pub fn features_untracked(&self) -> &feature_gate::Features {
 531         self.features.get()
 532     }
 533
 534     pub fn init_features(&self, features: feature_gate::Features) {
 535         self.features.set(features);
 536     }
 537
 538     /// Calculates the flavor of LTO to use for this compilation.
 539     pub fn lto(&self) -> config::Lto {
 540         // If our target has codegen requirements ignore the command line
 541         if self.target.target.options.requires_lto {
 542             return config::Lto::Fat;
 543         }
 544
 545         // If the user specified something, return that. If they only said `-C
 546         // lto` and we've for whatever reason forced off ThinLTO via the CLI,
 547         // then ensure we can't use a ThinLTO.
 548         match self.opts.cg.lto {
 549             config::Lto::No => {}
 550             config::Lto::Yes if self.opts.cli_forced_thinlto_off => return config::Lto::Fat,
 551             other => return other,
 552         }
 553
 554         // Ok at this point the target doesn't require anything and the user
 555         // hasn't asked for anything. Our next decision is whether or not
 556         // we enable "auto" ThinLTO where we use multiple codegen units and
 557         // then do ThinLTO over those codegen units. The logic below will
 558         // either return `No` or `ThinLocal`.
 559
 560         // If processing command line options determined that we're incompatible
 561         // with ThinLTO (e.g. `-C lto --emit llvm-ir`) then return that option.
 562         if self.opts.cli_forced_thinlto_off {
 563             return config::Lto::No;
 564         }
 565
 566         // If `-Z thinlto` specified process that, but note that this is mostly
 567         // a deprecated option now that `-C lto=thin` exists.
 568         if let Some(enabled) = self.opts.debugging_opts.thinlto {
 569             if enabled {
 570                 return config::Lto::ThinLocal;
 571             } else {
 572                 return config::Lto::No;
 573             }
 574         }
 575
 576         // If there's only one codegen unit and LTO isn't enabled then there's
 577         // no need for ThinLTO so just return false.
 578         if self.codegen_units() == 1 {
 579             return config::Lto::No;
 580         }
 581
 582         // Right now ThinLTO isn't compatible with incremental compilation.
 583         if self.opts.incremental.is_some() {
 584             return config::Lto::No;
 585         }
 586
 587         // Now we're in "defaults" territory. By default we enable ThinLTO for
 588         // optimized compiles (anything greater than O0).
 589         match self.opts.optimize {
 590             config::OptLevel::No => config::Lto::No,
 591             _ => config::Lto::ThinLocal,
 592         }
 593     }
 594
 595     /// Returns the panic strategy for this compile session. If the user explicitly selected one
 596     /// using '-C panic', use that, otherwise use the panic strategy defined by the target.
 597     pub fn panic_strategy(&self) -> PanicStrategy {
 598         self.opts
 599             .cg
 600             .panic
 601             .unwrap_or(self.target.target.options.panic_strategy)
 602     }
 603     pub fn linker_flavor(&self) -> LinkerFlavor {
 604         self.opts
 605             .debugging_opts
 606             .linker_flavor
 607             .unwrap_or(self.target.target.linker_flavor)
 608     }
 609
 610     pub fn fewer_names(&self) -> bool {
 611         let more_names = self.opts
 612             .output_types
 613             .contains_key(&OutputType::LlvmAssembly)
 614             || self.opts.output_types.contains_key(&OutputType::Bitcode);
 615         self.opts.debugging_opts.fewer_names || !more_names
 616     }
 617
 618     pub fn no_landing_pads(&self) -> bool {
 619         self.opts.debugging_opts.no_landing_pads || self.panic_strategy() == PanicStrategy::Abort
 620     }
 621     pub fn unstable_options(&self) -> bool {
 622         self.opts.debugging_opts.unstable_options
 623     }
 624     pub fn nonzeroing_move_hints(&self) -> bool {
 625         self.opts.debugging_opts.enable_nonzeroing_move_hints
 626     }
 627     pub fn overflow_checks(&self) -> bool {
 628         self.opts
 629             .cg
 630             .overflow_checks
 631             .or(self.opts.debugging_opts.force_overflow_checks)
 632             .unwrap_or(self.opts.debug_assertions)
 633     }
 634
 635     pub fn crt_static(&self) -> bool {
 636         // If the target does not opt in to crt-static support, use its default.
 637         if self.target.target.options.crt_static_respected {
 638             self.crt_static_feature()
 639         } else {
 640             self.target.target.options.crt_static_default
 641         }
 642     }
 643
 644     pub fn crt_static_feature(&self) -> bool {
 645         let requested_features = self.opts.cg.target_feature.split(',');
 646         let found_negative = requested_features.clone().any(|r| r == "-crt-static");
 647         let found_positive = requested_features.clone().any(|r| r == "+crt-static");
 648
 649         // If the target we're compiling for requests a static crt by default,
 650         // then see if the `-crt-static` feature was passed to disable that.
 651         // Otherwise if we don't have a static crt by default then see if the
 652         // `+crt-static` feature was passed.
 653         if self.target.target.options.crt_static_default {
 654             !found_negative
 655         } else {
 656             found_positive
 657         }
 658     }
 659
 660     pub fn must_not_eliminate_frame_pointers(&self) -> bool {
 661         self.opts.debuginfo != DebugInfoLevel::NoDebugInfo
 662             || !self.target.target.options.eliminate_frame_pointer
 663     }
 664
 665     /// Returns the symbol name for the registrar function,
 666     /// given the crate Svh and the function DefIndex.
 667     pub fn generate_plugin_registrar_symbol(&self, disambiguator: CrateDisambiguator) -> String {
 668         format!(
 669             "__rustc_plugin_registrar_{}__",
 670             disambiguator.to_fingerprint().to_hex()
 671         )
 672     }
 673
 674     pub fn generate_derive_registrar_symbol(&self, disambiguator: CrateDisambiguator) -> String {
 675         format!(
 676             "__rustc_derive_registrar_{}__",
 677             disambiguator.to_fingerprint().to_hex()
 678         )
 679     }
 680
 681     pub fn sysroot<'a>(&'a self) -> &'a Path {
 682         match self.opts.maybe_sysroot {
 683             Some(ref sysroot) => sysroot,
 684             None => self.default_sysroot
 685                 .as_ref()
 686                 .expect("missing sysroot and default_sysroot in Session"),
 687         }
 688     }
 689     pub fn target_filesearch(&self, kind: PathKind) -> filesearch::FileSearch {
 690         filesearch::FileSearch::new(
 691             self.sysroot(),
 692             self.opts.target_triple.triple(),
 693             &self.opts.search_paths,
 694             kind,
 695         )
 696     }
 697     pub fn host_filesearch(&self, kind: PathKind) -> filesearch::FileSearch {
 698         filesearch::FileSearch::new(
 699             self.sysroot(),
 700             config::host_triple(),
 701             &self.opts.search_paths,
 702             kind,
 703         )
 704     }
 705
 706     pub fn set_incr_session_load_dep_graph(&self, load: bool) {
 707         let mut incr_comp_session = self.incr_comp_session.borrow_mut();
 708
 709         match *incr_comp_session {
 710             IncrCompSession::Active {
 711                 ref mut load_dep_graph,
 712                 ..
 713             } => {
 714                 *load_dep_graph = load;
 715             }
 716             _ => {}
 717         }
 718     }
 719
 720     pub fn incr_session_load_dep_graph(&self) -> bool {
 721         let incr_comp_session = self.incr_comp_session.borrow();
 722         match *incr_comp_session {
 723             IncrCompSession::Active { load_dep_graph, .. } => load_dep_graph,
 724             _ => false,
 725         }
 726     }
 727
 728     pub fn init_incr_comp_session(
 729         &self,
 730         session_dir: PathBuf,
 731         lock_file: flock::Lock,
 732         load_dep_graph: bool,
 733     ) {
 734         let mut incr_comp_session = self.incr_comp_session.borrow_mut();
 735
 736         if let IncrCompSession::NotInitialized = *incr_comp_session {
 737         } else {
 738             bug!(
 739                 "Trying to initialize IncrCompSession `{:?}`",
 740                 *incr_comp_session
 741             )
 742         }
 743
 744         *incr_comp_session = IncrCompSession::Active {
 745             session_directory: session_dir,
 746             lock_file,
 747             load_dep_graph,
 748         };
 749     }
 750
 751     pub fn finalize_incr_comp_session(&self, new_directory_path: PathBuf) {
 752         let mut incr_comp_session = self.incr_comp_session.borrow_mut();
 753
 754         if let IncrCompSession::Active { .. } = *incr_comp_session {
 755         } else {
 756             bug!(
 757                 "Trying to finalize IncrCompSession `{:?}`",
 758                 *incr_comp_session
 759             )
 760         }
 761
 762         // Note: This will also drop the lock file, thus unlocking the directory
 763         *incr_comp_session = IncrCompSession::Finalized {
 764             session_directory: new_directory_path,
 765         };
 766     }
 767
 768     pub fn mark_incr_comp_session_as_invalid(&self) {
 769         let mut incr_comp_session = self.incr_comp_session.borrow_mut();
 770
 771         let session_directory = match *incr_comp_session {
 772             IncrCompSession::Active {
 773                 ref session_directory,
 774                 ..
 775             } => session_directory.clone(),
 776             IncrCompSession::InvalidBecauseOfErrors { .. } => return,
 777             _ => bug!(
 778                 "Trying to invalidate IncrCompSession `{:?}`",
 779                 *incr_comp_session
 780             ),
 781         };
 782
 783         // Note: This will also drop the lock file, thus unlocking the directory
 784         *incr_comp_session = IncrCompSession::InvalidBecauseOfErrors { session_directory };
 785     }
 786
 787     pub fn incr_comp_session_dir(&self) -> cell::Ref<PathBuf> {
 788         let incr_comp_session = self.incr_comp_session.borrow();
 789         cell::Ref::map(
 790             incr_comp_session,
 791             |incr_comp_session| match *incr_comp_session {
 792                 IncrCompSession::NotInitialized => bug!(
 793                     "Trying to get session directory from IncrCompSession `{:?}`",
 794                     *incr_comp_session
 795                 ),
 796                 IncrCompSession::Active {
 797                     ref session_directory,
 798                     ..
 799                 }
 800                 | IncrCompSession::Finalized {
 801                     ref session_directory,
 802                 }
 803                 | IncrCompSession::InvalidBecauseOfErrors {
 804                     ref session_directory,
 805                 } => session_directory,
 806             },
 807         )
 808     }
 809
 810     pub fn incr_comp_session_dir_opt(&self) -> Option<cell::Ref<PathBuf>> {
 811         if self.opts.incremental.is_some() {
 812             Some(self.incr_comp_session_dir())
 813         } else {
 814             None
 815         }
 816     }
 817
 818     pub fn print_perf_stats(&self) {
 819         println!(
 820             "Total time spent computing symbol hashes:      {}",
 821             duration_to_secs_str(*self.perf_stats.symbol_hash_time.lock())
 822         );
 823         println!(
 824             "Total time spent decoding DefPath tables:      {}",
 825             duration_to_secs_str(*self.perf_stats.decode_def_path_tables_time.lock())
 826         );
 827         println!("Total queries canonicalized:                   {}",
 828                  self.perf_stats.queries_canonicalized.load(Ordering::Relaxed));
 829         println!("normalize_ty_after_erasing_regions:            {}",
 830                  self.perf_stats.normalize_ty_after_erasing_regions.load(Ordering::Relaxed));
 831         println!("normalize_projection_ty:                       {}",
 832                  self.perf_stats.normalize_projection_ty.load(Ordering::Relaxed));
 833     }
 834
 835     /// We want to know if we're allowed to do an optimization for crate foo from -z fuel=foo=n.
 836     /// This expends fuel if applicable, and records fuel if applicable.
 837     pub fn consider_optimizing<T: Fn() -> String>(&self, crate_name: &str, msg: T) -> bool {
 838         assert!(self.query_threads() == 1);
 839         let mut ret = true;
 840         match self.optimization_fuel_crate {
 841             Some(ref c) if c == crate_name => {
 842                 let fuel = self.optimization_fuel_limit.get();
 843                 ret = fuel != 0;
 844                 if fuel == 0 && !self.out_of_fuel.get() {
 845                     println!("optimization-fuel-exhausted: {}", msg());
 846                     self.out_of_fuel.set(true);
 847                 } else if fuel > 0 {
 848                     self.optimization_fuel_limit.set(fuel - 1);
 849                 }
 850             }
 851             _ => {}
 852         }
 853         match self.print_fuel_crate {
 854             Some(ref c) if c == crate_name => {
 855                 self.print_fuel.set(self.print_fuel.get() + 1);
 856             }
 857             _ => {}
 858         }
 859         ret
 860     }
 861
 862     /// Returns the number of query threads that should be used for this
 863     /// compilation
 864     pub fn query_threads(&self) -> usize {
 865         self.opts.debugging_opts.query_threads.unwrap_or(1)
 866     }
 867
 868     /// Returns the number of codegen units that should be used for this
 869     /// compilation
 870     pub fn codegen_units(&self) -> usize {
 871         if let Some(n) = self.opts.cli_forced_codegen_units {
 872             return n;
 873         }
 874         if let Some(n) = self.target.target.options.default_codegen_units {
 875             return n as usize;
 876         }
 877
 878         // Why is 16 codegen units the default all the time?
 879         //
 880         // The main reason for enabling multiple codegen units by default is to
 881         // leverage the ability for the trans backend to do translation and
 882         // codegen in parallel. This allows us, especially for large crates, to
 883         // make good use of all available resources on the machine once we've
 884         // hit that stage of compilation. Large crates especially then often
 885         // take a long time in trans/codegen and this helps us amortize that
 886         // cost.
 887         //
 888         // Note that a high number here doesn't mean that we'll be spawning a
 889         // large number of threads in parallel. The backend of rustc contains
 890         // global rate limiting through the `jobserver` crate so we'll never
 891         // overload the system with too much work, but rather we'll only be
 892         // optimizing when we're otherwise cooperating with other instances of
 893         // rustc.
 894         //
 895         // Rather a high number here means that we should be able to keep a lot
 896         // of idle cpus busy. By ensuring that no codegen unit takes *too* long
 897         // to build we'll be guaranteed that all cpus will finish pretty closely
 898         // to one another and we should make relatively optimal use of system
 899         // resources
 900         //
 901         // Note that the main cost of codegen units is that it prevents LLVM
 902         // from inlining across codegen units. Users in general don't have a lot
 903         // of control over how codegen units are split up so it's our job in the
 904         // compiler to ensure that undue performance isn't lost when using
 905         // codegen units (aka we can't require everyone to slap `#[inline]` on
 906         // everything).
 907         //
 908         // If we're compiling at `-O0` then the number doesn't really matter too
 909         // much because performance doesn't matter and inlining is ok to lose.
 910         // In debug mode we just want to try to guarantee that no cpu is stuck
 911         // doing work that could otherwise be farmed to others.
 912         //
 913         // In release mode, however (O1 and above) performance does indeed
 914         // matter! To recover the loss in performance due to inlining we'll be
 915         // enabling ThinLTO by default (the function for which is just below).
 916         // This will ensure that we recover any inlining wins we otherwise lost
 917         // through codegen unit partitioning.
 918         //
 919         // ---
 920         //
 921         // Ok that's a lot of words but the basic tl;dr; is that we want a high
 922         // number here -- but not too high. Additionally we're "safe" to have it
 923         // always at the same number at all optimization levels.
 924         //
 925         // As a result 16 was chosen here! Mostly because it was a power of 2
 926         // and most benchmarks agreed it was roughly a local optimum. Not very
 927         // scientific.
 928         16
 929     }
 930
 931     pub fn teach(&self, code: &DiagnosticId) -> bool {
 932         self.opts.debugging_opts.teach && self.parse_sess.span_diagnostic.must_teach(code)
 933     }
 934
 935     /// Are we allowed to use features from the Rust 2018 edition?
 936     pub fn rust_2018(&self) -> bool {
 937         self.opts.edition >= Edition::Edition2018
 938     }
 939
 940     pub fn edition(&self) -> Edition {
 941         self.opts.edition
 942     }
 943 }
 944
 945 pub fn build_session(
 946     sopts: config::Options,
 947     local_crate_source_file: Option<PathBuf>,
 948     registry: errors::registry::Registry,
 949 ) -> Session {
 950     let file_path_mapping = sopts.file_path_mapping();
 951
 952     build_session_with_codemap(
 953         sopts,
 954         local_crate_source_file,
 955         registry,
 956         Lrc::new(codemap::CodeMap::new(file_path_mapping)),
 957         None,
 958     )
 959 }
 960
 961 pub fn build_session_with_codemap(
 962     sopts: config::Options,
 963     local_crate_source_file: Option<PathBuf>,
 964     registry: errors::registry::Registry,
 965     codemap: Lrc<codemap::CodeMap>,
 966     emitter_dest: Option<Box<dyn Write + Send>>,
 967 ) -> Session {
 968     // FIXME: This is not general enough to make the warning lint completely override
 969     // normal diagnostic warnings, since the warning lint can also be denied and changed
 970     // later via the source code.
 971     let warnings_allow = sopts
 972         .lint_opts
 973         .iter()
 974         .filter(|&&(ref key, _)| *key == "warnings")
 975         .map(|&(_, ref level)| *level == lint::Allow)
 976         .last()
 977         .unwrap_or(false);
 978     let cap_lints_allow = sopts.lint_cap.map_or(false, |cap| cap == lint::Allow);
 979
 980     let can_emit_warnings = !(warnings_allow || cap_lints_allow);
 981
 982     let treat_err_as_bug = sopts.debugging_opts.treat_err_as_bug;
 983
 984     let external_macro_backtrace = sopts.debugging_opts.external_macro_backtrace;
 985
 986     let emitter: Box<dyn Emitter + sync::Send> =
 987         match (sopts.error_format, emitter_dest) {
 988             (config::ErrorOutputType::HumanReadable(color_config), None) => Box::new(
 989                 EmitterWriter::stderr(
 990                     color_config,
 991                     Some(codemap.clone()),
 992                     false,
 993                     sopts.debugging_opts.teach,
 994                 ).ui_testing(sopts.debugging_opts.ui_testing),
 995             ),
 996             (config::ErrorOutputType::HumanReadable(_), Some(dst)) => Box::new(
 997                 EmitterWriter::new(dst, Some(codemap.clone()), false, false)
 998                     .ui_testing(sopts.debugging_opts.ui_testing),
 999             ),
1000             (config::ErrorOutputType::Json(pretty), None) => Box::new(
1001                 JsonEmitter::stderr(
1002                     Some(registry),
1003                     codemap.clone(),
1004                     pretty,
1005                     sopts.debugging_opts.approximate_suggestions,
1006                 ).ui_testing(sopts.debugging_opts.ui_testing),
1007             ),
1008             (config::ErrorOutputType::Json(pretty), Some(dst)) => Box::new(
1009                 JsonEmitter::new(
1010                     dst,
1011                     Some(registry),
1012                     codemap.clone(),
1013                     pretty,
1014                     sopts.debugging_opts.approximate_suggestions,
1015                 ).ui_testing(sopts.debugging_opts.ui_testing),
1016             ),
1017             (config::ErrorOutputType::Short(color_config), None) => Box::new(
1018                 EmitterWriter::stderr(color_config, Some(codemap.clone()), true, false),
1019             ),
1020             (config::ErrorOutputType::Short(_), Some(dst)) => {
1021                 Box::new(EmitterWriter::new(dst, Some(codemap.clone()), true, false))
1022             }
1023         };
1024
1025     let diagnostic_handler = errors::Handler::with_emitter_and_flags(
1026         emitter,
1027         errors::HandlerFlags {
1028             can_emit_warnings,
1029             treat_err_as_bug,
1030             external_macro_backtrace,
1031             ..Default::default()
1032         },
1033     );
1034
1035     build_session_(sopts, local_crate_source_file, diagnostic_handler, codemap)
1036 }
1037
1038 pub fn build_session_(
1039     sopts: config::Options,
1040     local_crate_source_file: Option<PathBuf>,
1041     span_diagnostic: errors::Handler,
1042     codemap: Lrc<codemap::CodeMap>,
1043 ) -> Session {
1044     let host_triple = TargetTriple::from_triple(config::host_triple());
1045     let host = match Target::search(&host_triple) {
1046         Ok(t) => t,
1047         Err(e) => {
1048             span_diagnostic
1049                 .fatal(&format!("Error loading host specification: {}", e))
1050                 .raise();
1051         }
1052     };
1053     let target_cfg = config::build_target_config(&sopts, &span_diagnostic);
1054
1055     let p_s = parse::ParseSess::with_span_handler(span_diagnostic, codemap);
1056     let default_sysroot = match sopts.maybe_sysroot {
1057         Some(_) => None,
1058         None => Some(filesearch::get_or_default_sysroot()),
1059     };
1060
1061     let file_path_mapping = sopts.file_path_mapping();
1062
1063     let local_crate_source_file =
1064         local_crate_source_file.map(|path| file_path_mapping.map_prefix(path).0);
1065
1066     let optimization_fuel_crate = sopts.debugging_opts.fuel.as_ref().map(|i| i.0.clone());
1067     let optimization_fuel_limit =
1068         LockCell::new(sopts.debugging_opts.fuel.as_ref().map(|i| i.1).unwrap_or(0));
1069     let print_fuel_crate = sopts.debugging_opts.print_fuel.clone();
1070     let print_fuel = LockCell::new(0);
1071
1072     let working_dir = match env::current_dir() {
1073         Ok(dir) => dir,
1074         Err(e) => p_s.span_diagnostic
1075             .fatal(&format!("Current directory is invalid: {}", e))
1076             .raise(),
1077     };
1078     let working_dir = file_path_mapping.map_prefix(working_dir);
1079
1080     let sess = Session {
1081         target: target_cfg,
1082         host,
1083         opts: sopts,
1084         parse_sess: p_s,
1085         // For a library crate, this is always none
1086         entry_fn: Once::new(),
1087         plugin_registrar_fn: Once::new(),
1088         derive_registrar_fn: Once::new(),
1089         default_sysroot,
1090         local_crate_source_file,
1091         working_dir,
1092         lint_store: RwLock::new(lint::LintStore::new()),
1093         buffered_lints: Lock::new(Some(lint::LintBuffer::new())),
1094         one_time_diagnostics: Lock::new(FxHashSet()),
1095         plugin_llvm_passes: OneThread::new(RefCell::new(Vec::new())),
1096         plugin_attributes: OneThread::new(RefCell::new(Vec::new())),
1097         crate_types: Once::new(),
1098         dependency_formats: Once::new(),
1099         crate_disambiguator: Once::new(),
1100         features: Once::new(),
1101         recursion_limit: Once::new(),
1102         type_length_limit: Once::new(),
1103         const_eval_stack_frame_limit: 100,
1104         next_node_id: OneThread::new(Cell::new(NodeId::new(1))),
1105         injected_allocator: Once::new(),
1106         allocator_kind: Once::new(),
1107         injected_panic_runtime: Once::new(),
1108         imported_macro_spans: OneThread::new(RefCell::new(HashMap::new())),
1109         incr_comp_session: OneThread::new(RefCell::new(IncrCompSession::NotInitialized)),
1110         ignored_attr_names: ich::compute_ignored_attr_names(),
1111         profile_channel: Lock::new(None),
1112         perf_stats: PerfStats {
1113             symbol_hash_time: Lock::new(Duration::from_secs(0)),
1114             decode_def_path_tables_time: Lock::new(Duration::from_secs(0)),
1115             queries_canonicalized: AtomicUsize::new(0),
1116             normalize_ty_after_erasing_regions: AtomicUsize::new(0),
1117             normalize_projection_ty: AtomicUsize::new(0),
1118         },
1119         code_stats: Lock::new(CodeStats::new()),
1120         optimization_fuel_crate,
1121         optimization_fuel_limit,
1122         print_fuel_crate,
1123         print_fuel,
1124         out_of_fuel: LockCell::new(false),
1125         // Note that this is unsafe because it may misinterpret file descriptors
1126         // on Unix as jobserver file descriptors. We hopefully execute this near
1127         // the beginning of the process though to ensure we don't get false
1128         // positives, or in other words we try to execute this before we open
1129         // any file descriptors ourselves.
1130         //
1131         // Pick a "reasonable maximum" if we don't otherwise have
1132         // a jobserver in our environment, capping out at 32 so we
1133         // don't take everything down by hogging the process run queue.
1134         // The fixed number is used to have deterministic compilation
1135         // across machines.
1136         //
1137         // Also note that we stick this in a global because there could be
1138         // multiple `Session` instances in this process, and the jobserver is
1139         // per-process.
1140         jobserver: unsafe {
1141             static mut GLOBAL_JOBSERVER: *mut Client = 0 as *mut _;
1142             static INIT: std::sync::Once = std::sync::ONCE_INIT;
1143             INIT.call_once(|| {
1144                 let client = Client::from_env().unwrap_or_else(|| {
1145                     Client::new(32).expect("failed to create jobserver")
1146                 });
1147                 GLOBAL_JOBSERVER = Box::into_raw(Box::new(client));
1148             });
1149             (*GLOBAL_JOBSERVER).clone()
1150         },
1151         has_global_allocator: Once::new(),
1152     };
1153
1154     sess
1155 }
1156
1157 /// Hash value constructed out of all the `-C metadata` arguments passed to the
1158 /// compiler. Together with the crate-name forms a unique global identifier for
1159 /// the crate.
1160 #[derive(Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Clone, Copy, RustcEncodable, RustcDecodable)]
1161 pub struct CrateDisambiguator(Fingerprint);
1162
1163 impl CrateDisambiguator {
1164     pub fn to_fingerprint(self) -> Fingerprint {
1165         self.0
1166     }
1167 }
1168
1169 impl From<Fingerprint> for CrateDisambiguator {
1170     fn from(fingerprint: Fingerprint) -> CrateDisambiguator {
1171         CrateDisambiguator(fingerprint)
1172     }
1173 }
1174
1175 impl_stable_hash_for!(tuple_struct CrateDisambiguator { fingerprint });
1176
1177 /// Holds data on the current incremental compilation session, if there is one.
1178 #[derive(Debug)]
1179 pub enum IncrCompSession {
1180     /// This is the state the session will be in until the incr. comp. dir is
1181     /// needed.
1182     NotInitialized,
1183     /// This is the state during which the session directory is private and can
1184     /// be modified.
1185     Active {
1186         session_directory: PathBuf,
1187         lock_file: flock::Lock,
1188         load_dep_graph: bool,
1189     },
1190     /// This is the state after the session directory has been finalized. In this
1191     /// state, the contents of the directory must not be modified any more.
1192     Finalized { session_directory: PathBuf },
1193     /// This is an error state that is reached when some compilation error has
1194     /// occurred. It indicates that the contents of the session directory must
1195     /// not be used, since they might be invalid.
1196     InvalidBecauseOfErrors { session_directory: PathBuf },
1197 }
1198
1199 pub fn early_error(output: config::ErrorOutputType, msg: &str) -> ! {
1200     let emitter: Box<dyn Emitter + sync::Send> = match output {
1201         config::ErrorOutputType::HumanReadable(color_config) => {
1202             Box::new(EmitterWriter::stderr(color_config, None, false, false))
1203         }
1204         config::ErrorOutputType::Json(pretty) => Box::new(JsonEmitter::basic(pretty)),
1205         config::ErrorOutputType::Short(color_config) => {
1206             Box::new(EmitterWriter::stderr(color_config, None, true, false))
1207         }
1208     };
1209     let handler = errors::Handler::with_emitter(true, false, emitter);
1210     handler.emit(&MultiSpan::new(), msg, errors::Level::Fatal);
1211     errors::FatalError.raise();
1212 }
1213
1214 pub fn early_warn(output: config::ErrorOutputType, msg: &str) {
1215     let emitter: Box<dyn Emitter + sync::Send> = match output {
1216         config::ErrorOutputType::HumanReadable(color_config) => {
1217             Box::new(EmitterWriter::stderr(color_config, None, false, false))
1218         }
1219         config::ErrorOutputType::Json(pretty) => Box::new(JsonEmitter::basic(pretty)),
1220         config::ErrorOutputType::Short(color_config) => {
1221             Box::new(EmitterWriter::stderr(color_config, None, true, false))
1222         }
1223     };
1224     let handler = errors::Handler::with_emitter(true, false, emitter);
1225     handler.emit(&MultiSpan::new(), msg, errors::Level::Warning);
1226 }
1227
1228 #[derive(Copy, Clone, Debug)]
1229 pub enum CompileIncomplete {
1230     Stopped,
1231     Errored(ErrorReported),
1232 }
1233 impl From<ErrorReported> for CompileIncomplete {
1234     fn from(err: ErrorReported) -> CompileIncomplete {
1235         CompileIncomplete::Errored(err)
1236     }
1237 }
1238 pub type CompileResult = Result<(), CompileIncomplete>;
1239
1240 pub fn compile_result_from_err_count(err_count: usize) -> CompileResult {
1241     if err_count == 0 {
1242         Ok(())
1243     } else {
1244         Err(CompileIncomplete::Errored(ErrorReported))
1245     }
1246 }
1247
1248 #[cold]
1249 #[inline(never)]
1250 pub fn bug_fmt(file: &'static str, line: u32, args: fmt::Arguments) -> ! {
1251     // this wrapper mostly exists so I don't have to write a fully
1252     // qualified path of None::<Span> inside the bug!() macro definition
1253     opt_span_bug_fmt(file, line, None::<Span>, args);
1254 }
1255
1256 #[cold]
1257 #[inline(never)]
1258 pub fn span_bug_fmt<S: Into<MultiSpan>>(
1259     file: &'static str,
1260     line: u32,
1261     span: S,
1262     args: fmt::Arguments,
1263 ) -> ! {
1264     opt_span_bug_fmt(file, line, Some(span), args);
1265 }
1266
1267 fn opt_span_bug_fmt<S: Into<MultiSpan>>(
1268     file: &'static str,
1269     line: u32,
1270     span: Option<S>,
1271     args: fmt::Arguments,
1272 ) -> ! {
1273     tls::with_opt(move |tcx| {
1274         let msg = format!("{}:{}: {}", file, line, args);
1275         match (tcx, span) {
1276             (Some(tcx), Some(span)) => tcx.sess.diagnostic().span_bug(span, &msg),
1277             (Some(tcx), None) => tcx.sess.diagnostic().bug(&msg),
1278             (None, _) => panic!(msg),
1279         }
1280     });
1281     unreachable!();
1282 }