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