1 use crate::cgu_reuse_tracker
::CguReuseTracker
;
2 use crate::code_stats
::CodeStats
;
3 pub use crate::code_stats
::{DataTypeKind, FieldInfo, SizeKind, VariantInfo}
;
4 use crate::config
::{self, CrateType, OutputType, PrintRequest, SanitizerSet, SwitchWithOptPath}
;
6 use crate::lint
::{self, LintId}
;
7 use crate::parse
::ParseSess
;
8 use crate::search_paths
::{PathKind, SearchPath}
;
10 pub use rustc_ast
::attr
::MarkedAttrs
;
11 pub use rustc_ast
::Attribute
;
12 use rustc_data_structures
::flock
;
13 use rustc_data_structures
::fx
::{FxHashMap, FxHashSet}
;
14 use rustc_data_structures
::jobserver
::{self, Client}
;
15 use rustc_data_structures
::profiling
::{duration_to_secs_str, SelfProfiler, SelfProfilerRef}
;
16 use rustc_data_structures
::sync
::{
17 self, AtomicU64
, AtomicUsize
, Lock
, Lrc
, OnceCell
, OneThread
, Ordering
, Ordering
::SeqCst
,
19 use rustc_errors
::annotate_snippet_emitter_writer
::AnnotateSnippetEmitterWriter
;
20 use rustc_errors
::emitter
::{Emitter, EmitterWriter, HumanReadableErrorType}
;
21 use rustc_errors
::json
::JsonEmitter
;
22 use rustc_errors
::registry
::Registry
;
23 use rustc_errors
::{Applicability, Diagnostic, DiagnosticBuilder, DiagnosticId, ErrorReported}
;
24 use rustc_lint_defs
::FutureBreakage
;
25 pub use rustc_span
::crate_disambiguator
::CrateDisambiguator
;
26 use rustc_span
::edition
::Edition
;
27 use rustc_span
::source_map
::{FileLoader, MultiSpan, RealFileLoader, SourceMap, Span}
;
28 use rustc_span
::{sym, SourceFileHashAlgorithm, Symbol}
;
29 use rustc_target
::asm
::InlineAsmArch
;
30 use rustc_target
::spec
::{CodeModel, PanicStrategy, RelocModel, RelroLevel}
;
31 use rustc_target
::spec
::{SplitDebuginfo, Target, TargetTriple, TlsModel}
;
33 use std
::cell
::{self, RefCell}
;
37 use std
::num
::NonZeroU32
;
38 use std
::ops
::{Div, Mul}
;
39 use std
::path
::PathBuf
;
40 use std
::str::FromStr
;
42 use std
::time
::Duration
;
44 pub trait SessionLintStore
: sync
::Send
+ sync
::Sync
{
45 fn name_to_lint(&self, lint_name
: &str) -> LintId
;
48 pub struct OptimizationFuel
{
49 /// If `-zfuel=crate=n` is specified, initially set to `n`, otherwise `0`.
51 /// We're rejecting all further optimizations.
55 /// The behavior of the CTFE engine when an error occurs with regards to backtraces.
56 #[derive(Clone, Copy)]
57 pub enum CtfeBacktrace
{
58 /// Do nothing special, return the error as usual without a backtrace.
60 /// Capture a backtrace at the point the error is created and return it in the error
61 /// (to be printed later if/when the error ever actually gets shown to the user).
63 /// Capture a backtrace at the point the error is created and immediately print it out.
67 /// New-type wrapper around `usize` for representing limits. Ensures that comparisons against
68 /// limits are consistent throughout the compiler.
69 #[derive(Clone, Copy, Debug)]
70 pub struct Limit(pub usize);
73 /// Create a new limit from a `usize`.
74 pub fn new(value
: usize) -> Self {
78 /// Check that `value` is within the limit. Ensures that the same comparisons are used
79 /// throughout the compiler, as mismatches can cause ICEs, see #72540.
81 pub fn value_within_limit(&self, value
: usize) -> bool
{
86 impl fmt
::Display
for Limit
{
87 fn fmt(&self, f
: &mut fmt
::Formatter
<'_
>) -> fmt
::Result
{
88 write
!(f
, "{}", self.0)
92 impl Div
<usize> for Limit
{
95 fn div(self, rhs
: usize) -> Self::Output
{
96 Limit
::new(self.0 / rhs
)
100 impl Mul
<usize> for Limit
{
103 fn mul(self, rhs
: usize) -> Self::Output
{
104 Limit
::new(self.0 * rhs
)
108 /// Represents the data associated with a compilation
109 /// session for a single crate.
113 pub opts
: config
::Options
,
114 pub host_tlib_path
: SearchPath
,
115 /// `None` if the host and target are the same.
116 pub target_tlib_path
: Option
<SearchPath
>,
117 pub parse_sess
: ParseSess
,
118 pub sysroot
: PathBuf
,
119 /// The name of the root source file of the crate, in the local file system.
120 /// `None` means that there is no source file.
121 pub local_crate_source_file
: Option
<PathBuf
>,
122 /// The directory the compiler has been executed in plus a flag indicating
123 /// if the value stored here has been affected by path remapping.
124 pub working_dir
: (PathBuf
, bool
),
126 /// Set of `(DiagnosticId, Option<Span>, message)` tuples tracking
127 /// (sub)diagnostics that have been set once, but should not be set again,
128 /// in order to avoid redundantly verbose output (Issue #24690, #44953).
129 pub one_time_diagnostics
: Lock
<FxHashSet
<(DiagnosticMessageId
, Option
<Span
>, String
)>>,
130 crate_types
: OnceCell
<Vec
<CrateType
>>,
131 /// The `crate_disambiguator` is constructed out of all the `-C metadata`
132 /// arguments passed to the compiler. Its value together with the crate-name
133 /// forms a unique global identifier for the crate. It is used to allow
134 /// multiple crates with the same name to coexist. See the
135 /// `rustc_codegen_llvm::back::symbol_names` module for more information.
136 pub crate_disambiguator
: OnceCell
<CrateDisambiguator
>,
138 features
: OnceCell
<rustc_feature
::Features
>,
140 lint_store
: OnceCell
<Lrc
<dyn SessionLintStore
>>,
142 /// The maximum recursion limit for potentially infinitely recursive
143 /// operations such as auto-dereference and monomorphization.
144 pub recursion_limit
: OnceCell
<Limit
>,
146 /// The maximum length of types during monomorphization.
147 pub type_length_limit
: OnceCell
<Limit
>,
149 /// The maximum blocks a const expression can evaluate.
150 pub const_eval_limit
: OnceCell
<Limit
>,
152 incr_comp_session
: OneThread
<RefCell
<IncrCompSession
>>,
153 /// Used for incremental compilation tests. Will only be populated if
154 /// `-Zquery-dep-graph` is specified.
155 pub cgu_reuse_tracker
: CguReuseTracker
,
157 /// Used by `-Z self-profile`.
158 pub prof
: SelfProfilerRef
,
160 /// Some measurements that are being gathered during compilation.
161 pub perf_stats
: PerfStats
,
163 /// Data about code being compiled, gathered during compilation.
164 pub code_stats
: CodeStats
,
166 /// If `-zfuel=crate=n` is specified, `Some(crate)`.
167 optimization_fuel_crate
: Option
<String
>,
169 /// Tracks fuel info if `-zfuel=crate=n` is specified.
170 optimization_fuel
: Lock
<OptimizationFuel
>,
172 // The next two are public because the driver needs to read them.
173 /// If `-zprint-fuel=crate`, `Some(crate)`.
174 pub print_fuel_crate
: Option
<String
>,
175 /// Always set to zero and incremented so that we can print fuel expended by a crate.
176 pub print_fuel
: AtomicU64
,
178 /// Loaded up early on in the initialization of this `Session` to avoid
179 /// false positives about a job server in our environment.
180 pub jobserver
: Client
,
182 /// Cap lint level specified by a driver specifically.
183 pub driver_lint_caps
: FxHashMap
<lint
::LintId
, lint
::Level
>,
185 /// `Span`s of trait methods that weren't found to avoid emitting object safety errors
186 pub trait_methods_not_found
: Lock
<FxHashSet
<Span
>>,
188 /// Mapping from ident span to path span for paths that don't exist as written, but that
189 /// exist under `std`. For example, wrote `str::from_utf8` instead of `std::str::from_utf8`.
190 pub confused_type_with_std_module
: Lock
<FxHashMap
<Span
, Span
>>,
192 /// Path for libraries that will take preference over libraries shipped by Rust.
193 /// Used by windows-gnu targets to priortize system mingw-w64 libraries.
194 pub system_library_path
: OneThread
<RefCell
<Option
<Option
<PathBuf
>>>>,
196 /// Tracks the current behavior of the CTFE engine when an error occurs.
197 /// Options range from returning the error without a backtrace to returning an error
198 /// and immediately printing the backtrace to stderr.
199 pub ctfe_backtrace
: Lock
<CtfeBacktrace
>,
201 /// This tracks where `-Zunleash-the-miri-inside-of-you` was used to get around a
202 /// const check, optionally with the relevant feature gate. We use this to
203 /// warn about unleashing, but with a single diagnostic instead of dozens that
204 /// drown everything else in noise.
205 miri_unleashed_features
: Lock
<Vec
<(Span
, Option
<Symbol
>)>>,
207 /// Base directory containing the `src/` for the Rust standard library, and
208 /// potentially `rustc` as well, if we can can find it. Right now it's always
209 /// `$sysroot/lib/rustlib/src/rust` (i.e. the `rustup` `rust-src` component).
211 /// This directory is what the virtual `/rustc/$hash` is translated back to,
212 /// if Rust was built with path remapping to `/rustc/$hash` enabled
213 /// (the `rust.remap-debuginfo` option in `config.toml`).
214 pub real_rust_source_base_dir
: Option
<PathBuf
>,
216 /// Architecture to use for interpreting asm!.
217 pub asm_arch
: Option
<InlineAsmArch
>,
219 /// Set of enabled features for the current target.
220 pub target_features
: FxHashSet
<Symbol
>,
222 known_attrs
: Lock
<MarkedAttrs
>,
223 used_attrs
: Lock
<MarkedAttrs
>,
225 /// `Span`s for `if` conditions that we have suggested turning into `if let`.
226 pub if_let_suggestions
: Lock
<FxHashSet
<Span
>>,
229 pub struct PerfStats
{
230 /// The accumulated time spent on computing symbol hashes.
231 pub symbol_hash_time
: Lock
<Duration
>,
232 /// Total number of values canonicalized queries constructed.
233 pub queries_canonicalized
: AtomicUsize
,
234 /// Number of times this query is invoked.
235 pub normalize_generic_arg_after_erasing_regions
: AtomicUsize
,
236 /// Number of times this query is invoked.
237 pub normalize_projection_ty
: AtomicUsize
,
240 /// Enum to support dispatch of one-time diagnostics (in `Session.diag_once`).
241 enum DiagnosticBuilderMethod
{
244 SpanSuggestion(String
), // suggestion
245 // Add more variants as needed to support one-time diagnostics.
248 /// Trait implemented by error types. This should not be implemented manually. Instead, use
249 /// `#[derive(SessionDiagnostic)]` -- see [rustc_macros::SessionDiagnostic].
250 pub trait SessionDiagnostic
<'a
> {
251 /// Write out as a diagnostic out of `sess`.
253 fn into_diagnostic(self, sess
: &'a Session
) -> DiagnosticBuilder
<'a
>;
256 /// Diagnostic message ID, used by `Session.one_time_diagnostics` to avoid
257 /// emitting the same message more than once.
258 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
259 pub enum DiagnosticMessageId
{
260 ErrorId(u16), // EXXXX error code as integer
261 LintId(lint
::LintId
),
262 StabilityId(Option
<NonZeroU32
>), // issue number
265 impl From
<&'
static lint
::Lint
> for DiagnosticMessageId
{
266 fn from(lint
: &'
static lint
::Lint
) -> Self {
267 DiagnosticMessageId
::LintId(lint
::LintId
::of(lint
))
272 pub fn miri_unleashed_feature(&self, span
: Span
, feature_gate
: Option
<Symbol
>) {
273 self.miri_unleashed_features
.lock().push((span
, feature_gate
));
276 fn check_miri_unleashed_features(&self) {
277 let unleashed_features
= self.miri_unleashed_features
.lock();
278 if !unleashed_features
.is_empty() {
279 let mut must_err
= false;
280 // Create a diagnostic pointing at where things got unleashed.
281 let mut diag
= self.struct_warn("skipping const checks");
282 for &(span
, feature_gate
) in unleashed_features
.iter() {
283 // FIXME: `span_label` doesn't do anything, so we use "help" as a hack.
284 if let Some(feature_gate
) = feature_gate
{
285 diag
.span_help(span
, &format
!("skipping check for `{}` feature", feature_gate
));
286 // The unleash flag must *not* be used to just "hack around" feature gates.
289 diag
.span_help(span
, "skipping check that does not even have a feature gate");
293 // If we should err, make sure we did.
294 if must_err
&& !self.has_errors() {
295 // We have skipped a feature gate, and not run into other errors... reject.
297 "`-Zunleash-the-miri-inside-of-you` may not be used to circumvent feature \
298 gates, except when testing error paths in the CTFE engine",
304 /// Invoked all the way at the end to finish off diagnostics printing.
305 pub fn finish_diagnostics(&self, registry
: &Registry
) {
306 self.check_miri_unleashed_features();
307 self.diagnostic().print_error_count(registry
);
308 self.emit_future_breakage();
311 fn emit_future_breakage(&self) {
312 if !self.opts
.debugging_opts
.emit_future_incompat_report
{
316 let diags
= self.diagnostic().take_future_breakage_diagnostics();
317 if diags
.is_empty() {
320 // If any future-breakage lints were registered, this lint store
321 // should be available
322 let lint_store
= self.lint_store
.get().expect("`lint_store` not initialized!");
323 let diags_and_breakage
: Vec
<(FutureBreakage
, Diagnostic
)> = diags
326 let lint_name
= match &diag
.code
{
327 Some(DiagnosticId
::Lint { name, has_future_breakage: true }
) => name
,
328 _
=> panic
!("Unexpected code in diagnostic {:?}", diag
),
330 let lint
= lint_store
.name_to_lint(&lint_name
);
331 let future_breakage
=
332 lint
.lint
.future_incompatible
.unwrap().future_breakage
.unwrap();
333 (future_breakage
, diag
)
336 self.parse_sess
.span_diagnostic
.emit_future_breakage_report(diags_and_breakage
);
339 pub fn local_crate_disambiguator(&self) -> CrateDisambiguator
{
340 self.crate_disambiguator
.get().copied().unwrap()
343 pub fn crate_types(&self) -> &[CrateType
] {
344 self.crate_types
.get().unwrap().as_slice()
347 pub fn init_crate_types(&self, crate_types
: Vec
<CrateType
>) {
348 self.crate_types
.set(crate_types
).expect("`crate_types` was initialized twice")
352 pub fn recursion_limit(&self) -> Limit
{
353 self.recursion_limit
.get().copied().unwrap()
357 pub fn type_length_limit(&self) -> Limit
{
358 self.type_length_limit
.get().copied().unwrap()
361 pub fn const_eval_limit(&self) -> Limit
{
362 self.const_eval_limit
.get().copied().unwrap()
365 pub fn struct_span_warn
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str) -> DiagnosticBuilder
<'_
> {
366 self.diagnostic().struct_span_warn(sp
, msg
)
368 pub fn struct_span_warn_with_code
<S
: Into
<MultiSpan
>>(
373 ) -> DiagnosticBuilder
<'_
> {
374 self.diagnostic().struct_span_warn_with_code(sp
, msg
, code
)
376 pub fn struct_warn(&self, msg
: &str) -> DiagnosticBuilder
<'_
> {
377 self.diagnostic().struct_warn(msg
)
379 pub fn struct_span_allow
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str) -> DiagnosticBuilder
<'_
> {
380 self.diagnostic().struct_span_allow(sp
, msg
)
382 pub fn struct_allow(&self, msg
: &str) -> DiagnosticBuilder
<'_
> {
383 self.diagnostic().struct_allow(msg
)
385 pub fn struct_span_err
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str) -> DiagnosticBuilder
<'_
> {
386 self.diagnostic().struct_span_err(sp
, msg
)
388 pub fn struct_span_err_with_code
<S
: Into
<MultiSpan
>>(
393 ) -> DiagnosticBuilder
<'_
> {
394 self.diagnostic().struct_span_err_with_code(sp
, msg
, code
)
396 // FIXME: This method should be removed (every error should have an associated error code).
397 pub fn struct_err(&self, msg
: &str) -> DiagnosticBuilder
<'_
> {
398 self.diagnostic().struct_err(msg
)
400 pub fn struct_err_with_code(&self, msg
: &str, code
: DiagnosticId
) -> DiagnosticBuilder
<'_
> {
401 self.diagnostic().struct_err_with_code(msg
, code
)
403 pub fn struct_span_fatal
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str) -> DiagnosticBuilder
<'_
> {
404 self.diagnostic().struct_span_fatal(sp
, msg
)
406 pub fn struct_span_fatal_with_code
<S
: Into
<MultiSpan
>>(
411 ) -> DiagnosticBuilder
<'_
> {
412 self.diagnostic().struct_span_fatal_with_code(sp
, msg
, code
)
414 pub fn struct_fatal(&self, msg
: &str) -> DiagnosticBuilder
<'_
> {
415 self.diagnostic().struct_fatal(msg
)
418 pub fn span_fatal
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str) -> ! {
419 self.diagnostic().span_fatal(sp
, msg
).raise()
421 pub fn span_fatal_with_code
<S
: Into
<MultiSpan
>>(
427 self.diagnostic().span_fatal_with_code(sp
, msg
, code
).raise()
429 pub fn fatal(&self, msg
: &str) -> ! {
430 self.diagnostic().fatal(msg
).raise()
432 pub fn span_err_or_warn
<S
: Into
<MultiSpan
>>(&self, is_warning
: bool
, sp
: S
, msg
: &str) {
434 self.span_warn(sp
, msg
);
436 self.span_err(sp
, msg
);
439 pub fn span_err
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str) {
440 self.diagnostic().span_err(sp
, msg
)
442 pub fn span_err_with_code
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str, code
: DiagnosticId
) {
443 self.diagnostic().span_err_with_code(sp
, &msg
, code
)
445 pub fn err(&self, msg
: &str) {
446 self.diagnostic().err(msg
)
448 pub fn emit_err
<'a
>(&'a
self, err
: impl SessionDiagnostic
<'a
>) {
449 err
.into_diagnostic(self).emit()
451 pub fn err_count(&self) -> usize {
452 self.diagnostic().err_count()
454 pub fn has_errors(&self) -> bool
{
455 self.diagnostic().has_errors()
457 pub fn has_errors_or_delayed_span_bugs(&self) -> bool
{
458 self.diagnostic().has_errors_or_delayed_span_bugs()
460 pub fn abort_if_errors(&self) {
461 self.diagnostic().abort_if_errors();
463 pub fn compile_status(&self) -> Result
<(), ErrorReported
> {
464 if self.has_errors() {
465 self.diagnostic().emit_stashed_diagnostics();
471 // FIXME(matthewjasper) Remove this method, it should never be needed.
472 pub fn track_errors
<F
, T
>(&self, f
: F
) -> Result
<T
, ErrorReported
>
476 let old_count
= self.err_count();
478 let errors
= self.err_count() - old_count
;
479 if errors
== 0 { Ok(result) }
else { Err(ErrorReported) }
481 pub fn span_warn
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str) {
482 self.diagnostic().span_warn(sp
, msg
)
484 pub fn span_warn_with_code
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str, code
: DiagnosticId
) {
485 self.diagnostic().span_warn_with_code(sp
, msg
, code
)
487 pub fn warn(&self, msg
: &str) {
488 self.diagnostic().warn(msg
)
490 pub fn opt_span_warn
<S
: Into
<MultiSpan
>>(&self, opt_sp
: Option
<S
>, msg
: &str) {
492 Some(sp
) => self.span_warn(sp
, msg
),
493 None
=> self.warn(msg
),
496 /// Delay a span_bug() call until abort_if_errors()
498 pub fn delay_span_bug
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str) {
499 self.diagnostic().delay_span_bug(sp
, msg
)
502 /// Used for code paths of expensive computations that should only take place when
503 /// warnings or errors are emitted. If no messages are emitted ("good path"), then
504 /// it's likely a bug.
505 pub fn delay_good_path_bug(&self, msg
: &str) {
506 if self.opts
.debugging_opts
.print_type_sizes
507 || self.opts
.debugging_opts
.query_dep_graph
508 || self.opts
.debugging_opts
.dump_mir
.is_some()
509 || self.opts
.debugging_opts
.unpretty
.is_some()
510 || self.opts
.output_types
.contains_key(&OutputType
::Mir
)
511 || std
::env
::var_os("RUSTC_LOG").is_some()
516 self.diagnostic().delay_good_path_bug(msg
)
519 pub fn note_without_error(&self, msg
: &str) {
520 self.diagnostic().note_without_error(msg
)
522 pub fn span_note_without_error
<S
: Into
<MultiSpan
>>(&self, sp
: S
, msg
: &str) {
523 self.diagnostic().span_note_without_error(sp
, msg
)
525 pub fn struct_note_without_error(&self, msg
: &str) -> DiagnosticBuilder
<'_
> {
526 self.diagnostic().struct_note_without_error(msg
)
529 pub fn diagnostic(&self) -> &rustc_errors
::Handler
{
530 &self.parse_sess
.span_diagnostic
533 /// Analogous to calling methods on the given `DiagnosticBuilder`, but
534 /// deduplicates on lint ID, span (if any), and message for this `Session`
535 fn diag_once
<'a
, 'b
>(
537 diag_builder
: &'b
mut DiagnosticBuilder
<'a
>,
538 method
: DiagnosticBuilderMethod
,
539 msg_id
: DiagnosticMessageId
,
541 span_maybe
: Option
<Span
>,
543 let id_span_message
= (msg_id
, span_maybe
, message
.to_owned());
544 let fresh
= self.one_time_diagnostics
.borrow_mut().insert(id_span_message
);
547 DiagnosticBuilderMethod
::Note
=> {
548 diag_builder
.note(message
);
550 DiagnosticBuilderMethod
::SpanNote
=> {
551 let span
= span_maybe
.expect("`span_note` needs a span");
552 diag_builder
.span_note(span
, message
);
554 DiagnosticBuilderMethod
::SpanSuggestion(suggestion
) => {
555 let span
= span_maybe
.expect("`span_suggestion_*` needs a span");
556 diag_builder
.span_suggestion(
560 Applicability
::Unspecified
,
567 pub fn diag_span_note_once
<'a
, 'b
>(
569 diag_builder
: &'b
mut DiagnosticBuilder
<'a
>,
570 msg_id
: DiagnosticMessageId
,
576 DiagnosticBuilderMethod
::SpanNote
,
583 pub fn diag_note_once
<'a
, 'b
>(
585 diag_builder
: &'b
mut DiagnosticBuilder
<'a
>,
586 msg_id
: DiagnosticMessageId
,
589 self.diag_once(diag_builder
, DiagnosticBuilderMethod
::Note
, msg_id
, message
, None
);
592 pub fn diag_span_suggestion_once
<'a
, 'b
>(
594 diag_builder
: &'b
mut DiagnosticBuilder
<'a
>,
595 msg_id
: DiagnosticMessageId
,
602 DiagnosticBuilderMethod
::SpanSuggestion(suggestion
),
610 pub fn source_map(&self) -> &SourceMap
{
611 self.parse_sess
.source_map()
613 pub fn verbose(&self) -> bool
{
614 self.opts
.debugging_opts
.verbose
616 pub fn time_passes(&self) -> bool
{
617 self.opts
.debugging_opts
.time_passes
|| self.opts
.debugging_opts
.time
619 pub fn instrument_mcount(&self) -> bool
{
620 self.opts
.debugging_opts
.instrument_mcount
622 pub fn time_llvm_passes(&self) -> bool
{
623 self.opts
.debugging_opts
.time_llvm_passes
625 pub fn meta_stats(&self) -> bool
{
626 self.opts
.debugging_opts
.meta_stats
628 pub fn asm_comments(&self) -> bool
{
629 self.opts
.debugging_opts
.asm_comments
631 pub fn verify_llvm_ir(&self) -> bool
{
632 self.opts
.debugging_opts
.verify_llvm_ir
|| option_env
!("RUSTC_VERIFY_LLVM_IR").is_some()
634 pub fn borrowck_stats(&self) -> bool
{
635 self.opts
.debugging_opts
.borrowck_stats
637 pub fn print_llvm_passes(&self) -> bool
{
638 self.opts
.debugging_opts
.print_llvm_passes
640 pub fn binary_dep_depinfo(&self) -> bool
{
641 self.opts
.debugging_opts
.binary_dep_depinfo
643 pub fn mir_opt_level(&self) -> usize {
647 .unwrap_or_else(|| if self.opts
.optimize
!= config
::OptLevel
::No { 2 }
else { 1 }
)
650 /// Gets the features enabled for the current compilation session.
651 /// DO NOT USE THIS METHOD if there is a TyCtxt available, as it circumvents
652 /// dependency tracking. Use tcx.features() instead.
654 pub fn features_untracked(&self) -> &rustc_feature
::Features
{
655 self.features
.get().unwrap()
658 pub fn init_features(&self, features
: rustc_feature
::Features
) {
659 match self.features
.set(features
) {
661 Err(_
) => panic
!("`features` was initialized twice"),
665 pub fn init_lint_store(&self, lint_store
: Lrc
<dyn SessionLintStore
>) {
669 .expect("`lint_store` was initialized twice");
672 /// Calculates the flavor of LTO to use for this compilation.
673 pub fn lto(&self) -> config
::Lto
{
674 // If our target has codegen requirements ignore the command line
675 if self.target
.requires_lto
{
676 return config
::Lto
::Fat
;
679 // If the user specified something, return that. If they only said `-C
680 // lto` and we've for whatever reason forced off ThinLTO via the CLI,
681 // then ensure we can't use a ThinLTO.
682 match self.opts
.cg
.lto
{
683 config
::LtoCli
::Unspecified
=> {
684 // The compiler was invoked without the `-Clto` flag. Fall
685 // through to the default handling
687 config
::LtoCli
::No
=> {
688 // The user explicitly opted out of any kind of LTO
689 return config
::Lto
::No
;
691 config
::LtoCli
::Yes
| config
::LtoCli
::Fat
| config
::LtoCli
::NoParam
=> {
692 // All of these mean fat LTO
693 return config
::Lto
::Fat
;
695 config
::LtoCli
::Thin
=> {
696 return if self.opts
.cli_forced_thinlto_off
{
704 // Ok at this point the target doesn't require anything and the user
705 // hasn't asked for anything. Our next decision is whether or not
706 // we enable "auto" ThinLTO where we use multiple codegen units and
707 // then do ThinLTO over those codegen units. The logic below will
708 // either return `No` or `ThinLocal`.
710 // If processing command line options determined that we're incompatible
711 // with ThinLTO (e.g., `-C lto --emit llvm-ir`) then return that option.
712 if self.opts
.cli_forced_thinlto_off
{
713 return config
::Lto
::No
;
716 // If `-Z thinlto` specified process that, but note that this is mostly
717 // a deprecated option now that `-C lto=thin` exists.
718 if let Some(enabled
) = self.opts
.debugging_opts
.thinlto
{
720 return config
::Lto
::ThinLocal
;
722 return config
::Lto
::No
;
726 // If there's only one codegen unit and LTO isn't enabled then there's
727 // no need for ThinLTO so just return false.
728 if self.codegen_units() == 1 {
729 return config
::Lto
::No
;
732 // Now we're in "defaults" territory. By default we enable ThinLTO for
733 // optimized compiles (anything greater than O0).
734 match self.opts
.optimize
{
735 config
::OptLevel
::No
=> config
::Lto
::No
,
736 _
=> config
::Lto
::ThinLocal
,
740 /// Returns the panic strategy for this compile session. If the user explicitly selected one
741 /// using '-C panic', use that, otherwise use the panic strategy defined by the target.
742 pub fn panic_strategy(&self) -> PanicStrategy
{
743 self.opts
.cg
.panic
.unwrap_or(self.target
.panic_strategy
)
745 pub fn fewer_names(&self) -> bool
{
746 if let Some(fewer_names
) = self.opts
.debugging_opts
.fewer_names
{
749 let more_names
= self.opts
.output_types
.contains_key(&OutputType
::LlvmAssembly
)
750 || self.opts
.output_types
.contains_key(&OutputType
::Bitcode
)
751 // AddressSanitizer and MemorySanitizer use alloca name when reporting an issue.
752 || self.opts
.debugging_opts
.sanitizer
.intersects(SanitizerSet
::ADDRESS
| SanitizerSet
::MEMORY
);
757 pub fn unstable_options(&self) -> bool
{
758 self.opts
.debugging_opts
.unstable_options
760 pub fn is_nightly_build(&self) -> bool
{
761 self.opts
.unstable_features
.is_nightly_build()
763 pub fn overflow_checks(&self) -> bool
{
767 .or(self.opts
.debugging_opts
.force_overflow_checks
)
768 .unwrap_or(self.opts
.debug_assertions
)
771 /// Check whether this compile session and crate type use static crt.
772 pub fn crt_static(&self, crate_type
: Option
<CrateType
>) -> bool
{
773 if !self.target
.crt_static_respected
{
774 // If the target does not opt in to crt-static support, use its default.
775 return self.target
.crt_static_default
;
778 let requested_features
= self.opts
.cg
.target_feature
.split('
,'
);
779 let found_negative
= requested_features
.clone().any(|r
| r
== "-crt-static");
780 let found_positive
= requested_features
.clone().any(|r
| r
== "+crt-static");
782 if found_positive
|| found_negative
{
784 } else if crate_type
== Some(CrateType
::ProcMacro
)
785 || crate_type
== None
&& self.opts
.crate_types
.contains(&CrateType
::ProcMacro
)
787 // FIXME: When crate_type is not available,
788 // we use compiler options to determine the crate_type.
789 // We can't check `#![crate_type = "proc-macro"]` here.
792 self.target
.crt_static_default
796 pub fn inline_asm_dialect(&self) -> rustc_ast
::LlvmAsmDialect
{
797 match self.asm_arch
{
798 Some(InlineAsmArch
::X86
| InlineAsmArch
::X86_64
) => rustc_ast
::LlvmAsmDialect
::Intel
,
799 _
=> rustc_ast
::LlvmAsmDialect
::Att
,
803 pub fn relocation_model(&self) -> RelocModel
{
804 self.opts
.cg
.relocation_model
.unwrap_or(self.target
.relocation_model
)
807 pub fn code_model(&self) -> Option
<CodeModel
> {
808 self.opts
.cg
.code_model
.or(self.target
.code_model
)
811 pub fn tls_model(&self) -> TlsModel
{
812 self.opts
.debugging_opts
.tls_model
.unwrap_or(self.target
.tls_model
)
815 pub fn is_wasi_reactor(&self) -> bool
{
816 self.target
.options
.os
== "wasi"
818 self.opts
.debugging_opts
.wasi_exec_model
,
819 Some(config
::WasiExecModel
::Reactor
)
823 pub fn split_debuginfo(&self) -> SplitDebuginfo
{
824 self.opts
.cg
.split_debuginfo
.unwrap_or(self.target
.split_debuginfo
)
827 pub fn target_can_use_split_dwarf(&self) -> bool
{
828 !self.target
.is_like_windows
&& !self.target
.is_like_osx
831 pub fn must_not_eliminate_frame_pointers(&self) -> bool
{
832 // "mcount" function relies on stack pointer.
833 // See <https://sourceware.org/binutils/docs/gprof/Implementation.html>.
834 if self.instrument_mcount() {
836 } else if let Some(x
) = self.opts
.cg
.force_frame_pointers
{
839 !self.target
.eliminate_frame_pointer
843 pub fn must_emit_unwind_tables(&self) -> bool
{
844 // This is used to control the emission of the `uwtable` attribute on
847 // At the very least, unwind tables are needed when compiling with
848 // `-C panic=unwind`.
850 // On some targets (including windows), however, exceptions include
851 // other events such as illegal instructions, segfaults, etc. This means
852 // that on Windows we end up still needing unwind tables even if the `-C
853 // panic=abort` flag is passed.
855 // You can also find more info on why Windows needs unwind tables in:
856 // https://bugzilla.mozilla.org/show_bug.cgi?id=1302078
858 // If a target requires unwind tables, then they must be emitted.
859 // Otherwise, we can defer to the `-C force-unwind-tables=<yes/no>`
860 // value, if it is provided, or disable them, if not.
861 if self.panic_strategy() == PanicStrategy
::Unwind
{
863 } else if self.target
.requires_uwtable
{
866 self.opts
.cg
.force_unwind_tables
.unwrap_or(false)
870 /// Returns the symbol name for the registrar function,
871 /// given the crate `Svh` and the function `DefIndex`.
872 pub fn generate_plugin_registrar_symbol(&self, disambiguator
: CrateDisambiguator
) -> String
{
873 format
!("__rustc_plugin_registrar_{}__", disambiguator
.to_fingerprint().to_hex())
876 pub fn generate_proc_macro_decls_symbol(&self, disambiguator
: CrateDisambiguator
) -> String
{
877 format
!("__rustc_proc_macro_decls_{}__", disambiguator
.to_fingerprint().to_hex())
880 pub fn target_filesearch(&self, kind
: PathKind
) -> filesearch
::FileSearch
<'_
> {
881 filesearch
::FileSearch
::new(
883 self.opts
.target_triple
.triple(),
884 &self.opts
.search_paths
,
885 // `target_tlib_path == None` means it's the same as `host_tlib_path`.
886 self.target_tlib_path
.as_ref().unwrap_or(&self.host_tlib_path
),
890 pub fn host_filesearch(&self, kind
: PathKind
) -> filesearch
::FileSearch
<'_
> {
891 filesearch
::FileSearch
::new(
893 config
::host_triple(),
894 &self.opts
.search_paths
,
895 &self.host_tlib_path
,
900 pub fn set_incr_session_load_dep_graph(&self, load
: bool
) {
901 let mut incr_comp_session
= self.incr_comp_session
.borrow_mut();
903 if let IncrCompSession
::Active { ref mut load_dep_graph, .. }
= *incr_comp_session
{
904 *load_dep_graph
= load
;
908 pub fn incr_session_load_dep_graph(&self) -> bool
{
909 let incr_comp_session
= self.incr_comp_session
.borrow();
910 match *incr_comp_session
{
911 IncrCompSession
::Active { load_dep_graph, .. }
=> load_dep_graph
,
916 pub fn init_incr_comp_session(
918 session_dir
: PathBuf
,
919 lock_file
: flock
::Lock
,
920 load_dep_graph
: bool
,
922 let mut incr_comp_session
= self.incr_comp_session
.borrow_mut();
924 if let IncrCompSession
::NotInitialized
= *incr_comp_session
{
926 panic
!("Trying to initialize IncrCompSession `{:?}`", *incr_comp_session
)
930 IncrCompSession
::Active { session_directory: session_dir, lock_file, load_dep_graph }
;
933 pub fn finalize_incr_comp_session(&self, new_directory_path
: PathBuf
) {
934 let mut incr_comp_session
= self.incr_comp_session
.borrow_mut();
936 if let IncrCompSession
::Active { .. }
= *incr_comp_session
{
938 panic
!("trying to finalize `IncrCompSession` `{:?}`", *incr_comp_session
);
941 // Note: this will also drop the lock file, thus unlocking the directory.
942 *incr_comp_session
= IncrCompSession
::Finalized { session_directory: new_directory_path }
;
945 pub fn mark_incr_comp_session_as_invalid(&self) {
946 let mut incr_comp_session
= self.incr_comp_session
.borrow_mut();
948 let session_directory
= match *incr_comp_session
{
949 IncrCompSession
::Active { ref session_directory, .. }
=> session_directory
.clone(),
950 IncrCompSession
::InvalidBecauseOfErrors { .. }
=> return,
951 _
=> panic
!("trying to invalidate `IncrCompSession` `{:?}`", *incr_comp_session
),
954 // Note: this will also drop the lock file, thus unlocking the directory.
955 *incr_comp_session
= IncrCompSession
::InvalidBecauseOfErrors { session_directory }
;
958 pub fn incr_comp_session_dir(&self) -> cell
::Ref
<'_
, PathBuf
> {
959 let incr_comp_session
= self.incr_comp_session
.borrow();
960 cell
::Ref
::map(incr_comp_session
, |incr_comp_session
| match *incr_comp_session
{
961 IncrCompSession
::NotInitialized
=> panic
!(
962 "trying to get session directory from `IncrCompSession`: {:?}",
965 IncrCompSession
::Active { ref session_directory, .. }
966 | IncrCompSession
::Finalized { ref session_directory }
967 | IncrCompSession
::InvalidBecauseOfErrors { ref session_directory }
=> {
973 pub fn incr_comp_session_dir_opt(&self) -> Option
<cell
::Ref
<'_
, PathBuf
>> {
974 self.opts
.incremental
.as_ref().map(|_
| self.incr_comp_session_dir())
977 pub fn print_perf_stats(&self) {
979 "Total time spent computing symbol hashes: {}",
980 duration_to_secs_str(*self.perf_stats
.symbol_hash_time
.lock())
983 "Total queries canonicalized: {}",
984 self.perf_stats
.queries_canonicalized
.load(Ordering
::Relaxed
)
987 "normalize_generic_arg_after_erasing_regions: {}",
988 self.perf_stats
.normalize_generic_arg_after_erasing_regions
.load(Ordering
::Relaxed
)
991 "normalize_projection_ty: {}",
992 self.perf_stats
.normalize_projection_ty
.load(Ordering
::Relaxed
)
996 /// We want to know if we're allowed to do an optimization for crate foo from -z fuel=foo=n.
997 /// This expends fuel if applicable, and records fuel if applicable.
998 pub fn consider_optimizing
<T
: Fn() -> String
>(&self, crate_name
: &str, msg
: T
) -> bool
{
1000 if let Some(ref c
) = self.optimization_fuel_crate
{
1001 if c
== crate_name
{
1002 assert_eq
!(self.threads(), 1);
1003 let mut fuel
= self.optimization_fuel
.lock();
1004 ret
= fuel
.remaining
!= 0;
1005 if fuel
.remaining
== 0 && !fuel
.out_of_fuel
{
1006 self.warn(&format
!("optimization-fuel-exhausted: {}", msg()));
1007 fuel
.out_of_fuel
= true;
1008 } else if fuel
.remaining
> 0 {
1009 fuel
.remaining
-= 1;
1013 if let Some(ref c
) = self.print_fuel_crate
{
1014 if c
== crate_name
{
1015 assert_eq
!(self.threads(), 1);
1016 self.print_fuel
.fetch_add(1, SeqCst
);
1022 /// Returns the number of query threads that should be used for this
1024 pub fn threads(&self) -> usize {
1025 self.opts
.debugging_opts
.threads
1028 /// Returns the number of codegen units that should be used for this
1030 pub fn codegen_units(&self) -> usize {
1031 if let Some(n
) = self.opts
.cli_forced_codegen_units
{
1034 if let Some(n
) = self.target
.default_codegen_units
{
1038 // If incremental compilation is turned on, we default to a high number
1039 // codegen units in order to reduce the "collateral damage" small
1041 if self.opts
.incremental
.is_some() {
1045 // Why is 16 codegen units the default all the time?
1047 // The main reason for enabling multiple codegen units by default is to
1048 // leverage the ability for the codegen backend to do codegen and
1049 // optimization in parallel. This allows us, especially for large crates, to
1050 // make good use of all available resources on the machine once we've
1051 // hit that stage of compilation. Large crates especially then often
1052 // take a long time in codegen/optimization and this helps us amortize that
1055 // Note that a high number here doesn't mean that we'll be spawning a
1056 // large number of threads in parallel. The backend of rustc contains
1057 // global rate limiting through the `jobserver` crate so we'll never
1058 // overload the system with too much work, but rather we'll only be
1059 // optimizing when we're otherwise cooperating with other instances of
1062 // Rather a high number here means that we should be able to keep a lot
1063 // of idle cpus busy. By ensuring that no codegen unit takes *too* long
1064 // to build we'll be guaranteed that all cpus will finish pretty closely
1065 // to one another and we should make relatively optimal use of system
1068 // Note that the main cost of codegen units is that it prevents LLVM
1069 // from inlining across codegen units. Users in general don't have a lot
1070 // of control over how codegen units are split up so it's our job in the
1071 // compiler to ensure that undue performance isn't lost when using
1072 // codegen units (aka we can't require everyone to slap `#[inline]` on
1075 // If we're compiling at `-O0` then the number doesn't really matter too
1076 // much because performance doesn't matter and inlining is ok to lose.
1077 // In debug mode we just want to try to guarantee that no cpu is stuck
1078 // doing work that could otherwise be farmed to others.
1080 // In release mode, however (O1 and above) performance does indeed
1081 // matter! To recover the loss in performance due to inlining we'll be
1082 // enabling ThinLTO by default (the function for which is just below).
1083 // This will ensure that we recover any inlining wins we otherwise lost
1084 // through codegen unit partitioning.
1088 // Ok that's a lot of words but the basic tl;dr; is that we want a high
1089 // number here -- but not too high. Additionally we're "safe" to have it
1090 // always at the same number at all optimization levels.
1092 // As a result 16 was chosen here! Mostly because it was a power of 2
1093 // and most benchmarks agreed it was roughly a local optimum. Not very
1098 pub fn teach(&self, code
: &DiagnosticId
) -> bool
{
1099 self.opts
.debugging_opts
.teach
&& self.diagnostic().must_teach(code
)
1102 pub fn rust_2015(&self) -> bool
{
1103 self.opts
.edition
== Edition
::Edition2015
1106 /// Are we allowed to use features from the Rust 2018 edition?
1107 pub fn rust_2018(&self) -> bool
{
1108 self.opts
.edition
>= Edition
::Edition2018
1111 /// Are we allowed to use features from the Rust 2021 edition?
1112 pub fn rust_2021(&self) -> bool
{
1113 self.opts
.edition
>= Edition
::Edition2021
1116 pub fn edition(&self) -> Edition
{
1120 /// Returns `true` if we cannot skip the PLT for shared library calls.
1121 pub fn needs_plt(&self) -> bool
{
1122 // Check if the current target usually needs PLT to be enabled.
1123 // The user can use the command line flag to override it.
1124 let needs_plt
= self.target
.needs_plt
;
1126 let dbg_opts
= &self.opts
.debugging_opts
;
1128 let relro_level
= dbg_opts
.relro_level
.unwrap_or(self.target
.relro_level
);
1130 // Only enable this optimization by default if full relro is also enabled.
1131 // In this case, lazy binding was already unavailable, so nothing is lost.
1132 // This also ensures `-Wl,-z,now` is supported by the linker.
1133 let full_relro
= RelroLevel
::Full
== relro_level
;
1135 // If user didn't explicitly forced us to use / skip the PLT,
1136 // then try to skip it where possible.
1137 dbg_opts
.plt
.unwrap_or(needs_plt
|| !full_relro
)
1140 /// Checks if LLVM lifetime markers should be emitted.
1141 pub fn emit_lifetime_markers(&self) -> bool
{
1142 self.opts
.optimize
!= config
::OptLevel
::No
1143 // AddressSanitizer uses lifetimes to detect use after scope bugs.
1144 // MemorySanitizer uses lifetimes to detect use of uninitialized stack variables.
1145 // HWAddressSanitizer will use lifetimes to detect use after scope bugs in the future.
1146 || self.opts
.debugging_opts
.sanitizer
.intersects(SanitizerSet
::ADDRESS
| SanitizerSet
::MEMORY
| SanitizerSet
::HWADDRESS
)
1149 pub fn link_dead_code(&self) -> bool
{
1150 self.opts
.cg
.link_dead_code
.unwrap_or(false)
1153 pub fn mark_attr_known(&self, attr
: &Attribute
) {
1154 self.known_attrs
.lock().mark(attr
)
1157 pub fn is_attr_known(&self, attr
: &Attribute
) -> bool
{
1158 self.known_attrs
.lock().is_marked(attr
)
1161 pub fn mark_attr_used(&self, attr
: &Attribute
) {
1162 self.used_attrs
.lock().mark(attr
)
1165 pub fn is_attr_used(&self, attr
: &Attribute
) -> bool
{
1166 self.used_attrs
.lock().is_marked(attr
)
1169 /// Returns `true` if the attribute's path matches the argument. If it
1170 /// matches, then the attribute is marked as used.
1172 /// This method should only be used by rustc, other tools can use
1173 /// `Attribute::has_name` instead, because only rustc is supposed to report
1174 /// the `unused_attributes` lint. (`MetaItem` and `NestedMetaItem` are
1175 /// produced by lowering an `Attribute` and don't have identity, so they
1176 /// only have the `has_name` method, and you need to mark the original
1177 /// `Attribute` as used when necessary.)
1178 pub fn check_name(&self, attr
: &Attribute
, name
: Symbol
) -> bool
{
1179 let matches
= attr
.has_name(name
);
1181 self.mark_attr_used(attr
);
1186 pub fn is_proc_macro_attr(&self, attr
: &Attribute
) -> bool
{
1187 [sym
::proc_macro
, sym
::proc_macro_attribute
, sym
::proc_macro_derive
]
1189 .any(|kind
| self.check_name(attr
, *kind
))
1192 pub fn contains_name(&self, attrs
: &[Attribute
], name
: Symbol
) -> bool
{
1193 attrs
.iter().any(|item
| self.check_name(item
, name
))
1196 pub fn find_by_name
<'a
>(
1198 attrs
: &'a
[Attribute
],
1200 ) -> Option
<&'a Attribute
> {
1201 attrs
.iter().find(|attr
| self.check_name(attr
, name
))
1204 pub fn filter_by_name
<'a
>(
1206 attrs
: &'a
[Attribute
],
1208 ) -> impl Iterator
<Item
= &'a Attribute
> {
1209 attrs
.iter().filter(move |attr
| self.check_name(attr
, name
))
1212 pub fn first_attr_value_str_by_name(
1214 attrs
: &[Attribute
],
1216 ) -> Option
<Symbol
> {
1217 attrs
.iter().find(|at
| self.check_name(at
, name
)).and_then(|at
| at
.value_str())
1222 sopts
: &config
::Options
,
1223 registry
: rustc_errors
::registry
::Registry
,
1224 source_map
: Lrc
<SourceMap
>,
1225 emitter_dest
: Option
<Box
<dyn Write
+ Send
>>,
1226 ) -> Box
<dyn Emitter
+ sync
::Send
> {
1227 let macro_backtrace
= sopts
.debugging_opts
.macro_backtrace
;
1228 match (sopts
.error_format
, emitter_dest
) {
1229 (config
::ErrorOutputType
::HumanReadable(kind
), dst
) => {
1230 let (short
, color_config
) = kind
.unzip();
1232 if let HumanReadableErrorType
::AnnotateSnippet(_
) = kind
{
1234 AnnotateSnippetEmitterWriter
::new(Some(source_map
), short
, macro_backtrace
);
1235 Box
::new(emitter
.ui_testing(sopts
.debugging_opts
.ui_testing
))
1237 let emitter
= match dst
{
1238 None
=> EmitterWriter
::stderr(
1242 sopts
.debugging_opts
.teach
,
1243 sopts
.debugging_opts
.terminal_width
,
1246 Some(dst
) => EmitterWriter
::new(
1250 false, // no teach messages when writing to a buffer
1251 false, // no colors when writing to a buffer
1252 None
, // no terminal width
1256 Box
::new(emitter
.ui_testing(sopts
.debugging_opts
.ui_testing
))
1259 (config
::ErrorOutputType
::Json { pretty, json_rendered }
, None
) => Box
::new(
1260 JsonEmitter
::stderr(
1265 sopts
.debugging_opts
.terminal_width
,
1268 .ui_testing(sopts
.debugging_opts
.ui_testing
),
1270 (config
::ErrorOutputType
::Json { pretty, json_rendered }
, Some(dst
)) => Box
::new(
1277 sopts
.debugging_opts
.terminal_width
,
1280 .ui_testing(sopts
.debugging_opts
.ui_testing
),
1285 pub enum DiagnosticOutput
{
1287 Raw(Box
<dyn Write
+ Send
>),
1290 pub fn build_session(
1291 sopts
: config
::Options
,
1292 local_crate_source_file
: Option
<PathBuf
>,
1293 registry
: rustc_errors
::registry
::Registry
,
1294 diagnostics_output
: DiagnosticOutput
,
1295 driver_lint_caps
: FxHashMap
<lint
::LintId
, lint
::Level
>,
1296 file_loader
: Option
<Box
<dyn FileLoader
+ Send
+ Sync
+ '
static>>,
1297 target_override
: Option
<Target
>,
1299 // FIXME: This is not general enough to make the warning lint completely override
1300 // normal diagnostic warnings, since the warning lint can also be denied and changed
1301 // later via the source code.
1302 let warnings_allow
= sopts
1305 .filter(|&&(ref key
, _
)| *key
== "warnings")
1306 .map(|&(_
, ref level
)| *level
== lint
::Allow
)
1309 let cap_lints_allow
= sopts
.lint_cap
.map_or(false, |cap
| cap
== lint
::Allow
);
1310 let can_emit_warnings
= !(warnings_allow
|| cap_lints_allow
);
1312 let write_dest
= match diagnostics_output
{
1313 DiagnosticOutput
::Default
=> None
,
1314 DiagnosticOutput
::Raw(write
) => Some(write
),
1317 let target_cfg
= config
::build_target_config(&sopts
, target_override
);
1318 let host_triple
= TargetTriple
::from_triple(config
::host_triple());
1319 let host
= Target
::search(&host_triple
).unwrap_or_else(|e
| {
1320 early_error(sopts
.error_format
, &format
!("Error loading host specification: {}", e
))
1323 let loader
= file_loader
.unwrap_or_else(|| Box
::new(RealFileLoader
));
1324 let hash_kind
= sopts
.debugging_opts
.src_hash_algorithm
.unwrap_or_else(|| {
1325 if target_cfg
.is_like_msvc
{
1326 SourceFileHashAlgorithm
::Sha1
1328 SourceFileHashAlgorithm
::Md5
1331 let source_map
= Lrc
::new(SourceMap
::with_file_loader_and_hash_kind(
1333 sopts
.file_path_mapping(),
1336 let emitter
= default_emitter(&sopts
, registry
, source_map
.clone(), write_dest
);
1338 let span_diagnostic
= rustc_errors
::Handler
::with_emitter_and_flags(
1340 sopts
.debugging_opts
.diagnostic_handler_flags(can_emit_warnings
),
1343 let self_profiler
= if let SwitchWithOptPath
::Enabled(ref d
) = sopts
.debugging_opts
.self_profile
1346 if let Some(ref directory
) = d { directory }
else { std::path::Path::new(".") }
;
1348 let profiler
= SelfProfiler
::new(
1350 sopts
.crate_name
.as_deref(),
1351 &sopts
.debugging_opts
.self_profile_events
,
1354 Ok(profiler
) => Some(Arc
::new(profiler
)),
1356 early_warn(sopts
.error_format
, &format
!("failed to create profiler: {}", e
));
1364 let mut parse_sess
= ParseSess
::with_span_handler(span_diagnostic
, source_map
);
1365 parse_sess
.assume_incomplete_release
= sopts
.debugging_opts
.assume_incomplete_release
;
1366 let sysroot
= match &sopts
.maybe_sysroot
{
1367 Some(sysroot
) => sysroot
.clone(),
1368 None
=> filesearch
::get_or_default_sysroot(),
1371 let host_triple
= config
::host_triple();
1372 let target_triple
= sopts
.target_triple
.triple();
1373 let host_tlib_path
= SearchPath
::from_sysroot_and_triple(&sysroot
, host_triple
);
1374 let target_tlib_path
= if host_triple
== target_triple
{
1377 Some(SearchPath
::from_sysroot_and_triple(&sysroot
, target_triple
))
1380 let file_path_mapping
= sopts
.file_path_mapping();
1382 let local_crate_source_file
=
1383 local_crate_source_file
.map(|path
| file_path_mapping
.map_prefix(path
).0);
1385 let optimization_fuel_crate
= sopts
.debugging_opts
.fuel
.as_ref().map(|i
| i
.0.clone());
1386 let optimization_fuel
= Lock
::new(OptimizationFuel
{
1387 remaining
: sopts
.debugging_opts
.fuel
.as_ref().map_or(0, |i
| i
.1),
1390 let print_fuel_crate
= sopts
.debugging_opts
.print_fuel
.clone();
1391 let print_fuel
= AtomicU64
::new(0);
1393 let working_dir
= env
::current_dir().unwrap_or_else(|e
| {
1394 parse_sess
.span_diagnostic
.fatal(&format
!("Current directory is invalid: {}", e
)).raise()
1396 let working_dir
= file_path_mapping
.map_prefix(working_dir
);
1398 let cgu_reuse_tracker
= if sopts
.debugging_opts
.query_dep_graph
{
1399 CguReuseTracker
::new()
1401 CguReuseTracker
::new_disabled()
1404 let prof
= SelfProfilerRef
::new(
1406 sopts
.debugging_opts
.time_passes
|| sopts
.debugging_opts
.time
,
1407 sopts
.debugging_opts
.time_passes
,
1410 let ctfe_backtrace
= Lock
::new(match env
::var("RUSTC_CTFE_BACKTRACE") {
1411 Ok(ref val
) if val
== "immediate" => CtfeBacktrace
::Immediate
,
1412 Ok(ref val
) if val
!= "0" => CtfeBacktrace
::Capture
,
1413 _
=> CtfeBacktrace
::Disabled
,
1416 // Try to find a directory containing the Rust `src`, for more details see
1417 // the doc comment on the `real_rust_source_base_dir` field.
1418 let real_rust_source_base_dir
= {
1419 // This is the location used by the `rust-src` `rustup` component.
1420 let mut candidate
= sysroot
.join("lib/rustlib/src/rust");
1421 if let Ok(metadata
) = candidate
.symlink_metadata() {
1422 // Replace the symlink rustbuild creates, with its destination.
1423 // We could try to use `fs::canonicalize` instead, but that might
1424 // produce unnecessarily verbose path.
1425 if metadata
.file_type().is_symlink() {
1426 if let Ok(symlink_dest
) = std
::fs
::read_link(&candidate
) {
1427 candidate
= symlink_dest
;
1432 // Only use this directory if it has a file we can expect to always find.
1433 if candidate
.join("library/std/src/lib.rs").is_file() { Some(candidate) }
else { None }
1437 if target_cfg
.allow_asm { InlineAsmArch::from_str(&target_cfg.arch).ok() }
else { None }
;
1439 let sess
= Session
{
1447 local_crate_source_file
,
1449 one_time_diagnostics
: Default
::default(),
1450 crate_types
: OnceCell
::new(),
1451 crate_disambiguator
: OnceCell
::new(),
1452 features
: OnceCell
::new(),
1453 lint_store
: OnceCell
::new(),
1454 recursion_limit
: OnceCell
::new(),
1455 type_length_limit
: OnceCell
::new(),
1456 const_eval_limit
: OnceCell
::new(),
1457 incr_comp_session
: OneThread
::new(RefCell
::new(IncrCompSession
::NotInitialized
)),
1460 perf_stats
: PerfStats
{
1461 symbol_hash_time
: Lock
::new(Duration
::from_secs(0)),
1462 queries_canonicalized
: AtomicUsize
::new(0),
1463 normalize_generic_arg_after_erasing_regions
: AtomicUsize
::new(0),
1464 normalize_projection_ty
: AtomicUsize
::new(0),
1466 code_stats
: Default
::default(),
1467 optimization_fuel_crate
,
1471 jobserver
: jobserver
::client(),
1473 trait_methods_not_found
: Lock
::new(Default
::default()),
1474 confused_type_with_std_module
: Lock
::new(Default
::default()),
1475 system_library_path
: OneThread
::new(RefCell
::new(Default
::default())),
1477 miri_unleashed_features
: Lock
::new(Default
::default()),
1478 real_rust_source_base_dir
,
1480 target_features
: FxHashSet
::default(),
1481 known_attrs
: Lock
::new(MarkedAttrs
::new()),
1482 used_attrs
: Lock
::new(MarkedAttrs
::new()),
1483 if_let_suggestions
: Default
::default(),
1486 validate_commandline_args_with_session_available(&sess
);
1491 // If it is useful to have a Session available already for validating a
1492 // commandline argument, you can do so here.
1493 fn validate_commandline_args_with_session_available(sess
: &Session
) {
1494 // Since we don't know if code in an rlib will be linked to statically or
1495 // dynamically downstream, rustc generates `__imp_` symbols that help linkers
1496 // on Windows deal with this lack of knowledge (#27438). Unfortunately,
1497 // these manually generated symbols confuse LLD when it tries to merge
1498 // bitcode during ThinLTO. Therefore we disallow dynamic linking on Windows
1499 // when compiling for LLD ThinLTO. This way we can validly just not generate
1500 // the `dllimport` attributes and `__imp_` symbols in that case.
1501 if sess
.opts
.cg
.linker_plugin_lto
.enabled()
1502 && sess
.opts
.cg
.prefer_dynamic
1503 && sess
.target
.is_like_windows
1506 "Linker plugin based LTO is not supported together with \
1507 `-C prefer-dynamic` when targeting Windows-like targets",
1511 // Make sure that any given profiling data actually exists so LLVM can't
1512 // decide to silently skip PGO.
1513 if let Some(ref path
) = sess
.opts
.cg
.profile_use
{
1516 "File `{}` passed to `-C profile-use` does not exist.",
1522 // Unwind tables cannot be disabled if the target requires them.
1523 if let Some(include_uwtables
) = sess
.opts
.cg
.force_unwind_tables
{
1524 if sess
.panic_strategy() == PanicStrategy
::Unwind
&& !include_uwtables
{
1526 "panic=unwind requires unwind tables, they cannot be disabled \
1527 with `-C force-unwind-tables=no`.",
1531 if sess
.target
.requires_uwtable
&& !include_uwtables
{
1533 "target requires unwind tables, they cannot be disabled with \
1534 `-C force-unwind-tables=no`.",
1539 // PGO does not work reliably with panic=unwind on Windows. Let's make it
1540 // an error to combine the two for now. It always runs into an assertions
1541 // if LLVM is built with assertions, but without assertions it sometimes
1542 // does not crash and will probably generate a corrupted binary.
1543 // We should only display this error if we're actually going to run PGO.
1544 // If we're just supposed to print out some data, don't show the error (#61002).
1545 if sess
.opts
.cg
.profile_generate
.enabled()
1546 && sess
.target
.is_like_msvc
1547 && sess
.panic_strategy() == PanicStrategy
::Unwind
1548 && sess
.opts
.prints
.iter().all(|&p
| p
== PrintRequest
::NativeStaticLibs
)
1551 "Profile-guided optimization does not yet work in conjunction \
1552 with `-Cpanic=unwind` on Windows when targeting MSVC. \
1553 See issue #61002 <https://github.com/rust-lang/rust/issues/61002> \
1554 for more information.",
1558 const ASAN_SUPPORTED_TARGETS
: &[&str] = &[
1559 "aarch64-apple-darwin",
1561 "aarch64-unknown-linux-gnu",
1562 "x86_64-apple-darwin",
1564 "x86_64-unknown-freebsd",
1565 "x86_64-unknown-linux-gnu",
1567 const LSAN_SUPPORTED_TARGETS
: &[&str] = &[
1568 "aarch64-apple-darwin",
1569 "aarch64-unknown-linux-gnu",
1570 "x86_64-apple-darwin",
1571 "x86_64-unknown-linux-gnu",
1573 const MSAN_SUPPORTED_TARGETS
: &[&str] =
1574 &["aarch64-unknown-linux-gnu", "x86_64-unknown-freebsd", "x86_64-unknown-linux-gnu"];
1575 const TSAN_SUPPORTED_TARGETS
: &[&str] = &[
1576 "aarch64-apple-darwin",
1577 "aarch64-unknown-linux-gnu",
1578 "x86_64-apple-darwin",
1579 "x86_64-unknown-freebsd",
1580 "x86_64-unknown-linux-gnu",
1582 const HWASAN_SUPPORTED_TARGETS
: &[&str] =
1583 &["aarch64-linux-android", "aarch64-unknown-linux-gnu"];
1585 // Sanitizers can only be used on some tested platforms.
1586 for s
in sess
.opts
.debugging_opts
.sanitizer
{
1587 let supported_targets
= match s
{
1588 SanitizerSet
::ADDRESS
=> ASAN_SUPPORTED_TARGETS
,
1589 SanitizerSet
::LEAK
=> LSAN_SUPPORTED_TARGETS
,
1590 SanitizerSet
::MEMORY
=> MSAN_SUPPORTED_TARGETS
,
1591 SanitizerSet
::THREAD
=> TSAN_SUPPORTED_TARGETS
,
1592 SanitizerSet
::HWADDRESS
=> HWASAN_SUPPORTED_TARGETS
,
1593 _
=> panic
!("unrecognized sanitizer {}", s
),
1595 if !supported_targets
.contains(&&*sess
.opts
.target_triple
.triple()) {
1597 "`-Zsanitizer={}` only works with targets: {}",
1599 supported_targets
.join(", ")
1602 let conflicting
= sess
.opts
.debugging_opts
.sanitizer
- s
;
1603 if !conflicting
.is_empty() {
1605 "`-Zsanitizer={}` is incompatible with `-Zsanitizer={}`",
1608 // Don't report additional errors.
1614 /// Holds data on the current incremental compilation session, if there is one.
1616 pub enum IncrCompSession
{
1617 /// This is the state the session will be in until the incr. comp. dir is
1620 /// This is the state during which the session directory is private and can
1622 Active { session_directory: PathBuf, lock_file: flock::Lock, load_dep_graph: bool }
,
1623 /// This is the state after the session directory has been finalized. In this
1624 /// state, the contents of the directory must not be modified any more.
1625 Finalized { session_directory: PathBuf }
,
1626 /// This is an error state that is reached when some compilation error has
1627 /// occurred. It indicates that the contents of the session directory must
1628 /// not be used, since they might be invalid.
1629 InvalidBecauseOfErrors { session_directory: PathBuf }
,
1632 pub fn early_error(output
: config
::ErrorOutputType
, msg
: &str) -> ! {
1633 let emitter
: Box
<dyn Emitter
+ sync
::Send
> = match output
{
1634 config
::ErrorOutputType
::HumanReadable(kind
) => {
1635 let (short
, color_config
) = kind
.unzip();
1636 Box
::new(EmitterWriter
::stderr(color_config
, None
, short
, false, None
, false))
1638 config
::ErrorOutputType
::Json { pretty, json_rendered }
=> {
1639 Box
::new(JsonEmitter
::basic(pretty
, json_rendered
, None
, false))
1642 let handler
= rustc_errors
::Handler
::with_emitter(true, None
, emitter
);
1643 handler
.struct_fatal(msg
).emit();
1644 rustc_errors
::FatalError
.raise();
1647 pub fn early_warn(output
: config
::ErrorOutputType
, msg
: &str) {
1648 let emitter
: Box
<dyn Emitter
+ sync
::Send
> = match output
{
1649 config
::ErrorOutputType
::HumanReadable(kind
) => {
1650 let (short
, color_config
) = kind
.unzip();
1651 Box
::new(EmitterWriter
::stderr(color_config
, None
, short
, false, None
, false))
1653 config
::ErrorOutputType
::Json { pretty, json_rendered }
=> {
1654 Box
::new(JsonEmitter
::basic(pretty
, json_rendered
, None
, false))
1657 let handler
= rustc_errors
::Handler
::with_emitter(true, None
, emitter
);
1658 handler
.struct_warn(msg
).emit();