1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
// #[cfg(feature = "c")]
// use core::num::NonZeroUsize;
use core::{
alloc::{AllocError, Allocator, Layout},
cell::UnsafeCell,
marker::PhantomPinned,
mem::{ManuallyDrop, MaybeUninit},
num::NonZeroU64,
ops::Deref,
pin::Pin,
ptr::{self, NonNull},
sync::atomic::{AtomicPtr, AtomicU64, Ordering::*},
};
use super::{Context, Heap};
use crate::{
arena::Arenas,
base::{BaseAlloc, Chunk},
};
const POINTER_WIDTH: u32 = usize::BITS;
const BUCKETS: usize = POINTER_WIDTH as usize - 1;
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
struct BucketIndex {
bucket: usize,
bucket_count: usize,
index: usize,
}
impl BucketIndex {
const fn from_id(id: NonZeroU64) -> Self {
let bucket = POINTER_WIDTH - id.leading_zeros() - 1;
let bucket_count = 1 << bucket;
let index = id.get() - bucket_count;
debug_assert!(index < isize::MAX as u64);
BucketIndex {
bucket: bucket as usize,
bucket_count: bucket_count as usize,
index: index as usize,
}
}
}
#[repr(align(128))]
struct Entry<'arena, B: BaseAlloc> {
cx: ManuallyDrop<Context<'arena, B>>,
heap: ManuallyDrop<Heap<'arena, 'arena, B>>,
next_reclaimed_id: AtomicU64,
_marker: PhantomPinned,
}
impl<'arena, B: BaseAlloc> Drop for Entry<'arena, B> {
fn drop(&mut self) {
// SAFETY: The drop order should be explicitly specified: The heap should be
// dropped before the context.
unsafe {
ManuallyDrop::drop(&mut self.heap);
ManuallyDrop::drop(&mut self.cx);
}
}
}
struct Bucket<'arena, B: BaseAlloc> {
chunk: UnsafeCell<MaybeUninit<Chunk<B>>>,
pointer: AtomicPtr<Entry<'arena, B>>,
}
impl<'arena, B: BaseAlloc> Bucket<'arena, B> {
const fn new() -> Self {
Bucket {
chunk: UnsafeCell::new(MaybeUninit::uninit()),
pointer: AtomicPtr::new(ptr::null_mut()),
}
}
const NEW: Self = Bucket::new();
fn allocate(bi: BucketIndex, arenas: &'arena Arenas<B>) -> Chunk<B> {
let layout = Layout::new::<Entry<'arena, B>>();
let (layout, _) = layout
.repeat(bi.bucket_count)
.expect("layout calculation failed: too many bucket requests");
let Ok(chunk) = arenas.base().allocate(layout, true) else {
unreachable!("allocation for thread-local failed: too many bucket requests")
};
let mut bucket = chunk.pointer().cast::<Entry<'arena, B>>();
for _ in 0..bi.bucket_count {
// SAFETY: All `bucket`s are within the range of the previously allocated chunk,
// for its layout is calculated before.
unsafe {
let td = bucket.as_uninit_mut();
let td = td.write(Entry {
cx: ManuallyDrop::new(Context::new(arenas)),
heap: ManuallyDrop::new(Heap::new_uninit()),
next_reclaimed_id: AtomicU64::new(0),
_marker: PhantomPinned,
});
td.heap.init(Pin::new_unchecked(&td.cx));
bucket = bucket.add(1);
}
}
chunk
}
/// # Safety
///
/// This function is mocking the signature and purpose of `Drop::drop`, but
/// it needs `bucket_index` for its metadata. Thus, `bucket_index` must
/// corresponds to the position of the bucket.
unsafe fn drop(this: &mut Self, bucket_index: usize) -> bool {
let mut bucket = *this.pointer.get_mut();
if !bucket.is_null() {
let bucket_count = 1 << bucket_index;
for _ in 0..bucket_count {
unsafe { ptr::drop_in_place(bucket) };
bucket = bucket.add(1);
}
unsafe { this.chunk.get_mut().assume_init_drop() }
return true;
}
false
}
}
/// 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`].
pub struct ThreadLocal<'arena, B: BaseAlloc> {
arena: &'arena Arenas<B>,
empty_heap: Heap<'arena, 'arena, B>,
buckets: [Bucket<'arena, B>; BUCKETS],
next_reclaimed_id: AtomicU64,
next_id: AtomicU64,
_marker: PhantomPinned,
}
// SAFETY:
// - For buckets, we only expose thread data entries to its corresponding
// thread, so there's no data race;
// - For IDs, we use atomics to assign and recycle the thread ids, se there's no
// data race either;
// - For the empty heap, this structure is immutable since empty heaps cannot
// allocate anything, and thus cannot deallocate anything either.
unsafe impl<'arena, B: BaseAlloc + Sync> Sync for ThreadLocal<'arena, B> {}
impl<'arena, B: BaseAlloc> ThreadLocal<'arena, B> {
/// Creates a collection for thread-local heaps.
pub const fn new(arena: &'arena Arenas<B>) -> Self {
Self {
arena,
empty_heap: Heap::new_uninit(),
buckets: [Bucket::NEW; BUCKETS],
next_reclaimed_id: AtomicU64::new(0),
next_id: AtomicU64::new(1),
_marker: PhantomPinned,
}
}
/// 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`.
pub const fn empty_heap(&'static self) -> Pin<&'static Heap<'static, 'static, B>> {
Pin::static_ref(&self.empty_heap)
}
}
impl<'arena, B: BaseAlloc> ThreadLocal<'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 unsafe fn get(self: Pin<&Self>, id: NonZeroU64) -> Pin<&Heap<'arena, '_, B>> {
let bi = BucketIndex::from_id(id);
self.map_unchecked(|this| {
// SAFETY: the thread data entry is initialized in `self.assign`.
this.get_inner(bi).unwrap_unchecked()
})
}
/// 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 fn assign(self: Pin<&Self>) -> (Pin<&Heap<'arena, '_, B>>, NonZeroU64) {
// SAFETY: `id` is used to initialize its thread data entry below immediately.
let id = unsafe { self.acquire_id() };
let bi = BucketIndex::from_id(id);
// SAFETY: `id` is freshly allocated, which belongs to no other thread.
//
// Note that while freshly allocated, the value of `id` may be reclaimed from
// another dead thread, which means its thread data entry can be already
// initialized and should not be `insert`ed unconditionally.
let heap = unsafe {
self.map_unchecked(|this| {
if let Some(heap) = this.get_inner(bi) {
return heap;
}
this.insert(bi)
})
};
(heap, id)
}
/// # Safety
///
/// The corresponding thread data entry to the returned ID must be
/// initialized after acquisition.
unsafe fn acquire_id(self: Pin<&Self>) -> NonZeroU64 {
let mut id = self.next_reclaimed_id.load(Relaxed);
loop {
let Some(ret) = NonZeroU64::new(id) else {
const MAX_ID: u64 = i64::MAX as u64;
const SATURATED_ID: u64 = (MAX_ID & u64::MAX) + ((MAX_ID ^ u64::MAX) >> 1);
break match self.next_id.fetch_add(1, Relaxed) {
MAX_ID.. => {
self.next_id.store(SATURATED_ID, Relaxed);
panic!("Thread ID overflow");
}
// SAFETY: `next_id` is less than `MAX_ID` and greater than 0.
next_id => unsafe { NonZeroU64::new_unchecked(next_id) },
};
};
let bi = BucketIndex::from_id(ret);
// SAFETY: Every reclaimed id corresponds to a previously owner thread alongside
// with its valid thread data entry.
let td = unsafe { self.entry(bi).unwrap_unchecked() };
let next = td.next_reclaimed_id.load(Relaxed);
match self
.next_reclaimed_id
.compare_exchange_weak(id, next, AcqRel, Acquire)
{
Ok(_) => break ret,
Err(actual) => id = actual,
}
}
}
/// 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 [assign]ed.
/// - The current thread must not use this id to access its thread-local
/// heap.
///
/// [assign]: ThreadLocal::assign
pub unsafe fn put(self: Pin<&Self>, id: NonZeroU64) {
let mut old = self.next_reclaimed_id.load(Relaxed);
loop {
let bi = BucketIndex::from_id(id);
// SAFETY: The corresponding data is initialized.
let td = unsafe { self.entry(bi).unwrap_unchecked() };
td.next_reclaimed_id.store(old, Relaxed);
match self
.next_reclaimed_id
.compare_exchange_weak(old, id.get(), AcqRel, Acquire)
{
Ok(_) => return,
Err(x) => old = x,
}
}
}
}
impl<'arena, B: BaseAlloc> ThreadLocal<'arena, B> {
#[inline]
unsafe fn bucket_slot(&self, bi: BucketIndex) -> &Bucket<'arena, B> {
self.buckets.get_unchecked(bi.bucket)
}
#[inline]
unsafe fn entry(&self, bi: BucketIndex) -> Option<&Entry<'arena, B>> {
let bucket = self.bucket_slot(bi).pointer.load(Acquire);
if bucket.is_null() {
return None;
}
Some(&*bucket.add(bi.index))
}
#[inline]
unsafe fn get_inner(&self, bi: BucketIndex) -> Option<&Heap<'arena, 'arena, B>> {
Some(&self.entry(bi)?.heap)
}
#[cold]
unsafe fn insert(&self, bi: BucketIndex) -> &Heap<'arena, 'arena, B> {
let bucket_slot = self.bucket_slot(bi);
let bucket = bucket_slot.pointer.load(Acquire);
let bucket = if bucket.is_null() {
let chunk = Bucket::allocate(bi, self.arena);
let new_bucket = chunk.pointer().cast();
match bucket_slot.pointer.compare_exchange(
ptr::null_mut(),
new_bucket.as_ptr(),
AcqRel,
Acquire,
) {
Ok(_) => {
(*bucket_slot.chunk.get()).write(chunk);
new_bucket.as_ptr()
}
Err(already_init) => already_init,
}
} else {
bucket
};
&(*bucket.add(bi.index)).heap
}
}
impl<'arena, B: BaseAlloc> Drop for ThreadLocal<'arena, B> {
fn drop(&mut self) {
for (index, bucket_slot) in self.buckets.iter_mut().enumerate() {
// SAFETY: `drop` only during drops. Following the normal drop order.
if !unsafe { Bucket::drop(bucket_slot, index) } {
break;
}
}
}
}
/// A thread-local heap allocated from [`ThreadLocal`].
///
/// This structure is practically equivalent to [`Heap`], except being
/// allocated from a dedicated collection of thread-locals to avoid invocation
/// of built-in TLS allocation functions like `__tls_get_addr`.
///
/// # Examples
///
/// Creating thread data on the stack:
///
/// ```
/// #![feature(allocator_api)]
///
/// use core::pin::pin;
/// use ferroc::{
/// arena::Arenas,
/// base::Mmap,
/// heap::{ThreadLocal, ThreadData}
/// };
///
/// let arenas = Arenas::new(Mmap);
/// let thread_local = pin!(ThreadLocal::new(&arenas));
/// let thread_data = ThreadData::new(thread_local.as_ref());
///
/// let mut vec = Vec::with_capacity_in(5, &thread_data);
/// vec.extend([1, 2, 3, 4, 5]);
/// assert_eq!(vec.iter().sum::<i32>(), 15);
/// ```
///
/// Creating on the real thread-local storage:
///
/// ```
/// # #![feature(allocator_api)]
///
/// # use core::pin::Pin;
/// # use ferroc::{
/// # arena::Arenas,
/// # base::Mmap,
/// # heap::{ThreadLocal, ThreadData}
/// # };
///
/// static ARENAS: Arenas<Mmap> = Arenas::new(Mmap);
/// static THREAD_LOCAL: ThreadLocal<Mmap> = ThreadLocal::new(&ARENAS);
///
/// thread_local! {
/// static THREAD_DATA: ThreadData<'static, 'static, Mmap>
/// = ThreadData::new(Pin::static_ref(&THREAD_LOCAL));
/// }
///
/// THREAD_DATA.with(|td| {
/// let mut vec = Vec::with_capacity_in(5, td);
/// vec.extend([1, 2, 3, 4, 5]);
/// assert_eq!(vec.iter().sum::<i32>(), 15);
/// })
/// ```
///
/// While this structure is not `Send` or `Sync`, users can wrap it with a unit
/// struct and forward the (de)allocation functions to `THREAD_DATA.with(|td| /*
/// ... */)`, thus creating a `Send` & `Sync` Allocator.
///
/// **HOWEVER**, Since the [`thread_local!`](std::thread_local) macro in the
/// standard library uses allocation internally, marking the wrapped allocator
/// above as the global allocator will result in infinite recursion. If a global
/// allocator is desired, consider using this crate's [`config`](crate::config)
/// macros instead.
pub struct ThreadData<'t, 'arena: 't, B: BaseAlloc> {
thread_local: Pin<&'t ThreadLocal<'arena, B>>,
heap: Pin<&'t Heap<'arena, 't, B>>,
id: NonZeroU64,
}
impl<'t, 'arena: 't, B: BaseAlloc> ThreadData<'t, 'arena, B> {
/// Creates a new thread-local heap.
pub fn new(thread_local: Pin<&'t ThreadLocal<'arena, B>>) -> Self {
let (heap, id) = thread_local.assign();
ThreadData { thread_local, heap, id }
}
}
impl<'t, 'arena: 't, B: BaseAlloc> Deref for ThreadData<'t, 'arena, B> {
type Target = Heap<'arena, 't, B>;
fn deref(&self) -> &Self::Target {
&self.heap
}
}
unsafe impl<'t, 'arena: 't, B: BaseAlloc> Allocator for ThreadData<'t, 'arena, B> {
fn allocate(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError> {
Allocator::allocate(&**self, layout)
}
unsafe fn deallocate(&self, ptr: NonNull<u8>, layout: Layout) {
Allocator::deallocate(&**self, ptr, layout)
}
}
impl<'t, 'arena: 't, B: BaseAlloc> Drop for ThreadData<'t, 'arena, B> {
fn drop(&mut self) {
// SAFETY: `id` is previously allocated from `thread_local`, and `heap` is not
// used any longer.
unsafe { self.thread_local.put(self.id) }
}
}
#[cfg(all(test, feature = "base-mmap"))]
mod tests {
use core::num::NonZeroU64;
use crate::heap::thread_local::BucketIndex;
#[test]
fn test_bi() {
assert_eq!(BucketIndex::from_id(NonZeroU64::MIN), BucketIndex {
bucket: 0,
bucket_count: 1,
index: 0,
});
assert_eq!(
BucketIndex::from_id(NonZeroU64::MIN.checked_add(1).unwrap()),
BucketIndex {
bucket: 1,
bucket_count: 2,
index: 0,
}
);
assert_eq!(
BucketIndex::from_id(NonZeroU64::MIN.checked_add(2).unwrap()),
BucketIndex {
bucket: 1,
bucket_count: 2,
index: 1,
}
);
assert_eq!(
BucketIndex::from_id(NonZeroU64::MIN.checked_add(3).unwrap()),
BucketIndex {
bucket: 2,
bucket_count: 4,
index: 0,
}
);
assert_eq!(
BucketIndex::from_id(NonZeroU64::MIN.checked_add(4).unwrap()),
BucketIndex {
bucket: 2,
bucket_count: 4,
index: 1,
}
);
}
}