src/librustc/session/mod.rs

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