sim Class Reference

Poser wrapper base class. More...

#include <sim.h>

Inheritance diagram for sim:

Collaboration diagram for sim:


Public Member Functions
	sim (void)
	Basic Constructor.
	sim (CkMigrateMessage *)
virtual	~sim ()
	Destructor.
void	pup (PUP::er &p)
	Pack/unpack/sizing operator.
void	Step ()
	Start a forward execution step on myStrat.
void	Step (prioMsg *m)
	Start a prioritized forward execution step on myStrat.
void	CheckpointStep (eventMsg *m)
	Start a forward execution step on myStrat after a checkpoint (sequential mode only).
void	Status ()
	Report safe time to PVT branch.
void	Commit ()
	Commit events based on new GVT estimate.
void	CheckpointCommit ()
	Commit all possible events before a checkpoint to disk.
void	Cancel (cancelMsg *m)
	Add m to cancellation list.
void	ReportLBdata ()
	Report load information to local load balancer.
void	Migrate (destMsg *m)
	Migrate this poser to processor indicated in m.
void	Terminate ()
	Terminate this poser, when everyone is terminated we exit.
void	SeqBeginCheckpoint ()
	In sequential mode, begin checkpoint after reaching quiescence.
void	SeqResumeAfterCheckpoint ()
	In sequential mode, resume after checkpointing or restarting.
void	invokeStopEvent ()
	Implement this for posers that will need to execute events when POSE reaches quiescence.
void	setSimulationStartGVT (POSE_TimeType startGVT)
	Set simulationStartGVT in the rep.
int	PVTindex ()
	Return this poser's unique index on PVT branch.
int	IsActive ()
	Test active flag.
void	Activate ()
	Set active flag.
void	Deactivate ()
	Unset active flag.
virtual void	ResolveFn (int fnIdx, void *msg)
	Invoke an event on this poser according to fnIdx and pass it msg.
virtual void	ResolveCommitFn (int fnIdx, void *msg)
	Invoke the commit version of an event to handle special behaviors.
void	registerSent (POSE_TimeType timestamp)
	Notify the PVT of a message send.
void	CommitPrintf (const char *Fmt,...)
	Used for buffered output.
void	CommitError (const char *Fmt,...)
	Used for buffered output of error messages.
void	ResumeFromSync (void)
void	dump ()
	Dump all data fields.
Data Fields
eventQueue *	eq
	This poser's event queue.
strat *	myStrat
	This poser's synchronization strategy.
rep *	objID
	This poser's user representation.
CancelList	cancels
	List of incoming cancellations for this poser.
PVT *	localPVT
	The local PVT to report to.
int	myPVTidx
	Unique global ID for this object on PVT branch.
int	myLBidx
	Unique global ID for this object in load balancing data structures.
int	DOs
	Number of forward execution steps.
int	UNDOs
	Number of undone events.
int	sync
	Synchronization strategy type (optimistic or conservative).
int *	srVector
	Number of sends/recvs per PE.
POSE_TimeType	lastGVT
	Most recent GVT estimate.
double	st
	Relative start time, end time, and current time.
double	et
double	ct
localStat *	localStats
	The local statistics collector.
POSE_TimeType	dop_override_evt
	Used to manually override the value of evt for DOP calculations.
long long	basicStats [2]
	Used to count the number of commits (in [0]) and rollbacks (in [1]).
LBgroup *	localLBG
	The local load balancer.
Protected Attributes
int	active
	Flag to indicate that a Step message is scheduled.
Private Member Functions
void	InternalCommitPrintf (const char *Fmt, va_list ap)
	Used by buffered print functions.

Detailed Description

Poser wrapper base class.

The poser base class: all user posers are translated to classes that inherit from this class, and act as wrappers around the actual user object's representation to control the simulation behavior. These objects are plugged into the POSE_objects array which is of this type.

Definition at line 191 of file sim.h.

Constructor & Destructor Documentation

sim::sim ( void )

Basic Constructor.

Definition at line 13 of file sim.C.

References active, basicStats, CkLocalBranch(), Converse::CkMyPe(), Converse::CkNumPes(), DOs, eq, int, lastGVT, POSE_Config::lb_on, localLBG, localPVT, localStats, malloc(), myStrat, objID, pose_config, srVector, POSE_Config::stats, TheLBG, theLocalStats, ThePVT, and UNDOs.

Here is the call graph for this function:

sim::sim ( CkMigrateMessage * ) [inline]

