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             [few] privacy_access_levels: rustc::middle::privacy::AccessLevels,
  86             [few] target_features_whitelist: rustc_data_structures::fx::FxHashMap<
  87                 String,
  88                 Option<syntax::symbol::Symbol>
  89             >,
  90             [few] wasm_import_module_map: rustc_data_structures::fx::FxHashMap<
  91                 rustc::hir::def_id::DefId,
  92                 String
  93             >,
  94             [few] get_lib_features: rustc::middle::lib_features::LibFeatures,
  95             [few] defined_lib_features: rustc::middle::lang_items::LanguageItems,
  96             [few] visible_parent_map: rustc::util::nodemap::DefIdMap<rustc::hir::def_id::DefId>,
  97             [few] foreign_module: rustc::middle::cstore::ForeignModule,
  98             [few] foreign_modules: Vec<rustc::middle::cstore::ForeignModule>,
  99             [few] reachable_non_generics: rustc::util::nodemap::DefIdMap<
 100                 rustc::middle::exported_symbols::SymbolExportLevel
 101             >,
 102         ], $tcx);
 103     )
 104 }
 105
 106 macro_rules! arena_for_type {
 107     ([][$ty:ty]) => {
 108         TypedArena<$ty>
 109     };
 110     ([few $(, $attrs:ident)*][$ty:ty]) => {
 111         PhantomData<$ty>
 112     };
 113     ([$ignore:ident $(, $attrs:ident)*]$args:tt) => {
 114         arena_for_type!([$($attrs),*]$args)
 115     };
 116 }
 117
 118 macro_rules! declare_arena {
 119     ([], [$($a:tt $name:ident: $ty:ty,)*], $tcx:lifetime) => {
 120         #[derive(Default)]
 121         pub struct Arena<$tcx> {
 122             dropless: DroplessArena,
 123             drop: DropArena,
 124             $($name: arena_for_type!($a[$ty]),)*
 125         }
 126     }
 127 }
 128
 129 macro_rules! which_arena_for_type {
 130     ([][$arena:expr]) => {
 131         Some($arena)
 132     };
 133     ([few$(, $attrs:ident)*][$arena:expr]) => {
 134         None
 135     };
 136     ([$ignore:ident$(, $attrs:ident)*]$args:tt) => {
 137         which_arena_for_type!([$($attrs),*]$args)
 138     };
 139 }
 140
 141 macro_rules! impl_arena_allocatable {
 142     ([], [$($a:tt $name:ident: $ty:ty,)*], $tcx:lifetime) => {
 143         $(
 144             impl ArenaAllocatable for $ty {}
 145             unsafe impl<$tcx> ArenaField<$tcx> for $ty {
 146                 #[inline]
 147                 fn arena<'a>(_arena: &'a Arena<$tcx>) -> Option<&'a TypedArena<Self>> {
 148                     which_arena_for_type!($a[&_arena.$name])
 149                 }
 150             }
 151         )*
 152     }
 153 }
 154
 155 arena_types!(declare_arena, [], 'tcx);
 156
 157 arena_types!(impl_arena_allocatable, [], 'tcx);
 158
 159 pub trait ArenaAllocatable {}
 160
 161 impl<T: Copy> ArenaAllocatable for T {}
 162
 163 unsafe trait ArenaField<'tcx>: Sized {
 164     /// Returns a specific arena to allocate from.
 165     /// If None is returned, the DropArena will be used.
 166     fn arena<'a>(arena: &'a Arena<'tcx>) -> Option<&'a TypedArena<Self>>;
 167 }
 168
 169 unsafe impl<'tcx, T> ArenaField<'tcx> for T {
 170     #[inline]
 171     default fn arena<'a>(_: &'a Arena<'tcx>) -> Option<&'a TypedArena<Self>> {
 172         panic!()
 173     }
 174 }
 175
 176 impl<'tcx> Arena<'tcx> {
 177     #[inline]
 178     pub fn alloc<T: ArenaAllocatable>(&self, value: T) -> &mut T {
 179         if !mem::needs_drop::<T>() {
 180             return self.dropless.alloc(value);
 181         }
 182         match <T as ArenaField<'tcx>>::arena(self) {
 183             Some(arena) => arena.alloc(value),
 184             None => unsafe { self.drop.alloc(value) },
 185         }
 186     }
 187
 188     #[inline]
 189     pub fn alloc_slice<T: Copy>(&self, value: &[T]) -> &mut [T] {
 190         if value.len() == 0 {
 191             return &mut []
 192         }
 193         self.dropless.alloc_slice(value)
 194     }
 195
 196     pub fn alloc_from_iter<
 197         T: ArenaAllocatable,
 198         I: IntoIterator<Item = T>
 199     >(
 200         &'a self,
 201         iter: I
 202     ) -> &'a mut [T] {
 203         if !mem::needs_drop::<T>() {
 204             return self.dropless.alloc_from_iter(iter);
 205         }
 206         match <T as ArenaField<'tcx>>::arena(self) {
 207             Some(arena) => arena.alloc_from_iter(iter),
 208             None => unsafe { self.drop.alloc_from_iter(iter) },
 209         }
 210     }
 211 }
 212
 213 /// Calls the destructor for an object when dropped.
 214 struct DropType {
 215     drop_fn: unsafe fn(*mut u8),
 216     obj: *mut u8,
 217 }
 218
 219 unsafe fn drop_for_type<T>(to_drop: *mut u8) {
 220     std::ptr::drop_in_place(to_drop as *mut T)
 221 }
 222
 223 impl Drop for DropType {
 224     fn drop(&mut self) {
 225         unsafe {
 226             (self.drop_fn)(self.obj)
 227         }
 228     }
 229 }
 230
 231 /// An arena which can be used to allocate any type.
 232 /// Allocating in this arena is unsafe since the type system
 233 /// doesn't know which types it contains. In order to
 234 /// allocate safely, you must store a PhantomData<T>
 235 /// alongside this arena for each type T you allocate.
 236 #[derive(Default)]
 237 struct DropArena {
 238     /// A list of destructors to run when the arena drops.
 239     /// Ordered so `destructors` gets dropped before the arena
 240     /// since its destructor can reference memory in the arena.
 241     destructors: RefCell<Vec<DropType>>,
 242     arena: DroplessArena,
 243 }
 244
 245 impl DropArena {
 246     #[inline]
 247     unsafe fn alloc<T>(&self, object: T) -> &mut T {
 248         let mem = self.arena.alloc_raw(
 249             mem::size_of::<T>(),
 250             mem::align_of::<T>()
 251         ) as *mut _ as *mut T;
 252         // Write into uninitialized memory.
 253         ptr::write(mem, object);
 254         let result = &mut *mem;
 255         // Record the destructor after doing the allocation as that may panic
 256         // and would cause `object`'s destuctor to run twice if it was recorded before
 257         self.destructors.borrow_mut().push(DropType {
 258             drop_fn: drop_for_type::<T>,
 259             obj: result as *mut T as *mut u8,
 260         });
 261         result
 262     }
 263
 264     #[inline]
 265     unsafe fn alloc_from_iter<T, I: IntoIterator<Item = T>>(&self, iter: I) -> &mut [T] {
 266         let mut vec: SmallVec<[_; 8]> = iter.into_iter().collect();
 267         if vec.is_empty() {
 268             return &mut [];
 269         }
 270         let len = vec.len();
 271
 272         let start_ptr = self.arena.alloc_raw(
 273             len.checked_mul(mem::size_of::<T>()).unwrap(),
 274             mem::align_of::<T>()
 275         ) as *mut _ as *mut T;
 276
 277         let mut destructors = self.destructors.borrow_mut();
 278         // Reserve space for the destructors so we can't panic while adding them
 279         destructors.reserve(len);
 280
 281         // Move the content to the arena by copying it and then forgetting
 282         // the content of the SmallVec
 283         vec.as_ptr().copy_to_nonoverlapping(start_ptr, len);
 284         mem::forget(vec.drain());
 285
 286         // Record the destructors after doing the allocation as that may panic
 287         // and would cause `object`'s destuctor to run twice if it was recorded before
 288         for i in 0..len {
 289             destructors.push(DropType {
 290                 drop_fn: drop_for_type::<T>,
 291                 obj: start_ptr.offset(i as isize) as *mut u8,
 292             });
 293         }
 294
 295         slice::from_raw_parts_mut(start_ptr, len)
 296     }
 297 }