leveldb源码学习之内存池Arena

Arena：Leveldb的简单的内存池，它所作的工作十分简单，申请内存时，将申请到的内存块放入std::vector blocks_中，在Arena的生命周期结束后，统一释放掉所有申请到的内存，内部结构如图所示。

Arena主要提供了两个申请函数：其中一个直接分配内存，另一个可以申请对齐的内存空间。Arena没有直接调用delete/free函数，而是由Arena的析构函数统一释放所有的内存。

util/arena.h

#ifndef STORAGE_LEVELDB_UTIL_ARENA_H_
#define STORAGE_LEVELDB_UTIL_ARENA_H_

#include <atomic>
#include <cassert>
#include <cstddef>
#include <cstdint>
#include <vector>

namespace leveldb {

class Arena {
 public:
  Arena();

  Arena(const Arena&) = delete; // 禁用拷贝构造
  Arena& operator=(const Arena&) = delete; // 禁用赋值

  ~Arena();

  // //返回指向新分配内存块的指针.
  char* Allocate(size_t bytes);

  // 分配由malloc保证对齐的内存
  char* AllocateAligned(size_t bytes);

  // 返回内存使用量的估计..
  size_t MemoryUsage() const {
    return memory_usage_.load(std::memory_order_relaxed);
  }

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

  // Allocation state
  char* alloc_ptr_; // 记录下次分配的起始点
  size_t alloc_bytes_remaining_;// 剩余的空闲内存空间字节数

  // 已分配的内存块数组
  std::vector<char*> blocks_;

  // 总内存使用量.
  std::atomic<size_t> memory_usage_;
};

inline char* Arena::Allocate(size_t bytes) {
  assert(bytes > 0);// 必须大于0字节
  if (bytes <= alloc_bytes_remaining_) {// 所需空间小于剩余空间，可分配
    char* result = alloc_ptr_;// 剩余空间起始地址
    alloc_ptr_ += bytes;
    alloc_bytes_remaining_ -= bytes;
    return result;
  }
  return AllocateFallback(bytes);// 大于剩余空间，另外分配
}

}  // namespace leveldb

#endif  // STORAGE_LEVELDB_UTIL_ARENA_H_
           

util / arena.cc

#include "util/arena.h"

namespace leveldb {

static const int kBlockSize = 4096;  // 默认块大小 4KB

Arena::Arena()
    : alloc_ptr_(nullptr), alloc_bytes_remaining_(0), memory_usage_(0) {}

Arena::~Arena() {
  for (size_t i = 0; i < blocks_.size(); i++) {
    delete[] blocks_[i];
  }
}

// 重新分配一块对齐空间
char* Arena::AllocateFallback(size_t bytes) {
  if (bytes > kBlockSize / 4) {
    // 分配对象大于 block size 四分之一. 单独对齐分配以避免浪费空间
    char* result = AllocateNewBlock(bytes);
    return result;
  }

  // 重新分配一块block，原有block 剩余空间不用了.
  alloc_ptr_ = AllocateNewBlock(kBlockSize);
  alloc_bytes_remaining_ = kBlockSize;

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

// 分配内存对齐的空间
char* Arena::AllocateAligned(size_t bytes) {
  const int align = (sizeof(void*) > 8) ? sizeof(void*) : 8; // 对齐内存地址的大小
  static_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 { 
    // 重新分配一块对齐空间
    result = AllocateFallback(bytes);
  }
  assert((reinterpret_cast<uintptr_t>(result) & (align - 1)) == 0);
  return result;
}

// 直接new分配空间
char* Arena::AllocateNewBlock(size_t block_bytes) {
  char* result = new char[block_bytes];
  blocks_.push_back(result); // 用数组保存新的block起始地址
  memory_usage_.fetch_add(block_bytes + sizeof(char*),
                          std::memory_order_relaxed); // 记录使用内存数量，这里是分配的空间加上一个起始地址的变量 blocks_[]？
  return result;
}

}  // namespace leveldb