Repository navigation
Expand file tree
/
Copy pathsession.rs
More file actions
1934 lines (1702 loc) · 75.8 KB
/
Copy pathsession.rs
File metadata and controls
1934 lines (1702 loc) · 75.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use std::any::Any;
use std::ops::{Deref, DerefMut};
use std::path::Component::Prefix;
use std::path::PathBuf;
use std::str::FromStr;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, AtomicUsize};
use std::{env, io};
use rustc_data_structures::flock;
use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexSet};
use rustc_data_structures::profiling::{SelfProfiler, SelfProfilerRef};
use rustc_data_structures::sync::{AppendOnlyVec, DynSend, DynSync, Lock};
use rustc_errors::annotate_snippet_emitter_writer::AnnotateSnippetEmitter;
use rustc_errors::codes::*;
use rustc_errors::emitter::{DynEmitter, HumanReadableErrorType, OutputTheme, stderr_destination};
use rustc_errors::json::JsonEmitter;
use rustc_errors::timings::TimingSectionHandler;
use rustc_errors::{
Diag, DiagCtxt, DiagCtxtHandle, DiagMessage, Diagnostic, ErrorGuaranteed, PResult, TerminalUrl,
};
use rustc_feature::UnstableFeatures;
use rustc_macros::StableHash;
pub use rustc_span::def_id::StableCrateId;
use rustc_span::edition::Edition;
use rustc_span::source_map::{FilePathMapping, SourceMap};
use rustc_span::{RealFileName, Span, Symbol};
use rustc_structures::{CrateType, Limit};
use rustc_target::asm::InlineAsmArch;
use rustc_target::spec::{
Arch, CfgAbi, CodeModel, DebuginfoKind, MergeFunctions, Os, PanicStrategy, RelocModel,
RelroLevel, SanitizerSet, SmallDataThresholdSupport, SplitDebuginfo, StackProtector,
SymbolVisibility, Target, TargetTuple, TlsModel, apple,
};
use crate::code_stats::CodeStats;
pub use crate::code_stats::{DataTypeKind, FieldInfo, FieldKind, SizeKind, VariantInfo};
use crate::config::{
self, BranchProtection, Cfg, CheckCfg, CoverageLevel, CoverageOptions, DebugInfo,
ErrorOutputType, FunctionReturn, Input, InstrumentCoverage, InstrumentMcount, LtoCli,
NATIVE_CPU, OutFileName, OutputType, PAuthKey, PointerAuthOption, SwitchWithOptPath,
};
use crate::filesearch::FileSearch;
use crate::lint::LintId;
use crate::parse::ParseSess;
use crate::search_paths::SearchPath;
use crate::{diagnostics, filesearch, lint};
/// The behavior of the CTFE engine when an error occurs with regards to backtraces.
#[derive(Clone, Copy)]
pub enum CtfeBacktrace {
/// Do nothing special, return the error as usual without a backtrace.
Disabled,
/// Capture a backtrace at the point the error is created and return it in the error
/// (to be printed later if/when the error ever actually gets shown to the user).
Capture,
/// Capture a backtrace at the point the error is created and immediately print it out.
Immediate,
}
#[derive(Clone, Copy, Debug, StableHash)]
pub struct Limits {
/// The maximum recursion limit for potentially infinitely recursive
/// operations such as auto-dereference and monomorphization.
pub recursion_limit: Limit,
/// The size at which the `large_assignments` lint starts
/// being emitted.
pub move_size_limit: Limit,
/// The maximum length of types during monomorphization.
pub type_length_limit: Limit,
/// The maximum pattern complexity allowed (internal only).
pub pattern_complexity_limit: Limit,
}
pub struct CompilerIO {
pub input: Input,
pub output_dir: Option<PathBuf>,
pub output_file: Option<OutFileName>,
pub temps_dir: Option<PathBuf>,
}
pub trait DynLintStore: Any + DynSync + DynSend {
/// Provides a way to access lint groups without depending on `rustc_lint`
fn lint_groups_iter(&self) -> Box<dyn Iterator<Item = LintGroup> + '_>;
}
/// Hardware pointer-signing keys in ARM8.3.
/// These values are the same as used in ptrauth.h.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PointerAuthARM8_3Key {
ASIA = 0,
ASIB = 1,
ASDA = 2,
ASDB = 3,
}
/// Forms of extra discrimination.
pub enum PointerAuthDiscrimination {
/// No additional discrimination.
None,
/// Include a hash of the entity's type.
Type,
/// Include a hash of the entity's identity.
Decl,
/// Discriminate using a constant value.
Constant,
}
/// Types of address discrimination.
pub enum PointerAuthAddressDiscriminator {
/// Enable/disable hardware address discrimination.
HardwareAddress(bool),
/// Use a synthetic value. For instance init/fini entries can not the address of the arrays,
/// they must use a synthetic value of `1`.
Synthetic(u64),
}
pub struct PointerAuthSchema {
pub is_address_discriminated: PointerAuthAddressDiscriminator,
pub discrimination_kind: PointerAuthDiscrimination,
pub key: PointerAuthARM8_3Key,
pub constant_discriminator: u16,
}
impl PointerAuthSchema {
pub fn function_pointers_default(target: &Target) -> Self {
assert!(target.cfg_abi == CfgAbi::Pauthtest);
return Self {
is_address_discriminated: PointerAuthAddressDiscriminator::HardwareAddress(false),
discrimination_kind: PointerAuthDiscrimination::None,
key: PointerAuthARM8_3Key::ASIA,
constant_discriminator: 0,
};
}
pub fn init_fini_default(target: &Target) -> Self {
assert!(target.cfg_abi == CfgAbi::Pauthtest);
return Self {
is_address_discriminated: PointerAuthAddressDiscriminator::Synthetic(1),
discrimination_kind: PointerAuthDiscrimination::None,
key: PointerAuthARM8_3Key::ASIA,
// ptrauth_string_discriminator("init_fini")
constant_discriminator: 0xd9d4,
};
}
}
pub struct PointerAuthConfig {
/// Should return addresses be authenticated?
pub return_addresses: bool,
/// Do authentication failures cause a trap?
pub auth_traps: bool,
/// Do indirect goto label addresses need to be authenticated?
pub indirect_gotos: bool,
/// Should ELF GOT entries be signed?
pub elf_got: bool,
/// Use hardened lowering for jump-table dispatch?
pub aarch64_jump_table_hardening: bool,
/// The ABI for C function pointers.
pub function_pointers: Option<PointerAuthSchema>,
/// The ABI for function addresses in .init_array and .fini_array
pub init_fini: Option<PointerAuthSchema>,
/// Use of pointer authentication intrinsics.
pub intrinsics: bool,
/// The following are used only for compatibility with C++ and control over generated abi
/// version. They do not control Rust code generation.
pub typeinfo_vt_ptr_discrimination: bool,
pub vt_ptr_addr_discrimination: bool,
pub vt_ptr_type_discrimination: bool,
}
impl PointerAuthConfig {
fn default(target: &Target) -> Self {
assert!(target.cfg_abi == CfgAbi::Pauthtest);
return Self {
return_addresses: true,
auth_traps: true,
indirect_gotos: true,
elf_got: false,
aarch64_jump_table_hardening: true,
function_pointers: Some(PointerAuthSchema::function_pointers_default(target)),
init_fini: Some(PointerAuthSchema::init_fini_default(target)),
intrinsics: true,
typeinfo_vt_ptr_discrimination: true,
vt_ptr_addr_discrimination: true,
vt_ptr_type_discrimination: true,
};
}
pub fn calculate_pauth_abi_version(&self, target: &Target) -> u32 {
assert!(target.cfg_abi == CfgAbi::Pauthtest);
// Bit positions of version flags for AARCH64_PAUTH_PLATFORM_LLVM_LINUX.
// NOTE: The enum values must stay in sync with clang, see:
// <llvm_root>/llvm/include/llvm/BinaryFormat/ELF.h
//
// We do not expect to use C++ virtual dispatch, but enable these flags
// for compatibility with C++ code. Intrinsics are also always enabled.
//
// Link to PAuth core info documentation:
// <https://github.com/ARM-software/abi-aa/blob/2025Q4/pauthabielf64/pauthabielf64.rst#core-information>
const INTRINSICS: u32 = 0;
const CALLS: u32 = 1;
const RETURNS: u32 = 2;
const AUTHTRAPS: u32 = 3;
const VT_PTR_ADDR_DISCR: u32 = 4;
const VT_PTR_TYPE_DISCR: u32 = 5;
const INIT_FINI: u32 = 6;
const INIT_FINI_ADDR_DISC: u32 = 7;
const GOT: u32 = 8;
const GOTOS: u32 = 9;
const TYPEINFO_VT_PTR_DISCR: u32 = 10;
// FIXME(jchlanda) We don't yet support function pointer type discrimination.
// const FPTR_TYPE_DISCR: u32 = 11;
let pauth_abi_version: u32 = (u32::from(self.intrinsics) << INTRINSICS)
| (u32::from(self.function_pointers.is_some()) << CALLS)
| (u32::from(self.return_addresses) << RETURNS)
| (u32::from(self.auth_traps) << AUTHTRAPS)
| (u32::from(self.vt_ptr_addr_discrimination) << VT_PTR_ADDR_DISCR)
| (u32::from(self.vt_ptr_type_discrimination) << VT_PTR_TYPE_DISCR)
| (u32::from(self.init_fini.is_some()) << INIT_FINI)
| (u32::from(self.init_fini.as_ref().is_some_and(|schema| {
matches!(
schema.is_address_discriminated,
PointerAuthAddressDiscriminator::HardwareAddress(true)
| PointerAuthAddressDiscriminator::Synthetic(_)
)
})) << INIT_FINI_ADDR_DISC)
| (u32::from(self.elf_got) << GOT)
| (u32::from(self.indirect_gotos) << GOTOS)
| (u32::from(self.typeinfo_vt_ptr_discrimination) << TYPEINFO_VT_PTR_DISCR);
pauth_abi_version
}
pub fn from_raw(raw: &[(PointerAuthOption, bool)], target: &Target) -> Option<Self> {
if target.cfg_abi != CfgAbi::Pauthtest {
return None;
}
let mut cfg = Self::default(target);
if raw.is_empty() {
return Some(cfg);
}
for (opt, enabled) in raw {
match opt {
PointerAuthOption::Calls => {
if *enabled {
cfg.function_pointers.get_or_insert_with(|| {
PointerAuthSchema::function_pointers_default(target)
});
} else {
cfg.function_pointers = None;
}
}
PointerAuthOption::FunctionPointerTypeDiscrimination => {
if *enabled {
let schema = cfg.function_pointers.get_or_insert_with(|| {
PointerAuthSchema::function_pointers_default(target)
});
schema.discrimination_kind = PointerAuthDiscrimination::Type;
} else if let Some(schema) = &mut cfg.function_pointers {
schema.discrimination_kind = PointerAuthDiscrimination::None;
}
}
PointerAuthOption::ReturnAddresses => cfg.return_addresses = *enabled,
PointerAuthOption::AuthTraps => cfg.auth_traps = *enabled,
PointerAuthOption::IndirectGotos => cfg.indirect_gotos = *enabled,
PointerAuthOption::ElfGot => cfg.elf_got = *enabled,
PointerAuthOption::Aarch64JumpTableHardening => {
cfg.aarch64_jump_table_hardening = *enabled
}
PointerAuthOption::InitFini => {
if *enabled {
cfg.init_fini
.get_or_insert_with(|| PointerAuthSchema::init_fini_default(target));
} else {
cfg.init_fini = None;
}
}
PointerAuthOption::InitFiniAddressDiscrimination => {
if *enabled {
let schema = cfg
.init_fini
.get_or_insert_with(|| PointerAuthSchema::init_fini_default(target));
schema.is_address_discriminated =
PointerAuthAddressDiscriminator::HardwareAddress(true);
} else if let Some(schema) = &mut cfg.init_fini {
schema.is_address_discriminated =
PointerAuthAddressDiscriminator::Synthetic(1);
}
}
PointerAuthOption::Intrinsics => cfg.intrinsics = *enabled,
PointerAuthOption::TypeInfoVTPtrDisc => {
cfg.typeinfo_vt_ptr_discrimination = *enabled
}
PointerAuthOption::VTPtrAddrDisc => cfg.vt_ptr_addr_discrimination = *enabled,
PointerAuthOption::VTPtrTypeDisc => cfg.vt_ptr_type_discrimination = *enabled,
}
}
Some(cfg)
}
pub fn fn_attrs(&self) -> Vec<&'static str> {
// FIXME(jchlanda) This is not an exhaustive list of all `ptrauth`-related attributes, but only
// those currently supported. The list is expected to grow as additional functionality is
// implemented, particularly for C++ interoperability.
let mut attrs = vec![];
if self.aarch64_jump_table_hardening {
attrs.push("aarch64-jump-table-hardening");
}
if self.auth_traps {
attrs.push("ptrauth-auth-traps");
}
if self.function_pointers.is_some() {
attrs.push("ptrauth-calls");
}
if self.indirect_gotos {
attrs.push("ptrauth-indirect-gotos");
}
if self.return_addresses {
attrs.push("ptrauth-returns");
}
attrs
}
}
/// Partial session built before the full session. More specifically, `EarlySession` is used to
/// init the codegen backend, and then both pieces are used to build the full `Session`.
pub struct EarlySession {
pub target: Target,
pub host: Target,
pub opts: config::Options,
pub psess: ParseSess,
}
// JUSTIFICATION: defn of the suggested wrapper fns
#[allow(rustc::bad_opt_access)]
impl EarlySession {
#[inline]
pub fn dcx(&self) -> DiagCtxtHandle<'_> {
self.psess.dcx()
}
#[inline]
pub fn source_map(&self) -> &SourceMap {
self.psess.source_map()
}
/// Note: this is simpler than `Session::lto`, hence the `early_` prefix (to more clearly
/// distinguish it).
pub fn early_lto(&self) -> LtoCli {
self.opts.cg.lto
}
pub fn print_llvm_stats(&self) -> bool {
self.opts.unstable_opts.print_codegen_stats
}
pub fn print_llvm_stats_json(&self) -> Option<&String> {
self.opts.unstable_opts.print_codegen_stats_json.as_ref()
}
pub fn relocation_model(&self) -> RelocModel {
self.opts.cg.relocation_model.unwrap_or(self.target.relocation_model)
}
pub fn code_model(&self) -> Option<CodeModel> {
self.opts.cg.code_model.or(self.target.code_model)
}
pub fn tls_model(&self) -> TlsModel {
self.opts.unstable_opts.tls_model.unwrap_or(self.target.tls_model)
}
/// Returns the panic strategy for this compile session. If the user explicitly selected one
/// using '-C panic', use that, otherwise use the panic strategy defined by the target.
pub fn panic_strategy(&self) -> PanicStrategy {
self.opts.cg.panic.unwrap_or(self.target.panic_strategy)
}
/// Get the deployment target on Apple platforms based on the standard environment variables,
/// or fall back to the minimum version supported by `rustc`.
///
/// This should be guarded behind `if sess.target.is_like_darwin`.
pub fn apple_deployment_target(&self) -> apple::OSVersion {
let min = apple::OSVersion::minimum_deployment_target(&self.target);
let env_var = apple::deployment_target_env_var(&self.target.os);
// FIXME(madsmtm): Track changes to this.
if let Ok(deployment_target) = env::var(env_var) {
match apple::OSVersion::from_str(&deployment_target) {
Ok(version) => {
let os_min = apple::OSVersion::os_minimum_deployment_target(&self.target.os);
// It is common that the deployment target is set a bit too low, for example on
// macOS Aarch64 to also target older x86_64. So we only want to warn when
// variable is lower than the minimum OS supported by rustc, not when the
// variable is lower than the minimum for a specific target.
if version < os_min {
self.dcx().emit_warn(diagnostics::AppleDeploymentTarget::TooLow {
env_var,
version: version.fmt_pretty().to_string(),
os_min: os_min.fmt_pretty().to_string(),
});
}
// Raise the deployment target to the minimum supported.
version.max(min)
}
Err(error) => {
self.dcx()
.emit_err(diagnostics::AppleDeploymentTarget::Invalid { env_var, error });
min
}
}
} else {
// If no deployment target variable is set, default to the minimum found above.
min
}
}
pub fn sanitizers(&self) -> SanitizerSet {
self.opts
.unstable_opts
.sanitizer
.combine_with_defaults(self.target.options.default_sanitizers)
}
pub fn merge_functions(&self) -> MergeFunctions {
self.opts.unstable_opts.merge_functions.unwrap_or(self.target.merge_functions)
}
pub fn is_nightly_build(&self) -> bool {
self.opts.unstable_features.is_nightly_build()
}
}
/// Some info about the backend, returned by `CodegenBackend::init` and put into the `Session`.
#[derive(Default)]
pub struct CodegenBackendInit {
/// See `Session::global_backend_features`.
pub global_backend_features: Vec<String>,
/// See `Session::replaced_intrinsics`.
pub replaced_intrinsics: Vec<Symbol>,
/// See `Session::fallback_intrinsics`.
pub fallback_intrinsics: Vec<Symbol>,
/// See `Session::thin_lto_supported`.
pub thin_lto_supported: bool = true,
}
/// Represents the data associated with a compilation
/// session for a single crate.
pub struct Session {
/// The `EarlySession` is embedded so it can be passed to functions that need it.
/// `Session::deref{_,mut}` exist so the fields within can be accessed as if they were direct
/// fields of `Session`.
pub early_sess: EarlySession,
pub wasm_proc_macro_tuple: TargetTuple,
pub wasm_proc_macro_target: Target,
pub target_tlib_path: SearchPath,
pub unstable_features: UnstableFeatures,
pub config: Cfg,
pub check_config: CheckCfg,
/// Spans passed to `proc_macro::quote_span`. Each span has a numerical
/// identifier represented by its position in the vector.
proc_macro_quoted_spans: AppendOnlyVec<Span>,
/// Input, input file path and output file path to this compilation process.
pub io: CompilerIO,
/// Used by `-Z self-profile`.
pub prof: SelfProfilerRef,
/// Used to emit section timings events (enabled by `--json=timings`).
pub timings: TimingSectionHandler,
/// Data about code being compiled, gathered during compilation.
pub code_stats: CodeStats,
/// This only ever stores a `LintStore` but we don't want a dependency on that type here.
pub lint_store: Option<Arc<dyn DynLintStore>>,
/// Cap lint level specified by a driver specifically.
pub driver_lint_caps: FxHashMap<lint::LintId, lint::Level>,
/// Tracks the current behavior of the CTFE engine when an error occurs.
/// Options range from returning the error without a backtrace to returning an error
/// and immediately printing the backtrace to stderr.
/// The `Lock` is only used by miri to allow setting `ctfe_backtrace` after analysis when
/// `MIRI_BACKTRACE` is set. This makes it only apply to miri's errors and not to all CTFE
/// errors.
pub ctfe_backtrace: Lock<CtfeBacktrace>,
/// This tracks where `-Zunleash-the-miri-inside-of-you` was used to get around a
/// const check, optionally with the relevant feature gate. We use this to
/// warn about unleashing, but with a single diagnostic instead of dozens that
/// drown everything else in noise.
miri_unleashed_features: Lock<Vec<(Span, Option<Symbol>)>>,
/// Architecture to use for interpreting asm!.
pub asm_arch: Option<InlineAsmArch>,
/// Set of actually enabled features for the current target, including ones that are not
/// in `cfg(target_feature)` because they are unstable or internal-only.
/// This is used by the compiler itself when it needs to know which target features are actually
/// going to be enabled in the backend (e.g. for knowing which registers inline asm can use).
pub internal_target_features: FxIndexSet<Symbol>,
/// The list of backend target features for this session. Not used by Rust itself because the
/// concrete feature names can be backend-specific. This is computed from the target's base
/// features, `-Ctarget-cpu`, `-Ctarget-feature`, and other flags that the current backend
/// models as target features (but that are not considered target features in Rust).
pub global_backend_features: Vec<String>,
/// The version of the rustc process, possibly including a commit hash and description.
pub cfg_version: &'static str,
/// The inner atomic value is set to true when a feature marked as `internal` is
/// enabled. Makes it so that "please report a bug" is hidden, as ICEs with
/// internal features are wontfix, and they are usually the cause of the ICEs.
/// None signifies that this is not tracked.
pub using_internal_features: &'static AtomicBool,
/// Environment variables accessed during the build and their values when they exist.
pub env_depinfo: Lock<FxIndexSet<(Symbol, Option<Symbol>)>>,
/// File paths accessed during the build.
pub file_depinfo: Lock<FxIndexSet<Symbol>>,
target_filesearch: Arc<FileSearch>,
host_filesearch: Arc<FileSearch>,
wasm_proc_macro_filesearch: Option<Arc<FileSearch>>,
/// A list of all intrinsics that the current codegen backend definitely replaces with its own
/// implementations, which means their fallback bodies do not need to be monomorphized.
pub replaced_intrinsics: FxHashSet<Symbol>,
/// A list of all intrinsics that the current codegen backend definitely does *not* replace
/// with its own implementations, which means their fallback bodies can be MIR-inlined.
pub fallback_intrinsics: FxHashSet<Symbol>,
/// Does the codegen backend support ThinLTO?
pub thin_lto_supported: bool,
/// Global per-session counter for MIR optimization pass applications.
///
/// Used by `-Zmir-opt-bisect-limit` to assign an index to each
/// optimization-pass execution candidate during this compilation.
pub mir_opt_bisect_eval_count: AtomicUsize,
/// Whether the test harness removed a user-written `#[rustc_main]` attribute
/// while generating the synthetic test entry point.
pub removed_rustc_main_attr: AtomicBool,
/// Config specifying targets' pointer authentication preference.
pub pointer_auth_config: Option<PointerAuthConfig>,
/// Cached sanitizer set. Cached because it is accessed frequently.
sanitizers: SanitizerSet,
}
impl Deref for Session {
type Target = EarlySession;
fn deref(&self) -> &EarlySession {
&self.early_sess
}
}
impl DerefMut for Session {
fn deref_mut(&mut self) -> &mut EarlySession {
&mut self.early_sess
}
}
#[derive(Clone, Copy)]
pub enum CodegenUnits {
/// Specified by the user. In this case we try fairly hard to produce the
/// number of CGUs requested.
User(usize),
/// A default value, i.e. not specified by the user. In this case we take
/// more liberties about CGU formation, e.g. avoid producing very small
/// CGUs.
Default(usize),
}
impl CodegenUnits {
pub fn as_usize(self) -> usize {
match self {
CodegenUnits::User(n) => n,
CodegenUnits::Default(n) => n,
}
}
}
pub struct LintGroup {
pub name: &'static str,
pub lints: Vec<LintId>,
pub is_externally_loaded: bool,
}
impl Session {
pub fn miri_unleashed_feature(&self, span: Span, feature_gate: Option<Symbol>) {
self.miri_unleashed_features.lock().push((span, feature_gate));
}
pub fn local_crate_source_file(&self) -> Option<RealFileName> {
Some(
self.source_map()
.path_mapping()
.to_real_filename(self.source_map().working_dir(), self.io.input.opt_path()?),
)
}
fn check_miri_unleashed_features(&self) -> Option<ErrorGuaranteed> {
let mut guar = None;
let unleashed_features = self.miri_unleashed_features.lock();
if !unleashed_features.is_empty() {
let mut must_err = false;
// Create a diagnostic pointing at where things got unleashed.
self.dcx().emit_warn(diagnostics::SkippingConstChecks {
unleashed_features: unleashed_features
.iter()
.map(|(span, gate)| {
gate.map(|gate| {
must_err = true;
diagnostics::UnleashedFeatureHelp::Named { span: *span, gate }
})
.unwrap_or(diagnostics::UnleashedFeatureHelp::Unnamed { span: *span })
})
.collect(),
});
// If we should err, make sure we did.
if must_err && self.dcx().has_errors().is_none() {
// We have skipped a feature gate, and not run into other errors... reject.
guar = Some(self.dcx().emit_err(diagnostics::NotCircumventFeature));
}
}
guar
}
/// Invoked all the way at the end to finish off diagnostics printing.
pub fn finish_diagnostics(&self) -> Option<ErrorGuaranteed> {
let mut guar = None;
guar = guar.or(self.check_miri_unleashed_features());
guar = guar.or(self.dcx().emit_stashed_diagnostics());
self.dcx().print_error_count();
if self.opts.json_future_incompat {
self.dcx().emit_future_breakage_report();
}
guar
}
/// Returns true if the crate is a testing one.
pub fn is_test_crate(&self) -> bool {
self.opts.test
}
/// `feature` must be a language feature.
#[track_caller]
pub fn create_feature_err<'a>(&'a self, err: impl Diagnostic<'a>, feature: Symbol) -> Diag<'a> {
let mut err = self.dcx().create_err(err);
if err.code.is_none() {
err.code(E0658);
}
diagnostics::add_feature_diagnostics(&mut err, self, feature);
err
}
/// Record the fact that we called `trimmed_def_paths`, and do some
/// checking about whether its cost was justified.
pub fn record_trimmed_def_paths(&self) {
if self.opts.unstable_opts.print_type_sizes
|| self.opts.unstable_opts.query_dep_graph
|| self.opts.unstable_opts.dump_mir.is_some()
|| self.opts.unstable_opts.unpretty.is_some()
|| self.prof.is_args_recording_enabled()
|| self.opts.output_types.contains_key(&OutputType::Mir)
|| std::env::var_os("RUSTC_LOG").is_some()
{
return;
}
self.dcx().set_must_produce_diag()
}
pub fn proc_macro_quoted_spans(&self) -> impl Iterator<Item = (usize, Span)> {
// This is equivalent to `.iter().copied().enumerate()`, but that isn't possible for
// AppendOnlyVec, so we resort to this scheme.
self.proc_macro_quoted_spans.iter_enumerated()
}
pub fn save_proc_macro_span(&self, span: Span) -> usize {
self.proc_macro_quoted_spans.push(span)
}
/// Returns `true` if internal lints should be added to the lint store - i.e. if
/// `-Zunstable-options` is provided and this isn't rustdoc (internal lints can trigger errors
/// to be emitted under rustdoc).
pub fn enable_internal_lints(&self) -> bool {
self.unstable_options() && !self.opts.actually_rustdoc
}
pub fn instrument_coverage(&self) -> bool {
self.opts.cg.instrument_coverage() != InstrumentCoverage::No
}
pub fn instrument_coverage_branch(&self) -> bool {
self.instrument_coverage()
&& self.opts.unstable_opts.coverage_options.level >= CoverageLevel::Branch
}
pub fn instrument_coverage_condition(&self) -> bool {
self.instrument_coverage()
&& self.opts.unstable_opts.coverage_options.level >= CoverageLevel::Condition
}
/// Provides direct access to the `CoverageOptions` struct, so that
/// individual flags for debugging/testing coverage instrumetation don't
/// need separate accessors.
pub fn coverage_options(&self) -> &CoverageOptions {
&self.opts.unstable_opts.coverage_options
}
pub fn is_sanitizer_cfi_enabled(&self) -> bool {
self.sanitizers().contains(SanitizerSet::CFI)
}
pub fn is_sanitizer_cfi_canonical_jump_tables_disabled(&self) -> bool {
self.opts.unstable_opts.sanitizer_cfi_canonical_jump_tables == Some(false)
}
pub fn is_sanitizer_cfi_canonical_jump_tables_enabled(&self) -> bool {
self.opts.unstable_opts.sanitizer_cfi_canonical_jump_tables == Some(true)
}
pub fn is_sanitizer_cfi_generalize_pointers_enabled(&self) -> bool {
self.opts.unstable_opts.sanitizer_cfi_generalize_pointers == Some(true)
}
pub fn is_sanitizer_cfi_normalize_integers_enabled(&self) -> bool {
self.opts.unstable_opts.sanitizer_cfi_normalize_integers == Some(true)
}
pub fn is_sanitizer_cfi_recover_enabled(&self) -> bool {
self.opts.unstable_opts.sanitizer_cfi_recover == Some(true)
}
pub fn is_sanitizer_cfi_diag_enabled(&self) -> bool {
self.opts.unstable_opts.sanitizer_cfi_diag == Some(true)
}
pub fn is_sanitizer_cfi_minimal_runtime_enabled(&self) -> bool {
self.opts.unstable_opts.sanitizer_cfi_minimal_runtime == Some(true)
}
pub fn is_sanitizer_kcfi_arity_enabled(&self) -> bool {
self.opts.unstable_opts.sanitizer_kcfi_arity == Some(true)
}
pub fn is_sanitizer_kcfi_enabled(&self) -> bool {
self.sanitizers().contains(SanitizerSet::KCFI)
}
pub fn is_split_lto_unit_enabled(&self) -> bool {
self.opts.unstable_opts.split_lto_unit == Some(true)
}
/// Check whether this compile session and crate type use static crt.
pub fn crt_static(&self, crate_type: Option<CrateType>) -> bool {
if !self.target.crt_static_respected {
// If the target does not opt in to crt-static support, use its default.
return self.target.crt_static_default;
}
let requested_features = self.opts.cg.target_feature.split(',');
let found_negative = requested_features.clone().any(|r| r == "-crt-static");
let found_positive = requested_features.clone().any(|r| r == "+crt-static");
// JUSTIFICATION: necessary use of crate_types directly (see FIXME below)
#[allow(rustc::bad_opt_access)]
if found_positive || found_negative {
found_positive
} else if crate_type == Some(CrateType::ProcMacro)
|| crate_type == None && self.opts.crate_types.contains(&CrateType::ProcMacro)
{
// FIXME: When crate_type is not available,
// we use compiler options to determine the crate_type.
// We can't check `#![crate_type = "proc-macro"]` here.
false
} else {
self.target.crt_static_default
}
}
pub fn is_wasi_reactor(&self) -> bool {
self.target.options.os == Os::Wasi
&& matches!(
self.opts.unstable_opts.wasi_exec_model,
Some(config::WasiExecModel::Reactor)
)
}
/// Returns `true` if the target can use the current split debuginfo configuration.
pub fn target_can_use_split_dwarf(&self) -> bool {
self.target.debuginfo_kind == DebuginfoKind::Dwarf
}
pub fn target_filesearch(&self) -> &filesearch::FileSearch {
&self.target_filesearch
}
pub fn host_filesearch(&self) -> &filesearch::FileSearch {
&self.host_filesearch
}
pub fn wasm_proc_macro_filesearch(&self) -> &filesearch::FileSearch {
self.wasm_proc_macro_filesearch.as_ref().expect("wasm_filesearch not set")
}
/// Returns a list of directories where target-specific tool binaries are located. Some fallback
/// directories are also returned, for example if `--sysroot` is used but tools are missing
/// (#125246): we also add the bin directories to the sysroot where rustc is located.
pub fn get_tools_search_paths(&self, self_contained: bool) -> Vec<PathBuf> {
let search_paths = self
.opts
.sysroot
.all_paths()
.map(|sysroot| filesearch::make_target_bin_path(&sysroot, config::host_tuple()));
if self_contained {
// The self-contained tools are expected to be e.g. in `bin/self-contained` in the
// sysroot's `rustlib` path, so we add such a subfolder to the bin path, and the
// fallback paths.
search_paths.flat_map(|path| [path.clone(), path.join("self-contained")]).collect()
} else {
search_paths.collect()
}
}
/// Is this edition 2015?
pub fn is_rust_2015(&self) -> bool {
self.edition().is_rust_2015()
}
/// Are we allowed to use features from the Rust 2018 edition?
pub fn at_least_rust_2018(&self) -> bool {
self.edition().at_least_rust_2018()
}
/// Are we allowed to use features from the Rust 2021 edition?
pub fn at_least_rust_2021(&self) -> bool {
self.edition().at_least_rust_2021()
}
/// Are we allowed to use features from the Rust 2024 edition?
pub fn at_least_rust_2024(&self) -> bool {
self.edition().at_least_rust_2024()
}
/// Returns `true` if we should use the PLT for shared library calls.
pub fn needs_plt(&self) -> bool {
// Check if the current target usually wants PLT to be enabled.
// The user can use the command line flag to override it.
let want_plt = self.target.plt_by_default;
let dbg_opts = &self.opts.unstable_opts;
let relro_level = self.opts.cg.relro_level.unwrap_or(self.target.relro_level);
// Only enable this optimization by default if full relro is also enabled.
// In this case, lazy binding was already unavailable, so nothing is lost.
// This also ensures `-Wl,-z,now` is supported by the linker.
let full_relro = RelroLevel::Full == relro_level;
// If user didn't explicitly forced us to use / skip the PLT,
// then use it unless the target doesn't want it by default or the full relro forces it on.
dbg_opts.plt.unwrap_or(want_plt || !full_relro)
}
/// Checks if LLVM lifetime markers should be emitted.
pub fn emit_lifetime_markers(&self) -> bool {
self.opts.optimize != config::OptLevel::No
// AddressSanitizer and KernelAddressSanitizer uses lifetimes to detect use after scope bugs.
//
// MemorySanitizer uses lifetimes to detect use of uninitialized stack variables.
//
// HWAddressSanitizer and KernelHWAddressSanitizer will use lifetimes to detect use after
// scope bugs in the future.
|| self.sanitizers().intersects(SanitizerSet::ADDRESS | SanitizerSet::KERNELADDRESS | SanitizerSet::MEMORY | SanitizerSet::HWADDRESS | SanitizerSet::KERNELHWADDRESS)
// Lifetimes are necessary for retagging semantics.
|| self.opts.unstable_opts.codegen_emit_retag.is_some()
}
pub fn diagnostic_width(&self) -> usize {
let default_column_width = 140;
if let Some(width) = self.opts.diagnostic_width {
width
} else if self.opts.unstable_opts.ui_testing {
default_column_width
} else {
termize::dimensions().map_or(default_column_width, |(w, _)| w)
}
}
/// Returns the default symbol visibility.
pub fn default_visibility(&self) -> SymbolVisibility {
self.opts
.unstable_opts
.default_visibility
.or(self.target.options.default_visibility)
.unwrap_or(SymbolVisibility::Interposable)
}
pub fn staticlib_components(&self, verbatim: bool) -> (&str, &str) {
if verbatim {
("", "")
} else {
(&*self.target.staticlib_prefix, &*self.target.staticlib_suffix)
}
}
pub fn lint_groups_iter(&self) -> Box<dyn Iterator<Item = LintGroup> + '_> {
match self.lint_store {
Some(ref lint_store) => lint_store.lint_groups_iter(),
None => Box::new(std::iter::empty()),
}
}
/// Resolves a `path` mentioned inside Rust code, returning an absolute path.
///
/// This unifies the logic used for resolving `include_*!` and debugger visualizers.
pub fn resolve_path(&self, path: impl Into<PathBuf>, span: Span) -> PResult<'_, PathBuf> {
let path = path.into();
// Relative paths are resolved relative to the file in which they are found
// after macro expansion (that is, they are unhygienic).
if !path.is_absolute() {
let callsite = span.source_callsite();
let source_map = self.source_map();
let Some(mut base_path) = source_map.span_to_filename(callsite).into_local_path()
else {
return Err(self.dcx().create_err(diagnostics::ResolveRelativePath {
span,
path: source_map
.filename_for_diagnostics(&source_map.span_to_filename(callsite))
.to_string(),
}));
};
base_path.pop();
base_path.push(path);
Ok(base_path)
} else {
// This ensures that Windows verbatim paths are fixed if mixed path separators are used,
// which can happen when `concat!` is used to join paths.
match path.components().next() {
Some(Prefix(prefix)) if prefix.kind().is_verbatim() => {
Ok(path.components().collect())
}
_ => Ok(path),
}
}
}
}
// JUSTIFICATION: defn of the suggested wrapper fns
#[allow(rustc::bad_opt_access)]
impl Session {
pub fn verbose_internals(&self) -> bool {
self.opts.unstable_opts.verbose_internals
}
pub fn verify_llvm_ir(&self) -> bool {
self.opts.unstable_opts.verify_llvm_ir || option_env!("RUSTC_VERIFY_LLVM_IR").is_some()
}
pub fn binary_dep_depinfo(&self) -> bool {
self.opts.unstable_opts.binary_dep_depinfo
}
pub fn mir_opt_level(&self) -> usize {
self.opts.unstable_opts.mir_opt_level.unwrap_or_else(|| self.opts.optimize.mir_opt_level())
}
/// Calculates the flavor of LTO to use for this compilation.
pub fn lto(&self) -> config::Lto {
// If our target has codegen requirements ignore the command line
if self.target.requires_lto {
return config::Lto::Fat;
}
// If the user specified something, return that. If they only said `-C
// lto` and we've for whatever reason forced off ThinLTO via the CLI,
// then ensure we can't use a ThinLTO.
match self.opts.cg.lto {
config::LtoCli::Unspecified => {
// The compiler was invoked without the `-Clto` flag. Fall
// through to the default handling
}