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