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