BaseLB Class Reference
[Charm++ Load Balancing Framework]

Base class for all LB strategies. More...

#include <BaseLB.h>

Inheritance diagram for BaseLB:

[legend]

Collaboration diagram for BaseLB:

[legend]

Public Member Functions
	BaseLB (const CkLBOptions &opt)
	BaseLB (CkMigrateMessage *m)
virtual	~BaseLB ()
void	unregister ()
const char *	lbName ()
int	step ()
virtual void	turnOff ()
virtual void	turnOn ()
virtual int	useMem ()
virtual void	pup (PUP::er &p)
virtual void	flushStates ()
CkGroupID	getGroupID ()
Protected Attributes
int	seqno
const char *	lbname
LBDatabase *	theLbdb
LDBarrierReceiver	receiver
int	notifier
int	startLbFnHdl
Private Member Functions
void	initLB (const CkLBOptions &)
Data Structures
struct	LDStats
	Passed to the virtual functions Strategy(. More...
struct	ProcStats

---

Detailed Description

Base class for all LB strategies.

BaseLB is the base class for all LB strategy class. it does some tracking about how many lb strategies are created. it also defines some common functions.

Definition at line 22 of file BaseLB.h.

---

Constructor & Destructor Documentation

BaseLB::BaseLB

(

const CkLBOptions &

opt

)

[inline]

Definition at line 143 of file BaseLB.h.

References initLB().

BaseLB::BaseLB

(

CkMigrateMessage *

m

)

[inline]

Definition at line 144 of file BaseLB.h.

---

Member Function Documentation

const char* BaseLB::lbName

(

)

[inline]

Definition at line 148 of file BaseLB.h.

References lbname.

Referenced by NborBaseLB::AtSync(), HybridBaseLB::Loadbalancing(), HybridBaseLB::ProcessAtSync(), HbmLB::ProcessAtSync(), NborBaseLB::ReceiveStats(), NborBaseLB::ResumeClients(), HybridBaseLB::ResumeClients(), and HbmLB::ResumeClients().

int BaseLB::step

(

)

[inline]

Reimplemented in WSLB.

Definition at line 149 of file BaseLB.h.

References LBDatabase::step(), and theLbdb.

Referenced by _getGlobalStepHandler(), NborBaseLB::AssembleStats(), NborBaseLB::AtSync(), HybridBaseLB::AtSync(), HbmLB::AtSync(), CentralLB::AtSync(), CentralLB::BuildStatsMsg(), CentralLB::CheckMigrationComplete(), CentralLB::endMigrationDone(), CentralLB::LoadBalance(), CentralLB::MigrationDone(), HybridBaseLB::ProcessAtSync(), HbmLB::ProcessAtSync(), CentralLB::ProcessReceiveMigration(), CentralLB::ReceiveDummyMigration(), CentralLB::ReceiveStats(), HybridBaseLB::reportLBMem(), HybridBaseLB::reportLBQulity(), HbmLB::reportLBQulity(), NborBaseLB::ResumeClients(), HybridBaseLB::ResumeClients(), HbmLB::ResumeClients(), CentralLB::SendStats(), CentralLB::simulationWrite(), and ScotchRefineLB::work().

virtual void BaseLB::turnOff

(

)

[inline, virtual]

Reimplemented in CentralLB.

Definition at line 150 of file BaseLB.h.

References CmiAbort().

virtual void BaseLB::turnOn

(

)

[inline, virtual]

Reimplemented in CentralLB.

Definition at line 151 of file BaseLB.h.

References CmiAbort().

virtual int BaseLB::useMem

(

)

[inline, virtual]

Reimplemented in CentralLB, HbmLB, and HybridBaseLB.

Definition at line 152 of file BaseLB.h.

CkGroupID BaseLB::getGroupID

(

void

)

[inline]

Definition at line 156 of file BaseLB.h.

---

Field Documentation

int BaseLB::seqno [protected]

Definition at line 25 of file BaseLB.h.

Referenced by CentralLB::CheckMigrationComplete(), initLB(), CentralLB::pup(), and pup().

const char* BaseLB::lbname [protected]

Definition at line 26 of file BaseLB.h.

Referenced by CentralLB::CheckMigrationComplete(), CommAwareRefineLB::CommAwareRefineLB(), CreateLBFunc_Def(), GreedyAgentLB::GreedyAgentLB(), GreedyLB::GreedyLB(), GridCommLB::GridCommLB(), GridCommRefineLB::GridCommRefineLB(), GridHybridLB::GridHybridLB(), GridHybridSeedLB::GridHybridSeedLB(), GridMetisLB::GridMetisLB(), HbmLB::HbmLB(), HybridBaseLB::HybridBaseLB(), CentralLB::initLB(), initLB(), lbName(), CentralLB::LoadBalance(), MetisLB::MetisLB(), NborBaseLB::NborBaseLB(), NullLB::NullLB(), OrbLB::OrbLB(), NullLB::pup(), RandCentLB::RandCentLB(), RecBipartLB::RecBipartLB(), RefineKLB::RefineKLB(), RefineLB::RefineLB(), RefineSwapLB::RefineSwapLB(), CentralLB::simulationRead(), CentralLB::Strategy(), TeamLB::TeamLB(), TempAwareGreedyLB::TempAwareGreedyLB(), WSLB::WSLB(), and ZoltanLB::ZoltanLB().

LBDatabase* BaseLB::theLbdb [protected]

Definition at line 27 of file BaseLB.h.

Referenced by WSLB::AssembleStats(), NborBaseLB::AssembleStats(), HybridBaseLB::AssembleStats(), CentralLB::BuildStatsMsg(), CentralLB::CheckMigrationComplete(), flushStates(), HbmLB::HbmLB(), HybridBaseLB::HybridBaseLB(), NullLB::init(), CentralLB::initLB(), initLB(), NborBaseLB::MigrationDone(), HybridBaseLB::MigrationDone(), HbmLB::MigrationDone(), CentralLB::MigrationDone(), NullLB::migrationsDone(), NborBaseLB::NborBaseLB(), HbmLB::ProcessAtSync(), CentralLB::ProcessAtSync(), CentralLB::ProcessReceiveMigration(), HybridBaseLB::PropagateInfo(), HybridBaseLB::ReceiveMigration(), HbmLB::ReceiveMigrationDelta(), WSLB::ReceiveStats(), NborBaseLB::ReceiveStats(), WSLB::ResumeClients(), NborBaseLB::ResumeClients(), HybridBaseLB::ResumeClients(), HbmLB::ResumeClients(), CentralLB::ResumeClients(), CentralLB::SendStats(), step(), CentralLB::turnOff(), CentralLB::turnOn(), unregister(), WSLB::WSLB(), CentralLB::~CentralLB(), HbmLB::~HbmLB(), HybridBaseLB::~HybridBaseLB(), NborBaseLB::~NborBaseLB(), NullLB::~NullLB(), and WSLB::~WSLB().

LDBarrierReceiver BaseLB::receiver [protected]

Definition at line 28 of file BaseLB.h.

int BaseLB::notifier [protected]

Definition at line 29 of file BaseLB.h.

Referenced by HbmLB::HbmLB(), HybridBaseLB::HybridBaseLB(), CentralLB::initLB(), NborBaseLB::NborBaseLB(), CentralLB::turnOff(), CentralLB::turnOn(), WSLB::WSLB(), CentralLB::~CentralLB(), HbmLB::~HbmLB(), HybridBaseLB::~HybridBaseLB(), NborBaseLB::~NborBaseLB(), and WSLB::~WSLB().

int BaseLB::startLbFnHdl [protected]

Definition at line 30 of file BaseLB.h.

Referenced by CentralLB::initLB(), CentralLB::turnOff(), and CentralLB::turnOn().

---

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

• ck-ldb/BaseLB.h
• ck-ldb/BaseLB.C