Struct ProvenanceMap

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

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

impl<Prov> ProvenanceMap<Prov>

pub fn new() -> Self

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.

impl ProvenanceMap

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.

impl<Prov: Provenance> ProvenanceMap<Prov>

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.

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

Returns all byte-wise provenance in the given range.

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

Get the provenance of a single byte.

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.

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.

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

Yields all the provenances stored in this map.

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

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.

pub fn write_wildcards(&mut self, alloc_size: usize)

Overwrites all provenance in the allocation with wildcard provenance.

Provided for usage in Miri and panics otherwise.

impl<Prov: Provenance> ProvenanceMap<Prov>

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

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

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

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

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

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

where Prov: HashStable<StableHashingContext<'__ctx>>,

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

impl<Prov> StructuralPartialEq for ProvenanceMap<Prov>

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