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             [] layouts: rustc::ty::layout::LayoutDetails,
  23             [] generics: rustc::ty::Generics,
  24             [] trait_def: rustc::ty::TraitDef,
  25             [] adt_def: rustc::ty::AdtDef,
  26             [] steal_mir: rustc::ty::steal::Steal<rustc::mir::BodyAndCache<$tcx>>,
  27             [] mir: rustc::mir::BodyAndCache<$tcx>,
  28             [] steal_promoted: rustc::ty::steal::Steal<
  29                 rustc_index::vec::IndexVec<
  30                     rustc::mir::Promoted,
  31                     rustc::mir::BodyAndCache<$tcx>
  32                 >
  33             >,
  34             [] promoted: rustc_index::vec::IndexVec<
  35                 rustc::mir::Promoted,
  36                 rustc::mir::BodyAndCache<$tcx>
  37             >,
  38             [] tables: rustc::ty::TypeckTables<$tcx>,
  39             [] const_allocs: rustc::mir::interpret::Allocation,
  40             [] vtable_method: Option<(
  41                 rustc::hir::def_id::DefId,
  42                 rustc::ty::subst::SubstsRef<$tcx>
  43             )>,
  44             [few, decode] mir_keys: rustc::util::nodemap::DefIdSet,
  45             [decode] specialization_graph: rustc::traits::specialization_graph::Graph,
  46             [] region_scope_tree: rustc::middle::region::ScopeTree,
  47             [] item_local_set: rustc::util::nodemap::ItemLocalSet,
  48             [decode] mir_const_qualif: rustc_index::bit_set::BitSet<rustc::mir::Local>,
  49             [] trait_impls_of: rustc::ty::trait_def::TraitImpls,
  50             [] dropck_outlives:
  51                 rustc::infer::canonical::Canonical<'tcx,
  52                     rustc::infer::canonical::QueryResponse<'tcx,
  53                         rustc::traits::query::dropck_outlives::DropckOutlivesResult<'tcx>
  54                     >
  55                 >,
  56             [] normalize_projection_ty:
  57                 rustc::infer::canonical::Canonical<'tcx,
  58                     rustc::infer::canonical::QueryResponse<'tcx,
  59                         rustc::traits::query::normalize::NormalizationResult<'tcx>
  60                     >
  61                 >,
  62             [] implied_outlives_bounds:
  63                 rustc::infer::canonical::Canonical<'tcx,
  64                     rustc::infer::canonical::QueryResponse<'tcx,
  65                         Vec<rustc::traits::query::outlives_bounds::OutlivesBound<'tcx>>
  66                     >
  67                 >,
  68             [] type_op_subtype:
  69                 rustc::infer::canonical::Canonical<'tcx,
  70                     rustc::infer::canonical::QueryResponse<'tcx, ()>
  71                 >,
  72             [] type_op_normalize_poly_fn_sig:
  73                 rustc::infer::canonical::Canonical<'tcx,
  74                     rustc::infer::canonical::QueryResponse<'tcx, rustc::ty::PolyFnSig<'tcx>>
  75                 >,
  76             [] type_op_normalize_fn_sig:
  77                 rustc::infer::canonical::Canonical<'tcx,
  78                     rustc::infer::canonical::QueryResponse<'tcx, rustc::ty::FnSig<'tcx>>
  79                 >,
  80             [] type_op_normalize_predicate:
  81                 rustc::infer::canonical::Canonical<'tcx,
  82                     rustc::infer::canonical::QueryResponse<'tcx, rustc::ty::Predicate<'tcx>>
  83                 >,
  84             [] type_op_normalize_ty:
  85                 rustc::infer::canonical::Canonical<'tcx,
  86                     rustc::infer::canonical::QueryResponse<'tcx, rustc::ty::Ty<'tcx>>
  87                 >,
  88             [few] crate_inherent_impls: rustc::ty::CrateInherentImpls,
  89             [few] upstream_monomorphizations:
  90                 rustc::util::nodemap::DefIdMap<
  91                     rustc_data_structures::fx::FxHashMap<
  92                         rustc::ty::subst::SubstsRef<'tcx>,
  93                         rustc::hir::def_id::CrateNum
  94                     >
  95                 >,
  96             [few] diagnostic_items: rustc_data_structures::fx::FxHashMap<
  97                 syntax::symbol::Symbol,
  98                 rustc::hir::def_id::DefId,
  99             >,
 100             [few] resolve_lifetimes: rustc::middle::resolve_lifetime::ResolveLifetimes,
 101             [few] lint_levels: rustc::lint::LintLevelMap,
 102             [few] stability_index: rustc::middle::stability::Index<'tcx>,
 103             [few] features: rustc_feature::Features,
 104             [few] all_traits: Vec<rustc::hir::def_id::DefId>,
 105             [few] privacy_access_levels: rustc::middle::privacy::AccessLevels,
 106             [few] target_features_whitelist: rustc_data_structures::fx::FxHashMap<
 107                 String,
 108                 Option<syntax::symbol::Symbol>
 109             >,
 110             [few] wasm_import_module_map: rustc_data_structures::fx::FxHashMap<
 111                 rustc::hir::def_id::DefId,
 112                 String
 113             >,
 114             [few] get_lib_features: rustc::middle::lib_features::LibFeatures,
 115             [few] defined_lib_features: rustc::middle::lang_items::LanguageItems,
 116             [few] visible_parent_map: rustc::util::nodemap::DefIdMap<rustc::hir::def_id::DefId>,
 117             [few] foreign_module: rustc::middle::cstore::ForeignModule,
 118             [few] foreign_modules: Vec<rustc::middle::cstore::ForeignModule>,
 119             [few] reachable_non_generics: rustc::util::nodemap::DefIdMap<
 120                 rustc::middle::exported_symbols::SymbolExportLevel
 121             >,
 122             [few] crate_variances: rustc::ty::CrateVariancesMap<'tcx>,
 123             [few] inferred_outlives_crate: rustc::ty::CratePredicatesMap<'tcx>,
 124             [] upvars: rustc_data_structures::fx::FxIndexMap<rustc::hir::HirId, rustc::hir::Upvar>,
 125             // HIR nodes arenas
 126             [few] hir_forest: rustc::hir::map::Forest<$tcx>,
 127             [] attribute: syntax::ast::Attribute,
 128             [] global_asm: rustc::hir::GlobalAsm,
 129             [] fn_decl: rustc::hir::FnDecl,
 130             [] foreign_item: rustc::hir::ForeignItem<$tcx>,
 131             [] impl_item_ref: rustc::hir::ImplItemRef,
 132             [] macro_def: rustc::hir::MacroDef<$tcx>,
 133             [] param: rustc::hir::Param,
 134             [] path: rustc::hir::Path,
 135             [] struct_field: rustc::hir::StructField<$tcx>,
 136             [] trait_item_ref: rustc::hir::TraitItemRef,
 137             [] ty: rustc::hir::Ty,
 138             [] variant: rustc::hir::Variant<$tcx>,
 139         ], $tcx);
 140     )
 141 }
 142
 143 macro_rules! arena_for_type {
 144     ([][$ty:ty]) => {
 145         TypedArena<$ty>
 146     };
 147     ([few $(, $attrs:ident)*][$ty:ty]) => {
 148         PhantomData<$ty>
 149     };
 150     ([$ignore:ident $(, $attrs:ident)*]$args:tt) => {
 151         arena_for_type!([$($attrs),*]$args)
 152     };
 153 }
 154
 155 macro_rules! declare_arena {
 156     ([], [$($a:tt $name:ident: $ty:ty,)*], $tcx:lifetime) => {
 157         #[derive(Default)]
 158         pub struct Arena<$tcx> {
 159             dropless: DroplessArena,
 160             drop: DropArena,
 161             $($name: arena_for_type!($a[$ty]),)*
 162         }
 163     }
 164 }
 165
 166 macro_rules! which_arena_for_type {
 167     ([][$arena:expr]) => {
 168         Some($arena)
 169     };
 170     ([few$(, $attrs:ident)*][$arena:expr]) => {
 171         None
 172     };
 173     ([$ignore:ident$(, $attrs:ident)*]$args:tt) => {
 174         which_arena_for_type!([$($attrs),*]$args)
 175     };
 176 }
 177
 178 macro_rules! impl_arena_allocatable {
 179     ([], [$($a:tt $name:ident: $ty:ty,)*], $tcx:lifetime) => {
 180         $(
 181             impl ArenaAllocatable for $ty {}
 182             unsafe impl<$tcx> ArenaField<$tcx> for $ty {
 183                 #[inline]
 184                 fn arena<'a>(_arena: &'a Arena<$tcx>) -> Option<&'a TypedArena<Self>> {
 185                     which_arena_for_type!($a[&_arena.$name])
 186                 }
 187             }
 188         )*
 189     }
 190 }
 191
 192 arena_types!(declare_arena, [], 'tcx);
 193
 194 arena_types!(impl_arena_allocatable, [], 'tcx);
 195
 196 pub trait ArenaAllocatable {}
 197
 198 impl<T: Copy> ArenaAllocatable for T {}
 199
 200 unsafe trait ArenaField<'tcx>: Sized {
 201     /// Returns a specific arena to allocate from.
 202     /// If `None` is returned, the `DropArena` will be used.
 203     fn arena<'a>(arena: &'a Arena<'tcx>) -> Option<&'a TypedArena<Self>>;
 204 }
 205
 206 unsafe impl<'tcx, T> ArenaField<'tcx> for T {
 207     #[inline]
 208     default fn arena<'a>(_: &'a Arena<'tcx>) -> Option<&'a TypedArena<Self>> {
 209         panic!()
 210     }
 211 }
 212
 213 impl<'tcx> Arena<'tcx> {
 214     #[inline]
 215     pub fn alloc<T: ArenaAllocatable>(&self, value: T) -> &mut T {
 216         if !mem::needs_drop::<T>() {
 217             return self.dropless.alloc(value);
 218         }
 219         match <T as ArenaField<'tcx>>::arena(self) {
 220             Some(arena) => arena.alloc(value),
 221             None => unsafe { self.drop.alloc(value) },
 222         }
 223     }
 224
 225     #[inline]
 226     pub fn alloc_slice<T: Copy>(&self, value: &[T]) -> &mut [T] {
 227         if value.len() == 0 {
 228             return &mut []
 229         }
 230         self.dropless.alloc_slice(value)
 231     }
 232
 233     pub fn alloc_from_iter<
 234         T: ArenaAllocatable,
 235         I: IntoIterator<Item = T>
 236     >(
 237         &'a self,
 238         iter: I
 239     ) -> &'a mut [T] {
 240         if !mem::needs_drop::<T>() {
 241             return self.dropless.alloc_from_iter(iter);
 242         }
 243         match <T as ArenaField<'tcx>>::arena(self) {
 244             Some(arena) => arena.alloc_from_iter(iter),
 245             None => unsafe { self.drop.alloc_from_iter(iter) },
 246         }
 247     }
 248 }
 249
 250 /// Calls the destructor for an object when dropped.
 251 struct DropType {
 252     drop_fn: unsafe fn(*mut u8),
 253     obj: *mut u8,
 254 }
 255
 256 unsafe fn drop_for_type<T>(to_drop: *mut u8) {
 257     std::ptr::drop_in_place(to_drop as *mut T)
 258 }
 259
 260 impl Drop for DropType {
 261     fn drop(&mut self) {
 262         unsafe {
 263             (self.drop_fn)(self.obj)
 264         }
 265     }
 266 }
 267
 268 /// An arena which can be used to allocate any type.
 269 /// Allocating in this arena is unsafe since the type system
 270 /// doesn't know which types it contains. In order to
 271 /// allocate safely, you must store a PhantomData<T>
 272 /// alongside this arena for each type T you allocate.
 273 #[derive(Default)]
 274 struct DropArena {
 275     /// A list of destructors to run when the arena drops.
 276     /// Ordered so `destructors` gets dropped before the arena
 277     /// since its destructor can reference memory in the arena.
 278     destructors: RefCell<Vec<DropType>>,
 279     arena: DroplessArena,
 280 }
 281
 282 impl DropArena {
 283     #[inline]
 284     unsafe fn alloc<T>(&self, object: T) -> &mut T {
 285         let mem = self.arena.alloc_raw(
 286             mem::size_of::<T>(),
 287             mem::align_of::<T>()
 288         ) as *mut _ as *mut T;
 289         // Write into uninitialized memory.
 290         ptr::write(mem, object);
 291         let result = &mut *mem;
 292         // Record the destructor after doing the allocation as that may panic
 293         // and would cause `object`'s destuctor to run twice if it was recorded before
 294         self.destructors.borrow_mut().push(DropType {
 295             drop_fn: drop_for_type::<T>,
 296             obj: result as *mut T as *mut u8,
 297         });
 298         result
 299     }
 300
 301     #[inline]
 302     unsafe fn alloc_from_iter<T, I: IntoIterator<Item = T>>(&self, iter: I) -> &mut [T] {
 303         let mut vec: SmallVec<[_; 8]> = iter.into_iter().collect();
 304         if vec.is_empty() {
 305             return &mut [];
 306         }
 307         let len = vec.len();
 308
 309         let start_ptr = self.arena.alloc_raw(
 310             len.checked_mul(mem::size_of::<T>()).unwrap(),
 311             mem::align_of::<T>()
 312         ) as *mut _ as *mut T;
 313
 314         let mut destructors = self.destructors.borrow_mut();
 315         // Reserve space for the destructors so we can't panic while adding them
 316         destructors.reserve(len);
 317
 318         // Move the content to the arena by copying it and then forgetting
 319         // the content of the SmallVec
 320         vec.as_ptr().copy_to_nonoverlapping(start_ptr, len);
 321         mem::forget(vec.drain(..));
 322
 323         // Record the destructors after doing the allocation as that may panic
 324         // and would cause `object`'s destuctor to run twice if it was recorded before
 325         for i in 0..len {
 326             destructors.push(DropType {
 327                 drop_fn: drop_for_type::<T>,
 328                 obj: start_ptr.offset(i as isize) as *mut u8,
 329             });
 330         }
 331
 332         slice::from_raw_parts_mut(start_ptr, len)
 333     }
 334 }