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