src/librustc/session/mod.rs

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