RecyclingAllocator.h revision e264f62ca09a8f65c87a46d562a4d0f9ec5d457e
1//==- llvm/Support/RecyclingAllocator.h - Recycling Allocator ----*- C++ -*-==//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file defines the RecyclingAllocator class.  See the doxygen comment for
11// RecyclingAllocator for more details on the implementation.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_SUPPORT_RECYCLINGALLOCATOR_H
16#define LLVM_SUPPORT_RECYCLINGALLOCATOR_H
17
18#include "llvm/Support/Recycler.h"
19
20namespace llvm {
21
22/// RecyclingAllocator - This class wraps an Allocator, adding the
23/// functionality of recycling deleted objects.
24///
25template<class AllocatorType, class T,
26         size_t Size = sizeof(T), size_t Align = AlignOf<T>::Alignment>
27class RecyclingAllocator {
28private:
29  /// Base - Implementation details.
30  ///
31  Recycler<T, Size, Align> Base;
32
33  /// Allocator - The wrapped allocator.
34  ///
35  AllocatorType Allocator;
36
37public:
38  ~RecyclingAllocator() { Base.clear(Allocator); }
39
40  /// Allocate - Return a pointer to storage for an object of type
41  /// SubClass. The storage may be either newly allocated or recycled.
42  ///
43  template<class SubClass>
44  SubClass *Allocate() { return Base.template Allocate<SubClass>(Allocator); }
45
46  T *Allocate() { return Base.Allocate(Allocator); }
47
48  /// Deallocate - Release storage for the pointed-to object. The
49  /// storage will be kept track of and may be recycled.
50  ///
51  template<class SubClass>
52  void Deallocate(SubClass* E) { return Base.Deallocate(Allocator, E); }
53
54  void PrintStats() { Base.PrintStats(); }
55};
56
57}
58
59#endif
60