levelDB源码学习——Arena（简单内存池）

简介

　　Arena是levelDb的内存池的管理类，这个类比较简单。它负责向系统申请内存块，并将申请到的内存块放在vector<char *> blocks_ 中进行管理。blocks_的每个元素就是一个内存块的首地址。在Arena的对象离开它的作用域的时候，调用析构函数将这些块进行释放。它的申请的内存管理结构如下所示
　
　　

　　Arena默认向系统申请的内存块的大小是static const int kBlockSize = 4096。当有一个内存分配请求向Arena请求size大小的内存时，分配原则如下：
　　1. 当前块中所剩空间可以满足请求的话，直接从当前块中取出size大小的内存进行分配，并更新alloc_ptr_和alloc_bytes_remaining 的值
　　2. 当当前块不满足的时候，如果size大于kBlockSize/4的话，就重新分配一个大小为size的块，将这一块直接给请求，如果size不大于kBlockSize/4 的话，就分配一个kBlockSize大小的块，在这个块中分配内存。这样的话之前的那个块中剩余的内存就会浪费了。
　　
　　Arena还提供了分配地址对其的内存块的接口，用户调用这个接口的话，分配到的内存的首地址是8的倍数。Arena 的这个分配地址对齐的内存块的接口，其返回的内存块的起始地址是 8 的整数倍。也就是说，返回的地址是这两种形式："0x_______0" 和 "0x_______8"。要是在分配内存的时候发现当前的地址并不是这种形式，那就多分配点内存用来填补不够的 Byte，最多可能浪费 7 个 Byte。
　　

//文件Arena.h

class Arena {
 public:
  Arena();
  ~Arena();

  // Return a pointer to a newly allocated memory block of "bytes" bytes.
  char* Allocate(size_t bytes);

  // Allocate memory with the normal alignment(对齐) guarantees provided by malloc
  char* AllocateAligned(size_t bytes);

  // Returns an estimate of the total memory usage of data allocated
  // by the arena (including space allocated but not yet used for user
  // allocations).
  size_t MemoryUsage() const {
    return blocks_memory_ + blocks_.capacity() * sizeof(char*);
  }

 private:
  char* AllocateFallback(size_t bytes);
  char* AllocateNewBlock(size_t block_bytes);

  // Allocation state
  char* alloc_ptr_;
  size_t alloc_bytes_remaining_;

  // Array of new[] allocated memory blocks
  std::vector<char*> blocks_;

  // blocks中至今已经分配到的内存大小
  // Bytes of memory in blocks allocated so far(至今)
  size_t blocks_memory_;

  // No copying allowed
  Arena(const Arena&);
  void operator=(const Arena&);
};

// Allocate是从已经malloc的空间[alloc_ptr_ ...]中分配一个bytes大小的空间
inline char* Arena::Allocate(size_t bytes) {
  // 不允许分配大小为0的字节
  // The semantics of what to return are a bit messy if we allow
  // 0-byte allocations, so we disallow them here (we don't need
  // them for our internal use).
  assert(bytes > 0);
  if (bytes <= alloc_bytes_remaining_) {
    char* result = alloc_ptr_;
    alloc_ptr_ += bytes;
    alloc_bytes_remaining_ -= bytes;
    return result;
  }
  // 当前内存池中内存不够分配，利用AllocateFallback分配
  // 那这样的话，AllocateFallback之前的那一块中的剩余空间就被浪费了？？
  return AllocateFallback(bytes);
}

//文件Arena.cc

static const int kBlockSize = 4096;

Arena::Arena() {
  blocks_memory_ = 0;
  alloc_ptr_ = NULL;  // First allocation will allocate a block
  alloc_bytes_remaining_ = 0;
}

Arena::~Arena() {
  // Arena将分配到内存块放在vector<char *>blocks_中管理，blocks_[i]保存第i个内存块的首地址
  for (size_t i = 0; i < blocks_.size(); i++) {
    delete[] blocks_[i];
  }
}

char* Arena::AllocateFallback(size_t bytes) {
  if (bytes > kBlockSize / 4) {
    // Object is more than a quarter of our block size.  Allocate it separately
    // to avoid wasting too much space in leftover bytes.
    // bytes > kBlockSize / 4 的时候，就直接向系统申请一个bytes大小的块，这样可以减少内存的waste
    // 这样分配之后，alloc_ptr_和alloc_bytes_remaining_还是之前那块的信息
    char* result = AllocateNewBlock(bytes);
    return result;
  }

  // We waste the remaining space in the current block.
  alloc_ptr_ = AllocateNewBlock(kBlockSize);
  alloc_bytes_remaining_ = kBlockSize;

  char* result = alloc_ptr_;
  alloc_ptr_ += bytes;
  alloc_bytes_remaining_ -= bytes;
  return result;
}

// 按照对齐方式要么在blocks_中分配内存，要么重新new一个块
// 对齐分配的函数看的不是很懂，下来再研究研究
char* Arena::AllocateAligned(size_t bytes) {
  const int align = (sizeof(void*) > 8) ? sizeof(void*) : 8;
  assert((align & (align-1)) == 0);   // Pointer size should be a power of 2
  size_t current_mod = reinterpret_cast<uintptr_t>(alloc_ptr_) & (align-1);
  size_t slop = (current_mod == 0 ? 0 : align - current_mod);
  size_t needed = bytes + slop;
  char* result;
  if (needed <= alloc_bytes_remaining_) {
    result = alloc_ptr_ + slop;
    alloc_ptr_ += needed;
    alloc_bytes_remaining_ -= needed;
  } else {
    // AllocateFallback always returned aligned memory
    result = AllocateFallback(bytes);
  }
  assert((reinterpret_cast<uintptr_t>(result) & (align-1)) == 0);
  return result;
}

// 向系统申请一个指定大小的block，并将这个block放入vector<char *> blocks_中
char* Arena::AllocateNewBlock(size_t block_bytes) {
  char* result = new char[block_bytes];
  blocks_memory_ += block_bytes;
  blocks_.push_back(result);
  return result;
}