pub struct Pointer<Prov = AllocId> {
pub(super) offset: Size,
pub provenance: Prov,
}
Expand description
Represents a pointer in the Miri engine.
Pointers are “tagged” with provenance information; typically the AllocId
they belong to.
Fields§
§offset: Size
§provenance: Prov
Implementations§
source§impl<Prov> Pointer<Option<Prov>>
impl<Prov> Pointer<Option<Prov>>
sourcepub fn into_pointer_or_addr(self) -> Result<Pointer<Prov>, Size>
pub fn into_pointer_or_addr(self) -> Result<Pointer<Prov>, Size>
Convert this pointer that might have a provenance into a pointer that definitely has a provenance, or an absolute address.
This is rarely what you want; call ptr_try_get_alloc_id
instead.
sourcepub fn addr(self) -> Sizewhere
Prov: Provenance,
pub fn addr(self) -> Sizewhere Prov: Provenance,
Returns the absolute address the pointer points to. Only works if Prov::OFFSET_IS_ADDR is true!
source§impl<Prov> Pointer<Option<Prov>>
impl<Prov> Pointer<Option<Prov>>
sourcepub fn from_addr_invalid(addr: u64) -> Self
pub fn from_addr_invalid(addr: u64) -> Self
Creates a pointer to the given address, with invalid provenance (i.e., cannot be used for any memory access).
pub fn null() -> Self
source§impl<'tcx, Prov> Pointer<Prov>
impl<'tcx, Prov> Pointer<Prov>
pub fn new(provenance: Prov, offset: Size) -> Self
sourcepub fn into_parts(self) -> (Prov, Size)
pub fn into_parts(self) -> (Prov, Size)
Obtain the constituents of this pointer. Not that the meaning of the offset depends on the type Prov
!
This function must only be used in the implementation of Machine::ptr_get_alloc
,
and when a Pointer
is taken apart to be stored efficiently in an Allocation
.
pub fn map_provenance(self, f: impl FnOnce(Prov) -> Prov) -> Self
pub fn offset( self, i: Size, cx: &impl HasDataLayout ) -> InterpResult<'tcx, Self>
pub fn overflowing_offset( self, i: Size, cx: &impl HasDataLayout ) -> (Self, bool)
pub fn wrapping_offset(self, i: Size, cx: &impl HasDataLayout) -> Self
pub fn signed_offset( self, i: i64, cx: &impl HasDataLayout ) -> InterpResult<'tcx, Self>
pub fn overflowing_signed_offset( self, i: i64, cx: &impl HasDataLayout ) -> (Self, bool)
pub fn wrapping_signed_offset(self, i: i64, cx: &impl HasDataLayout) -> Self
Trait Implementations§
source§impl<Prov: Provenance> Debug for Pointer<Prov>
impl<Prov: Provenance> Debug for Pointer<Prov>
source§impl<'tcx, Prov, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for Pointer<Prov>where
Prov: Decodable<__D>,
impl<'tcx, Prov, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for Pointer<Prov>where Prov: Decodable<__D>,
source§impl<'tcx, Prov, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for Pointer<Prov>where
Prov: Encodable<__E>,
impl<'tcx, Prov, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for Pointer<Prov>where Prov: Encodable<__E>,
source§impl From<AllocId> for Pointer
impl From<AllocId> for Pointer
Produces a Pointer
that points to the beginning of the Allocation
.
source§impl<'__ctx, Prov> HashStable<StableHashingContext<'__ctx>> for Pointer<Prov>where
Prov: HashStable<StableHashingContext<'__ctx>>,
impl<'__ctx, Prov> HashStable<StableHashingContext<'__ctx>> for Pointer<Prov>where Prov: HashStable<StableHashingContext<'__ctx>>,
fn hash_stable( &self, __hcx: &mut StableHashingContext<'__ctx>, __hasher: &mut StableHasher )
source§impl IntoDiagnosticArg for Pointer
impl IntoDiagnosticArg for Pointer
fn into_diagnostic_arg(self) -> DiagnosticArgValue<'static>
source§impl<Prov: PartialEq> PartialEq<Pointer<Prov>> for Pointer<Prov>
impl<Prov: PartialEq> PartialEq<Pointer<Prov>> for Pointer<Prov>
impl<Prov: Copy> Copy for Pointer<Prov>
impl<Prov: Eq> Eq for Pointer<Prov>
impl<Prov> StructuralEq for Pointer<Prov>
impl<Prov> StructuralPartialEq for Pointer<Prov>
Auto Trait Implementations§
impl<Prov> RefUnwindSafe for Pointer<Prov>where Prov: RefUnwindSafe,
impl<Prov> Send for Pointer<Prov>where Prov: Send,
impl<Prov> Sync for Pointer<Prov>where Prov: Sync,
impl<Prov> Unpin for Pointer<Prov>where Prov: Unpin,
impl<Prov> UnwindSafe for Pointer<Prov>where Prov: UnwindSafe,
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<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<Tcx, T> DepNodeParams<Tcx> for Twhere
Tcx: DepContext,
T: for<'a> HashStable<StableHashingContext<'a>> + Debug,
impl<Tcx, T> DepNodeParams<Tcx> for Twhere Tcx: DepContext, T: for<'a> HashStable<StableHashingContext<'a>> + Debug,
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<P> IntoQueryParam<P> for P
impl<P> IntoQueryParam<P> for P
fn into_query_param(self) -> P
source§impl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
source§impl<'tcx, T> ToPredicate<'tcx, T> for T
impl<'tcx, T> ToPredicate<'tcx, T> for T
fn to_predicate(self, _tcx: TyCtxt<'tcx>) -> 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: &[QueryInfo], _guar: ErrorGuaranteed ) -> T
Layout§
Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.