LocationTree in miri::borrow_tracker::tree_borrows::tree - Rust
Description: The state of the full tree for a particular location: for all nodes, the local permissions of that node, and the tracking for wildcard accesses.

Skip to main content

## LocationTree

# Struct LocationTree

Source

    pub struct LocationTree {
        pub perms: UniValMap<LocationState>,
        pub exposed_cache: ExposedCache,
    }

Expand description

The state of the full tree for a particular location: for all nodes, the local permissions of that node, and the tracking for wildcard accesses.

## Fields§

§`perms: UniValMap<LocationState>`

Maps a tag to a perm, with possible lazy initialization.

NOTE: not all tags registered in `Tree::nodes` are necessarily in all ranges of `perms`, because `perms` is in part lazily initialized. Just because `nodes.get(key)` is `Some(_)` does not mean you can safely `unwrap` any `perm.get(key)`.

We do uphold the fact that `keys(perms)` is a subset of `keys(nodes)`

§`exposed_cache: ExposedCache`

Caches information about the relatedness of nodes for a wildcard access.

## Implementations§

Source§

### impl<'tcx> LocationTree

Source

#### fn get_min_exposed_child( root: UniIndex, nodes: &UniValMap<Node>, ) -> Option<BorTag>

Returns the smallest exposed tag, if any, that is a transitive child of `root`.

Source

#### fn perform_access( &mut self, roots: impl Iterator<Item = UniIndex>, nodes: &mut UniValMap<Node>, access_source: Option<UniIndex>, access_kind: AccessKind, global: &RefCell<GlobalStateInner>, visit_children: ChildrenVisitMode, diagnostics: &DiagnosticInfo, min_exposed_child: Option<BorTag>, ) -> InterpResult<'tcx>

Performs an access on this location.

- `access_source`: The index, if any, where the access came from.
- `visit_children`: Whether to skip updating the children of `access_source`.
- `min_exposed_child`: The tag of the smallest exposed (transitive) child of the accessed node. This is only used with `visit_children == SkipChildrenOfAccessed`, where we need to skip children of the accessed node.

Source

#### fn perform_normal_access( &mut self, access_source: UniIndex, nodes: &mut UniValMap<Node>, access_kind: AccessKind, global: &RefCell<GlobalStateInner>, visit_children: ChildrenVisitMode, diagnostics: &DiagnosticInfo, ) -> InterpResult<'tcx, UniIndex>

Performs a normal access on the tree containing `access_source`.

Returns the root index of this tree.

- `access_source`: The index of the tag being accessed.
- `visit_children`: Whether to skip the children of `access_source` during the access. Used for protector end access.

Source

#### fn perform_wildcard_access( &mut self, root: UniIndex, access_source: Option<UniIndex>, max_local_tag: Option<BorTag>, nodes: &mut UniValMap<Node>, access_kind: AccessKind, global: &RefCell<GlobalStateInner>, diagnostics: &DiagnosticInfo, is_wildcard_tree: bool, ) -> InterpResult<'tcx>

Performs a wildcard access on the tree with root `root`. Takes the `access_relatedness` for each node from the `WildcardState` datastructure.

- `root`: Root of the tree being accessed.
- `access_source`: the index of the accessed tag, if any. This is only used for printing the correct tag on errors.
- `max_local_tag`: The access can only be local for nodes whose tag is at most `max_local_tag`.

## Trait Implementations§

Source§

### impl Clone for LocationTree

Source§

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

Returns a duplicate 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 Debug for LocationTree

Source§

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

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

### impl PartialEq for LocationTree

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

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

### impl Eq for LocationTree

Source§

### impl StructuralPartialEq for LocationTree

## Auto Trait Implementations§

§

### impl Freeze for LocationTree

§

### impl RefUnwindSafe for LocationTree

§

### impl Send for LocationTree

§

### impl Sync for LocationTree

§

### impl Unpin for LocationTree

§

### impl UnsafeUnpin for LocationTree

§

### impl UnwindSafe for LocationTree

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

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

§

#### fn vzip(self) -> V

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