Struct ferroc::heap::ThreadLocal

pub struct ThreadLocal<'arena, B: BaseAlloc> { /* private fields */ }

A collection for thread-local heaps.

This structure serves as a substitute for builtin dynamic TLS support with __tls_get_addr, which uses its slow dlmalloc to allocate TLS variables.

Most of the direct utilities from this structure is unsafe. For usages that are totally safe, see the examples in ThreadData.

Implementations

impl<'arena, B: BaseAlloc> ThreadLocal<'arena, B>

pub const fn new(arena: &'arena Arenas<B>) -> Self

Creates a collection for thread-local heaps.

pub const fn empty_heap( &'static self ) -> Pin<&'static Heap<'static, 'static, B>>

The default uninitialized heap, serving as a const initialization thread-local heap references.

This method is safe because uninitialized heaps don’t mutate their inner data at all, thus practically Sync.

impl<'arena, B: BaseAlloc> ThreadLocal<'arena, B>

pub unsafe fn get(self: Pin<&Self>, id: NonZeroU64) -> Pin<&Heap<'arena, '_, B>>

Acquire the current thread-local heap with this thread’s initialized id.

Safety

id must be unique with each live thread regarding only this structure and may or may not be recycled.

pub fn assign(self: Pin<&Self>) -> (Pin<&Heap<'arena, '_, B>>, NonZeroU64)

Acquires a new thread id and initialize its associated heap.

Examples

Users can Store the information in its thread-local variable in 2 ways:

1. Store the thread ID only, and get access to the heap every time using self.get;
2. Store both the thread ID and the pinned heap.

Both 2 ways needs to run its corresponding destructor manually. If RAII is preferred, ThreadData can be used instead.

Panics

Panics if the acquisition failed.

pub unsafe fn put(self: Pin<&Self>, id: NonZeroU64)

Release the current thread-local heap with this thread’s id.

This function may be registered as the thread-local destructor when the current thread exits.

Safety

• id must be previously assigned.
• The current thread must not use this id to access its thread-local heap.

Trait Implementations

impl<'arena, B: BaseAlloc> Drop for ThreadLocal<'arena, B>

fn drop(&mut self)

Executes the destructor for this type.

impl<'arena, B: BaseAlloc + Sync> Sync for ThreadLocal<'arena, B>