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.
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.
11 pub use self::code_stats::{DataTypeKind, SizeKind, FieldInfo, VariantInfo};
12 use self::code_stats::CodeStats;
14 use dep_graph::cgu_reuse_tracker::CguReuseTracker;
15 use hir::def_id::CrateNum;
16 use rustc_data_structures::fingerprint::Fingerprint;
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;
28 use rustc_data_structures::base_n;
29 use rustc_data_structures::sync::{self, Lrc, Lock, LockCell, OneThread, Once, RwLock};
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;
42 use rustc_target::spec::{PanicStrategy, RelroLevel, Target, TargetTriple};
43 use rustc_data_structures::flock;
44 use jobserver::Client;
47 use std::cell::{self, Cell, RefCell};
51 use std::path::{Path, PathBuf};
52 use std::time::Duration;
54 use std::sync::atomic::{AtomicUsize, Ordering};
61 /// Represents the data associated with a compilation
62 /// session for a single crate.
64 pub target: config::Config,
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 proc_macro_decls_static: 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),
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>>,
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>,
100 features: Once<feature_gate::Features>,
102 /// The maximum recursion limit for potentially infinitely recursive
103 /// operations such as auto-dereference and monomorphization.
104 pub recursion_limit: Once<usize>,
106 /// The maximum length of types during monomorphization.
107 pub type_length_limit: Once<usize>,
109 /// The maximum number of stackframes allowed in const eval
110 pub const_eval_stack_frame_limit: usize,
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
115 pub allocator_kind: Once<Option<AllocatorKind>>,
116 pub injected_panic_runtime: Once<Option<CrateNum>>,
118 /// Map from imported macro spans (which consist of
119 /// the localized span for the macro body) to the
120 /// macro name and definition span in the source crate.
121 pub imported_macro_spans: OneThread<RefCell<FxHashMap<Span, (String, Span)>>>,
123 incr_comp_session: OneThread<RefCell<IncrCompSession>>,
124 /// Used for incremental compilation tests. Will only be populated if
125 /// `-Zquery-dep-graph` is specified.
126 pub cgu_reuse_tracker: CguReuseTracker,
128 /// Used by -Z profile-queries in util::common
129 pub profile_channel: Lock<Option<mpsc::Sender<ProfileQueriesMsg>>>,
131 /// Used by -Z self-profile
132 pub self_profiling: Lock<SelfProfiler>,
134 /// Some measurements that are being gathered during compilation.
135 pub perf_stats: PerfStats,
137 /// Data about code being compiled, gathered during compilation.
138 pub code_stats: Lock<CodeStats>,
140 next_node_id: OneThread<Cell<ast::NodeId>>,
142 /// If -zfuel=crate=n is specified, Some(crate).
143 optimization_fuel_crate: Option<String>,
144 /// If -zfuel=crate=n is specified, initially set to n. Otherwise 0.
145 optimization_fuel_limit: LockCell<u64>,
146 /// We're rejecting all further optimizations.
147 out_of_fuel: LockCell<bool>,
149 // The next two are public because the driver needs to read them.
150 /// If -zprint-fuel=crate, Some(crate).
151 pub print_fuel_crate: Option<String>,
152 /// Always set to zero and incremented so that we can print fuel expended by a crate.
153 pub print_fuel: LockCell<u64>,
155 /// Loaded up early on in the initialization of this `Session` to avoid
156 /// false positives about a job server in our environment.
157 pub jobserver: Client,
159 /// Metadata about the allocators for the current crate being compiled
160 pub has_global_allocator: Once<bool>,
162 /// Metadata about the panic handlers for the current crate being compiled
163 pub has_panic_handler: Once<bool>,
165 /// Cap lint level specified by a driver specifically.
166 pub driver_lint_caps: FxHashMap<lint::LintId, lint::Level>,
169 pub struct PerfStats {
170 /// The accumulated time spent on computing symbol hashes
171 pub symbol_hash_time: Lock<Duration>,
172 /// The accumulated time spent decoding def path tables from metadata
173 pub decode_def_path_tables_time: Lock<Duration>,
174 /// Total number of values canonicalized queries constructed.
175 pub queries_canonicalized: AtomicUsize,
176 /// Number of times this query is invoked.
177 pub normalize_ty_after_erasing_regions: AtomicUsize,
178 /// Number of times this query is invoked.
179 pub normalize_projection_ty: AtomicUsize,
182 /// Enum to support dispatch of one-time diagnostics (in Session.diag_once)
183 enum DiagnosticBuilderMethod {
186 SpanSuggestion(String), // suggestion
187 // add more variants as needed to support one-time diagnostics
190 /// Diagnostic message ID—used by `Session.one_time_diagnostics` to avoid
191 /// emitting the same message more than once
192 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
193 pub enum DiagnosticMessageId {
194 ErrorId(u16), // EXXXX error code as integer
195 LintId(lint::LintId),
196 StabilityId(u32), // issue number
199 impl From<&'static lint::Lint> for DiagnosticMessageId {
200 fn from(lint: &'static lint::Lint) -> Self {
201 DiagnosticMessageId::LintId(lint::LintId::of(lint))
206 pub fn local_crate_disambiguator(&self) -> CrateDisambiguator {
207 *self.crate_disambiguator.get()
210 pub fn struct_span_warn<'a, S: Into<MultiSpan>>(
214 ) -> DiagnosticBuilder<'a> {
215 self.diagnostic().struct_span_warn(sp, msg)
217 pub fn struct_span_warn_with_code<'a, S: Into<MultiSpan>>(
222 ) -> DiagnosticBuilder<'a> {
223 self.diagnostic().struct_span_warn_with_code(sp, msg, code)
225 pub fn struct_warn<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a> {
226 self.diagnostic().struct_warn(msg)
228 pub fn struct_span_err<'a, S: Into<MultiSpan>>(
232 ) -> DiagnosticBuilder<'a> {
233 self.diagnostic().struct_span_err(sp, msg)
235 pub fn struct_span_err_with_code<'a, S: Into<MultiSpan>>(
240 ) -> DiagnosticBuilder<'a> {
241 self.diagnostic().struct_span_err_with_code(sp, msg, code)
243 // FIXME: This method should be removed (every error should have an associated error code).
244 pub fn struct_err<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a> {
245 self.diagnostic().struct_err(msg)
247 pub fn struct_err_with_code<'a>(
251 ) -> DiagnosticBuilder<'a> {
252 self.diagnostic().struct_err_with_code(msg, code)
254 pub fn struct_span_fatal<'a, S: Into<MultiSpan>>(
258 ) -> DiagnosticBuilder<'a> {
259 self.diagnostic().struct_span_fatal(sp, msg)
261 pub fn struct_span_fatal_with_code<'a, S: Into<MultiSpan>>(
266 ) -> DiagnosticBuilder<'a> {
267 self.diagnostic().struct_span_fatal_with_code(sp, msg, code)
269 pub fn struct_fatal<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a> {
270 self.diagnostic().struct_fatal(msg)
273 pub fn span_fatal<S: Into<MultiSpan>>(&self, sp: S, msg: &str) -> ! {
274 self.diagnostic().span_fatal(sp, msg).raise()
276 pub fn span_fatal_with_code<S: Into<MultiSpan>>(
283 .span_fatal_with_code(sp, msg, code)
286 pub fn fatal(&self, msg: &str) -> ! {
287 self.diagnostic().fatal(msg).raise()
289 pub fn span_err_or_warn<S: Into<MultiSpan>>(&self, is_warning: bool, sp: S, msg: &str) {
291 self.span_warn(sp, msg);
293 self.span_err(sp, msg);
296 pub fn span_err<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
297 self.diagnostic().span_err(sp, msg)
299 pub fn span_err_with_code<S: Into<MultiSpan>>(&self, sp: S, msg: &str, code: DiagnosticId) {
300 self.diagnostic().span_err_with_code(sp, &msg, code)
302 pub fn err(&self, msg: &str) {
303 self.diagnostic().err(msg)
305 pub fn err_count(&self) -> usize {
306 self.diagnostic().err_count()
308 pub fn has_errors(&self) -> bool {
309 self.diagnostic().has_errors()
311 pub fn abort_if_errors(&self) {
312 self.diagnostic().abort_if_errors();
314 pub fn compile_status(&self) -> Result<(), CompileIncomplete> {
315 compile_result_from_err_count(self.err_count())
317 pub fn track_errors<F, T>(&self, f: F) -> Result<T, ErrorReported>
321 let old_count = self.err_count();
323 let errors = self.err_count() - old_count;
330 pub fn span_warn<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
331 self.diagnostic().span_warn(sp, msg)
333 pub fn span_warn_with_code<S: Into<MultiSpan>>(&self, sp: S, msg: &str, code: DiagnosticId) {
334 self.diagnostic().span_warn_with_code(sp, msg, code)
336 pub fn warn(&self, msg: &str) {
337 self.diagnostic().warn(msg)
339 pub fn opt_span_warn<S: Into<MultiSpan>>(&self, opt_sp: Option<S>, msg: &str) {
341 Some(sp) => self.span_warn(sp, msg),
342 None => self.warn(msg),
345 /// Delay a span_bug() call until abort_if_errors()
346 pub fn delay_span_bug<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
347 self.diagnostic().delay_span_bug(sp, msg)
349 pub fn note_without_error(&self, msg: &str) {
350 self.diagnostic().note_without_error(msg)
352 pub fn span_note_without_error<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
353 self.diagnostic().span_note_without_error(sp, msg)
355 pub fn span_unimpl<S: Into<MultiSpan>>(&self, sp: S, msg: &str) -> ! {
356 self.diagnostic().span_unimpl(sp, msg)
358 pub fn unimpl(&self, msg: &str) -> ! {
359 self.diagnostic().unimpl(msg)
362 pub fn buffer_lint<S: Into<MultiSpan>>(
364 lint: &'static lint::Lint,
369 match *self.buffered_lints.borrow_mut() {
370 Some(ref mut buffer) => {
371 buffer.add_lint(lint, id, sp.into(), msg, BuiltinLintDiagnostics::Normal)
373 None => bug!("can't buffer lints after HIR lowering"),
377 pub fn buffer_lint_with_diagnostic<S: Into<MultiSpan>>(
379 lint: &'static lint::Lint,
383 diagnostic: BuiltinLintDiagnostics,
385 match *self.buffered_lints.borrow_mut() {
386 Some(ref mut buffer) => buffer.add_lint(lint, id, sp.into(), msg, diagnostic),
387 None => bug!("can't buffer lints after HIR lowering"),
391 pub fn reserve_node_ids(&self, count: usize) -> ast::NodeId {
392 let id = self.next_node_id.get();
394 match id.as_usize().checked_add(count) {
396 self.next_node_id.set(ast::NodeId::from_usize(next));
398 None => bug!("Input too large, ran out of node ids!"),
403 pub fn next_node_id(&self) -> NodeId {
404 self.reserve_node_ids(1)
406 pub fn diagnostic<'a>(&'a self) -> &'a errors::Handler {
407 &self.parse_sess.span_diagnostic
410 /// Analogous to calling methods on the given `DiagnosticBuilder`, but
411 /// deduplicates on lint ID, span (if any), and message for this `Session`
412 fn diag_once<'a, 'b>(
414 diag_builder: &'b mut DiagnosticBuilder<'a>,
415 method: DiagnosticBuilderMethod,
416 msg_id: DiagnosticMessageId,
418 span_maybe: Option<Span>,
420 let id_span_message = (msg_id, span_maybe, message.to_owned());
421 let fresh = self.one_time_diagnostics
423 .insert(id_span_message);
426 DiagnosticBuilderMethod::Note => {
427 diag_builder.note(message);
429 DiagnosticBuilderMethod::SpanNote => {
430 let span = span_maybe.expect("span_note needs a span");
431 diag_builder.span_note(span, message);
433 DiagnosticBuilderMethod::SpanSuggestion(suggestion) => {
434 let span = span_maybe.expect("span_suggestion_* needs a span");
435 diag_builder.span_suggestion_with_applicability(
439 Applicability::Unspecified,
446 pub fn diag_span_note_once<'a, 'b>(
448 diag_builder: &'b mut DiagnosticBuilder<'a>,
449 msg_id: DiagnosticMessageId,
455 DiagnosticBuilderMethod::SpanNote,
462 pub fn diag_note_once<'a, 'b>(
464 diag_builder: &'b mut DiagnosticBuilder<'a>,
465 msg_id: DiagnosticMessageId,
470 DiagnosticBuilderMethod::Note,
477 pub fn diag_span_suggestion_once<'a, 'b>(
479 diag_builder: &'b mut DiagnosticBuilder<'a>,
480 msg_id: DiagnosticMessageId,
487 DiagnosticBuilderMethod::SpanSuggestion(suggestion),
494 pub fn source_map<'a>(&'a self) -> &'a source_map::SourceMap {
495 self.parse_sess.source_map()
497 pub fn verbose(&self) -> bool {
498 self.opts.debugging_opts.verbose
500 pub fn time_passes(&self) -> bool {
501 self.opts.debugging_opts.time_passes
503 pub fn profile_queries(&self) -> bool {
504 self.opts.debugging_opts.profile_queries
505 || self.opts.debugging_opts.profile_queries_and_keys
507 pub fn profile_queries_and_keys(&self) -> bool {
508 self.opts.debugging_opts.profile_queries_and_keys
510 pub fn count_llvm_insns(&self) -> bool {
511 self.opts.debugging_opts.count_llvm_insns
513 pub fn time_llvm_passes(&self) -> bool {
514 self.opts.debugging_opts.time_llvm_passes
516 pub fn codegen_stats(&self) -> bool {
517 self.opts.debugging_opts.codegen_stats
519 pub fn meta_stats(&self) -> bool {
520 self.opts.debugging_opts.meta_stats
522 pub fn asm_comments(&self) -> bool {
523 self.opts.debugging_opts.asm_comments
525 pub fn verify_llvm_ir(&self) -> bool {
526 self.opts.debugging_opts.verify_llvm_ir
527 || cfg!(always_verify_llvm_ir)
529 pub fn borrowck_stats(&self) -> bool {
530 self.opts.debugging_opts.borrowck_stats
532 pub fn print_llvm_passes(&self) -> bool {
533 self.opts.debugging_opts.print_llvm_passes
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.
540 pub fn features_untracked(&self) -> &feature_gate::Features {
544 pub fn init_features(&self, features: feature_gate::Features) {
545 self.features.set(features);
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;
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
563 config::LtoCli::No => {
564 // The user explicitly opted out of any kind of LTO
565 return config::Lto::No;
567 config::LtoCli::Yes |
568 config::LtoCli::Fat |
569 config::LtoCli::NoParam => {
570 // All of these mean fat LTO
571 return config::Lto::Fat;
573 config::LtoCli::Thin => {
574 return if self.opts.cli_forced_thinlto_off {
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`.
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;
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 {
598 return config::Lto::ThinLocal;
600 return config::Lto::No;
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;
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,
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 {
624 .unwrap_or(self.target.target.options.panic_strategy)
626 pub fn fewer_names(&self) -> bool {
627 let more_names = self.opts
629 .contains_key(&OutputType::LlvmAssembly)
630 || self.opts.output_types.contains_key(&OutputType::Bitcode);
631 self.opts.debugging_opts.fewer_names || !more_names
634 pub fn no_landing_pads(&self) -> bool {
635 self.opts.debugging_opts.no_landing_pads || self.panic_strategy() == PanicStrategy::Abort
637 pub fn unstable_options(&self) -> bool {
638 self.opts.debugging_opts.unstable_options
640 pub fn overflow_checks(&self) -> bool {
644 .or(self.opts.debugging_opts.force_overflow_checks)
645 .unwrap_or(self.opts.debug_assertions)
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()
653 self.target.target.options.crt_static_default
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");
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 {
673 pub fn must_not_eliminate_frame_pointers(&self) -> bool {
674 if let Some(x) = self.opts.cg.force_frame_pointers {
677 !self.target.target.options.eliminate_frame_pointer
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 {
685 "__rustc_plugin_registrar_{}__",
686 disambiguator.to_fingerprint().to_hex()
690 pub fn generate_proc_macro_decls_symbol(&self, disambiguator: CrateDisambiguator) -> String {
692 "__rustc_proc_macro_decls_{}__",
693 disambiguator.to_fingerprint().to_hex()
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
702 .expect("missing sysroot and default_sysroot in Session"),
705 pub fn target_filesearch(&self, kind: PathKind) -> filesearch::FileSearch<'_> {
706 filesearch::FileSearch::new(
708 self.opts.target_triple.triple(),
709 &self.opts.search_paths,
713 pub fn host_filesearch(&self, kind: PathKind) -> filesearch::FileSearch<'_> {
714 filesearch::FileSearch::new(
716 config::host_triple(),
717 &self.opts.search_paths,
722 pub fn set_incr_session_load_dep_graph(&self, load: bool) {
723 let mut incr_comp_session = self.incr_comp_session.borrow_mut();
725 if let IncrCompSession::Active { ref mut load_dep_graph, .. } = *incr_comp_session {
726 *load_dep_graph = load;
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,
738 pub fn init_incr_comp_session(
740 session_dir: PathBuf,
741 lock_file: flock::Lock,
742 load_dep_graph: bool,
744 let mut incr_comp_session = self.incr_comp_session.borrow_mut();
746 if let IncrCompSession::NotInitialized = *incr_comp_session {
749 "Trying to initialize IncrCompSession `{:?}`",
754 *incr_comp_session = IncrCompSession::Active {
755 session_directory: session_dir,
761 pub fn finalize_incr_comp_session(&self, new_directory_path: PathBuf) {
762 let mut incr_comp_session = self.incr_comp_session.borrow_mut();
764 if let IncrCompSession::Active { .. } = *incr_comp_session {
767 "Trying to finalize IncrCompSession `{:?}`",
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,
778 pub fn mark_incr_comp_session_as_invalid(&self) {
779 let mut incr_comp_session = self.incr_comp_session.borrow_mut();
781 let session_directory = match *incr_comp_session {
782 IncrCompSession::Active {
783 ref session_directory,
785 } => session_directory.clone(),
786 IncrCompSession::InvalidBecauseOfErrors { .. } => return,
788 "Trying to invalidate IncrCompSession `{:?}`",
793 // Note: This will also drop the lock file, thus unlocking the directory
794 *incr_comp_session = IncrCompSession::InvalidBecauseOfErrors { session_directory };
797 pub fn incr_comp_session_dir(&self) -> cell::Ref<'_, PathBuf> {
798 let incr_comp_session = self.incr_comp_session.borrow();
801 |incr_comp_session| match *incr_comp_session {
802 IncrCompSession::NotInitialized => bug!(
803 "Trying to get session directory from IncrCompSession `{:?}`",
806 IncrCompSession::Active {
807 ref session_directory,
810 | IncrCompSession::Finalized {
811 ref session_directory,
813 | IncrCompSession::InvalidBecauseOfErrors {
814 ref session_directory,
815 } => session_directory,
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())
828 pub fn profiler<F: FnOnce(&mut SelfProfiler) -> ()>(&self, f: F) {
829 if self.opts.debugging_opts.self_profile || self.opts.debugging_opts.profile_json {
830 let mut profiler = self.self_profiling.borrow_mut();
835 pub fn print_profiler_results(&self) {
836 let mut profiler = self.self_profiling.borrow_mut();
837 profiler.print_results(&self.opts);
840 pub fn save_json_results(&self) {
841 let profiler = self.self_profiling.borrow();
842 profiler.save_results(&self.opts);
845 pub fn print_perf_stats(&self) {
847 "Total time spent computing symbol hashes: {}",
848 duration_to_secs_str(*self.perf_stats.symbol_hash_time.lock())
851 "Total time spent decoding DefPath tables: {}",
852 duration_to_secs_str(*self.perf_stats.decode_def_path_tables_time.lock())
854 println!("Total queries canonicalized: {}",
855 self.perf_stats.queries_canonicalized.load(Ordering::Relaxed));
856 println!("normalize_ty_after_erasing_regions: {}",
857 self.perf_stats.normalize_ty_after_erasing_regions.load(Ordering::Relaxed));
858 println!("normalize_projection_ty: {}",
859 self.perf_stats.normalize_projection_ty.load(Ordering::Relaxed));
862 /// We want to know if we're allowed to do an optimization for crate foo from -z fuel=foo=n.
863 /// This expends fuel if applicable, and records fuel if applicable.
864 pub fn consider_optimizing<T: Fn() -> String>(&self, crate_name: &str, msg: T) -> bool {
866 if let Some(ref c) = self.optimization_fuel_crate {
868 assert_eq!(self.query_threads(), 1);
869 let fuel = self.optimization_fuel_limit.get();
871 if fuel == 0 && !self.out_of_fuel.get() {
872 eprintln!("optimization-fuel-exhausted: {}", msg());
873 self.out_of_fuel.set(true);
875 self.optimization_fuel_limit.set(fuel - 1);
879 if let Some(ref c) = self.print_fuel_crate {
881 assert_eq!(self.query_threads(), 1);
882 self.print_fuel.set(self.print_fuel.get() + 1);
888 /// Returns the number of query threads that should be used for this
890 pub fn query_threads_from_opts(opts: &config::Options) -> usize {
891 opts.debugging_opts.query_threads.unwrap_or(1)
894 /// Returns the number of query threads that should be used for this
896 pub fn query_threads(&self) -> usize {
897 Self::query_threads_from_opts(&self.opts)
900 /// Returns the number of codegen units that should be used for this
902 pub fn codegen_units(&self) -> usize {
903 if let Some(n) = self.opts.cli_forced_codegen_units {
906 if let Some(n) = self.target.target.options.default_codegen_units {
910 // Why is 16 codegen units the default all the time?
912 // The main reason for enabling multiple codegen units by default is to
913 // leverage the ability for the codegen backend to do codegen and
914 // optimization in parallel. This allows us, especially for large crates, to
915 // make good use of all available resources on the machine once we've
916 // hit that stage of compilation. Large crates especially then often
917 // take a long time in codegen/optimization and this helps us amortize that
920 // Note that a high number here doesn't mean that we'll be spawning a
921 // large number of threads in parallel. The backend of rustc contains
922 // global rate limiting through the `jobserver` crate so we'll never
923 // overload the system with too much work, but rather we'll only be
924 // optimizing when we're otherwise cooperating with other instances of
927 // Rather a high number here means that we should be able to keep a lot
928 // of idle cpus busy. By ensuring that no codegen unit takes *too* long
929 // to build we'll be guaranteed that all cpus will finish pretty closely
930 // to one another and we should make relatively optimal use of system
933 // Note that the main cost of codegen units is that it prevents LLVM
934 // from inlining across codegen units. Users in general don't have a lot
935 // of control over how codegen units are split up so it's our job in the
936 // compiler to ensure that undue performance isn't lost when using
937 // codegen units (aka we can't require everyone to slap `#[inline]` on
940 // If we're compiling at `-O0` then the number doesn't really matter too
941 // much because performance doesn't matter and inlining is ok to lose.
942 // In debug mode we just want to try to guarantee that no cpu is stuck
943 // doing work that could otherwise be farmed to others.
945 // In release mode, however (O1 and above) performance does indeed
946 // matter! To recover the loss in performance due to inlining we'll be
947 // enabling ThinLTO by default (the function for which is just below).
948 // This will ensure that we recover any inlining wins we otherwise lost
949 // through codegen unit partitioning.
953 // Ok that's a lot of words but the basic tl;dr; is that we want a high
954 // number here -- but not too high. Additionally we're "safe" to have it
955 // always at the same number at all optimization levels.
957 // As a result 16 was chosen here! Mostly because it was a power of 2
958 // and most benchmarks agreed it was roughly a local optimum. Not very
963 pub fn teach(&self, code: &DiagnosticId) -> bool {
964 self.opts.debugging_opts.teach && self.diagnostic().must_teach(code)
967 pub fn rust_2015(&self) -> bool {
968 self.opts.edition == Edition::Edition2015
971 /// Are we allowed to use features from the Rust 2018 edition?
972 pub fn rust_2018(&self) -> bool {
973 self.opts.edition >= Edition::Edition2018
976 pub fn edition(&self) -> Edition {
980 /// True if we cannot skip the PLT for shared library calls.
981 pub fn needs_plt(&self) -> bool {
982 // Check if the current target usually needs PLT to be enabled.
983 // The user can use the command line flag to override it.
984 let needs_plt = self.target.target.options.needs_plt;
986 let dbg_opts = &self.opts.debugging_opts;
988 let relro_level = dbg_opts.relro_level
989 .unwrap_or(self.target.target.options.relro_level);
991 // Only enable this optimization by default if full relro is also enabled.
992 // In this case, lazy binding was already unavailable, so nothing is lost.
993 // This also ensures `-Wl,-z,now` is supported by the linker.
994 let full_relro = RelroLevel::Full == relro_level;
996 // If user didn't explicitly forced us to use / skip the PLT,
997 // then try to skip it where possible.
998 dbg_opts.plt.unwrap_or(needs_plt || !full_relro)
1002 pub fn build_session(
1003 sopts: config::Options,
1004 local_crate_source_file: Option<PathBuf>,
1005 registry: errors::registry::Registry,
1007 let file_path_mapping = sopts.file_path_mapping();
1009 build_session_with_source_map(
1011 local_crate_source_file,
1013 Lrc::new(source_map::SourceMap::new(file_path_mapping)),
1018 pub fn build_session_with_source_map(
1019 sopts: config::Options,
1020 local_crate_source_file: Option<PathBuf>,
1021 registry: errors::registry::Registry,
1022 source_map: Lrc<source_map::SourceMap>,
1023 emitter_dest: Option<Box<dyn Write + Send>>,
1025 // FIXME: This is not general enough to make the warning lint completely override
1026 // normal diagnostic warnings, since the warning lint can also be denied and changed
1027 // later via the source code.
1028 let warnings_allow = sopts
1031 .filter(|&&(ref key, _)| *key == "warnings")
1032 .map(|&(_, ref level)| *level == lint::Allow)
1035 let cap_lints_allow = sopts.lint_cap.map_or(false, |cap| cap == lint::Allow);
1037 let can_emit_warnings = !(warnings_allow || cap_lints_allow);
1039 let treat_err_as_bug = sopts.debugging_opts.treat_err_as_bug;
1040 let dont_buffer_diagnostics = sopts.debugging_opts.dont_buffer_diagnostics;
1041 let report_delayed_bugs = sopts.debugging_opts.report_delayed_bugs;
1043 let external_macro_backtrace = sopts.debugging_opts.external_macro_backtrace;
1045 let emitter: Box<dyn Emitter + sync::Send> =
1046 match (sopts.error_format, emitter_dest) {
1047 (config::ErrorOutputType::HumanReadable(color_config), None) => Box::new(
1048 EmitterWriter::stderr(
1050 Some(source_map.clone()),
1052 sopts.debugging_opts.teach,
1053 ).ui_testing(sopts.debugging_opts.ui_testing),
1055 (config::ErrorOutputType::HumanReadable(_), Some(dst)) => Box::new(
1056 EmitterWriter::new(dst, Some(source_map.clone()), false, false)
1057 .ui_testing(sopts.debugging_opts.ui_testing),
1059 (config::ErrorOutputType::Json(pretty), None) => Box::new(
1060 JsonEmitter::stderr(
1064 ).ui_testing(sopts.debugging_opts.ui_testing),
1066 (config::ErrorOutputType::Json(pretty), Some(dst)) => Box::new(
1072 ).ui_testing(sopts.debugging_opts.ui_testing),
1074 (config::ErrorOutputType::Short(color_config), None) => Box::new(
1075 EmitterWriter::stderr(color_config, Some(source_map.clone()), true, false),
1077 (config::ErrorOutputType::Short(_), Some(dst)) => {
1078 Box::new(EmitterWriter::new(dst, Some(source_map.clone()), true, false))
1082 let diagnostic_handler = errors::Handler::with_emitter_and_flags(
1084 errors::HandlerFlags {
1087 report_delayed_bugs,
1088 dont_buffer_diagnostics,
1089 external_macro_backtrace,
1090 ..Default::default()
1094 build_session_(sopts, local_crate_source_file, diagnostic_handler, source_map)
1097 pub fn build_session_(
1098 sopts: config::Options,
1099 local_crate_source_file: Option<PathBuf>,
1100 span_diagnostic: errors::Handler,
1101 source_map: Lrc<source_map::SourceMap>,
1103 let host_triple = TargetTriple::from_triple(config::host_triple());
1104 let host = Target::search(&host_triple).unwrap_or_else(|e|
1106 .fatal(&format!("Error loading host specification: {}", e))
1109 let target_cfg = config::build_target_config(&sopts, &span_diagnostic);
1111 let p_s = parse::ParseSess::with_span_handler(span_diagnostic, source_map);
1112 let default_sysroot = match sopts.maybe_sysroot {
1114 None => Some(filesearch::get_or_default_sysroot()),
1117 let file_path_mapping = sopts.file_path_mapping();
1119 let local_crate_source_file =
1120 local_crate_source_file.map(|path| file_path_mapping.map_prefix(path).0);
1122 let optimization_fuel_crate = sopts.debugging_opts.fuel.as_ref().map(|i| i.0.clone());
1123 let optimization_fuel_limit =
1124 LockCell::new(sopts.debugging_opts.fuel.as_ref().map(|i| i.1).unwrap_or(0));
1125 let print_fuel_crate = sopts.debugging_opts.print_fuel.clone();
1126 let print_fuel = LockCell::new(0);
1128 let working_dir = env::current_dir().unwrap_or_else(|e|
1130 .fatal(&format!("Current directory is invalid: {}", e))
1133 let working_dir = file_path_mapping.map_prefix(working_dir);
1135 let cgu_reuse_tracker = if sopts.debugging_opts.query_dep_graph {
1136 CguReuseTracker::new()
1138 CguReuseTracker::new_disabled()
1141 let sess = Session {
1146 // For a library crate, this is always none
1147 entry_fn: Once::new(),
1148 plugin_registrar_fn: Once::new(),
1149 proc_macro_decls_static: Once::new(),
1151 local_crate_source_file,
1153 lint_store: RwLock::new(lint::LintStore::new()),
1154 buffered_lints: Lock::new(Some(Default::default())),
1155 one_time_diagnostics: Default::default(),
1156 plugin_llvm_passes: OneThread::new(RefCell::new(Vec::new())),
1157 plugin_attributes: OneThread::new(RefCell::new(Vec::new())),
1158 crate_types: Once::new(),
1159 dependency_formats: Once::new(),
1160 crate_disambiguator: Once::new(),
1161 features: Once::new(),
1162 recursion_limit: Once::new(),
1163 type_length_limit: Once::new(),
1164 const_eval_stack_frame_limit: 100,
1165 next_node_id: OneThread::new(Cell::new(NodeId::from_u32(1))),
1166 allocator_kind: Once::new(),
1167 injected_panic_runtime: Once::new(),
1168 imported_macro_spans: OneThread::new(RefCell::new(FxHashMap::default())),
1169 incr_comp_session: OneThread::new(RefCell::new(IncrCompSession::NotInitialized)),
1171 self_profiling: Lock::new(SelfProfiler::new()),
1172 profile_channel: Lock::new(None),
1173 perf_stats: PerfStats {
1174 symbol_hash_time: Lock::new(Duration::from_secs(0)),
1175 decode_def_path_tables_time: Lock::new(Duration::from_secs(0)),
1176 queries_canonicalized: AtomicUsize::new(0),
1177 normalize_ty_after_erasing_regions: AtomicUsize::new(0),
1178 normalize_projection_ty: AtomicUsize::new(0),
1180 code_stats: Default::default(),
1181 optimization_fuel_crate,
1182 optimization_fuel_limit,
1185 out_of_fuel: LockCell::new(false),
1186 // Note that this is unsafe because it may misinterpret file descriptors
1187 // on Unix as jobserver file descriptors. We hopefully execute this near
1188 // the beginning of the process though to ensure we don't get false
1189 // positives, or in other words we try to execute this before we open
1190 // any file descriptors ourselves.
1192 // Pick a "reasonable maximum" if we don't otherwise have
1193 // a jobserver in our environment, capping out at 32 so we
1194 // don't take everything down by hogging the process run queue.
1195 // The fixed number is used to have deterministic compilation
1198 // Also note that we stick this in a global because there could be
1199 // multiple `Session` instances in this process, and the jobserver is
1202 static mut GLOBAL_JOBSERVER: *mut Client = 0 as *mut _;
1203 static INIT: std::sync::Once = std::sync::ONCE_INIT;
1205 let client = Client::from_env().unwrap_or_else(|| {
1206 Client::new(32).expect("failed to create jobserver")
1208 GLOBAL_JOBSERVER = Box::into_raw(Box::new(client));
1210 (*GLOBAL_JOBSERVER).clone()
1212 has_global_allocator: Once::new(),
1213 has_panic_handler: Once::new(),
1214 driver_lint_caps: Default::default(),
1217 validate_commandline_args_with_session_available(&sess);
1222 // If it is useful to have a Session available already for validating a
1223 // commandline argument, you can do so here.
1224 fn validate_commandline_args_with_session_available(sess: &Session) {
1226 if sess.opts.incremental.is_some() {
1230 sess.err("can't perform LTO when compiling incrementally");
1239 // Since we don't know if code in an rlib will be linked to statically or
1240 // dynamically downstream, rustc generates `__imp_` symbols that help the
1241 // MSVC linker deal with this lack of knowledge (#27438). Unfortunately,
1242 // these manually generated symbols confuse LLD when it tries to merge
1243 // bitcode during ThinLTO. Therefore we disallow dynamic linking on MSVC
1244 // when compiling for LLD ThinLTO. This way we can validly just not generate
1245 // the `dllimport` attributes and `__imp_` symbols in that case.
1246 if sess.opts.debugging_opts.cross_lang_lto.enabled() &&
1247 sess.opts.cg.prefer_dynamic &&
1248 sess.target.target.options.is_like_msvc {
1249 sess.err("Linker plugin based LTO is not supported together with \
1250 `-C prefer-dynamic` when targeting MSVC");
1254 /// Hash value constructed out of all the `-C metadata` arguments passed to the
1255 /// compiler. Together with the crate-name forms a unique global identifier for
1257 #[derive(Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Clone, Copy, RustcEncodable, RustcDecodable)]
1258 pub struct CrateDisambiguator(Fingerprint);
1260 impl CrateDisambiguator {
1261 pub fn to_fingerprint(self) -> Fingerprint {
1266 impl fmt::Display for CrateDisambiguator {
1267 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
1268 let (a, b) = self.0.as_value();
1269 let as_u128 = a as u128 | ((b as u128) << 64);
1270 f.write_str(&base_n::encode(as_u128, base_n::CASE_INSENSITIVE))
1274 impl From<Fingerprint> for CrateDisambiguator {
1275 fn from(fingerprint: Fingerprint) -> CrateDisambiguator {
1276 CrateDisambiguator(fingerprint)
1280 impl_stable_hash_via_hash!(CrateDisambiguator);
1282 /// Holds data on the current incremental compilation session, if there is one.
1284 pub enum IncrCompSession {
1285 /// This is the state the session will be in until the incr. comp. dir is
1288 /// This is the state during which the session directory is private and can
1291 session_directory: PathBuf,
1292 lock_file: flock::Lock,
1293 load_dep_graph: bool,
1295 /// This is the state after the session directory has been finalized. In this
1296 /// state, the contents of the directory must not be modified any more.
1297 Finalized { session_directory: PathBuf },
1298 /// This is an error state that is reached when some compilation error has
1299 /// occurred. It indicates that the contents of the session directory must
1300 /// not be used, since they might be invalid.
1301 InvalidBecauseOfErrors { session_directory: PathBuf },
1304 pub fn early_error(output: config::ErrorOutputType, msg: &str) -> ! {
1305 let emitter: Box<dyn Emitter + sync::Send> = match output {
1306 config::ErrorOutputType::HumanReadable(color_config) => {
1307 Box::new(EmitterWriter::stderr(color_config, None, false, false))
1309 config::ErrorOutputType::Json(pretty) => Box::new(JsonEmitter::basic(pretty)),
1310 config::ErrorOutputType::Short(color_config) => {
1311 Box::new(EmitterWriter::stderr(color_config, None, true, false))
1314 let handler = errors::Handler::with_emitter(true, false, emitter);
1315 handler.emit(&MultiSpan::new(), msg, errors::Level::Fatal);
1316 errors::FatalError.raise();
1319 pub fn early_warn(output: config::ErrorOutputType, msg: &str) {
1320 let emitter: Box<dyn Emitter + sync::Send> = match output {
1321 config::ErrorOutputType::HumanReadable(color_config) => {
1322 Box::new(EmitterWriter::stderr(color_config, None, false, false))
1324 config::ErrorOutputType::Json(pretty) => Box::new(JsonEmitter::basic(pretty)),
1325 config::ErrorOutputType::Short(color_config) => {
1326 Box::new(EmitterWriter::stderr(color_config, None, true, false))
1329 let handler = errors::Handler::with_emitter(true, false, emitter);
1330 handler.emit(&MultiSpan::new(), msg, errors::Level::Warning);
1333 #[derive(Copy, Clone, Debug)]
1334 pub enum CompileIncomplete {
1336 Errored(ErrorReported),
1338 impl From<ErrorReported> for CompileIncomplete {
1339 fn from(err: ErrorReported) -> CompileIncomplete {
1340 CompileIncomplete::Errored(err)
1343 pub type CompileResult = Result<(), CompileIncomplete>;
1345 pub fn compile_result_from_err_count(err_count: usize) -> CompileResult {
1349 Err(CompileIncomplete::Errored(ErrorReported))