SG::ArenaHeader Class Reference

Proxy for a group of Arenas. More...

#include <ArenaHeader.h>

Collaboration diagram for SG::ArenaHeader:

Public Member Functions
	ArenaHeader ()
	Constructor. More...
	~ArenaHeader ()
	Destructor. More...
LockedAllocator	allocator (size_t i)
	Translate an integer index to an Allocator pointer. More...
LockedAllocator	allocator (const EventContext &ctx, size_t i)
	Translate an integer index to an Allocator pointer. More...
ArenaBase *	setArena (ArenaBase *arena)
	Set the current Arena for the current thread. More...
void	addArena (ArenaBase *a)
	Add a new Arena to the group. More...
void	setArenaForSlot (int slot, ArenaBase *a)
	Record the arena associated with an event slot. More...
void	delArena (ArenaBase *a)
	Remove an Arena from the group. More...
void	report (std::ostream &os) const
	Generate a report of all Arenas in the group. More...
std::string	reportStr () const
	Generate a report of all Arenas in the group, and return the result as a string. More...
void	reset ()
	Call reset on all Allocators in the current Arena. More...

Static Public Member Functions
static ArenaHeader *	defaultHeader ()
	Return the global default Header instance. More...

Private Attributes
boost::thread_specific_ptr< ArenaBase >	m_arena
	Current Arena. More...
ArenaBase	m_defaultArena
	The default Arena. More...
std::vector< ArenaBase * >	m_arenas
	List of all Arenas in our group. More...
std::vector< ArenaBase * >	m_slots
	Arenas indexed by event slot. More...
std::mutex	m_mutex
	Mutex to protect access to m_defaultArena, m_arenas, and m_slots. More...

Detailed Description

Proxy for a group of Arenas.

See Arena.h for an overview of the arena-based memory allocators.

A Header collects a group of Arenas. One of these is the current Arena, in which memory operations will take place. We can also generate a report of memory usage from all the Arenas in the group.

We keep a thread-specific pointer to the current Arena, which is used to handle the mapping from indices to Allocator instances.

Definition at line 53 of file ArenaHeader.h.

Constructor & Destructor Documentation

ArenaHeader()

SG::ArenaHeader::ArenaHeader

(

)

Constructor.

Definition at line 34 of file ArenaHeader.cxx.

  : m_arena (null_arena_deleter)
{
}

~ArenaHeader()

SG::ArenaHeader::~ArenaHeader

(

)

Destructor.

This will clean up any memory allocated in the default Arena.

Definition at line 47 of file ArenaHeader.cxx.

{
  // We don't own this.
  m_arena.release();
}

Member Function Documentation

addArena()

void SG::ArenaHeader::addArena

(

ArenaBase *

a

)

Add a new Arena to the group.

Parameters

a	The Arena to add.

Definition at line 72 of file ArenaHeader.cxx.

{
  std::lock_guard<std::mutex> lock (m_mutex);
  m_arenas.push_back (a);
}

allocator() [1/2]

LockedAllocator SG::ArenaHeader::allocator	(	const EventContext &	ctx,
		size_t	i
	)

Translate an integer index to an Allocator pointer.

Parameters

ctx	Use the Arena associated with this event context.
i	The index to look up.

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

allocator() [2/2]

LockedAllocator SG::ArenaHeader::allocator

(

size_t

i

)

Translate an integer index to an Allocator pointer.

Parameters

i	The index to look up.

The default Arena will be used.

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

defaultHeader()

ArenaHeader * SG::ArenaHeader::defaultHeader ( )

static

Return the global default Header instance.

Definition at line 164 of file ArenaHeader.cxx.

{
  static ArenaHeader head ATLAS_THREAD_SAFE;
  return &head;
}

delArena()

void SG::ArenaHeader::delArena

(

ArenaBase *

a

)

Remove an Arena from the group.

Parameters

a	The Arena to remove.

Will trip an assertion if the Arena is not in the group.

Definition at line 101 of file ArenaHeader.cxx.

{
  std::lock_guard<std::mutex> lock (m_mutex);
  std::vector<ArenaBase*>::iterator it =
    std::find (m_arenas.begin(), m_arenas.end(), a);
  assert (it != m_arenas.end());
  m_arenas.erase (it);
}

report()

void SG::ArenaHeader::report

(

std::ostream &

os

)

const

Generate a report of all Arenas in the group.

Parameters

os	Stream to which to send a report.

Definition at line 115 of file ArenaHeader.cxx.

{
  std::lock_guard<std::mutex> lock (m_mutex);
  // All Allocators in the group.
  for (ArenaBase* arena : m_arenas) {
    os << "=== " << arena->name() << " ===" << std::endl;
    arena->report (os);
  }
 
  // The default Arena.
  os << "=== default ===" << std::endl;
  m_defaultArena.report (os);
}

reportStr()

std::string SG::ArenaHeader::reportStr

(

)

const

Generate a report of all Arenas in the group, and return the result as a string.

We have this in addition to report() in order to make it easier to call from scripting languages.

Definition at line 137 of file ArenaHeader.cxx.

{
  std::ostringstream s;
  report (s);
  return s.str();
}

reset()

void SG::ArenaHeader::reset

(

)

Call reset on all Allocators in the current Arena.

All elements allocated are returned to the free state. clear should be called on them if it was provided. The elements may continue to be cached internally, without returning to the system.

Definition at line 153 of file ArenaHeader.cxx.

{
  if (m_arena.get()) {
    m_arena->reset();
  }
}

setArena()

ArenaBase * SG::ArenaHeader::setArena

(

ArenaBase *

arena

)

Set the current Arena for the current thread.

Parameters

arena

New current Arena.

Returns

The previous Arena.

Definition at line 59 of file ArenaHeader.cxx.

{
  ArenaBase* ret = m_arena.get();
  m_arena.release();
  m_arena.reset (arena);
  return ret;
}

setArenaForSlot()

void SG::ArenaHeader::setArenaForSlot	(	int	slot,
		ArenaBase *	a
	)

Record the arena associated with an event slot.

Parameters

slot	The slot number.
a	The Arena instance.

Definition at line 84 of file ArenaHeader.cxx.

{
  if (slot < 0) return;
  std::lock_guard<std::mutex> lock (m_mutex);
  if (slot >= static_cast<int> (m_slots.size())) {
    m_slots.resize (slot+1);
  }
  m_slots[slot] = a;
}

Member Data Documentation

m_arena

boost::thread_specific_ptr<ArenaBase> SG::ArenaHeader::m_arena

private

Current Arena.

Definition at line 159 of file ArenaHeader.h.

m_arenas

std::vector<ArenaBase*> SG::ArenaHeader::m_arenas

private

List of all Arenas in our group.

Definition at line 165 of file ArenaHeader.h.

m_defaultArena

ArenaBase SG::ArenaHeader::m_defaultArena

private

The default Arena.

Definition at line 162 of file ArenaHeader.h.

m_mutex

std::mutex SG::ArenaHeader::m_mutex

mutableprivate

Mutex to protect access to m_defaultArena, m_arenas, and m_slots.

Definition at line 171 of file ArenaHeader.h.

m_slots

std::vector<ArenaBase*> SG::ArenaHeader::m_slots

private

Arenas indexed by event slot.

Definition at line 168 of file ArenaHeader.h.

---

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

• ArenaHeader.h
• ArenaHeader.cxx