pub struct ProvenanceMap<Prov = CtfeProvenance> {
    ptrs: SortedMap<Size, Prov>,
    bytes: Option<Box<SortedMap<Size, Prov>>>,
}
Expand description

Stores the provenance information of pointers stored in memory.

Fields§

§ptrs: SortedMap<Size, Prov>

Provenance in this map applies from the given offset for an entire pointer-size worth of bytes. Two entries in this map are always at least a pointer size apart.

§bytes: Option<Box<SortedMap<Size, Prov>>>

Provenance in this map only applies to the given single byte. This map is disjoint from the previous. It will always be empty when Prov::OFFSET_IS_ADDR is false.

Implementations§

source§

impl<Prov> ProvenanceMap<Prov>

source

pub fn new() -> Self

source

pub fn from_presorted_ptrs(r: Vec<(Size, Prov)>) -> Self

The caller must guarantee that the given provenance list is already sorted by address and contain no duplicates.

source§

impl ProvenanceMap

source

pub fn ptrs(&self) -> &SortedMap<Size, CtfeProvenance>

Give access to the ptr-sized provenances (which can also be thought of as relocations, and indeed that is how codegen treats them).

Only exposed with CtfeProvenance provenance, since it panics if there is bytewise provenance.

source§

impl<Prov: Provenance> ProvenanceMap<Prov>

source

pub(super) fn range_get_ptrs( &self, range: AllocRange, cx: &impl HasDataLayout, ) -> &[(Size, Prov)]

Returns all ptr-sized provenance in the given range. If the range has length 0, returns provenance that crosses the edge between start-1 and start.

source

fn range_get_bytes(&self, range: AllocRange) -> &[(Size, Prov)]

Returns all byte-wise provenance in the given range.

source

pub fn get(&self, offset: Size, cx: &impl HasDataLayout) -> Option<Prov>

Get the provenance of a single byte.

source

pub fn get_ptr(&self, offset: Size) -> Option<Prov>

Check if here is ptr-sized provenance at the given index. Does not mean anything for bytewise provenance! But can be useful as an optimization.

source

pub fn range_empty(&self, range: AllocRange, cx: &impl HasDataLayout) -> bool

Returns whether this allocation has provenance overlapping with the given range.

Note: this function exists to allow range_get_provenance to be private, in order to somewhat limit access to provenance outside of the Allocation abstraction.

source

pub fn provenances(&self) -> impl Iterator<Item = Prov> + '_

Yields all the provenances stored in this map.

source

pub fn insert_ptr(&mut self, offset: Size, prov: Prov, cx: &impl HasDataLayout)

source

pub fn clear( &mut self, range: AllocRange, cx: &impl HasDataLayout, ) -> AllocResult

Removes all provenance inside the given range. If there is provenance overlapping with the edges, might result in an error.

source§

impl<Prov: Provenance> ProvenanceMap<Prov>

source

pub fn prepare_copy( &self, src: AllocRange, dest: Size, count: u64, cx: &impl HasDataLayout, ) -> AllocResult<ProvenanceCopy<Prov>>

source

pub fn apply_copy(&mut self, copy: ProvenanceCopy<Prov>)

Applies a provenance copy. The affected range, as defined in the parameters to prepare_copy is expected to be clear of provenance.

Trait Implementations§

source§

impl<Prov: Clone> Clone for ProvenanceMap<Prov>

source§

fn clone(&self) -> ProvenanceMap<Prov>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<Prov: Debug> Debug for ProvenanceMap<Prov>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<D: Decoder, Prov: Provenance + Decodable<D>> Decodable<D> for ProvenanceMap<Prov>

source§

fn decode(d: &mut D) -> Self

source§

impl<S: Encoder, Prov: Provenance + Encodable<S>> Encodable<S> for ProvenanceMap<Prov>

source§

fn encode(&self, s: &mut S)

source§

impl<Prov: Hash> Hash for ProvenanceMap<Prov>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'__ctx, Prov> HashStable<StableHashingContext<'__ctx>> for ProvenanceMap<Prov>
where Prov: HashStable<StableHashingContext<'__ctx>>,

source§

fn hash_stable( &self, __hcx: &mut StableHashingContext<'__ctx>, __hasher: &mut StableHasher, )

source§

impl<Prov: PartialEq> PartialEq for ProvenanceMap<Prov>

source§

fn eq(&self, other: &ProvenanceMap<Prov>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<Prov: Eq> Eq for ProvenanceMap<Prov>

source§

impl<Prov> StructuralPartialEq for ProvenanceMap<Prov>

Auto Trait Implementations§

§

impl<Prov> Freeze for ProvenanceMap<Prov>

§

impl<Prov> RefUnwindSafe for ProvenanceMap<Prov>
where Prov: RefUnwindSafe,

§

impl<Prov> Send for ProvenanceMap<Prov>
where Prov: Send,

§

impl<Prov> Sync for ProvenanceMap<Prov>
where Prov: Sync,

§

impl<Prov> Unpin for ProvenanceMap<Prov>
where Prov: Unpin,

§

impl<Prov> UnwindSafe for ProvenanceMap<Prov>
where Prov: UnwindSafe,

Blanket Implementations§

source§

impl<T> Aligned for T

source§

const ALIGN: Alignment = _

Alignment of Self.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AnyEq for T
where T: Any + PartialEq,

source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

source§

fn as_any(&self) -> &(dyn Any + 'static)

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T, R> CollectAndApply<T, R> for T

source§

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

§

type Output = R

source§

impl<Tcx, T> DepNodeParams<Tcx> for T
where Tcx: DepContext, T: for<'a> HashStable<StableHashingContext<'a>> + Debug,

source§

default fn fingerprint_style() -> FingerprintStyle

source§

default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint

This method turns the parameters of a DepNodeConstructor into an opaque Fingerprint to be used in DepNode. Not all DepNodeParams support being turned into a Fingerprint (they don’t need to if the corresponding DepNode is anonymous).
source§

default fn to_debug_str(&self, _: Tcx) -> String

source§

default fn recover(_: Tcx, _: &DepNode) -> Option<T>

This method tries to recover the query key from the given DepNode, something which is needed when forcing DepNodes 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
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> Filterable for T

source§

fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
source§

impl<P> IntoQueryParam<P> for P

source§

impl<T> MaybeResult<T> for T

§

type Error = !

source§

fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

source§

fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

source§

fn upcast(self, interner: I) -> U

source§

impl<I, T> UpcastFrom<I, T> for T

source§

fn upcast_from(from: T, _tcx: I) -> T

source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<Tcx, T> Value<Tcx> for T
where Tcx: DepContext,

source§

default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed, ) -> T

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<'a, T> Captures<'a> for T
where T: ?Sized,

source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

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: 32 bytes