src/librustc/arena.rs

   1 use arena::{DroplessArena, TypedArena};
   2 use smallvec::SmallVec;
   3 use std::cell::RefCell;
   4 use std::marker::PhantomData;
   5 use std::mem;
   6 use std::ptr;
   7 use std::slice;
   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_hir::def_id::DefIdSet,
  45             [decode] specialization_graph: rustc::traits::specialization_graph::Graph,
  46             [] region_scope_tree: rustc::middle::region::ScopeTree,
  47             [] item_local_set: rustc_hir::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_hir::def_id::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                 rustc_span::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<rustc_span::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_hir::def_id::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_hir::def_id::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
 126             // Interned types
 127             [] tys: rustc::ty::TyS<$tcx>,
 128
 129             // HIR types
 130             [few] hir_forest: rustc::hir::map::Forest<$tcx>,
 131             [] arm: rustc_hir::Arm<$tcx>,
 132             [] attribute: syntax::ast::Attribute,
 133             [] block: rustc_hir::Block<$tcx>,
 134             [] bare_fn_ty: rustc_hir::BareFnTy<$tcx>,
 135             [few] global_asm: rustc_hir::GlobalAsm,
 136             [] generic_arg: rustc_hir::GenericArg<$tcx>,
 137             [] generic_args: rustc_hir::GenericArgs<$tcx>,
 138             [] generic_bound: rustc_hir::GenericBound<$tcx>,
 139             [] generic_param: rustc_hir::GenericParam<$tcx>,
 140             [] expr: rustc_hir::Expr<$tcx>,
 141             [] field: rustc_hir::Field<$tcx>,
 142             [] field_pat: rustc_hir::FieldPat<$tcx>,
 143             [] fn_decl: rustc_hir::FnDecl<$tcx>,
 144             [] foreign_item: rustc_hir::ForeignItem<$tcx>,
 145             [] impl_item_ref: rustc_hir::ImplItemRef<$tcx>,
 146             [] inline_asm: rustc_hir::InlineAsm<$tcx>,
 147             [] local: rustc_hir::Local<$tcx>,
 148             [few] macro_def: rustc_hir::MacroDef<$tcx>,
 149             [] param: rustc_hir::Param<$tcx>,
 150             [] pat: rustc_hir::Pat<$tcx>,
 151             [] path: rustc_hir::Path<$tcx>,
 152             [] path_segment: rustc_hir::PathSegment<$tcx>,
 153             [] poly_trait_ref: rustc_hir::PolyTraitRef<$tcx>,
 154             [] qpath: rustc_hir::QPath<$tcx>,
 155             [] stmt: rustc_hir::Stmt<$tcx>,
 156             [] struct_field: rustc_hir::StructField<$tcx>,
 157             [] trait_item_ref: rustc_hir::TraitItemRef,
 158             [] ty: rustc_hir::Ty<$tcx>,
 159             [] type_binding: rustc_hir::TypeBinding<$tcx>,
 160             [] variant: rustc_hir::Variant<$tcx>,
 161             [] where_predicate: rustc_hir::WherePredicate<$tcx>,
 162         ], $tcx);
 163     )
 164 }
 165
 166 macro_rules! arena_for_type {
 167     ([][$ty:ty]) => {
 168         TypedArena<$ty>
 169     };
 170     ([few $(, $attrs:ident)*][$ty:ty]) => {
 171         PhantomData<$ty>
 172     };
 173     ([$ignore:ident $(, $attrs:ident)*]$args:tt) => {
 174         arena_for_type!([$($attrs),*]$args)
 175     };
 176 }
 177
 178 macro_rules! declare_arena {
 179     ([], [$($a:tt $name:ident: $ty:ty,)*], $tcx:lifetime) => {
 180         #[derive(Default)]
 181         pub struct Arena<$tcx> {
 182             pub dropless: DroplessArena,
 183             drop: DropArena,
 184             $($name: arena_for_type!($a[$ty]),)*
 185         }
 186     }
 187 }
 188
 189 macro_rules! which_arena_for_type {
 190     ([][$arena:expr]) => {
 191         Some($arena)
 192     };
 193     ([few$(, $attrs:ident)*][$arena:expr]) => {
 194         None
 195     };
 196     ([$ignore:ident$(, $attrs:ident)*]$args:tt) => {
 197         which_arena_for_type!([$($attrs),*]$args)
 198     };
 199 }
 200
 201 macro_rules! impl_arena_allocatable {
 202     ([], [$($a:tt $name:ident: $ty:ty,)*], $tcx:lifetime) => {
 203         $(
 204             impl ArenaAllocatable for $ty {}
 205             unsafe impl<$tcx> ArenaField<$tcx> for $ty {
 206                 #[inline]
 207                 fn arena<'a>(_arena: &'a Arena<$tcx>) -> Option<&'a TypedArena<Self>> {
 208                     which_arena_for_type!($a[&_arena.$name])
 209                 }
 210             }
 211         )*
 212     }
 213 }
 214
 215 arena_types!(declare_arena, [], 'tcx);
 216
 217 arena_types!(impl_arena_allocatable, [], 'tcx);
 218
 219 pub trait ArenaAllocatable {}
 220
 221 impl<T: Copy> ArenaAllocatable for T {}
 222
 223 unsafe trait ArenaField<'tcx>: Sized {
 224     /// Returns a specific arena to allocate from.
 225     /// If `None` is returned, the `DropArena` will be used.
 226     fn arena<'a>(arena: &'a Arena<'tcx>) -> Option<&'a TypedArena<Self>>;
 227 }
 228
 229 unsafe impl<'tcx, T> ArenaField<'tcx> for T {
 230     #[inline]
 231     default fn arena<'a>(_: &'a Arena<'tcx>) -> Option<&'a TypedArena<Self>> {
 232         panic!()
 233     }
 234 }
 235
 236 impl<'tcx> Arena<'tcx> {
 237     #[inline]
 238     pub fn alloc<T: ArenaAllocatable>(&self, value: T) -> &mut T {
 239         if !mem::needs_drop::<T>() {
 240             return self.dropless.alloc(value);
 241         }
 242         match <T as ArenaField<'tcx>>::arena(self) {
 243             Some(arena) => arena.alloc(value),
 244             None => unsafe { self.drop.alloc(value) },
 245         }
 246     }
 247
 248     #[inline]
 249     pub fn alloc_slice<T: Copy>(&self, value: &[T]) -> &mut [T] {
 250         if value.len() == 0 {
 251             return &mut [];
 252         }
 253         self.dropless.alloc_slice(value)
 254     }
 255
 256     pub fn alloc_from_iter<T: ArenaAllocatable, I: IntoIterator<Item = T>>(
 257         &'a self,
 258         iter: I,
 259     ) -> &'a mut [T] {
 260         if !mem::needs_drop::<T>() {
 261             return self.dropless.alloc_from_iter(iter);
 262         }
 263         match <T as ArenaField<'tcx>>::arena(self) {
 264             Some(arena) => arena.alloc_from_iter(iter),
 265             None => unsafe { self.drop.alloc_from_iter(iter) },
 266         }
 267     }
 268 }
 269
 270 /// Calls the destructor for an object when dropped.
 271 struct DropType {
 272     drop_fn: unsafe fn(*mut u8),
 273     obj: *mut u8,
 274 }
 275
 276 unsafe fn drop_for_type<T>(to_drop: *mut u8) {
 277     std::ptr::drop_in_place(to_drop as *mut T)
 278 }
 279
 280 impl Drop for DropType {
 281     fn drop(&mut self) {
 282         unsafe { (self.drop_fn)(self.obj) }
 283     }
 284 }
 285
 286 /// An arena which can be used to allocate any type.
 287 /// Allocating in this arena is unsafe since the type system
 288 /// doesn't know which types it contains. In order to
 289 /// allocate safely, you must store a PhantomData<T>
 290 /// alongside this arena for each type T you allocate.
 291 #[derive(Default)]
 292 struct DropArena {
 293     /// A list of destructors to run when the arena drops.
 294     /// Ordered so `destructors` gets dropped before the arena
 295     /// since its destructor can reference memory in the arena.
 296     destructors: RefCell<Vec<DropType>>,
 297     arena: DroplessArena,
 298 }
 299
 300 impl DropArena {
 301     #[inline]
 302     unsafe fn alloc<T>(&self, object: T) -> &mut T {
 303         let mem =
 304             self.arena.alloc_raw(mem::size_of::<T>(), mem::align_of::<T>()) as *mut _ as *mut T;
 305         // Write into uninitialized memory.
 306         ptr::write(mem, object);
 307         let result = &mut *mem;
 308         // Record the destructor after doing the allocation as that may panic
 309         // and would cause `object`'s destuctor to run twice if it was recorded before
 310         self.destructors
 311             .borrow_mut()
 312             .push(DropType { drop_fn: drop_for_type::<T>, obj: result as *mut T as *mut u8 });
 313         result
 314     }
 315
 316     #[inline]
 317     unsafe fn alloc_from_iter<T, I: IntoIterator<Item = T>>(&self, iter: I) -> &mut [T] {
 318         let mut vec: SmallVec<[_; 8]> = iter.into_iter().collect();
 319         if vec.is_empty() {
 320             return &mut [];
 321         }
 322         let len = vec.len();
 323
 324         let start_ptr = self
 325             .arena
 326             .alloc_raw(len.checked_mul(mem::size_of::<T>()).unwrap(), mem::align_of::<T>())
 327             as *mut _ as *mut T;
 328
 329         let mut destructors = self.destructors.borrow_mut();
 330         // Reserve space for the destructors so we can't panic while adding them
 331         destructors.reserve(len);
 332
 333         // Move the content to the arena by copying it and then forgetting
 334         // the content of the SmallVec
 335         vec.as_ptr().copy_to_nonoverlapping(start_ptr, len);
 336         mem::forget(vec.drain(..));
 337
 338         // Record the destructors after doing the allocation as that may panic
 339         // and would cause `object`'s destuctor to run twice if it was recorded before
 340         for i in 0..len {
 341             destructors.push(DropType {
 342                 drop_fn: drop_for_type::<T>,
 343                 obj: start_ptr.offset(i as isize) as *mut u8,
 344             });
 345         }
 346
 347         slice::from_raw_parts_mut(start_ptr, len)
 348     }
 349 }