TlsData in miri::shims::tls - Rust
Description: API documentation for the Rust `TlsData` struct in crate `miri`.

Skip to main content

## TlsData

# Struct TlsData

Source

    pub struct TlsData<'tcx> {
        next_key: u128,
        keys: BTreeMap<u128, TlsEntry<'tcx>>,
        macos_thread_dtors: BTreeMap<ThreadId, Vec<(Instance<'tcx>, Scalar, Span)>>,
    }

## Fields§

§`next_key: u128`

The Key to use for the next thread-local allocation.

§`keys: BTreeMap<u128, TlsEntry<'tcx>>`

pthreads-style thread-local storage.

§`macos_thread_dtors: BTreeMap<ThreadId, Vec<(Instance<'tcx>, Scalar, Span)>>`

On macOS, each thread holds a list of destructor functions with their respective data arguments.

## Implementations§

Source§

### impl<'tcx> TlsData<'tcx>

Source

#### pub fn create_tls_key( &mut self, dtor: Option<(Instance<'tcx>, Span)>, max_size: Size, ) -> InterpResult<'tcx, u128>

Generate a new TLS key with the given destructor. `max_size` determines the integer size the key has to fit in.

Source

#### pub fn delete_tls_key(&mut self, key: u128) -> InterpResult<'tcx>

Source

#### pub fn load_tls( &self, key: u128, thread_id: ThreadId, cx: &impl HasDataLayout, ) -> InterpResult<'tcx, Scalar>

Source

#### pub fn store_tls( &mut self, key: u128, thread_id: ThreadId, new_data: Scalar, cx: &impl HasDataLayout, ) -> InterpResult<'tcx>

Source

#### pub fn add_macos_thread_dtor( &mut self, thread: ThreadId, dtor: Instance<'tcx>, data: Scalar, span: Span, ) -> InterpResult<'tcx>

Add a thread local storage destructor for the given thread. This function is used to implement the `_tlv_atexit` shim on MacOS.

Source

#### fn fetch_tls_dtor( &mut self, key: Option<u128>, thread_id: ThreadId, ) -> Option<(Instance<'tcx>, Scalar, u128, Span)>

Returns a dtor, its argument and its index, if one is supposed to run. `key` is the last dtors that was run; we return the next one after that.

An optional destructor function may be associated with each key value. At thread exit, if a key value has a non-NULL destructor pointer, and the thread has a non-NULL value associated with that key, the value of the key is set to NULL, and then the function pointed to is called with the previously associated value as its sole argument. The order of destructor calls is unspecified if more than one destructor exists for a thread when it exits.

If, after all the destructors have been called for all non-NULL values with associated destructors, there are still some non-NULL values with associated destructors, then the process is repeated. If, after at least {PTHREAD_DESTRUCTOR_ITERATIONS} iterations of destructor calls for outstanding non-NULL values, there are still some non-NULL values with associated destructors, implementations may stop calling destructors, or they may continue calling destructors until no non-NULL values with associated destructors exist, even though this might result in an infinite loop.

Source

#### fn delete_all_thread_tls(&mut self, thread_id: ThreadId)

Delete all TLS entries for the given thread. This function should be called after all TLS destructors have already finished.

## Trait Implementations§

Source§

### impl<'tcx> Debug for TlsData<'tcx>

Source§

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

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

### impl<'tcx> Default for TlsData<'tcx>

Source§

#### fn default() -> Self

Returns the “default value” for a type. Read more
Source§

### impl VisitProvenance for TlsData<'_>

Source§

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

## Auto Trait Implementations§

§

### impl<'tcx> Freeze for TlsData<'tcx>

§

### impl<'tcx> !RefUnwindSafe for TlsData<'tcx>

§

### impl<'tcx> Send for TlsData<'tcx>

§

### impl<'tcx> Sync for TlsData<'tcx>

§

### impl<'tcx> Unpin for TlsData<'tcx>

§

### impl<'tcx> UnsafeUnpin for TlsData<'tcx>

§

### impl<'tcx> !UnwindSafe for TlsData<'tcx>

## 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> 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, 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: 64 bytes