Definition at line 250 of file sim.h.

sim::~sim ( ) [virtual]

Destructor.

Definition at line 38 of file sim.C.

References active, eq, POSE_Config::lb_on, localLBG, localPVT, myLBidx, myPVTidx, myStrat, objID, LBgroup::objRemove(), PVT::objRemove(), and pose_config.

Here is the call graph for this function:

Member Function Documentation

void sim::pup ( PUP::er & p )

Pack/unpack/sizing operator.

Definition at line 53 of file sim.C.

References active, basicStats, cancels, CkLocalBranch(), DOs, eq, PVT::getGVT(), PUP::er::isUnpacking(), POSE_Config::lb_on, localLBG, localPVT, localStats, myLBidx, myPVTidx, LBgroup::objRegister(), PVT::objRegister(), p, pose_config, POSE_Skipped_Events, poseIndexOfStopEvent, CancelList::pup(), eventQueue::pup(), PUP::PUParray(), seqCheckpointInProgress, seqLastCheckpointGVT, seqLastCheckpointTime, seqStartTime, sync, TheLBG, theLocalStats, ThePVT, and UNDOs.

Here is the call graph for this function:

void sim::Step ( )

Start a forward execution step on myStrat.

Definition at line 95 of file sim.C.

References active, CmiWallTimer(), localStats, myStrat, pose_config, POSE_Config::stats, strat::Step(), strat::STRAT_T, localStat::SwitchTimer(), localStat::TimerRunning(), localStat::TimerStart(), localStat::TimerStop(), POSE_Config::trace, and traceUserBracketEvent().

Referenced by Commit().

Here is the call graph for this function:

Here is the caller graph for this function:

void sim::Step ( prioMsg * m )

Start a prioritized forward execution step on myStrat.

Definition at line 143 of file sim.C.

References active, CkFreeMsg(), localStats, myStrat, pose_config, POSE_Config::stats, strat::Step(), localStat::SwitchTimer(), localStat::TimerRunning(), localStat::TimerStart(), and localStat::TimerStop().

Here is the call graph for this function:

void sim::CheckpointStep ( eventMsg * m )

Start a forward execution step on myStrat after a checkpoint (sequential mode only).

Definition at line 171 of file sim.C.

References active, CkFreeMsg(), localStats, myStrat, pose_config, POSE_Config::stats, strat::Step(), strat::STRAT_T, localStat::SwitchTimer(), localStat::TimerRunning(), localStat::TimerStart(), and localStat::TimerStop().

Here is the call graph for this function:

void sim::Status ( ) [inline]

Report safe time to PVT branch.

Definition at line 262 of file sim.h.

References localPVT, myPVTidx, myStrat, objID, PVT::objUpdateOVT(), rep::OVT(), and strat::SafeTime().

Referenced by spec::Step(), opt3::Step(), opt2::Step(), opt::Step(), adapt5::Step(), adapt4::Step(), adapt3::Step(), adapt2::Step(), and adapt::Step().

Here is the call graph for this function:

Here is the caller graph for this function:

void sim::Commit ( )

Commit events based on new GVT estimate.

Definition at line 198 of file sim.C.

References active, CmiWallTimer(), eventQueue::CommitEvents(), eventQueue::currentPtr, PVT::done(), eq, PVT::getGVT(), lastGVT, localPVT, localStats, pose_config, POSE_endtime, POSE_Config::stats, Step(), localStat::SwitchTimer(), Terminate(), localStat::TimerRunning(), localStat::TimerStart(), localStat::TimerStop(), Event::timestamp, POSE_Config::trace, and traceUserBracketEvent().

Here is the call graph for this function:

void sim::CheckpointCommit ( )

Commit all possible events before a checkpoint to disk.

Definition at line 252 of file sim.C.

References active, CmiWallTimer(), eventQueue::CommitEvents(), eq, PVT::getGVT(), lastGVT, localPVT, localStats, pose_config, POSE_Config::stats, localStat::SwitchTimer(), localStat::TimerRunning(), localStat::TimerStart(), localStat::TimerStop(), POSE_Config::trace, and traceUserBracketEvent().

Here is the call graph for this function:

void sim::Cancel ( cancelMsg * m )

Add m to cancellation list.

Definition at line 310 of file sim.C.

