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