src/librustc/session/mod.rs

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