LWPoolAreaBookKeeper Class Reference

#include <LWPoolAreaBookKeeper.h>

Collaboration diagram for LWPoolAreaBookKeeper:

Public Member Functions
unsigned	nBytesCovered () const
unsigned	acquireEntry ()
void	returnEntry (unsigned)
bool	isCompletelyFull () const
bool	isCompletelyEmpty () const
unsigned	numberOfAvailableEntries () const
unsigned	numberOfEntriesHandedOut () const

Static Public Member Functions
static unsigned	nBytesNeededForCreate (unsigned nEntries)
static LWPoolAreaBookKeeper *	create (char *, unsigned nEntries)

Private Types
typedef unsigned	BitField

Private Member Functions
	LWPoolAreaBookKeeper (unsigned nEntries)
	~LWPoolAreaBookKeeper ()
	LWPoolAreaBookKeeper (const LWPoolAreaBookKeeper &)
LWPoolAreaBookKeeper &	operator= (const LWPoolAreaBookKeeper &)
void	findNewNonEmptyField ()

Static Private Member Functions
static unsigned	nFields (unsigned nEntries)

Private Attributes
const unsigned	m_nEntries
const unsigned	m_nFields
unsigned	m_nonEmptyField
unsigned	m_nUnusedEntries

Friends
class	LWPoolArea

Detailed Description

Definition at line 30 of file LWPoolAreaBookKeeper.h.

Member Typedef Documentation

BitField

typedef unsigned LWPoolAreaBookKeeper::BitField

private

Definition at line 48 of file LWPoolAreaBookKeeper.h.

Constructor & Destructor Documentation

LWPoolAreaBookKeeper() [1/2]

LWPoolAreaBookKeeper::LWPoolAreaBookKeeper ( unsigned  nEntries )

private

Definition at line 49 of file LWPoolAreaBookKeeper.cxx.

  : //m_fields(0),
    m_nEntries(nEntries),
    m_nFields(nFields(nEntries)),
    m_nonEmptyField(0),
    m_nUnusedEntries(nEntries)
{
  assert(CHAR_BIT==8);//Likely to have bugs if CHAR_BIT!=8
  memset(LW_FIELDS,0xFF,m_nFields*sizeof(LW_FIELDS[0]));//set all bits (0xFF is 8 bits)
  const unsigned nlast(nEntries%LW_ENTRIESPERGROUP);
  if (nlast)
    LW_FIELDS[m_nFields-1] >>= (LW_ENTRIESPERGROUP-nlast);//Only set the 'nlast' least significant bits
}

~LWPoolAreaBookKeeper()

LWPoolAreaBookKeeper::~LWPoolAreaBookKeeper ( )

inlineprivate

Definition at line 59 of file LWPoolAreaBookKeeper.h.

{}

LWPoolAreaBookKeeper() [2/2]

LWPoolAreaBookKeeper::LWPoolAreaBookKeeper ( const LWPoolAreaBookKeeper &  )

private

Member Function Documentation

acquireEntry()

unsigned LWPoolAreaBookKeeper::acquireEntry

(

)

create()

LWPoolAreaBookKeeper * LWPoolAreaBookKeeper::create ( char *  c, unsigned  nEntries  )

static

Definition at line 43 of file LWPoolAreaBookKeeper.cxx.

{
  return new(c) LWPoolAreaBookKeeper(nEntries);
}

findNewNonEmptyField()

void LWPoolAreaBookKeeper::findNewNonEmptyField ( )

private

Definition at line 64 of file LWPoolAreaBookKeeper.cxx.

{
  assert(!LW_FIELDS[m_nonEmptyField]);
  //For cache-locality reasons we first look in the following
  //fields, then start from 0:
  unsigned newNonEmptyField = UINT_MAX;
  for (unsigned iField = m_nonEmptyField+1; iField<m_nFields;++iField) {
    if (LW_FIELDS[iField]) {
      newNonEmptyField = iField;
      break;
    }
  }
  if (newNonEmptyField==UINT_MAX)
    for (unsigned iField = 0; iField<m_nonEmptyField;++iField) {
      if (LW_FIELDS[iField]) {
    newNonEmptyField = iField;
    break;
      }
    }
  m_nonEmptyField = newNonEmptyField;
  assert(m_nonEmptyField==UINT_MAX||LW_FIELDS[m_nonEmptyField]);
}

isCompletelyEmpty()

bool LWPoolAreaBookKeeper::isCompletelyEmpty

(

)

const

isCompletelyFull()

bool LWPoolAreaBookKeeper::isCompletelyFull

(

)

const

nBytesCovered()

unsigned LWPoolAreaBookKeeper::nBytesCovered

(

)

const

Definition at line 37 of file LWPoolAreaBookKeeper.cxx.

{
  return nBytesNeededForCreate(m_nEntries);
}

nBytesNeededForCreate()

unsigned LWPoolAreaBookKeeper::nBytesNeededForCreate ( unsigned  nEntries )

static

Definition at line 25 of file LWPoolAreaBookKeeper.cxx.

{
  return (nFields(nEntries)*sizeof(BitField)+sizeof(LWPoolAreaBookKeeper) + 7) & ~7;
}

nFields()

unsigned LWPoolAreaBookKeeper::nFields ( unsigned  nEntries )

staticprivate

Definition at line 31 of file LWPoolAreaBookKeeper.cxx.

{
  return nEntries/LW_ENTRIESPERGROUP+(nEntries%LW_ENTRIESPERGROUP?1:0);
}

numberOfAvailableEntries()

unsigned LWPoolAreaBookKeeper::numberOfAvailableEntries

(

)

const

numberOfEntriesHandedOut()

unsigned LWPoolAreaBookKeeper::numberOfEntriesHandedOut

(

)

const

operator=()

LWPoolAreaBookKeeper& LWPoolAreaBookKeeper::operator= ( const LWPoolAreaBookKeeper &  )

private

returnEntry()

void LWPoolAreaBookKeeper::returnEntry

(

unsigned

)

Friends And Related Function Documentation

LWPoolArea

friend class LWPoolArea

friend

Definition at line 50 of file LWPoolAreaBookKeeper.h.

Member Data Documentation

m_nEntries

const unsigned LWPoolAreaBookKeeper::m_nEntries

private

Definition at line 52 of file LWPoolAreaBookKeeper.h.

m_nFields

const unsigned LWPoolAreaBookKeeper::m_nFields

private

Definition at line 53 of file LWPoolAreaBookKeeper.h.

m_nonEmptyField

unsigned LWPoolAreaBookKeeper::m_nonEmptyField

private

Definition at line 54 of file LWPoolAreaBookKeeper.h.

m_nUnusedEntries

unsigned LWPoolAreaBookKeeper::m_nUnusedEntries

private

Definition at line 55 of file LWPoolAreaBookKeeper.h.

---

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

• LWPoolAreaBookKeeper.h
• LWPoolAreaBookKeeper.cxx