SG::ArenaBase Class Reference

Part of Arena dealing with the list of allocators. More...

#include <ArenaBase.h>

Inheritance diagram for SG::ArenaBase:

Collaboration diagram for SG::ArenaBase:

Classes
struct	AllocEntry
	Our allocator vector. More...

Public Member Functions
	ArenaBase (const std::string &name="")
	Constructor.
virtual	~ArenaBase ()
	Destructor.
	ArenaBase (const ArenaBase &)=delete
ArenaBase &	operator= (const ArenaBase &)=delete
LockedAllocator	allocator (size_t i)
	Translate an integer index to an Allocator pointer.
void	reset ()
	Reset all contained allocators.
void	erase ()
	Erase all contained allocators.
void	report (std::ostream &os) const
	Generate a report of the memory in use by this Arena.
ArenaAllocatorBase::Stats	stats () const
	Return statistics summed over all allocators in this Arena.
const std::string &	name () const
	Return this Arena's name.

Private Types
typedef std::lock_guard< std::mutex >	lock_t

Private Member Functions
ArenaAllocatorBase *	makeAllocator (size_t i)
	Make a new Allocator for index i.

Private Attributes
std::vector< AllocEntry >	m_allocs
std::string	m_name
	Our name.
std::mutex	m_mutex
	To guard access to m_allocs.

Detailed Description

Part of Arena dealing with the list of allocators.

Broken out from Arena to avoid a dependency loop with ArenaHeader. See Arena.h for an overview of the arena-based memory allocators.

Definition at line 41 of file ArenaBase.h.

Member Typedef Documentation

lock_t

typedef std::lock_guard<std::mutex> SG::ArenaBase::lock_t

private

Definition at line 102 of file ArenaBase.h.

Constructor & Destructor Documentation

ArenaBase() [1/2]

SG::ArenaBase::ArenaBase

(

const std::string &

name = ""

)

Constructor.

Parameters

name	The name of this Arena; to use in reports.

Definition at line 27 of file ArenaBase.cxx.

  : m_name (name)
{
}

~ArenaBase()

SG::ArenaBase::~ArenaBase ( )

virtual

Destructor.

Definition at line 36 of file ArenaBase.cxx.

{
}

ArenaBase() [2/2]

SG::ArenaBase::ArenaBase ( const ArenaBase & )

delete

Member Function Documentation

allocator()

LockedAllocator SG::ArenaBase::allocator

(

size_t

i

)

Translate an integer index to an Allocator pointer.

Parameters

i	The index to look up.

If the index isn't valid, an assertion will be tripped.

erase()

void SG::ArenaBase::erase

(

)

Erase all contained allocators.

All elements will be freed, and the memory returned to the system.

Definition at line 60 of file ArenaBase.cxx.

{
  lock_t l (m_mutex);
  for (AllocEntry& alloc : m_allocs) {
    if (alloc.m_alloc) {
      lock_t alloc_lock (*alloc.m_mutex);
      alloc.m_alloc->erase();
    }
  }
}

makeAllocator()

ArenaAllocatorBase * SG::ArenaBase::makeAllocator ( size_t i )

private

Make a new Allocator for index i.

Parameters

i	The index of the Allocator.

The Allocator vector was empty for index i. Make an appropriate new Allocator, store it in the vector, and return it. Will trip an assertion if the index is not valid.

This should be called with m_mutex held.

Definition at line 130 of file ArenaBase.cxx.

{
  // We have to create a new Allocator.
  // Make sure there's room in the vector.
  if (m_allocs.size() <= i) {
    m_allocs.resize (i+1);
  }
 
  // Create the Allocator, using the Registry.
  std::unique_ptr<ArenaAllocatorBase> alloc =
    ArenaAllocatorRegistry::instance()->create (i);
 
  // Install it in the vector.
  m_allocs[i].m_alloc = std::move (alloc);
  m_allocs[i].m_mutex = std::make_unique<std::mutex>();
 
  return m_allocs[i].m_alloc.get();
}

name()

const std::string & SG::ArenaBase::name

(

)

const

Return this Arena's name.

Definition at line 114 of file ArenaBase.cxx.

{
  return m_name;
}

operator=()

ArenaBase & SG::ArenaBase::operator= ( const ArenaBase & )

delete

report()

void SG::ArenaBase::report

(

std::ostream &

os

)

const

Generate a report of the memory in use by this Arena.

Parameters

os	The stream to which to write the report.

Definition at line 76 of file ArenaBase.cxx.

{
  lock_t l (m_mutex);
  bool first = true;
  for (const AllocEntry& alloc : m_allocs) {
    if (alloc.m_alloc) {
      if (first) {
        ArenaAllocatorBase::Stats::header (os);
        os << std::endl;
        first = false;
      }
      lock_t alloc_lock (*alloc.m_mutex);
      alloc.m_alloc->report (os);
    }
  }
}

reset()

void SG::ArenaBase::reset

(

)

Reset all contained allocators.

All elements will be freed.

Definition at line 44 of file ArenaBase.cxx.

{
  lock_t l (m_mutex);
  for (AllocEntry& alloc : m_allocs) {
    if (alloc.m_alloc) {
      lock_t alloc_lock (*alloc.m_mutex);
      alloc.m_alloc->reset();
    }
  }
}

stats()

ArenaAllocatorBase::Stats SG::ArenaBase::stats

(

)

const

Return statistics summed over all allocators in this Arena.

Definition at line 97 of file ArenaBase.cxx.

{
  ArenaAllocatorBase::Stats stats;
  lock_t l (m_mutex);
  for (const AllocEntry& alloc : m_allocs) {
    if (alloc.m_alloc) {
      lock_t alloc_lock (*alloc.m_mutex);
      stats += alloc.m_alloc->stats();
    }
  }
  return stats;
}

Member Data Documentation

m_allocs

std::vector<AllocEntry> SG::ArenaBase::m_allocs

private

Definition at line 124 of file ArenaBase.h.

m_mutex

std::mutex SG::ArenaBase::m_mutex

mutableprivate

To guard access to m_allocs.

Definition at line 130 of file ArenaBase.h.

m_name

std::string SG::ArenaBase::m_name

private

Our name.

Definition at line 127 of file ArenaBase.h.

---

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

• ArenaBase.h
• ArenaBase.cxx