src/librustc/arena.rs

   1 use arena::{TypedArena, DroplessArena};
   2 use std::mem;
   3 use std::ptr;
   4 use std::slice;
   5 use std::cell::RefCell;
   6 use std::marker::PhantomData;
   7 use smallvec::SmallVec;
   8
   9 /// This declares a list of types which can be allocated by `Arena`.
  10 ///
  11 /// The `few` modifier will cause allocation to use the shared arena and recording the destructor.
  12 /// This is faster and more memory efficient if there's only a few allocations of the type.
  13 /// Leaving `few` out will cause the type to get its own dedicated `TypedArena` which is
  14 /// faster and more memory efficient if there is lots of allocations.
  15 ///
  16 /// Specifying the `decode` modifier will add decode impls for &T and &[T] where T is the type
  17 /// listed. These impls will appear in the implement_ty_decoder! macro.
  18 #[macro_export]
  19 macro_rules! arena_types {
  20     ($macro:path, $args:tt, $tcx:lifetime) => (
  21         $macro!($args, [
  22             [] vtable_method: Option<(
  23                 rustc::hir::def_id::DefId,
  24                 rustc::ty::subst::SubstsRef<$tcx>
  25             )>,
  26             [few, decode] mir_keys: rustc::util::nodemap::DefIdSet,
  27             [decode] specialization_graph: rustc::traits::specialization_graph::Graph,
  28             [] region_scope_tree: rustc::middle::region::ScopeTree,
  29             [] item_local_set: rustc::util::nodemap::ItemLocalSet,
  30             [decode] mir_const_qualif: rustc_data_structures::bit_set::BitSet<rustc::mir::Local>,
  31             [] trait_impls_of: rustc::ty::trait_def::TraitImpls,
  32             [] dropck_outlives:
  33                 rustc::infer::canonical::Canonical<'tcx,
  34                     rustc::infer::canonical::QueryResponse<'tcx,
  35                         rustc::traits::query::dropck_outlives::DropckOutlivesResult<'tcx>
  36                     >
  37                 >,
  38             [] normalize_projection_ty:
  39                 rustc::infer::canonical::Canonical<'tcx,
  40                     rustc::infer::canonical::QueryResponse<'tcx,
  41                         rustc::traits::query::normalize::NormalizationResult<'tcx>
  42                     >
  43                 >,
  44             [] implied_outlives_bounds:
  45                 rustc::infer::canonical::Canonical<'tcx,
  46                     rustc::infer::canonical::QueryResponse<'tcx,
  47                         Vec<rustc::traits::query::outlives_bounds::OutlivesBound<'tcx>>
  48                     >
  49                 >,
  50             [] type_op_subtype:
  51                 rustc::infer::canonical::Canonical<'tcx,
  52                     rustc::infer::canonical::QueryResponse<'tcx, ()>
  53                 >,
  54             [] type_op_normalize_poly_fn_sig:
  55                 rustc::infer::canonical::Canonical<'tcx,
  56                     rustc::infer::canonical::QueryResponse<'tcx, rustc::ty::PolyFnSig<'tcx>>
  57                 >,
  58             [] type_op_normalize_fn_sig:
  59                 rustc::infer::canonical::Canonical<'tcx,
  60                     rustc::infer::canonical::QueryResponse<'tcx, rustc::ty::FnSig<'tcx>>
  61                 >,
  62             [] type_op_normalize_predicate:
  63                 rustc::infer::canonical::Canonical<'tcx,
  64                     rustc::infer::canonical::QueryResponse<'tcx, rustc::ty::Predicate<'tcx>>
  65                 >,
  66             [] type_op_normalize_ty:
  67                 rustc::infer::canonical::Canonical<'tcx,
  68                     rustc::infer::canonical::QueryResponse<'tcx, rustc::ty::Ty<'tcx>>
  69                 >,
  70             [few] crate_inherent_impls: rustc::ty::CrateInherentImpls,
  71             [decode] borrowck: rustc::middle::borrowck::BorrowCheckResult,
  72             [few] upstream_monomorphizations:
  73                 rustc::util::nodemap::DefIdMap<
  74                     rustc_data_structures::fx::FxHashMap<
  75                         rustc::ty::subst::SubstsRef<'tcx>,
  76                         rustc::hir::def_id::CrateNum
  77                     >
  78                 >,
  79             [few] resolve_lifetimes: rustc::middle::resolve_lifetime::ResolveLifetimes,
  80             [decode] generic_predicates: rustc::ty::GenericPredicates<'tcx>,
  81             [few] lint_levels: rustc::lint::LintLevelMap,
  82             [few] stability_index: rustc::middle::stability::Index<'tcx>,
  83             [few] features: syntax::feature_gate::Features,
  84             [few] all_traits: Vec<rustc::hir::def_id::DefId>,
  85         ], $tcx);
  86     )
  87 }
  88
  89 macro_rules! arena_for_type {
  90     ([][$ty:ty]) => {
  91         TypedArena<$ty>
  92     };
  93     ([few $(, $attrs:ident)*][$ty:ty]) => {
  94         PhantomData<$ty>
  95     };
  96     ([$ignore:ident $(, $attrs:ident)*]$args:tt) => {
  97         arena_for_type!([$($attrs),*]$args)
  98     };
  99 }
 100
 101 macro_rules! declare_arena {
 102     ([], [$($a:tt $name:ident: $ty:ty,)*], $tcx:lifetime) => {
 103         #[derive(Default)]
 104         pub struct Arena<$tcx> {
 105             dropless: DroplessArena,
 106             drop: DropArena,
 107             $($name: arena_for_type!($a[$ty]),)*
 108         }
 109     }
 110 }
 111
 112 macro_rules! which_arena_for_type {
 113     ([][$arena:expr]) => {
 114         Some($arena)
 115     };
 116     ([few$(, $attrs:ident)*][$arena:expr]) => {
 117         None
 118     };
 119     ([$ignore:ident$(, $attrs:ident)*]$args:tt) => {
 120         which_arena_for_type!([$($attrs),*]$args)
 121     };
 122 }
 123
 124 macro_rules! impl_arena_allocatable {
 125     ([], [$($a:tt $name:ident: $ty:ty,)*], $tcx:lifetime) => {
 126         $(
 127             impl ArenaAllocatable for $ty {}
 128             unsafe impl<$tcx> ArenaField<$tcx> for $ty {
 129                 #[inline]
 130                 fn arena<'a>(_arena: &'a Arena<$tcx>) -> Option<&'a TypedArena<Self>> {
 131                     which_arena_for_type!($a[&_arena.$name])
 132                 }
 133             }
 134         )*
 135     }
 136 }
 137
 138 arena_types!(declare_arena, [], 'tcx);
 139
 140 arena_types!(impl_arena_allocatable, [], 'tcx);
 141
 142 pub trait ArenaAllocatable {}
 143
 144 impl<T: Copy> ArenaAllocatable for T {}
 145
 146 unsafe trait ArenaField<'tcx>: Sized {
 147     /// Returns a specific arena to allocate from.
 148     /// If None is returned, the DropArena will be used.
 149     fn arena<'a>(arena: &'a Arena<'tcx>) -> Option<&'a TypedArena<Self>>;
 150 }
 151
 152 unsafe impl<'tcx, T> ArenaField<'tcx> for T {
 153     #[inline]
 154     default fn arena<'a>(_: &'a Arena<'tcx>) -> Option<&'a TypedArena<Self>> {
 155         panic!()
 156     }
 157 }
 158
 159 impl<'tcx> Arena<'tcx> {
 160     #[inline]
 161     pub fn alloc<T: ArenaAllocatable>(&self, value: T) -> &mut T {
 162         if !mem::needs_drop::<T>() {
 163             return self.dropless.alloc(value);
 164         }
 165         match <T as ArenaField<'tcx>>::arena(self) {
 166             Some(arena) => arena.alloc(value),
 167             None => unsafe { self.drop.alloc(value) },
 168         }
 169     }
 170
 171     #[inline]
 172     pub fn alloc_slice<T: Copy>(&self, value: &[T]) -> &mut [T] {
 173         if value.len() == 0 {
 174             return &mut []
 175         }
 176         self.dropless.alloc_slice(value)
 177     }
 178
 179     pub fn alloc_from_iter<
 180         T: ArenaAllocatable,
 181         I: IntoIterator<Item = T>
 182     >(
 183         &'a self,
 184         iter: I
 185     ) -> &'a mut [T] {
 186         if !mem::needs_drop::<T>() {
 187             return self.dropless.alloc_from_iter(iter);
 188         }
 189         match <T as ArenaField<'tcx>>::arena(self) {
 190             Some(arena) => arena.alloc_from_iter(iter),
 191             None => unsafe { self.drop.alloc_from_iter(iter) },
 192         }
 193     }
 194 }
 195
 196 /// Calls the destructor for an object when dropped.
 197 struct DropType {
 198     drop_fn: unsafe fn(*mut u8),
 199     obj: *mut u8,
 200 }
 201
 202 unsafe fn drop_for_type<T>(to_drop: *mut u8) {
 203     std::ptr::drop_in_place(to_drop as *mut T)
 204 }
 205
 206 impl Drop for DropType {
 207     fn drop(&mut self) {
 208         unsafe {
 209             (self.drop_fn)(self.obj)
 210         }
 211     }
 212 }
 213
 214 /// An arena which can be used to allocate any type.
 215 /// Allocating in this arena is unsafe since the type system
 216 /// doesn't know which types it contains. In order to
 217 /// allocate safely, you must store a PhantomData<T>
 218 /// alongside this arena for each type T you allocate.
 219 #[derive(Default)]
 220 struct DropArena {
 221     /// A list of destructors to run when the arena drops.
 222     /// Ordered so `destructors` gets dropped before the arena
 223     /// since its destructor can reference memory in the arena.
 224     destructors: RefCell<Vec<DropType>>,
 225     arena: DroplessArena,
 226 }
 227
 228 impl DropArena {
 229     #[inline]
 230     unsafe fn alloc<T>(&self, object: T) -> &mut T {
 231         let mem = self.arena.alloc_raw(
 232             mem::size_of::<T>(),
 233             mem::align_of::<T>()
 234         ) as *mut _ as *mut T;
 235         // Write into uninitialized memory.
 236         ptr::write(mem, object);
 237         let result = &mut *mem;
 238         // Record the destructor after doing the allocation as that may panic
 239         // and would cause `object`'s destuctor to run twice if it was recorded before
 240         self.destructors.borrow_mut().push(DropType {
 241             drop_fn: drop_for_type::<T>,
 242             obj: result as *mut T as *mut u8,
 243         });
 244         result
 245     }
 246
 247     #[inline]
 248     unsafe fn alloc_from_iter<T, I: IntoIterator<Item = T>>(&self, iter: I) -> &mut [T] {
 249         let mut vec: SmallVec<[_; 8]> = iter.into_iter().collect();
 250         if vec.is_empty() {
 251             return &mut [];
 252         }
 253         let len = vec.len();
 254
 255         let start_ptr = self.arena.alloc_raw(
 256             len.checked_mul(mem::size_of::<T>()).unwrap(),
 257             mem::align_of::<T>()
 258         ) as *mut _ as *mut T;
 259
 260         let mut destructors = self.destructors.borrow_mut();
 261         // Reserve space for the destructors so we can't panic while adding them
 262         destructors.reserve(len);
 263
 264         // Move the content to the arena by copying it and then forgetting
 265         // the content of the SmallVec
 266         vec.as_ptr().copy_to_nonoverlapping(start_ptr, len);
 267         mem::forget(vec.drain());
 268
 269         // Record the destructors after doing the allocation as that may panic
 270         // and would cause `object`'s destuctor to run twice if it was recorded before
 271         for i in 0..len {
 272             destructors.push(DropType {
 273                 drop_fn: drop_for_type::<T>,
 274                 obj: start_ptr.offset(i as isize) as *mut u8,
 275             });
 276         }
 277
 278         slice::from_raw_parts_mut(start_ptr, len)
 279     }
 280 }