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 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(&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                 f(&profiler);
 846             }
 847         }
 848     }
 849
 850     #[inline(always)]
 851     pub fn profiler<F: FnOnce(&SelfProfiler) -> ()>(&self, f: F) {
 852         if unlikely!(self.self_profiling.is_some()) {
 853             self.profiler_active(f)
 854         }
 855     }
 856
 857     pub fn print_perf_stats(&self) {
 858         println!(
 859             "Total time spent computing symbol hashes:      {}",
 860             duration_to_secs_str(*self.perf_stats.symbol_hash_time.lock())
 861         );
 862         println!(
 863             "Total time spent decoding DefPath tables:      {}",
 864             duration_to_secs_str(*self.perf_stats.decode_def_path_tables_time.lock())
 865         );
 866         println!("Total queries canonicalized:                   {}",
 867                  self.perf_stats.queries_canonicalized.load(Ordering::Relaxed));
 868         println!("normalize_ty_after_erasing_regions:            {}",
 869                  self.perf_stats.normalize_ty_after_erasing_regions.load(Ordering::Relaxed));
 870         println!("normalize_projection_ty:                       {}",
 871                  self.perf_stats.normalize_projection_ty.load(Ordering::Relaxed));
 872     }
 873
 874     /// We want to know if we're allowed to do an optimization for crate foo from -z fuel=foo=n.
 875     /// This expends fuel if applicable, and records fuel if applicable.
 876     pub fn consider_optimizing<T: Fn() -> String>(&self, crate_name: &str, msg: T) -> bool {
 877         let mut ret = true;
 878         if let Some(ref c) = self.optimization_fuel_crate {
 879             if c == crate_name {
 880                 assert_eq!(self.threads(), 1);
 881                 let mut fuel = self.optimization_fuel.lock();
 882                 ret = fuel.remaining != 0;
 883                 if fuel.remaining == 0 && !fuel.out_of_fuel {
 884                     eprintln!("optimization-fuel-exhausted: {}", msg());
 885                     fuel.out_of_fuel = true;
 886                 } else if fuel.remaining > 0 {
 887                     fuel.remaining -= 1;
 888                 }
 889             }
 890         }
 891         if let Some(ref c) = self.print_fuel_crate {
 892             if c == crate_name {
 893                 assert_eq!(self.threads(), 1);
 894                 self.print_fuel.fetch_add(1, SeqCst);
 895             }
 896         }
 897         ret
 898     }
 899
 900     /// Returns the number of query threads that should be used for this
 901     /// compilation
 902     pub fn threads_from_count(query_threads: Option<usize>) -> usize {
 903         query_threads.unwrap_or(::num_cpus::get())
 904     }
 905
 906     /// Returns the number of query threads that should be used for this
 907     /// compilation
 908     pub fn threads(&self) -> usize {
 909         Self::threads_from_count(self.opts.debugging_opts.threads)
 910     }
 911
 912     /// Returns the number of codegen units that should be used for this
 913     /// compilation
 914     pub fn codegen_units(&self) -> usize {
 915         if let Some(n) = self.opts.cli_forced_codegen_units {
 916             return n;
 917         }
 918         if let Some(n) = self.target.target.options.default_codegen_units {
 919             return n as usize;
 920         }
 921
 922         // Why is 16 codegen units the default all the time?
 923         //
 924         // The main reason for enabling multiple codegen units by default is to
 925         // leverage the ability for the codegen backend to do codegen and
 926         // optimization in parallel. This allows us, especially for large crates, to
 927         // make good use of all available resources on the machine once we've
 928         // hit that stage of compilation. Large crates especially then often
 929         // take a long time in codegen/optimization and this helps us amortize that
 930         // cost.
 931         //
 932         // Note that a high number here doesn't mean that we'll be spawning a
 933         // large number of threads in parallel. The backend of rustc contains
 934         // global rate limiting through the `jobserver` crate so we'll never
 935         // overload the system with too much work, but rather we'll only be
 936         // optimizing when we're otherwise cooperating with other instances of
 937         // rustc.
 938         //
 939         // Rather a high number here means that we should be able to keep a lot
 940         // of idle cpus busy. By ensuring that no codegen unit takes *too* long
 941         // to build we'll be guaranteed that all cpus will finish pretty closely
 942         // to one another and we should make relatively optimal use of system
 943         // resources
 944         //
 945         // Note that the main cost of codegen units is that it prevents LLVM
 946         // from inlining across codegen units. Users in general don't have a lot
 947         // of control over how codegen units are split up so it's our job in the
 948         // compiler to ensure that undue performance isn't lost when using
 949         // codegen units (aka we can't require everyone to slap `#[inline]` on
 950         // everything).
 951         //
 952         // If we're compiling at `-O0` then the number doesn't really matter too
 953         // much because performance doesn't matter and inlining is ok to lose.
 954         // In debug mode we just want to try to guarantee that no cpu is stuck
 955         // doing work that could otherwise be farmed to others.
 956         //
 957         // In release mode, however (O1 and above) performance does indeed
 958         // matter! To recover the loss in performance due to inlining we'll be
 959         // enabling ThinLTO by default (the function for which is just below).
 960         // This will ensure that we recover any inlining wins we otherwise lost
 961         // through codegen unit partitioning.
 962         //
 963         // ---
 964         //
 965         // Ok that's a lot of words but the basic tl;dr; is that we want a high
 966         // number here -- but not too high. Additionally we're "safe" to have it
 967         // always at the same number at all optimization levels.
 968         //
 969         // As a result 16 was chosen here! Mostly because it was a power of 2
 970         // and most benchmarks agreed it was roughly a local optimum. Not very
 971         // scientific.
 972         16
 973     }
 974
 975     pub fn teach(&self, code: &DiagnosticId) -> bool {
 976         self.opts.debugging_opts.teach && self.diagnostic().must_teach(code)
 977     }
 978
 979     pub fn rust_2015(&self) -> bool {
 980         self.opts.edition == Edition::Edition2015
 981     }
 982
 983     /// Are we allowed to use features from the Rust 2018 edition?
 984     pub fn rust_2018(&self) -> bool {
 985         self.opts.edition >= Edition::Edition2018
 986     }
 987
 988     pub fn edition(&self) -> Edition {
 989         self.opts.edition
 990     }
 991
 992     /// Returns `true` if we cannot skip the PLT for shared library calls.
 993     pub fn needs_plt(&self) -> bool {
 994         // Check if the current target usually needs PLT to be enabled.
 995         // The user can use the command line flag to override it.
 996         let needs_plt = self.target.target.options.needs_plt;
 997
 998         let dbg_opts = &self.opts.debugging_opts;
 999
1000         let relro_level = dbg_opts.relro_level
1001             .unwrap_or(self.target.target.options.relro_level);
1002
1003         // Only enable this optimization by default if full relro is also enabled.
1004         // In this case, lazy binding was already unavailable, so nothing is lost.
1005         // This also ensures `-Wl,-z,now` is supported by the linker.
1006         let full_relro = RelroLevel::Full == relro_level;
1007
1008         // If user didn't explicitly forced us to use / skip the PLT,
1009         // then try to skip it where possible.
1010         dbg_opts.plt.unwrap_or(needs_plt || !full_relro)
1011     }
1012 }
1013
1014 pub fn build_session(
1015     sopts: config::Options,
1016     local_crate_source_file: Option<PathBuf>,
1017     registry: errors::registry::Registry,
1018 ) -> Session {
1019     let file_path_mapping = sopts.file_path_mapping();
1020
1021     build_session_with_source_map(
1022         sopts,
1023         local_crate_source_file,
1024         registry,
1025         Lrc::new(source_map::SourceMap::new(file_path_mapping)),
1026         DiagnosticOutput::Default,
1027         Default::default(),
1028     )
1029 }
1030
1031 fn default_emitter(
1032     sopts: &config::Options,
1033     registry: errors::registry::Registry,
1034     source_map: &Lrc<source_map::SourceMap>,
1035     emitter_dest: Option<Box<dyn Write + Send>>,
1036 ) -> Box<dyn Emitter + sync::Send> {
1037     match (sopts.error_format, emitter_dest) {
1038         (config::ErrorOutputType::HumanReadable(kind), dst) => {
1039             let (short, color_config) = kind.unzip();
1040             let emitter = match dst {
1041                 None => EmitterWriter::stderr(
1042                     color_config,
1043                     Some(source_map.clone()),
1044                     short,
1045                     sopts.debugging_opts.teach,
1046                 ),
1047                 Some(dst) => EmitterWriter::new(
1048                     dst,
1049                     Some(source_map.clone()),
1050                     short,
1051                     false, // no teach messages when writing to a buffer
1052                     false, // no colors when writing to a buffer
1053                 ),
1054             };
1055             Box::new(emitter.ui_testing(sopts.debugging_opts.ui_testing))
1056         },
1057         (config::ErrorOutputType::Json { pretty, json_rendered }, None) => Box::new(
1058             JsonEmitter::stderr(
1059                 Some(registry),
1060                 source_map.clone(),
1061                 pretty,
1062                 json_rendered,
1063             ).ui_testing(sopts.debugging_opts.ui_testing),
1064         ),
1065         (config::ErrorOutputType::Json { pretty, json_rendered }, Some(dst)) => Box::new(
1066             JsonEmitter::new(
1067                 dst,
1068                 Some(registry),
1069                 source_map.clone(),
1070                 pretty,
1071                 json_rendered,
1072             ).ui_testing(sopts.debugging_opts.ui_testing),
1073         ),
1074     }
1075 }
1076
1077 pub enum DiagnosticOutput {
1078     Default,
1079     Raw(Box<dyn Write + Send>)
1080 }
1081
1082 pub fn build_session_with_source_map(
1083     sopts: config::Options,
1084     local_crate_source_file: Option<PathBuf>,
1085     registry: errors::registry::Registry,
1086     source_map: Lrc<source_map::SourceMap>,
1087     diagnostics_output: DiagnosticOutput,
1088     lint_caps: FxHashMap<lint::LintId, lint::Level>,
1089 ) -> Session {
1090     // FIXME: This is not general enough to make the warning lint completely override
1091     // normal diagnostic warnings, since the warning lint can also be denied and changed
1092     // later via the source code.
1093     let warnings_allow = sopts
1094         .lint_opts
1095         .iter()
1096         .filter(|&&(ref key, _)| *key == "warnings")
1097         .map(|&(_, ref level)| *level == lint::Allow)
1098         .last()
1099         .unwrap_or(false);
1100     let cap_lints_allow = sopts.lint_cap.map_or(false, |cap| cap == lint::Allow);
1101
1102     let can_emit_warnings = !(warnings_allow || cap_lints_allow);
1103
1104     let treat_err_as_bug = sopts.debugging_opts.treat_err_as_bug;
1105     let dont_buffer_diagnostics = sopts.debugging_opts.dont_buffer_diagnostics;
1106     let report_delayed_bugs = sopts.debugging_opts.report_delayed_bugs;
1107
1108     let external_macro_backtrace = sopts.debugging_opts.external_macro_backtrace;
1109
1110     let emitter = match diagnostics_output {
1111         DiagnosticOutput::Default => default_emitter(&sopts, registry, &source_map, None),
1112         DiagnosticOutput::Raw(write) => {
1113             default_emitter(&sopts, registry, &source_map, Some(write))
1114         }
1115     };
1116
1117     let diagnostic_handler = errors::Handler::with_emitter_and_flags(
1118         emitter,
1119         errors::HandlerFlags {
1120             can_emit_warnings,
1121             treat_err_as_bug,
1122             report_delayed_bugs,
1123             dont_buffer_diagnostics,
1124             external_macro_backtrace,
1125             ..Default::default()
1126         },
1127     );
1128
1129     build_session_(sopts, local_crate_source_file, diagnostic_handler, source_map, lint_caps)
1130 }
1131
1132 fn build_session_(
1133     sopts: config::Options,
1134     local_crate_source_file: Option<PathBuf>,
1135     span_diagnostic: errors::Handler,
1136     source_map: Lrc<source_map::SourceMap>,
1137     driver_lint_caps: FxHashMap<lint::LintId, lint::Level>,
1138 ) -> Session {
1139     let self_profiler =
1140         if let SwitchWithOptPath::Enabled(ref d) = sopts.debugging_opts.self_profile {
1141             let directory = if let Some(ref directory) = d {
1142                 directory
1143             } else {
1144                 std::path::Path::new(".")
1145             };
1146
1147             let profiler = SelfProfiler::new(
1148                 directory,
1149                 sopts.crate_name.as_ref().map(|s| &s[..]),
1150                 &sopts.debugging_opts.self_profile_events
1151             );
1152             match profiler {
1153                 Ok(profiler) => {
1154                     crate::ty::query::QueryName::register_with_profiler(&profiler);
1155                     Some(Arc::new(profiler))
1156                 },
1157                 Err(e) => {
1158                     early_warn(sopts.error_format, &format!("failed to create profiler: {}", e));
1159                     None
1160                 }
1161             }
1162         }
1163         else { None };
1164
1165     let host_triple = TargetTriple::from_triple(config::host_triple());
1166     let host = Target::search(&host_triple).unwrap_or_else(|e|
1167         span_diagnostic
1168             .fatal(&format!("Error loading host specification: {}", e))
1169             .raise()
1170     );
1171     let target_cfg = config::build_target_config(&sopts, &span_diagnostic);
1172
1173     let p_s = parse::ParseSess::with_span_handler(span_diagnostic, source_map);
1174     let sysroot = match &sopts.maybe_sysroot {
1175         Some(sysroot) => sysroot.clone(),
1176         None => filesearch::get_or_default_sysroot(),
1177     };
1178
1179     let host_triple = config::host_triple();
1180     let target_triple = sopts.target_triple.triple();
1181     let host_tlib_path = SearchPath::from_sysroot_and_triple(&sysroot, host_triple);
1182     let target_tlib_path = if host_triple == target_triple {
1183         None
1184     } else {
1185         Some(SearchPath::from_sysroot_and_triple(&sysroot, target_triple))
1186     };
1187
1188     let file_path_mapping = sopts.file_path_mapping();
1189
1190     let local_crate_source_file =
1191         local_crate_source_file.map(|path| file_path_mapping.map_prefix(path).0);
1192
1193     let optimization_fuel_crate = sopts.debugging_opts.fuel.as_ref().map(|i| i.0.clone());
1194     let optimization_fuel = Lock::new(OptimizationFuel {
1195         remaining: sopts.debugging_opts.fuel.as_ref().map(|i| i.1).unwrap_or(0),
1196         out_of_fuel: false,
1197     });
1198     let print_fuel_crate = sopts.debugging_opts.print_fuel.clone();
1199     let print_fuel = AtomicU64::new(0);
1200
1201     let working_dir = env::current_dir().unwrap_or_else(|e|
1202         p_s.span_diagnostic
1203             .fatal(&format!("Current directory is invalid: {}", e))
1204             .raise()
1205     );
1206     let working_dir = file_path_mapping.map_prefix(working_dir);
1207
1208     let cgu_reuse_tracker = if sopts.debugging_opts.query_dep_graph {
1209         CguReuseTracker::new()
1210     } else {
1211         CguReuseTracker::new_disabled()
1212     };
1213
1214     let sess = Session {
1215         target: target_cfg,
1216         host,
1217         opts: sopts,
1218         host_tlib_path,
1219         target_tlib_path,
1220         parse_sess: p_s,
1221         sysroot,
1222         local_crate_source_file,
1223         working_dir,
1224         lint_store: RwLock::new(lint::LintStore::new()),
1225         buffered_lints: Lock::new(Some(Default::default())),
1226         one_time_diagnostics: Default::default(),
1227         plugin_llvm_passes: OneThread::new(RefCell::new(Vec::new())),
1228         plugin_attributes: Lock::new(Vec::new()),
1229         crate_types: Once::new(),
1230         dependency_formats: Once::new(),
1231         crate_disambiguator: Once::new(),
1232         features: Once::new(),
1233         recursion_limit: Once::new(),
1234         type_length_limit: Once::new(),
1235         const_eval_stack_frame_limit: 100,
1236         next_node_id: OneThread::new(Cell::new(NodeId::from_u32(1))),
1237         allocator_kind: Once::new(),
1238         injected_panic_runtime: Once::new(),
1239         imported_macro_spans: OneThread::new(RefCell::new(FxHashMap::default())),
1240         incr_comp_session: OneThread::new(RefCell::new(IncrCompSession::NotInitialized)),
1241         cgu_reuse_tracker,
1242         self_profiling: self_profiler,
1243         profile_channel: Lock::new(None),
1244         perf_stats: PerfStats {
1245             symbol_hash_time: Lock::new(Duration::from_secs(0)),
1246             decode_def_path_tables_time: Lock::new(Duration::from_secs(0)),
1247             queries_canonicalized: AtomicUsize::new(0),
1248             normalize_ty_after_erasing_regions: AtomicUsize::new(0),
1249             normalize_projection_ty: AtomicUsize::new(0),
1250         },
1251         code_stats: Default::default(),
1252         optimization_fuel_crate,
1253         optimization_fuel,
1254         print_fuel_crate,
1255         print_fuel,
1256         jobserver: jobserver::client(),
1257         has_global_allocator: Once::new(),
1258         has_panic_handler: Once::new(),
1259         driver_lint_caps,
1260         trait_methods_not_found: Lock::new(Default::default()),
1261         confused_type_with_std_module: Lock::new(Default::default()),
1262     };
1263
1264     validate_commandline_args_with_session_available(&sess);
1265
1266     sess
1267 }
1268
1269 // If it is useful to have a Session available already for validating a
1270 // commandline argument, you can do so here.
1271 fn validate_commandline_args_with_session_available(sess: &Session) {
1272     // Since we don't know if code in an rlib will be linked to statically or
1273     // dynamically downstream, rustc generates `__imp_` symbols that help the
1274     // MSVC linker deal with this lack of knowledge (#27438). Unfortunately,
1275     // these manually generated symbols confuse LLD when it tries to merge
1276     // bitcode during ThinLTO. Therefore we disallow dynamic linking on MSVC
1277     // when compiling for LLD ThinLTO. This way we can validly just not generate
1278     // the `dllimport` attributes and `__imp_` symbols in that case.
1279     if sess.opts.cg.linker_plugin_lto.enabled() &&
1280        sess.opts.cg.prefer_dynamic &&
1281        sess.target.target.options.is_like_msvc {
1282         sess.err("Linker plugin based LTO is not supported together with \
1283                   `-C prefer-dynamic` when targeting MSVC");
1284     }
1285
1286     // Make sure that any given profiling data actually exists so LLVM can't
1287     // decide to silently skip PGO.
1288     if let Some(ref path) = sess.opts.debugging_opts.pgo_use {
1289         if !path.exists() {
1290             sess.err(&format!("File `{}` passed to `-Zpgo-use` does not exist.",
1291                               path.display()));
1292         }
1293     }
1294 }
1295
1296 /// Hash value constructed out of all the `-C metadata` arguments passed to the
1297 /// compiler. Together with the crate-name forms a unique global identifier for
1298 /// the crate.
1299 #[derive(Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Clone, Copy, RustcEncodable, RustcDecodable)]
1300 pub struct CrateDisambiguator(Fingerprint);
1301
1302 impl CrateDisambiguator {
1303     pub fn to_fingerprint(self) -> Fingerprint {
1304         self.0
1305     }
1306 }
1307
1308 impl fmt::Display for CrateDisambiguator {
1309     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
1310         let (a, b) = self.0.as_value();
1311         let as_u128 = a as u128 | ((b as u128) << 64);
1312         f.write_str(&base_n::encode(as_u128, base_n::CASE_INSENSITIVE))
1313     }
1314 }
1315
1316 impl From<Fingerprint> for CrateDisambiguator {
1317     fn from(fingerprint: Fingerprint) -> CrateDisambiguator {
1318         CrateDisambiguator(fingerprint)
1319     }
1320 }
1321
1322 impl_stable_hash_via_hash!(CrateDisambiguator);
1323
1324 /// Holds data on the current incremental compilation session, if there is one.
1325 #[derive(Debug)]
1326 pub enum IncrCompSession {
1327     /// This is the state the session will be in until the incr. comp. dir is
1328     /// needed.
1329     NotInitialized,
1330     /// This is the state during which the session directory is private and can
1331     /// be modified.
1332     Active {
1333         session_directory: PathBuf,
1334         lock_file: flock::Lock,
1335         load_dep_graph: bool,
1336     },
1337     /// This is the state after the session directory has been finalized. In this
1338     /// state, the contents of the directory must not be modified any more.
1339     Finalized { session_directory: PathBuf },
1340     /// This is an error state that is reached when some compilation error has
1341     /// occurred. It indicates that the contents of the session directory must
1342     /// not be used, since they might be invalid.
1343     InvalidBecauseOfErrors { session_directory: PathBuf },
1344 }
1345
1346 pub fn early_error(output: config::ErrorOutputType, msg: &str) -> ! {
1347     let emitter: Box<dyn Emitter + sync::Send> = match output {
1348         config::ErrorOutputType::HumanReadable(kind) => {
1349             let (short, color_config) = kind.unzip();
1350             Box::new(EmitterWriter::stderr(color_config, None, short, false))
1351         }
1352         config::ErrorOutputType::Json { pretty, json_rendered } =>
1353             Box::new(JsonEmitter::basic(pretty, json_rendered)),
1354     };
1355     let handler = errors::Handler::with_emitter(true, None, emitter);
1356     handler.emit(&MultiSpan::new(), msg, errors::Level::Fatal);
1357     errors::FatalError.raise();
1358 }
1359
1360 pub fn early_warn(output: config::ErrorOutputType, msg: &str) {
1361     let emitter: Box<dyn Emitter + sync::Send> = match output {
1362         config::ErrorOutputType::HumanReadable(kind) => {
1363             let (short, color_config) = kind.unzip();
1364             Box::new(EmitterWriter::stderr(color_config, None, short, false))
1365         }
1366         config::ErrorOutputType::Json { pretty, json_rendered } =>
1367             Box::new(JsonEmitter::basic(pretty, json_rendered)),
1368     };
1369     let handler = errors::Handler::with_emitter(true, None, emitter);
1370     handler.emit(&MultiSpan::new(), msg, errors::Level::Warning);
1371 }
1372
1373 pub type CompileResult = Result<(), ErrorReported>;
1374
1375 pub fn compile_result_from_err_count(err_count: usize) -> CompileResult {
1376     if err_count == 0 {
1377         Ok(())
1378     } else {
1379         Err(ErrorReported)
1380     }
1381 }