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