Enum rustc_middle::ty::instance::InstanceKind
source · pub enum InstanceKind<'tcx> {
Show 14 variants
Item(DefId),
Intrinsic(DefId),
VTableShim(DefId),
ReifyShim(DefId, Option<ReifyReason>),
FnPtrShim(DefId, Ty<'tcx>),
Virtual(DefId, usize),
ClosureOnceShim {
call_once: DefId,
track_caller: bool,
},
ConstructCoroutineInClosureShim {
coroutine_closure_def_id: DefId,
receiver_by_ref: bool,
},
CoroutineKindShim {
coroutine_def_id: DefId,
},
ThreadLocalShim(DefId),
DropGlue(DefId, Option<Ty<'tcx>>),
CloneShim(DefId, Ty<'tcx>),
FnPtrAddrShim(DefId, Ty<'tcx>),
AsyncDropGlueCtorShim(DefId, Option<Ty<'tcx>>),
}
Variants§
Item(DefId)
A user-defined callable item.
This includes:
fn
items- closures
- coroutines
Intrinsic(DefId)
An intrinsic fn
item (with "rust-intrinsic"
or "platform-intrinsic"
ABI).
Alongside Virtual
, this is the only InstanceKind
that does not have its own callable MIR.
Instead, codegen and const eval “magically” evaluate calls to intrinsics purely in the
caller.
VTableShim(DefId)
<T as Trait>::method
where method
receives unsizeable self: Self
(part of the
unsized_locals
feature).
The generated shim will take Self
via *mut Self
- conceptually this is &owned Self
-
and dereference the argument to call the original function.
ReifyShim(DefId, Option<ReifyReason>)
fn()
pointer where the function itself cannot be turned into a pointer.
One example is <dyn Trait as Trait>::fn
, where the shim contains
a virtual call, which codegen supports only via a direct call to the
<dyn Trait as Trait>::fn
instance (an InstanceKind::Virtual
).
Another example is functions annotated with #[track_caller]
, which
must have their implicit caller location argument populated for a call.
Because this is a required part of the function’s ABI but can’t be tracked
as a property of the function pointer, we use a single “caller location”
(the definition of the function itself).
The second field encodes why this shim was created. This allows distinguishing between
a ReifyShim
that appears in a vtable vs one that appears as a function pointer.
This field will only be populated if we are compiling in a mode that needs these shims to be separable, currently only when KCFI is enabled.
FnPtrShim(DefId, Ty<'tcx>)
<fn() as FnTrait>::call_*
(generated FnTrait
implementation for fn()
pointers).
DefId
is FnTrait::call_*
.
Virtual(DefId, usize)
Dynamic dispatch to <dyn Trait as Trait>::fn
.
This InstanceKind
does not have callable MIR. Calls to Virtual
instances must be
codegen’d as virtual calls through the vtable.
If this is reified to a fn
pointer, a ReifyShim
is used (see ReifyShim
above for more
details on that).
ClosureOnceShim
<[FnMut/Fn closure] as FnOnce>::call_once
.
The DefId
is the ID of the call_once
method in FnOnce
.
This generates a body that will just borrow the (owned) self type,
and dispatch to the FnMut::call_mut
instance for the closure.
ConstructCoroutineInClosureShim
<[FnMut/Fn coroutine-closure] as FnOnce>::call_once
The body generated here differs significantly from the ClosureOnceShim
,
since we need to generate a distinct coroutine type that will move the
closure’s upvars out of the closure.
CoroutineKindShim
<[coroutine] as Future>::poll
, but for coroutines produced when AsyncFnOnce
is called on a coroutine-closure whose closure kind greater than FnOnce
, or
similarly for AsyncFnMut
.
This will select the body that is produced by the ByMoveBody
transform, and thus
take and use all of its upvars by-move rather than by-ref.
ThreadLocalShim(DefId)
Compiler-generated accessor for thread locals which returns a reference to the thread local
the DefId
defines. This is used to export thread locals from dylibs on platforms lacking
native support.
DropGlue(DefId, Option<Ty<'tcx>>)
core::ptr::drop_in_place::<T>
.
The DefId
is for core::ptr::drop_in_place
.
The Option<Ty<'tcx>>
is either Some(T)
, or None
for empty drop
glue.
CloneShim(DefId, Ty<'tcx>)
Compiler-generated <T as Clone>::clone
implementation.
For all types that automatically implement Copy
, a trivial Clone
impl is provided too.
Additionally, arrays, tuples, and closures get a Clone
shim even if they aren’t Copy
.
The DefId
is for Clone::clone
, the Ty
is the type T
with the builtin Clone
impl.
FnPtrAddrShim(DefId, Ty<'tcx>)
Compiler-generated <T as FnPtr>::addr
implementation.
Automatically generated for all potentially higher-ranked fn(I) -> R
types.
The DefId
is for FnPtr::addr
, the Ty
is the type T
.
AsyncDropGlueCtorShim(DefId, Option<Ty<'tcx>>)
core::future::async_drop::async_drop_in_place::<'_, T>
.
The DefId
is for core::future::async_drop::async_drop_in_place
, the Ty
is the type T
.
Implementations§
source§impl<'tcx> InstanceKind<'tcx>
impl<'tcx> InstanceKind<'tcx>
pub fn def_id(self) -> DefId
sourcepub fn def_id_if_not_guaranteed_local_codegen(self) -> Option<DefId>
pub fn def_id_if_not_guaranteed_local_codegen(self) -> Option<DefId>
Returns the DefId
of instances which might not require codegen locally.
pub fn get_attrs( &self, tcx: TyCtxt<'tcx>, attr: Symbol, ) -> impl Iterator<Item = &'tcx Attribute>
sourcepub fn requires_inline(&self, tcx: TyCtxt<'tcx>) -> bool
pub fn requires_inline(&self, tcx: TyCtxt<'tcx>) -> bool
Returns true
if the LLVM version of this instance is unconditionally
marked with inline
. This implies that a copy of this instance is
generated in every codegen unit.
Note that this is only a hint. See the documentation for
generates_cgu_internal_copy
for more information.
sourcepub fn generates_cgu_internal_copy(&self, tcx: TyCtxt<'tcx>) -> bool
pub fn generates_cgu_internal_copy(&self, tcx: TyCtxt<'tcx>) -> bool
Returns true
if the machine code for this instance is instantiated in
each codegen unit that references it.
Note that this is only a hint! The compiler can globally decide to not
do this in order to speed up compilation. CGU-internal copies are
only exist to enable inlining. If inlining is not performed (e.g. at
-Copt-level=0
) then the time for generating them is wasted and it’s
better to create a single copy with external linkage.
pub fn requires_caller_location(&self, tcx: TyCtxt<'_>) -> bool
sourcepub fn has_polymorphic_mir_body(&self) -> bool
pub fn has_polymorphic_mir_body(&self) -> bool
Returns true
when the MIR body associated with this instance should be monomorphized
by its users (e.g. codegen or miri) by instantiating the args
from Instance
(see
Instance::args_for_mir_body
).
Otherwise, returns false
only for some kinds of shims where the construction of the MIR
body should perform necessary instantiations.
Trait Implementations§
source§impl<'tcx> AsLocalKey for InstanceKind<'tcx>
impl<'tcx> AsLocalKey for InstanceKind<'tcx>
type LocalKey = InstanceKind<'tcx>
source§fn as_local_key(&self) -> Option<Self::LocalKey>
fn as_local_key(&self) -> Option<Self::LocalKey>
source§impl<'tcx> Clone for InstanceKind<'tcx>
impl<'tcx> Clone for InstanceKind<'tcx>
source§fn clone(&self) -> InstanceKind<'tcx>
fn clone(&self) -> InstanceKind<'tcx>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'tcx> Debug for InstanceKind<'tcx>
impl<'tcx> Debug for InstanceKind<'tcx>
source§impl<'tcx> Hash for InstanceKind<'tcx>
impl<'tcx> Hash for InstanceKind<'tcx>
source§impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for InstanceKind<'tcx>
impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for InstanceKind<'tcx>
fn hash_stable( &self, __hcx: &mut StableHashingContext<'__ctx>, __hasher: &mut StableHasher, )
source§impl<'tcx> Key for InstanceKind<'tcx>
impl<'tcx> Key for InstanceKind<'tcx>
type Cache<V> = DefaultCache<InstanceKind<'tcx>, V>
source§fn default_span(&self, tcx: TyCtxt<'_>) -> Span
fn default_span(&self, tcx: TyCtxt<'_>) -> Span
self
, what span should we use?source§fn key_as_def_id(&self) -> Option<DefId>
fn key_as_def_id(&self) -> Option<DefId>
fn ty_def_id(&self) -> Option<DefId>
source§impl<'tcx, '__lifted> Lift<TyCtxt<'__lifted>> for InstanceKind<'tcx>
impl<'tcx, '__lifted> Lift<TyCtxt<'__lifted>> for InstanceKind<'tcx>
type Lifted = InstanceKind<'__lifted>
fn lift_to_interner( self, __tcx: TyCtxt<'__lifted>, ) -> Option<InstanceKind<'__lifted>>
source§impl<'tcx> PartialEq for InstanceKind<'tcx>
impl<'tcx> PartialEq for InstanceKind<'tcx>
source§fn eq(&self, other: &InstanceKind<'tcx>) -> bool
fn eq(&self, other: &InstanceKind<'tcx>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for InstanceKind<'tcx>
impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for InstanceKind<'tcx>
source§fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>(
self,
__folder: &mut __F,
) -> Result<Self, __F::Error>
fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>( self, __folder: &mut __F, ) -> Result<Self, __F::Error>
source§fn fold_with<F>(self, folder: &mut F) -> Selfwhere
F: TypeFolder<I>,
fn fold_with<F>(self, folder: &mut F) -> Selfwhere
F: TypeFolder<I>,
try_fold_with
for use with infallible
folders. Do not override this method, to ensure coherence with
try_fold_with
.source§impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for InstanceKind<'tcx>
impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for InstanceKind<'tcx>
source§fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>(
&self,
__visitor: &mut __V,
) -> __V::Result
fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>( &self, __visitor: &mut __V, ) -> __V::Result
impl<'tcx> Copy for InstanceKind<'tcx>
impl<'tcx> Eq for InstanceKind<'tcx>
impl<'tcx> StructuralPartialEq for InstanceKind<'tcx>
Auto Trait Implementations§
impl<'tcx> Freeze for InstanceKind<'tcx>
impl<'tcx> !RefUnwindSafe for InstanceKind<'tcx>
impl<'tcx> Send for InstanceKind<'tcx>
impl<'tcx> Sync for InstanceKind<'tcx>
impl<'tcx> Unpin for InstanceKind<'tcx>
impl<'tcx> !UnwindSafe for InstanceKind<'tcx>
Blanket Implementations§
source§impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut T
fn allocate_from_iter<'a>( arena: &'a Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'a mut [T]
source§impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut T
fn allocate_from_iter<'a>( arena: &'a Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'a mut [T]
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> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
source§impl<Tcx, T> DepNodeParams<Tcx> for T
impl<Tcx, T> DepNodeParams<Tcx> for T
default fn fingerprint_style() -> FingerprintStyle
source§default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_debug_str(&self, _: Tcx) -> String
source§default fn recover(_: Tcx, _: &DepNode) -> Option<T>
default fn recover(_: Tcx, _: &DepNode) -> Option<T>
DepNode
,
something which is needed when forcing DepNode
s during red-green
evaluation. The query system will only call this method if
fingerprint_style()
is not FingerprintStyle::Opaque
.
It is always valid to return None
here, in which case incremental
compilation will treat the query as having changed instead of forcing it.source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.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<P> IntoQueryParam<P> for P
impl<P> IntoQueryParam<P> for P
fn into_query_param(self) -> P
source§impl<'tcx, T> IsSuggestable<'tcx> for T
impl<'tcx, T> IsSuggestable<'tcx> for T
source§impl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
source§impl<I, T> TypeVisitableExt<I> for Twhere
I: Interner,
T: TypeVisitable<I>,
impl<I, T> TypeVisitableExt<I> for Twhere
I: Interner,
T: TypeVisitable<I>,
fn has_type_flags(&self, flags: TypeFlags) -> bool
source§fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
true
if self
has any late-bound regions that are either
bound by binder
or bound by some binder outside of binder
.
If binder
is ty::INNERMOST
, this indicates whether
there are any late-bound regions that appear free.fn error_reported(&self) -> Result<(), <I as Interner>::ErrorGuaranteed>
source§fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
true
if this type has any regions that escape binder
(and
hence are not bound by it).source§fn has_escaping_bound_vars(&self) -> bool
fn has_escaping_bound_vars(&self) -> bool
true
if this type has regions that are not a part of the type.
For example, for<'a> fn(&'a i32)
return false
, while fn(&'a i32)
would return true
. The latter can occur when traversing through the
former. Read morefn has_aliases(&self) -> bool
fn has_inherent_projections(&self) -> bool
fn has_opaque_types(&self) -> bool
fn has_coroutines(&self) -> bool
fn references_error(&self) -> bool
fn has_non_region_param(&self) -> bool
fn has_infer_regions(&self) -> bool
fn has_infer_types(&self) -> bool
fn has_non_region_infer(&self) -> bool
fn has_infer(&self) -> bool
fn has_placeholders(&self) -> bool
fn has_non_region_placeholders(&self) -> bool
fn has_param(&self) -> bool
source§fn has_free_regions(&self) -> bool
fn has_free_regions(&self) -> bool
fn has_erased_regions(&self) -> bool
source§fn has_erasable_regions(&self) -> bool
fn has_erasable_regions(&self) -> bool
source§fn is_global(&self) -> bool
fn is_global(&self) -> bool
source§fn has_bound_regions(&self) -> bool
fn has_bound_regions(&self) -> bool
source§fn has_non_region_bound_vars(&self) -> bool
fn has_non_region_bound_vars(&self) -> bool
source§fn has_bound_vars(&self) -> bool
fn has_bound_vars(&self) -> bool
source§fn still_further_specializable(&self) -> bool
fn still_further_specializable(&self) -> bool
impl
specialization.source§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<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed, ) -> 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: 24 bytes
Size for each variant:
Item
: 11 bytesIntrinsic
: 11 bytesVTableShim
: 11 bytesReifyShim
: 11 bytesFnPtrShim
: 23 bytesVirtual
: 23 bytesClosureOnceShim
: 11 bytesConstructCoroutineInClosureShim
: 11 bytesCoroutineKindShim
: 11 bytesThreadLocalShim
: 11 bytesDropGlue
: 23 bytesCloneShim
: 23 bytesFnPtrAddrShim
: 23 bytesAsyncDropGlueCtorShim
: 23 bytes