References cancels, CkFreeMsg(), CmiWallTimer(), cancelMsg::evID, CancelList::Insert(), localPVT, localStats, myStrat, PVT::objUpdate(), pose_config, POSE_Config::stats, strat::Step(), localStat::SwitchTimer(), localStat::TimerStart(), localStat::TimerStop(), cancelMsg::timestamp, POSE_Config::trace, and traceUserBracketEvent().

Here is the call graph for this function:

void sim::ReportLBdata ( )

Report load information to local load balancer.

Definition at line 289 of file sim.C.

References Converse::CkNumPes(), eventQueue::currentPtr, DOs, eq, POSE_Config::lb_on, localLBG, myLBidx, Event::next, objID, LBgroup::objUpdate(), rep::ovt, pose_config, POSE_UnsetTS, srVector, Event::timestamp, and UNDOs.

Here is the call graph for this function:

void sim::Migrate ( destMsg * m ) [inline]

Migrate this poser to processor indicated in m.

Definition at line 274 of file sim.h.

References destMsg::destPE.

void sim::Terminate ( ) [inline]

Terminate this poser, when everyone is terminated we exit.

Definition at line 276 of file sim.h.

References basicStats, objID, POSE_prepExit(), CkReduction::sum_int, and rep::terminus().

Referenced by Commit().

Here is the call graph for this function:

Here is the caller graph for this function:

void sim::SeqBeginCheckpoint ( )

In sequential mode, begin checkpoint after reaching quiescence.

Definition at line 368 of file sim.C.

References cb, CkStartCheckpoint(), CmiWallTimer(), seqCheckpointInProgress, seqLastCheckpointGVT, and seqStartTime.

Here is the call graph for this function:

void sim::SeqResumeAfterCheckpoint ( )

In sequential mode, resume after checkpointing or restarting.

Definition at line 380 of file sim.C.

References CkStartQD(), CmiWallTimer(), ct, eventQueue::currentPtr, POSE_Config::dop, eq, localStats, objID, rep::ovt, pose_config, POSE_GlobalClock, POSE_Skipped_Events, rep::registerTimestamp(), eventMsg::rst, eventMsg::sanitize(), seqCheckpointInProgress, seqLastCheckpointGVT, seqStartTime, Skipped_Event::simIndex, Event::srt, st, POSE_Config::stats, localStat::SwitchTimer(), and Skipped_Event::timestamp.

Here is the call graph for this function:

void sim::invokeStopEvent ( ) [inline]

Implement this for posers that will need to execute events when POSE reaches quiescence.

Definition at line 290 of file sim.h.

void sim::setSimulationStartGVT ( POSE_TimeType startGVT ) [inline]

Set simulationStartGVT in the rep.

Definition at line 292 of file sim.h.

References objID, and rep::setSimulationStartGVT().

Here is the call graph for this function:

int sim::PVTindex ( ) [inline]

Return this poser's unique index on PVT branch.

Definition at line 296 of file sim.h.

References myPVTidx.

int sim::IsActive ( ) [inline]

Test active flag.

Definition at line 298 of file sim.h.

References active.

Referenced by pvtObjectNode::sanitize().

Here is the caller graph for this function:

void sim::Activate ( ) [inline]

Set active flag.

Definition at line 300 of file sim.h.

References active.

Referenced by strat::Step().

Here is the caller graph for this function:

void sim::Deactivate ( ) [inline]

Unset active flag.

Definition at line 302 of file sim.h.

References active.

Referenced by strat::Step().

Here is the caller graph for this function:

virtual void sim::ResolveFn	(	int	fnIdx,
		void *	msg
	)			`[inline, virtual]`

Invoke an event on this poser according to fnIdx and pass it msg.

ResolveFn is generated along with the rest of the wrapper object and should handle all possible events on a poser.

Definition at line 306 of file sim.h.

Referenced by opt::Rollback(), strat::Step(), spec::Step(), seq::Step(), opt3::Step(), opt2::Step(), opt::Step(), con::Step(), adapt5::Step(), adapt4::Step(), adapt3::Step(), adapt2::Step(), and adapt::Step().

Here is the caller graph for this function:

virtual void sim::ResolveCommitFn	(	int	fnIdx,
		void *	msg
	)			`[inline, virtual]`

Invoke the commit version of an event to handle special behaviors.

This invokes the <fn>_commit method that user provides. It can be used to perform special activities, statistics gathering, output, or whatever the user wishes.

Definition at line 311 of file sim.h.

Referenced by eventQueue::CommitEvents().

Here is the caller graph for this function: