compiler/rustc_arena/src/lib.rs

   1 //! The arena, a fast but limited type of allocator.
   2 //!
   3 //! Arenas are a type of allocator that destroy the objects within, all at
   4 //! once, once the arena itself is destroyed. They do not support deallocation
   5 //! of individual objects while the arena itself is still alive. The benefit
   6 //! of an arena is very fast allocation; just a pointer bump.
   7 //!
   8 //! This crate implements several kinds of arena.
   9
  10 #![doc(
  11     html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/",
  12     test(no_crate_inject, attr(deny(warnings)))
  13 )]
  14 #![feature(dropck_eyepatch)]
  15 #![feature(new_uninit)]
  16 #![feature(maybe_uninit_slice)]
  17 #![feature(min_specialization)]
  18 #![cfg_attr(test, feature(test))]
  19
  20 use smallvec::SmallVec;
  21
  22 use std::alloc::Layout;
  23 use std::cell::{Cell, RefCell};
  24 use std::cmp;
  25 use std::marker::{PhantomData, Send};
  26 use std::mem::{self, MaybeUninit};
  27 use std::ptr;
  28 use std::slice;
  29
  30 #[inline(never)]
  31 #[cold]
  32 fn cold_path<F: FnOnce() -> R, R>(f: F) -> R {
  33     f()
  34 }
  35
  36 /// An arena that can hold objects of only one type.
  37 pub struct TypedArena<T> {
  38     /// A pointer to the next object to be allocated.
  39     ptr: Cell<*mut T>,
  40
  41     /// A pointer to the end of the allocated area. When this pointer is
  42     /// reached, a new chunk is allocated.
  43     end: Cell<*mut T>,
  44
  45     /// A vector of arena chunks.
  46     chunks: RefCell<Vec<TypedArenaChunk<T>>>,
  47
  48     /// Marker indicating that dropping the arena causes its owned
  49     /// instances of `T` to be dropped.
  50     _own: PhantomData<T>,
  51 }
  52
  53 struct TypedArenaChunk<T> {
  54     /// The raw storage for the arena chunk.
  55     storage: Box<[MaybeUninit<T>]>,
  56     /// The number of valid entries in the chunk.
  57     entries: usize,
  58 }
  59
  60 impl<T> TypedArenaChunk<T> {
  61     #[inline]
  62     unsafe fn new(capacity: usize) -> TypedArenaChunk<T> {
  63         TypedArenaChunk { storage: Box::new_uninit_slice(capacity), entries: 0 }
  64     }
  65
  66     /// Destroys this arena chunk.
  67     #[inline]
  68     unsafe fn destroy(&mut self, len: usize) {
  69         // The branch on needs_drop() is an -O1 performance optimization.
  70         // Without the branch, dropping TypedArena<u8> takes linear time.
  71         if mem::needs_drop::<T>() {
  72             ptr::drop_in_place(MaybeUninit::slice_assume_init_mut(&mut self.storage[..len]));
  73         }
  74     }
  75
  76     // Returns a pointer to the first allocated object.
  77     #[inline]
  78     fn start(&mut self) -> *mut T {
  79         MaybeUninit::slice_as_mut_ptr(&mut self.storage)
  80     }
  81
  82     // Returns a pointer to the end of the allocated space.
  83     #[inline]
  84     fn end(&mut self) -> *mut T {
  85         unsafe {
  86             if mem::size_of::<T>() == 0 {
  87                 // A pointer as large as possible for zero-sized elements.
  88                 !0 as *mut T
  89             } else {
  90                 self.start().add(self.storage.len())
  91             }
  92         }
  93     }
  94 }
  95
  96 // The arenas start with PAGE-sized chunks, and then each new chunk is twice as
  97 // big as its predecessor, up until we reach HUGE_PAGE-sized chunks, whereupon
  98 // we stop growing. This scales well, from arenas that are barely used up to
  99 // arenas that are used for 100s of MiBs. Note also that the chosen sizes match
 100 // the usual sizes of pages and huge pages on Linux.
 101 const PAGE: usize = 4096;
 102 const HUGE_PAGE: usize = 2 * 1024 * 1024;
 103
 104 impl<T> Default for TypedArena<T> {
 105     /// Creates a new `TypedArena`.
 106     fn default() -> TypedArena<T> {
 107         TypedArena {
 108             // We set both `ptr` and `end` to 0 so that the first call to
 109             // alloc() will trigger a grow().
 110             ptr: Cell::new(ptr::null_mut()),
 111             end: Cell::new(ptr::null_mut()),
 112             chunks: RefCell::new(vec![]),
 113             _own: PhantomData,
 114         }
 115     }
 116 }
 117
 118 trait IterExt<T> {
 119     fn alloc_from_iter(self, arena: &TypedArena<T>) -> &mut [T];
 120 }
 121
 122 impl<I, T> IterExt<T> for I
 123 where
 124     I: IntoIterator<Item = T>,
 125 {
 126     #[inline]
 127     default fn alloc_from_iter(self, arena: &TypedArena<T>) -> &mut [T] {
 128         let vec: SmallVec<[_; 8]> = self.into_iter().collect();
 129         vec.alloc_from_iter(arena)
 130     }
 131 }
 132
 133 impl<T, const N: usize> IterExt<T> for std::array::IntoIter<T, N> {
 134     #[inline]
 135     fn alloc_from_iter(self, arena: &TypedArena<T>) -> &mut [T] {
 136         let len = self.len();
 137         if len == 0 {
 138             return &mut [];
 139         }
 140         // Move the content to the arena by copying and then forgetting it
 141         unsafe {
 142             let start_ptr = arena.alloc_raw_slice(len);
 143             self.as_slice().as_ptr().copy_to_nonoverlapping(start_ptr, len);
 144             mem::forget(self);
 145             slice::from_raw_parts_mut(start_ptr, len)
 146         }
 147     }
 148 }
 149
 150 impl<T> IterExt<T> for Vec<T> {
 151     #[inline]
 152     fn alloc_from_iter(mut self, arena: &TypedArena<T>) -> &mut [T] {
 153         let len = self.len();
 154         if len == 0 {
 155             return &mut [];
 156         }
 157         // Move the content to the arena by copying and then forgetting it
 158         unsafe {
 159             let start_ptr = arena.alloc_raw_slice(len);
 160             self.as_ptr().copy_to_nonoverlapping(start_ptr, len);
 161             self.set_len(0);
 162             slice::from_raw_parts_mut(start_ptr, len)
 163         }
 164     }
 165 }
 166
 167 impl<A: smallvec::Array> IterExt<A::Item> for SmallVec<A> {
 168     #[inline]
 169     fn alloc_from_iter(mut self, arena: &TypedArena<A::Item>) -> &mut [A::Item] {
 170         let len = self.len();
 171         if len == 0 {
 172             return &mut [];
 173         }
 174         // Move the content to the arena by copying and then forgetting it
 175         unsafe {
 176             let start_ptr = arena.alloc_raw_slice(len);
 177             self.as_ptr().copy_to_nonoverlapping(start_ptr, len);
 178             self.set_len(0);
 179             slice::from_raw_parts_mut(start_ptr, len)
 180         }
 181     }
 182 }
 183
 184 impl<T> TypedArena<T> {
 185     /// Allocates an object in the `TypedArena`, returning a reference to it.
 186     #[inline]
 187     pub fn alloc(&self, object: T) -> &mut T {
 188         if self.ptr == self.end {
 189             self.grow(1)
 190         }
 191
 192         unsafe {
 193             if mem::size_of::<T>() == 0 {
 194                 self.ptr.set((self.ptr.get() as *mut u8).wrapping_offset(1) as *mut T);
 195                 let ptr = mem::align_of::<T>() as *mut T;
 196                 // Don't drop the object. This `write` is equivalent to `forget`.
 197                 ptr::write(ptr, object);
 198                 &mut *ptr
 199             } else {
 200                 let ptr = self.ptr.get();
 201                 // Advance the pointer.
 202                 self.ptr.set(self.ptr.get().offset(1));
 203                 // Write into uninitialized memory.
 204                 ptr::write(ptr, object);
 205                 &mut *ptr
 206             }
 207         }
 208     }
 209
 210     #[inline]
 211     fn can_allocate(&self, additional: usize) -> bool {
 212         let available_bytes = self.end.get() as usize - self.ptr.get() as usize;
 213         let additional_bytes = additional.checked_mul(mem::size_of::<T>()).unwrap();
 214         available_bytes >= additional_bytes
 215     }
 216
 217     /// Ensures there's enough space in the current chunk to fit `len` objects.
 218     #[inline]
 219     fn ensure_capacity(&self, additional: usize) {
 220         if !self.can_allocate(additional) {
 221             self.grow(additional);
 222             debug_assert!(self.can_allocate(additional));
 223         }
 224     }
 225
 226     #[inline]
 227     unsafe fn alloc_raw_slice(&self, len: usize) -> *mut T {
 228         assert!(mem::size_of::<T>() != 0);
 229         assert!(len != 0);
 230
 231         self.ensure_capacity(len);
 232
 233         let start_ptr = self.ptr.get();
 234         self.ptr.set(start_ptr.add(len));
 235         start_ptr
 236     }
 237
 238     /// Allocates a slice of objects that are copied into the `TypedArena`, returning a mutable
 239     /// reference to it. Will panic if passed a zero-sized types.
 240     ///
 241     /// Panics:
 242     ///
 243     ///  - Zero-sized types
 244     ///  - Zero-length slices
 245     #[inline]
 246     pub fn alloc_slice(&self, slice: &[T]) -> &mut [T]
 247     where
 248         T: Copy,
 249     {
 250         unsafe {
 251             let len = slice.len();
 252             let start_ptr = self.alloc_raw_slice(len);
 253             slice.as_ptr().copy_to_nonoverlapping(start_ptr, len);
 254             slice::from_raw_parts_mut(start_ptr, len)
 255         }
 256     }
 257
 258     #[inline]
 259     pub fn alloc_from_iter<I: IntoIterator<Item = T>>(&self, iter: I) -> &mut [T] {
 260         assert!(mem::size_of::<T>() != 0);
 261         iter.alloc_from_iter(self)
 262     }
 263
 264     /// Grows the arena.
 265     #[inline(never)]
 266     #[cold]
 267     fn grow(&self, additional: usize) {
 268         unsafe {
 269             // We need the element size to convert chunk sizes (ranging from
 270             // PAGE to HUGE_PAGE bytes) to element counts.
 271             let elem_size = cmp::max(1, mem::size_of::<T>());
 272             let mut chunks = self.chunks.borrow_mut();
 273             let mut new_cap;
 274             if let Some(last_chunk) = chunks.last_mut() {
 275                 // If a type is `!needs_drop`, we don't need to keep track of how many elements
 276                 // the chunk stores - the field will be ignored anyway.
 277                 if mem::needs_drop::<T>() {
 278                     let used_bytes = self.ptr.get() as usize - last_chunk.start() as usize;
 279                     last_chunk.entries = used_bytes / mem::size_of::<T>();
 280                 }
 281
 282                 // If the previous chunk's len is less than HUGE_PAGE
 283                 // bytes, then this chunk will be least double the previous
 284                 // chunk's size.
 285                 new_cap = last_chunk.storage.len().min(HUGE_PAGE / elem_size / 2);
 286                 new_cap *= 2;
 287             } else {
 288                 new_cap = PAGE / elem_size;
 289             }
 290             // Also ensure that this chunk can fit `additional`.
 291             new_cap = cmp::max(additional, new_cap);
 292
 293             let mut chunk = TypedArenaChunk::<T>::new(new_cap);
 294             self.ptr.set(chunk.start());
 295             self.end.set(chunk.end());
 296             chunks.push(chunk);
 297         }
 298     }
 299
 300     /// Clears the arena. Deallocates all but the longest chunk which may be reused.
 301     pub fn clear(&mut self) {
 302         unsafe {
 303             // Clear the last chunk, which is partially filled.
 304             let mut chunks_borrow = self.chunks.borrow_mut();
 305             if let Some(mut last_chunk) = chunks_borrow.last_mut() {
 306                 self.clear_last_chunk(&mut last_chunk);
 307                 let len = chunks_borrow.len();
 308                 // If `T` is ZST, code below has no effect.
 309                 for mut chunk in chunks_borrow.drain(..len - 1) {
 310                     chunk.destroy(chunk.entries);
 311                 }
 312             }
 313         }
 314     }
 315
 316     // Drops the contents of the last chunk. The last chunk is partially empty, unlike all other
 317     // chunks.
 318     fn clear_last_chunk(&self, last_chunk: &mut TypedArenaChunk<T>) {
 319         // Determine how much was filled.
 320         let start = last_chunk.start() as usize;
 321         // We obtain the value of the pointer to the first uninitialized element.
 322         let end = self.ptr.get() as usize;
 323         // We then calculate the number of elements to be dropped in the last chunk,
 324         // which is the filled area's length.
 325         let diff = if mem::size_of::<T>() == 0 {
 326             // `T` is ZST. It can't have a drop flag, so the value here doesn't matter. We get
 327             // the number of zero-sized values in the last and only chunk, just out of caution.
 328             // Recall that `end` was incremented for each allocated value.
 329             end - start
 330         } else {
 331             (end - start) / mem::size_of::<T>()
 332         };
 333         // Pass that to the `destroy` method.
 334         unsafe {
 335             last_chunk.destroy(diff);
 336         }
 337         // Reset the chunk.
 338         self.ptr.set(last_chunk.start());
 339     }
 340 }
 341
 342 unsafe impl<#[may_dangle] T> Drop for TypedArena<T> {
 343     fn drop(&mut self) {
 344         unsafe {
 345             // Determine how much was filled.
 346             let mut chunks_borrow = self.chunks.borrow_mut();
 347             if let Some(mut last_chunk) = chunks_borrow.pop() {
 348                 // Drop the contents of the last chunk.
 349                 self.clear_last_chunk(&mut last_chunk);
 350                 // The last chunk will be dropped. Destroy all other chunks.
 351                 for chunk in chunks_borrow.iter_mut() {
 352                     chunk.destroy(chunk.entries);
 353                 }
 354             }
 355             // Box handles deallocation of `last_chunk` and `self.chunks`.
 356         }
 357     }
 358 }
 359
 360 unsafe impl<T: Send> Send for TypedArena<T> {}
 361
 362 pub struct DroplessArena {
 363     /// A pointer to the start of the free space.
 364     start: Cell<*mut u8>,
 365
 366     /// A pointer to the end of free space.
 367     ///
 368     /// The allocation proceeds from the end of the chunk towards the start.
 369     /// When this pointer crosses the start pointer, a new chunk is allocated.
 370     end: Cell<*mut u8>,
 371
 372     /// A vector of arena chunks.
 373     chunks: RefCell<Vec<TypedArenaChunk<u8>>>,
 374 }
 375
 376 unsafe impl Send for DroplessArena {}
 377
 378 impl Default for DroplessArena {
 379     #[inline]
 380     fn default() -> DroplessArena {
 381         DroplessArena {
 382             start: Cell::new(ptr::null_mut()),
 383             end: Cell::new(ptr::null_mut()),
 384             chunks: Default::default(),
 385         }
 386     }
 387 }
 388
 389 impl DroplessArena {
 390     #[inline(never)]
 391     #[cold]
 392     fn grow(&self, additional: usize) {
 393         unsafe {
 394             let mut chunks = self.chunks.borrow_mut();
 395             let mut new_cap;
 396             if let Some(last_chunk) = chunks.last_mut() {
 397                 // There is no need to update `last_chunk.entries` because that
 398                 // field isn't used by `DroplessArena`.
 399
 400                 // If the previous chunk's len is less than HUGE_PAGE
 401                 // bytes, then this chunk will be least double the previous
 402                 // chunk's size.
 403                 new_cap = last_chunk.storage.len().min(HUGE_PAGE / 2);
 404                 new_cap *= 2;
 405             } else {
 406                 new_cap = PAGE;
 407             }
 408             // Also ensure that this chunk can fit `additional`.
 409             new_cap = cmp::max(additional, new_cap);
 410
 411             let mut chunk = TypedArenaChunk::<u8>::new(new_cap);
 412             self.start.set(chunk.start());
 413             self.end.set(chunk.end());
 414             chunks.push(chunk);
 415         }
 416     }
 417
 418     /// Allocates a byte slice with specified layout from the current memory
 419     /// chunk. Returns `None` if there is no free space left to satisfy the
 420     /// request.
 421     #[inline]
 422     fn alloc_raw_without_grow(&self, layout: Layout) -> Option<*mut u8> {
 423         let start = self.start.get() as usize;
 424         let end = self.end.get() as usize;
 425
 426         let align = layout.align();
 427         let bytes = layout.size();
 428
 429         let new_end = end.checked_sub(bytes)? & !(align - 1);
 430         if start <= new_end {
 431             let new_end = new_end as *mut u8;
 432             self.end.set(new_end);
 433             Some(new_end)
 434         } else {
 435             None
 436         }
 437     }
 438
 439     #[inline]
 440     pub fn alloc_raw(&self, layout: Layout) -> *mut u8 {
 441         assert!(layout.size() != 0);
 442         loop {
 443             if let Some(a) = self.alloc_raw_without_grow(layout) {
 444                 break a;
 445             }
 446             // No free space left. Allocate a new chunk to satisfy the request.
 447             // On failure the grow will panic or abort.
 448             self.grow(layout.size());
 449         }
 450     }
 451
 452     #[inline]
 453     pub fn alloc<T>(&self, object: T) -> &mut T {
 454         assert!(!mem::needs_drop::<T>());
 455
 456         let mem = self.alloc_raw(Layout::for_value::<T>(&object)) as *mut T;
 457
 458         unsafe {
 459             // Write into uninitialized memory.
 460             ptr::write(mem, object);
 461             &mut *mem
 462         }
 463     }
 464
 465     /// Allocates a slice of objects that are copied into the `DroplessArena`, returning a mutable
 466     /// reference to it. Will panic if passed a zero-sized type.
 467     ///
 468     /// Panics:
 469     ///
 470     ///  - Zero-sized types
 471     ///  - Zero-length slices
 472     #[inline]
 473     pub fn alloc_slice<T>(&self, slice: &[T]) -> &mut [T]
 474     where
 475         T: Copy,
 476     {
 477         assert!(!mem::needs_drop::<T>());
 478         assert!(mem::size_of::<T>() != 0);
 479         assert!(!slice.is_empty());
 480
 481         let mem = self.alloc_raw(Layout::for_value::<[T]>(slice)) as *mut T;
 482
 483         unsafe {
 484             mem.copy_from_nonoverlapping(slice.as_ptr(), slice.len());
 485             slice::from_raw_parts_mut(mem, slice.len())
 486         }
 487     }
 488
 489     #[inline]
 490     unsafe fn write_from_iter<T, I: Iterator<Item = T>>(
 491         &self,
 492         mut iter: I,
 493         len: usize,
 494         mem: *mut T,
 495     ) -> &mut [T] {
 496         let mut i = 0;
 497         // Use a manual loop since LLVM manages to optimize it better for
 498         // slice iterators
 499         loop {
 500             let value = iter.next();
 501             if i >= len || value.is_none() {
 502                 // We only return as many items as the iterator gave us, even
 503                 // though it was supposed to give us `len`
 504                 return slice::from_raw_parts_mut(mem, i);
 505             }
 506             ptr::write(mem.add(i), value.unwrap());
 507             i += 1;
 508         }
 509     }
 510
 511     #[inline]
 512     pub fn alloc_from_iter<T, I: IntoIterator<Item = T>>(&self, iter: I) -> &mut [T] {
 513         let iter = iter.into_iter();
 514         assert!(mem::size_of::<T>() != 0);
 515         assert!(!mem::needs_drop::<T>());
 516
 517         let size_hint = iter.size_hint();
 518
 519         match size_hint {
 520             (min, Some(max)) if min == max => {
 521                 // We know the exact number of elements the iterator will produce here
 522                 let len = min;
 523
 524                 if len == 0 {
 525                     return &mut [];
 526                 }
 527
 528                 let mem = self.alloc_raw(Layout::array::<T>(len).unwrap()) as *mut T;
 529                 unsafe { self.write_from_iter(iter, len, mem) }
 530             }
 531             (_, _) => {
 532                 cold_path(move || -> &mut [T] {
 533                     let mut vec: SmallVec<[_; 8]> = iter.collect();
 534                     if vec.is_empty() {
 535                         return &mut [];
 536                     }
 537                     // Move the content to the arena by copying it and then forgetting
 538                     // the content of the SmallVec
 539                     unsafe {
 540                         let len = vec.len();
 541                         let start_ptr =
 542                             self.alloc_raw(Layout::for_value::<[T]>(vec.as_slice())) as *mut T;
 543                         vec.as_ptr().copy_to_nonoverlapping(start_ptr, len);
 544                         vec.set_len(0);
 545                         slice::from_raw_parts_mut(start_ptr, len)
 546                     }
 547                 })
 548             }
 549         }
 550     }
 551 }
 552
 553 /// Calls the destructor for an object when dropped.
 554 struct DropType {
 555     drop_fn: unsafe fn(*mut u8),
 556     obj: *mut u8,
 557 }
 558
 559 unsafe fn drop_for_type<T>(to_drop: *mut u8) {
 560     std::ptr::drop_in_place(to_drop as *mut T)
 561 }
 562
 563 impl Drop for DropType {
 564     fn drop(&mut self) {
 565         unsafe { (self.drop_fn)(self.obj) }
 566     }
 567 }
 568
 569 /// An arena which can be used to allocate any type.
 570 ///
 571 /// # Safety
 572 ///
 573 /// Allocating in this arena is unsafe since the type system
 574 /// doesn't know which types it contains. In order to
 575 /// allocate safely, you must store a `PhantomData<T>`
 576 /// alongside this arena for each type `T` you allocate.
 577 #[derive(Default)]
 578 pub struct DropArena {
 579     /// A list of destructors to run when the arena drops.
 580     /// Ordered so `destructors` gets dropped before the arena
 581     /// since its destructor can reference memory in the arena.
 582     destructors: RefCell<Vec<DropType>>,
 583     arena: DroplessArena,
 584 }
 585
 586 impl DropArena {
 587     #[inline]
 588     pub unsafe fn alloc<T>(&self, object: T) -> &mut T {
 589         let mem = self.arena.alloc_raw(Layout::new::<T>()) as *mut T;
 590         // Write into uninitialized memory.
 591         ptr::write(mem, object);
 592         let result = &mut *mem;
 593         // Record the destructor after doing the allocation as that may panic
 594         // and would cause `object`'s destructor to run twice if it was recorded before.
 595         self.destructors
 596             .borrow_mut()
 597             .push(DropType { drop_fn: drop_for_type::<T>, obj: result as *mut T as *mut u8 });
 598         result
 599     }
 600
 601     #[inline]
 602     pub unsafe fn alloc_from_iter<T, I: IntoIterator<Item = T>>(&self, iter: I) -> &mut [T] {
 603         let mut vec: SmallVec<[_; 8]> = iter.into_iter().collect();
 604         if vec.is_empty() {
 605             return &mut [];
 606         }
 607         let len = vec.len();
 608
 609         let start_ptr = self.arena.alloc_raw(Layout::array::<T>(len).unwrap()) as *mut T;
 610
 611         let mut destructors = self.destructors.borrow_mut();
 612         // Reserve space for the destructors so we can't panic while adding them.
 613         destructors.reserve(len);
 614
 615         // Move the content to the arena by copying it and then forgetting
 616         // the content of the SmallVec.
 617         vec.as_ptr().copy_to_nonoverlapping(start_ptr, len);
 618         mem::forget(vec.drain(..));
 619
 620         // Record the destructors after doing the allocation as that may panic
 621         // and would cause `object`'s destructor to run twice if it was recorded before.
 622         for i in 0..len {
 623             destructors
 624                 .push(DropType { drop_fn: drop_for_type::<T>, obj: start_ptr.add(i) as *mut u8 });
 625         }
 626
 627         slice::from_raw_parts_mut(start_ptr, len)
 628     }
 629 }
 630
 631 #[macro_export]
 632 macro_rules! arena_for_type {
 633     ([][$ty:ty]) => {
 634         $crate::TypedArena<$ty>
 635     };
 636     ([few $(, $attrs:ident)*][$ty:ty]) => {
 637         ::std::marker::PhantomData<$ty>
 638     };
 639     ([$ignore:ident $(, $attrs:ident)*]$args:tt) => {
 640         $crate::arena_for_type!([$($attrs),*]$args)
 641     };
 642 }
 643
 644 #[macro_export]
 645 macro_rules! which_arena_for_type {
 646     ([][$arena:expr]) => {
 647         ::std::option::Option::Some($arena)
 648     };
 649     ([few$(, $attrs:ident)*][$arena:expr]) => {
 650         ::std::option::Option::None
 651     };
 652     ([$ignore:ident$(, $attrs:ident)*]$args:tt) => {
 653         $crate::which_arena_for_type!([$($attrs),*]$args)
 654     };
 655 }
 656
 657 #[macro_export]
 658 macro_rules! declare_arena {
 659     ([], [$($a:tt $name:ident: $ty:ty,)*], $tcx:lifetime) => {
 660         #[derive(Default)]
 661         pub struct Arena<$tcx> {
 662             pub dropless: $crate::DroplessArena,
 663             drop: $crate::DropArena,
 664             $($name: $crate::arena_for_type!($a[$ty]),)*
 665         }
 666
 667         pub trait ArenaAllocatable<'tcx, T = Self>: Sized {
 668             fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut Self;
 669             fn allocate_from_iter<'a>(
 670                 arena: &'a Arena<'tcx>,
 671                 iter: impl ::std::iter::IntoIterator<Item = Self>,
 672             ) -> &'a mut [Self];
 673         }
 674
 675         impl<'tcx, T: Copy> ArenaAllocatable<'tcx, ()> for T {
 676             #[inline]
 677             fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut Self {
 678                 arena.dropless.alloc(self)
 679             }
 680             #[inline]
 681             fn allocate_from_iter<'a>(
 682                 arena: &'a Arena<'tcx>,
 683                 iter: impl ::std::iter::IntoIterator<Item = Self>,
 684             ) -> &'a mut [Self] {
 685                 arena.dropless.alloc_from_iter(iter)
 686             }
 687
 688         }
 689         $(
 690             impl<$tcx> ArenaAllocatable<$tcx, $ty> for $ty {
 691                 #[inline]
 692                 fn allocate_on<'a>(self, arena: &'a Arena<$tcx>) -> &'a mut Self {
 693                     if !::std::mem::needs_drop::<Self>() {
 694                         return arena.dropless.alloc(self);
 695                     }
 696                     match $crate::which_arena_for_type!($a[&arena.$name]) {
 697                         ::std::option::Option::<&$crate::TypedArena<Self>>::Some(ty_arena) => {
 698                             ty_arena.alloc(self)
 699                         }
 700                         ::std::option::Option::None => unsafe { arena.drop.alloc(self) },
 701                     }
 702                 }
 703
 704                 #[inline]
 705                 fn allocate_from_iter<'a>(
 706                     arena: &'a Arena<$tcx>,
 707                     iter: impl ::std::iter::IntoIterator<Item = Self>,
 708                 ) -> &'a mut [Self] {
 709                     if !::std::mem::needs_drop::<Self>() {
 710                         return arena.dropless.alloc_from_iter(iter);
 711                     }
 712                     match $crate::which_arena_for_type!($a[&arena.$name]) {
 713                         ::std::option::Option::<&$crate::TypedArena<Self>>::Some(ty_arena) => {
 714                             ty_arena.alloc_from_iter(iter)
 715                         }
 716                         ::std::option::Option::None => unsafe { arena.drop.alloc_from_iter(iter) },
 717                     }
 718                 }
 719             }
 720         )*
 721
 722         impl<'tcx> Arena<'tcx> {
 723             #[inline]
 724             pub fn alloc<T: ArenaAllocatable<'tcx, U>, U>(&self, value: T) -> &mut T {
 725                 value.allocate_on(self)
 726             }
 727
 728             #[inline]
 729             pub fn alloc_slice<T: ::std::marker::Copy>(&self, value: &[T]) -> &mut [T] {
 730                 if value.is_empty() {
 731                     return &mut [];
 732                 }
 733                 self.dropless.alloc_slice(value)
 734             }
 735
 736             pub fn alloc_from_iter<'a, T: ArenaAllocatable<'tcx, U>, U>(
 737                 &'a self,
 738                 iter: impl ::std::iter::IntoIterator<Item = T>,
 739             ) -> &'a mut [T] {
 740                 T::allocate_from_iter(self, iter)
 741             }
 742         }
 743     }
 744 }
 745
 746 #[cfg(test)]
 747 mod tests;