Skip to main content

## Provenance

# Enum Provenance

Source

    pub enum Provenance {
        Concrete {
            alloc_id: AllocId,
            tag: BorTag,
        },
        Wildcard,
    }

Expand description

Pointer provenance.

## Variants§

§

### Concrete

For pointers with concrete provenance. we exactly know which allocation they are attached to and what their borrow tag is.

#### Fields

§`alloc_id: AllocId`
§`tag: BorTag`

Borrow Tracker tag.

§

### Wildcard

Pointers with wildcard provenance are created on int-to-ptr casts. According to the specification, we should at that point angelically “guess” a provenance that will make all future uses of this pointer work, if at all possible. Of course such a semantics cannot be actually implemented in Miri. So instead, we approximate this, erroring on the side of accepting too much code rather than rejecting correct code: a pointer with wildcard provenance “acts like” any previously exposed pointer. Each time it is used, we check whether some exposed pointer could have done what we want to do, and if the answer is yes then we allow the access. This allows too much code in two ways:

- The same wildcard pointer can “take the role” of multiple different exposed pointers on subsequent memory accesses.
- In the aliasing model, we don’t just have to know the borrow tag of the pointer used for the access, we also have to update the aliasing state – and that update can be very different depending on which borrow tag we pick! Stacked Borrows has support for this by switching to a stack that is only approximately known, i.e. we over-approximate the effect of using any exposed pointer for this access, and only keep information about the borrow stack that would be true with all possible choices.

## Trait Implementations§

Source§

### impl Clone for Provenance

Source§

#### fn clone(&self) -> Provenance

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Copy for Provenance

Source§

### impl Debug for Provenance

Source§

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

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

### impl Eq for Provenance

Source§

### impl Hash for Provenance

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 PartialEq for Provenance

Source§

#### fn eq(&self, other: &Provenance) -> bool

Equality operator `==`. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator `!=`. Read more
Source§

### impl Provenance for Provenance

Source§

#### const OFFSET_IS_ADDR: bool = true

We use absolute addresses in the `offset` of a `StrictPointer`.

Source§

#### const WILDCARD: Option<Self>

Miri implements wildcard provenance.

Source§

#### fn get_alloc_id(self) -> Option<AllocId>

If `OFFSET_IS_ADDR == false`, provenance must always be able to identify the allocation this ptr points to (i.e., this must return `Some`). Otherwise this function is best-effort (but must agree with `Machine::ptr_get_alloc`). (Identifying the offset in that allocation, however, is harder – use `Memory::ptr_get_alloc` for that.)
Source§

#### fn fmt(ptr: &Pointer<Self>, f: &mut Formatter<'_>) -> Result

Determines how a pointer should be printed.
Source§

### impl StructuralPartialEq for Provenance

Source§

### impl VisitProvenance for Provenance

Source§

#### fn visit_provenance(&self, visit: &mut VisitWith<'_>)

## Auto Trait Implementations§

§

### impl Freeze for Provenance

§

### impl RefUnwindSafe for Provenance

§

### impl Send for Provenance

§

### impl Sync for Provenance

§

### impl Unpin for Provenance

§

### impl UnsafeUnpin for Provenance

§

### impl UnwindSafe for Provenance

## Blanket Implementations§

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> 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> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

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

Source§

#### 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>,

Source§

#### 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>,

Source§

#### 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.

## 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: 16 bytes

Size for each variant:

- `Concrete`: 16 bytes
- `Wildcard`: 0 bytes