PMemArena Class Reference

#include <PMemAllocator.h>

Inheritance diagram for PMemArena:

Collaboration diagram for PMemArena:

Public Member Functions
	PMemArena (size_t min_block_size=1ULL<< 32, size_t size_limit=0)
	~PMemArena () override
void *	allocate (const size_t num_bytes) override
void *	allocateAndZero (const size_t num_bytes) override
size_t	bytesUsed () const override
size_t	totalBytes () const override
MemoryType	getMemoryType () const override
Public Member Functions inherited from Arena
virtual	~Arena ()

Private Attributes
size_t	size_limit_
size_t	size_
std::vector< std::pair< void *, size_t > >	allocations_
struct memkind *	pmem_kind_ = NULL

Additional Inherited Members
Public Types inherited from Arena
enum	MemoryType { MemoryType::DRAM, MemoryType::PMEM }

Detailed Description

Definition at line 24 of file PMemAllocator.h.

Constructor & Destructor Documentation

PMemArena::PMemArena ( size_t  min_block_size = 1ULL << 32, size_t  size_limit = 0  )

explicit

Definition at line 25 of file PMemAllocator.cpp.

References CHECK, CHECK_EQ, CHECK_GE, report::error_code(), g_pmem_path, g_pmem_size, logger::INFO, LOG, and pmem_kind_.

    : size_limit_(size_limit), size_(0) {
  std::error_code ec;
  auto pmem_space_info = std::filesystem::space(g_pmem_path.c_str(), ec);
  CHECK(!ec) << "Failed to get pmem space info for path: " << g_pmem_path
             << "error code: " << ec << "\n";
  size_t capacity = pmem_space_info.capacity;
  CHECK_EQ(memkind_check_dax_path(g_pmem_path.c_str()), 0)
      << g_pmem_path << " is not recognized as a direct-access pmem path.";
  CHECK_GE(capacity, g_pmem_size)
      << g_pmem_path << " is not large enough for the requested PMem space";
  CHECK_EQ(memkind_create_pmem(g_pmem_path.c_str(), capacity, &pmem_kind_), 0)
      << "Failed to create PMEM memory.";
  LOG(INFO) << "Created Pmem direct-access allocator at " << g_pmem_path
            << " with capacity " << capacity << "\n";
}

Here is the call graph for this function:

PMemArena::~PMemArena ( )

override

Definition at line 42 of file PMemAllocator.cpp.

References allocations_, and pmem_kind_.

                      {
  for (auto [ptr, size] : allocations_) {
    memkind_free(pmem_kind_, ptr);
  }
}

Member Function Documentation

void * PMemArena::allocate ( const size_t  num_bytes )

overridevirtual

Implements Arena.

Definition at line 48 of file PMemAllocator.cpp.

References allocations_, pmem_kind_, size_, and size_limit_.

Referenced by allocateAndZero().

                                                {
  if (size_limit_ != 0 && size_ + num_bytes > size_limit_) {
    throw OutOfHostMemory(num_bytes);
  }
  auto ret = memkind_malloc(pmem_kind_, num_bytes);
  size_ += num_bytes;
  allocations_.push_back({ret, num_bytes});
  return ret;
}

Here is the caller graph for this function:

void * PMemArena::allocateAndZero ( const size_t  num_bytes )

overridevirtual

Implements Arena.

Definition at line 58 of file PMemAllocator.cpp.

References allocate().

                                                       {
  auto ret = allocate(num_bytes);
  std::memset(ret, 0, num_bytes);
  return ret;
}

Here is the call graph for this function:

size_t PMemArena::bytesUsed ( ) const

overridevirtual

Implements Arena.

Definition at line 64 of file PMemAllocator.cpp.

References size_.

                                  {
  return size_;
}

MemoryType PMemArena::getMemoryType ( ) const

inlineoverridevirtual

Implements Arena.

Definition at line 38 of file PMemAllocator.h.

References Arena::PMEM.

{ return MemoryType::PMEM; }

size_t PMemArena::totalBytes ( ) const

overridevirtual

Implements Arena.

Definition at line 68 of file PMemAllocator.cpp.

                                   {
  return 0;
}

Member Data Documentation

std::vector<std::pair<void*, size_t> > PMemArena::allocations_

private

Definition at line 43 of file PMemAllocator.h.

Referenced by allocate(), and ~PMemArena().

struct memkind* PMemArena::pmem_kind_ = NULL

private

Definition at line 44 of file PMemAllocator.h.

Referenced by allocate(), PMemArena(), and ~PMemArena().

size_t PMemArena::size_

private

Definition at line 42 of file PMemAllocator.h.

Referenced by allocate(), and bytesUsed().

size_t PMemArena::size_limit_

private

Definition at line 41 of file PMemAllocator.h.

Referenced by allocate().

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/workspace/core-os-doxygen/DataMgr/Allocators/PMemAllocator.h
• /home/jenkins-slave/workspace/core-os-doxygen/DataMgr/Allocators/PMemAllocator.cpp