Struct rustc_session::session::Session
source · pub struct Session {Show 25 fields
pub target: Target,
pub host: Target,
pub opts: Options,
pub host_tlib_path: Lrc<SearchPath>,
pub target_tlib_path: Lrc<SearchPath>,
pub psess: ParseSess,
pub sysroot: PathBuf,
pub io: CompilerIO,
incr_comp_session: RwLock<IncrCompSession>,
pub prof: SelfProfilerRef,
pub code_stats: CodeStats,
optimization_fuel: Lock<OptimizationFuel>,
pub print_fuel: AtomicU64,
pub jobserver: Client,
pub lint_store: Option<Lrc<dyn LintStoreMarker>>,
pub registered_lints: bool,
pub driver_lint_caps: FxHashMap<LintId, Level>,
pub ctfe_backtrace: Lock<CtfeBacktrace>,
miri_unleashed_features: Lock<Vec<(Span, Option<Symbol>)>>,
pub asm_arch: Option<InlineAsmArch>,
pub target_features: FxIndexSet<Symbol>,
pub unstable_target_features: FxIndexSet<Symbol>,
pub cfg_version: &'static str,
pub using_internal_features: Arc<AtomicBool>,
pub expanded_args: Vec<String>,
}
Expand description
Represents the data associated with a compilation session for a single crate.
Fields§
§target: Target
§host: Target
§opts: Options
§host_tlib_path: Lrc<SearchPath>
§target_tlib_path: Lrc<SearchPath>
§psess: ParseSess
§sysroot: PathBuf
§io: CompilerIO
Input, input file path and output file path to this compilation process.
incr_comp_session: RwLock<IncrCompSession>
§prof: SelfProfilerRef
Used by -Z self-profile
.
code_stats: CodeStats
Data about code being compiled, gathered during compilation.
optimization_fuel: Lock<OptimizationFuel>
Tracks fuel info if -zfuel=crate=n
is specified.
print_fuel: AtomicU64
Always set to zero and incremented so that we can print fuel expended by a crate.
jobserver: Client
Loaded up early on in the initialization of this Session
to avoid
false positives about a job server in our environment.
lint_store: Option<Lrc<dyn LintStoreMarker>>
This only ever stores a LintStore
but we don’t want a dependency on that type here.
registered_lints: bool
Should be set if any lints are registered in lint_store
.
driver_lint_caps: FxHashMap<LintId, Level>
Cap lint level specified by a driver specifically.
ctfe_backtrace: Lock<CtfeBacktrace>
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.
miri_unleashed_features: Lock<Vec<(Span, Option<Symbol>)>>
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.
asm_arch: Option<InlineAsmArch>
Architecture to use for interpreting asm!.
target_features: FxIndexSet<Symbol>
Set of enabled features for the current target.
unstable_target_features: FxIndexSet<Symbol>
Set of enabled features for the current target, including unstable ones.
cfg_version: &'static str
The version of the rustc process, possibly including a commit hash and description.
using_internal_features: Arc<AtomicBool>
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.
expanded_args: Vec<String>
All commandline args used to invoke the compiler, with @file args fully expanded. This will only be used within debug info, e.g. in the pdb file on windows This is mainly useful for other tools that reads that debuginfo to figure out how to call the compiler with the same arguments.
Implementations§
source§impl Session
impl Session
pub fn miri_unleashed_feature(&self, span: Span, feature_gate: Option<Symbol>)
pub fn local_crate_source_file(&self) -> Option<RealFileName>
fn check_miri_unleashed_features(&self) -> Option<ErrorGuaranteed>
sourcepub fn finish_diagnostics(&self, registry: &Registry) -> Option<ErrorGuaranteed>
pub fn finish_diagnostics(&self, registry: &Registry) -> Option<ErrorGuaranteed>
Invoked all the way at the end to finish off diagnostics printing.
sourcepub fn is_test_crate(&self) -> bool
pub fn is_test_crate(&self) -> bool
Returns true if the crate is a testing one.
pub fn create_feature_err<'a>( &'a self, err: impl Diagnostic<'a>, feature: Symbol, ) -> Diag<'a>
sourcepub fn record_trimmed_def_paths(&self)
pub fn record_trimmed_def_paths(&self)
Record the fact that we called trimmed_def_paths
, and do some
checking about whether its cost was justified.
pub fn dcx(&self) -> DiagCtxtHandle<'_>
pub fn source_map(&self) -> &SourceMap
sourcepub fn enable_internal_lints(&self) -> bool
pub fn enable_internal_lints(&self) -> bool
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 instrument_coverage(&self) -> bool
pub fn instrument_coverage_branch(&self) -> bool
pub fn instrument_coverage_condition(&self) -> bool
pub fn instrument_coverage_mcdc(&self) -> bool
sourcepub fn coverage_no_mir_spans(&self) -> bool
pub fn coverage_no_mir_spans(&self) -> bool
True if -Zcoverage-options=no-mir-spans
was passed.
pub fn is_sanitizer_cfi_enabled(&self) -> bool
pub fn is_sanitizer_cfi_canonical_jump_tables_disabled(&self) -> bool
pub fn is_sanitizer_cfi_canonical_jump_tables_enabled(&self) -> bool
pub fn is_sanitizer_cfi_generalize_pointers_enabled(&self) -> bool
pub fn is_sanitizer_cfi_normalize_integers_enabled(&self) -> bool
pub fn is_sanitizer_kcfi_enabled(&self) -> bool
pub fn is_split_lto_unit_enabled(&self) -> bool
sourcepub fn crt_static(&self, crate_type: Option<CrateType>) -> bool
pub fn crt_static(&self, crate_type: Option<CrateType>) -> bool
Check whether this compile session and crate type use static crt.
pub fn is_wasi_reactor(&self) -> bool
sourcepub fn target_can_use_split_dwarf(&self) -> bool
pub fn target_can_use_split_dwarf(&self) -> bool
Returns true
if the target can use the current split debuginfo configuration.
pub fn generate_proc_macro_decls_symbol( &self, stable_crate_id: StableCrateId, ) -> String
pub fn target_filesearch(&self, kind: PathKind) -> FileSearch<'_>
pub fn host_filesearch(&self, kind: PathKind) -> FileSearch<'_>
sourcepub fn get_tools_search_paths(&self, self_contained: bool) -> Vec<PathBuf>
pub fn get_tools_search_paths(&self, self_contained: bool) -> Vec<PathBuf>
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 init_incr_comp_session(&self, session_dir: PathBuf, lock_file: Lock)
pub fn finalize_incr_comp_session(&self, new_directory_path: PathBuf)
pub fn mark_incr_comp_session_as_invalid(&self)
pub fn incr_comp_session_dir(&self) -> MappedReadGuard<'_, PathBuf>
pub fn incr_comp_session_dir_opt(&self) -> Option<MappedReadGuard<'_, PathBuf>>
sourcepub fn consider_optimizing(
&self,
get_crate_name: impl Fn() -> Symbol,
msg: impl Fn() -> String,
) -> bool
pub fn consider_optimizing( &self, get_crate_name: impl Fn() -> Symbol, msg: impl Fn() -> String, ) -> bool
We want to know if we’re allowed to do an optimization for crate foo from -z fuel=foo=n. This expends fuel if applicable, and records fuel if applicable.
sourcepub fn is_rust_2015(&self) -> bool
pub fn is_rust_2015(&self) -> bool
Is this edition 2015?
sourcepub fn at_least_rust_2018(&self) -> bool
pub fn at_least_rust_2018(&self) -> bool
Are we allowed to use features from the Rust 2018 edition?
sourcepub fn at_least_rust_2021(&self) -> bool
pub fn at_least_rust_2021(&self) -> bool
Are we allowed to use features from the Rust 2021 edition?
sourcepub fn at_least_rust_2024(&self) -> bool
pub fn at_least_rust_2024(&self) -> bool
Are we allowed to use features from the Rust 2024 edition?
sourcepub fn needs_plt(&self) -> bool
pub fn needs_plt(&self) -> bool
Returns true
if we should use the PLT for shared library calls.
sourcepub fn emit_lifetime_markers(&self) -> bool
pub fn emit_lifetime_markers(&self) -> bool
Checks if LLVM lifetime markers should be emitted.
pub fn diagnostic_width(&self) -> usize
Whether the default visibility of symbols should be “hidden” rather than “default”.
source§impl Session
impl Session
pub fn verbose_internals(&self) -> bool
pub fn print_llvm_stats(&self) -> bool
pub fn verify_llvm_ir(&self) -> bool
pub fn binary_dep_depinfo(&self) -> bool
pub fn mir_opt_level(&self) -> usize
sourcepub fn panic_strategy(&self) -> PanicStrategy
pub fn panic_strategy(&self) -> PanicStrategy
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 fewer_names(&self) -> bool
pub fn unstable_options(&self) -> bool
pub fn is_nightly_build(&self) -> bool
pub fn overflow_checks(&self) -> bool
pub fn ub_checks(&self) -> bool
pub fn relocation_model(&self) -> RelocModel
pub fn code_model(&self) -> Option<CodeModel>
pub fn tls_model(&self) -> TlsModel
pub fn direct_access_external_data(&self) -> Option<bool>
pub fn split_debuginfo(&self) -> SplitDebuginfo
pub fn stack_protector(&self) -> StackProtector
pub fn must_emit_unwind_tables(&self) -> bool
sourcepub fn threads(&self) -> usize
pub fn threads(&self) -> usize
Returns the number of query threads that should be used for this compilation
sourcepub fn codegen_units(&self) -> CodegenUnits
pub fn codegen_units(&self) -> CodegenUnits
Returns the number of codegen units that should be used for this compilation
pub fn teach(&self, code: ErrCode) -> bool
pub fn edition(&self) -> Edition
pub fn link_dead_code(&self) -> bool
pub fn filename_display_preference( &self, scope: RemapPathScopeComponents, ) -> FileNameDisplayPreference
Auto Trait Implementations§
impl !Freeze for Session
impl !RefUnwindSafe for Session
impl !Send for Session
impl !Sync for Session
impl Unpin for Session
impl !UnwindSafe for Session
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
source§impl<T> Filterable for T
impl<T> Filterable for T
source§fn filterable(
self,
filter_name: &'static str,
) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>
fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
source§impl<I, T> UpcastFrom<I, T> for T
impl<I, T> UpcastFrom<I, T> for T
fn upcast_from(from: T, _tcx: I) -> T
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeSendSync for T
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 6464 bytes