Struct miri::borrow_tracker::GlobalStateInner

pub struct GlobalStateInner {
    borrow_tracker_method: BorrowTrackerMethod,
    next_ptr_tag: BorTag,
    base_ptr_tags: FxHashMap<AllocId, BorTag>,
    next_call_id: CallId,
    protected_tags: FxHashMap<BorTag, ProtectorKind>,
    tracked_pointer_tags: FxHashSet<BorTag>,
    tracked_call_ids: FxHashSet<CallId>,
    retag_fields: RetagFields,
    unique_is_unique: bool,
}

Extra global state, available to the memory access hooks.

Fields

borrow_tracker_method: BorrowTrackerMethod

Borrow tracker method currently in use.

next_ptr_tag: BorTag

Next unused pointer ID (tag).

base_ptr_tags: FxHashMap<AllocId, BorTag>

Table storing the “base” tag for each allocation. The base tag is the one used for the initial pointer. We need this in a separate table to handle cyclic statics.

next_call_id: CallId

Next unused call ID (for protectors).

protected_tags: FxHashMap<BorTag, ProtectorKind>

All currently protected tags. An item is protected if its tag is in this set, and it has the “protected” bit set. We add tags to this when they are created with a protector in reborrow, and we remove tags from this when the call which is protecting them returns, in GlobalStateInner::end_call. See Stack::item_invalidated for more details.

tracked_pointer_tags: FxHashSet<BorTag>

The pointer ids to trace

tracked_call_ids: FxHashSet<CallId>

The call ids to trace

retag_fields: RetagFields

Whether to recurse into datatypes when searching for pointers to retag.

unique_is_unique: bool

Whether core::ptr::Unique gets special (Box-like) handling.

Implementations

impl GlobalStateInner

Utilities for initialization and ID generation

pub fn new( borrow_tracker_method: BorrowTrackerMethod, tracked_pointer_tags: FxHashSet<BorTag>, tracked_call_ids: FxHashSet<CallId>, retag_fields: RetagFields, unique_is_unique: bool ) -> Self

fn new_ptr(&mut self) -> BorTag

Generates a new pointer tag. Remember to also check track_pointer_tags and log its creation!

pub fn new_frame(&mut self, machine: &MiriMachine<'_, '_>) -> FrameState

fn end_call(&mut self, frame: &FrameExtra<'_>)

pub fn base_ptr_tag( &mut self, id: AllocId, machine: &MiriMachine<'_, '_> ) -> BorTag

pub fn remove_unreachable_allocs(&mut self, allocs: &LiveAllocs<'_, '_, '_>)

impl GlobalStateInner

pub fn new_allocation( &mut self, id: AllocId, alloc_size: Size, kind: MemoryKind<MiriMemoryKind>, machine: &MiriMachine<'_, '_> ) -> AllocState

Trait Implementations

impl Debug for GlobalStateInner

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

Formats the value using the given formatter.

impl VisitProvenance for GlobalStateInner

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

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