folly/Arena.h

   1 /*
   2  * Copyright 2015 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef FOLLY_ARENA_H_
  18 #define FOLLY_ARENA_H_
  19
  20 #include <cassert>
  21 #include <limits>
  22 #include <stdexcept>
  23 #include <utility>
  24 #include <boost/intrusive/slist.hpp>
  25
  26 #include <folly/Conv.h>
  27 #include <folly/Likely.h>
  28 #include <folly/Malloc.h>
  29 #include <folly/Memory.h>
  30
  31 namespace folly {
  32
  33 /**
  34  * Simple arena: allocate memory which gets freed when the arena gets
  35  * destroyed.
  36  *
  37  * The arena itself allocates memory using a custom allocator which provides
  38  * the following interface (same as required by StlAllocator in StlAllocator.h)
  39  *
  40  *   void* allocate(size_t size);
  41  *      Allocate a block of size bytes, properly aligned to the maximum
  42  *      alignment required on your system; throw std::bad_alloc if the
  43  *      allocation can't be satisfied.
  44  *
  45  *   void deallocate(void* ptr);
  46  *      Deallocate a previously allocated block.
  47  *
  48  * You may also specialize ArenaAllocatorTraits for your allocator type to
  49  * provide:
  50  *
  51  *   size_t goodSize(const Allocator& alloc, size_t size) const;
  52  *      Return a size (>= the provided size) that is considered "good" for your
  53  *      allocator (for example, if your allocator allocates memory in 4MB
  54  *      chunks, size should be rounded up to 4MB).  The provided value is
  55  *      guaranteed to be rounded up to a multiple of the maximum alignment
  56  *      required on your system; the returned value must be also.
  57  *
  58  * An implementation that uses malloc() / free() is defined below, see SysArena.
  59  */
  60 template <class Alloc> struct ArenaAllocatorTraits;
  61 template <class Alloc>
  62 class Arena {
  63  public:
  64   explicit Arena(const Alloc& alloc,
  65                  size_t minBlockSize = kDefaultMinBlockSize,
  66                  size_t sizeLimit = kNoSizeLimit,
  67                  size_t maxAlign = kDefaultMaxAlign)
  68     : allocAndSize_(alloc, minBlockSize)
  69     , ptr_(nullptr)
  70     , end_(nullptr)
  71     , totalAllocatedSize_(0)
  72     , bytesUsed_(0)
  73     , sizeLimit_(sizeLimit)
  74     , maxAlign_(maxAlign) {
  75     if ((maxAlign_ & (maxAlign_ - 1)) || maxAlign_ > alignof(Block)) {
  76       throw std::invalid_argument(
  77           folly::to<std::string>("Invalid maxAlign: ", maxAlign_));
  78     }
  79   }
  80
  81   ~Arena();
  82
  83   void* allocate(size_t size) {
  84     size = roundUp(size);
  85     bytesUsed_ += size;
  86
  87     assert(ptr_ <= end_);
  88     if (LIKELY((size_t)(end_ - ptr_) >= size)) {
  89       // Fast path: there's enough room in the current block
  90       char* r = ptr_;
  91       ptr_ += size;
  92       assert(isAligned(r));
  93       return r;
  94     }
  95
  96     // Not enough room in the current block
  97     void* r = allocateSlow(size);
  98     assert(isAligned(r));
  99     return r;
 100   }
 101
 102   void deallocate(void* p) {
 103     // Deallocate? Never!
 104   }
 105
 106   // Transfer ownership of all memory allocated from "other" to "this".
 107   void merge(Arena&& other);
 108
 109   // Gets the total memory used by the arena
 110   size_t totalSize() const {
 111     return totalAllocatedSize_ + sizeof(Arena);
 112   }
 113
 114   // Gets the total number of "used" bytes, i.e. bytes that the arena users
 115   // allocated via the calls to `allocate`. Doesn't include fragmentation, e.g.
 116   // if block size is 4KB and you allocate 2 objects of 3KB in size,
 117   // `bytesUsed()` will be 6KB, while `totalSize()` will be 8KB+.
 118   size_t bytesUsed() const {
 119     return bytesUsed_;
 120   }
 121
 122  private:
 123   // not copyable
 124   Arena(const Arena&) = delete;
 125   Arena& operator=(const Arena&) = delete;
 126
 127   // movable
 128   Arena(Arena&&) = default;
 129   Arena& operator=(Arena&&) = default;
 130
 131   struct Block;
 132   typedef boost::intrusive::slist_member_hook<
 133     boost::intrusive::tag<Arena>> BlockLink;
 134
 135   struct Block {
 136     BlockLink link;
 137
 138     // Allocate a block with at least size bytes of storage.
 139     // If allowSlack is true, allocate more than size bytes if convenient
 140     // (via ArenaAllocatorTraits::goodSize()) as we'll try to pack small
 141     // allocations in this block.
 142     static std::pair<Block*, size_t> allocate(
 143         Alloc& alloc, size_t size, bool allowSlack);
 144     void deallocate(Alloc& alloc);
 145
 146     char* start() {
 147       return reinterpret_cast<char*>(this + 1);
 148     }
 149
 150    private:
 151     Block() { }
 152     ~Block() { }
 153   } __attribute__((__aligned__));
 154   // This should be alignas(std::max_align_t) but neither alignas nor
 155   // max_align_t are supported by gcc 4.6.2.
 156
 157  public:
 158   static constexpr size_t kDefaultMinBlockSize = 4096 - sizeof(Block);
 159   static constexpr size_t kNoSizeLimit = 0;
 160   static constexpr size_t kDefaultMaxAlign = alignof(Block);
 161   static constexpr size_t kBlockOverhead = sizeof(Block);
 162
 163  private:
 164   bool isAligned(uintptr_t address) const {
 165     return (address & (maxAlign_ - 1)) == 0;
 166   }
 167   bool isAligned(void* p) const {
 168     return isAligned(reinterpret_cast<uintptr_t>(p));
 169   }
 170
 171   // Round up size so it's properly aligned
 172   size_t roundUp(size_t size) const {
 173     return (size + maxAlign_ - 1) & ~(maxAlign_ - 1);
 174   }
 175
 176   // cache_last<true> makes the list keep a pointer to the last element, so we
 177   // have push_back() and constant time splice_after()
 178   typedef boost::intrusive::slist<
 179     Block,
 180     boost::intrusive::member_hook<Block, BlockLink, &Block::link>,
 181     boost::intrusive::constant_time_size<false>,
 182     boost::intrusive::cache_last<true>> BlockList;
 183
 184   void* allocateSlow(size_t size);
 185
 186   // Empty member optimization: package Alloc with a non-empty member
 187   // in case Alloc is empty (as it is in the case of SysAlloc).
 188   struct AllocAndSize : public Alloc {
 189     explicit AllocAndSize(const Alloc& a, size_t s)
 190       : Alloc(a), minBlockSize(s) {
 191     }
 192
 193     size_t minBlockSize;
 194   };
 195
 196   size_t minBlockSize() const {
 197     return allocAndSize_.minBlockSize;
 198   }
 199   Alloc& alloc() { return allocAndSize_; }
 200   const Alloc& alloc() const { return allocAndSize_; }
 201
 202   AllocAndSize allocAndSize_;
 203   BlockList blocks_;
 204   char* ptr_;
 205   char* end_;
 206   size_t totalAllocatedSize_;
 207   size_t bytesUsed_;
 208   const size_t sizeLimit_;
 209   const size_t maxAlign_;
 210 };
 211
 212 template <class Alloc>
 213 struct IsArenaAllocator<Arena<Alloc>> : std::true_type { };
 214
 215 /**
 216  * By default, don't pad the given size.
 217  */
 218 template <class Alloc>
 219 struct ArenaAllocatorTraits {
 220   static size_t goodSize(const Alloc& alloc, size_t size) {
 221     return size;
 222   }
 223 };
 224
 225 template <>
 226 struct ArenaAllocatorTraits<SysAlloc> {
 227   static size_t goodSize(const SysAlloc& alloc, size_t size) {
 228     return goodMallocSize(size);
 229   }
 230 };
 231
 232 /**
 233  * Arena that uses the system allocator (malloc / free)
 234  */
 235 class SysArena : public Arena<SysAlloc> {
 236  public:
 237   explicit SysArena(size_t minBlockSize = kDefaultMinBlockSize,
 238                     size_t sizeLimit = kNoSizeLimit,
 239                     size_t maxAlign = kDefaultMaxAlign)
 240     : Arena<SysAlloc>(SysAlloc(), minBlockSize, sizeLimit, maxAlign) {
 241   }
 242 };
 243
 244 template <>
 245 struct IsArenaAllocator<SysArena> : std::true_type { };
 246
 247 }  // namespace folly
 248
 249 #include <folly/Arena-inl.h>
 250
 251 #endif /* FOLLY_ARENA_H_ */