Type Alias rustc_middle::query::queries::coverageinfo::LocalKey
source · pub type LocalKey<'tcx> = InstanceDef<'tcx>;
Aliased Type§
enum LocalKey<'tcx> {
Item(DefId),
Intrinsic(DefId),
VTableShim(DefId),
ReifyShim(DefId),
FnPtrShim(DefId, Ty<'tcx>),
Virtual(DefId, usize),
ClosureOnceShim {
call_once: DefId,
track_caller: bool,
},
ThreadLocalShim(DefId),
DropGlue(DefId, Option<Ty<'tcx>>),
CloneShim(DefId, Ty<'tcx>),
FnPtrAddrShim(DefId, Ty<'tcx>),
}
Variants§
Item(DefId)
A user-defined callable item.
This includes:
fn
items- closures
- generators
Intrinsic(DefId)
An intrinsic fn
item (with "rust-intrinsic"
or "platform-intrinsic"
ABI).
Alongside Virtual
, this is the only InstanceDef
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)
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 InstanceDef::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).
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 InstanceDef
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 closure] as FnOnce>::call_once
.
The DefId
is the ID of the call_once
method in FnOnce
.
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
.
Implementations§
source§impl<'tcx> InstanceDef<'tcx>
impl<'tcx> InstanceDef<'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 substituting 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 substitutions.
Trait Implementations§
source§impl<'tcx> AsLocalKey for InstanceDef<'tcx>
impl<'tcx> AsLocalKey for InstanceDef<'tcx>
type LocalKey = InstanceDef<'tcx>
source§fn as_local_key(&self) -> Option<Self::LocalKey>
fn as_local_key(&self) -> Option<Self::LocalKey>
source§impl<'tcx> Clone for InstanceDef<'tcx>
impl<'tcx> Clone for InstanceDef<'tcx>
source§fn clone(&self) -> InstanceDef<'tcx>
fn clone(&self) -> InstanceDef<'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 InstanceDef<'tcx>
impl<'tcx> Debug for InstanceDef<'tcx>
source§impl<'tcx> Hash for InstanceDef<'tcx>
impl<'tcx> Hash for InstanceDef<'tcx>
source§impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for InstanceDef<'tcx>
impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for InstanceDef<'tcx>
fn hash_stable( &self, __hcx: &mut StableHashingContext<'__ctx>, __hasher: &mut StableHasher )
source§impl<'tcx> Key for InstanceDef<'tcx>
impl<'tcx> Key for InstanceDef<'tcx>
type CacheSelector = DefaultCacheSelector<InstanceDef<'tcx>>
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_adt_id(&self) -> Option<DefId>
source§impl<'tcx, '__lifted> Lift<'__lifted> for InstanceDef<'tcx>
impl<'tcx, '__lifted> Lift<'__lifted> for InstanceDef<'tcx>
type Lifted = InstanceDef<'__lifted>
fn lift_to_tcx(self, __tcx: TyCtxt<'__lifted>) -> Option<InstanceDef<'__lifted>>
source§impl<'tcx> Ord for InstanceDef<'tcx>
impl<'tcx> Ord for InstanceDef<'tcx>
source§fn cmp(&self, other: &InstanceDef<'tcx>) -> Ordering
fn cmp(&self, other: &InstanceDef<'tcx>) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl<'tcx> PartialEq<InstanceDef<'tcx>> for InstanceDef<'tcx>
impl<'tcx> PartialEq<InstanceDef<'tcx>> for InstanceDef<'tcx>
source§fn eq(&self, other: &InstanceDef<'tcx>) -> bool
fn eq(&self, other: &InstanceDef<'tcx>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<'tcx> PartialOrd<InstanceDef<'tcx>> for InstanceDef<'tcx>
impl<'tcx> PartialOrd<InstanceDef<'tcx>> for InstanceDef<'tcx>
source§fn partial_cmp(&self, other: &InstanceDef<'tcx>) -> Option<Ordering>
fn partial_cmp(&self, other: &InstanceDef<'tcx>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for InstanceDef<'tcx>
impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for InstanceDef<'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 InstanceDef<'tcx>
impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for InstanceDef<'tcx>
source§fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>(
&self,
__visitor: &mut __V
) -> ControlFlow<__V::BreakTy>
fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>( &self, __visitor: &mut __V ) -> ControlFlow<__V::BreakTy>
impl<'tcx> Copy for InstanceDef<'tcx>
impl<'tcx> Eq for InstanceDef<'tcx>
impl<'tcx> StructuralEq for InstanceDef<'tcx>
impl<'tcx> StructuralPartialEq for InstanceDef<'tcx>
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 bytesThreadLocalShim
: 11 bytesDropGlue
: 23 bytesCloneShim
: 23 bytesFnPtrAddrShim
: 23 bytes