SST::Exit Class Reference

Exit Event Action. More...

#include <exit.h>

Inheritance diagram for SST::Exit:

Public Member Functions
	Exit (int num_threads, bool single_rank)
	Create a new ExitEvent.
bool	refInc (ComponentId_t, uint32_t thread)
	Increment Reference Count for a given Component ID.
bool	refDec (ComponentId_t, uint32_t thread)
	Decrement Reference Count for a given Component ID.
unsigned int	getRefCount ()
SimTime_t	getEndTime ()
	Gets the end time of the simulation.
void	setEndTime (SimTime_t time)
	Stores the time the simulation has ended.
SimTime_t	computeEndTime ()
	Computes the end time of the simulation.
void	execute () override
	Function which will be called when the time for this Activity comes to pass.
void	check ()
void	print (const std::string &header, Output &out) const override
unsigned int	getGlobalCount ()
void	serialize_order (SST::Core::Serialization::serializer &ser) override
	TODO to enable different partitioning on restart, will need to associate m_thread_counts and m_idSet back to components so that a new Exit event can be generated on restart.
ImplementSerializable(SST::Exit) private	Exit (const Exit &)=delete
Exit &	operator= (const Exit &)=delete
Public Member Functions inherited from SST::Action
bool	isAction () override final
Public Member Functions inherited from SST::Activity
void	setDeliveryTime (SimTime_t time)
	Set the time for which this Activity should be delivered.
SimTime_t	getDeliveryTime () const
	Return the time at which this Activity will be delivered.
int	getPriority () const
	Return the Priority of this Activity.
void	setOrderTag (uint32_t tag)
	Sets the order tag.
uint32_t	getOrderTag () const
	Return the order tag associated with this activity.
uint64_t	getQueueOrder () const
	Returns the queue order associated with this activity.
virtual bool	isEvent ()
std::string	toString () const override
	Get a string represenation of the event.
void	setQueueOrder (uint64_t order)
	Set a new Queue order.
virtual void	copyAllDeliveryInfo (const Activity *act)
Public Member Functions inherited from SST::Core::MemPoolItem
void *	operator new (std::size_t size) noexcept
	Allocates memory from a memory pool for a new Activity.
void	operator delete (void *ptr)
	Returns memory for this Activity to the appropriate memory pool.
Public Member Functions inherited from SST::Core::Serialization::serializable_base
virtual const char *	cls_name () const =0
virtual uint32_t	cls_id () const =0
virtual std::string	serialization_name () const =0

Data Fields
int	num_threads
unsigned int	m_refCount
unsigned int *	m_thread_counts
unsigned int	global_count
std::unordered_set< ComponentId_t >	m_idSet
SimTime_t	end_time
Core::ThreadSafe::Spinlock	slock
bool	single_rank

Additional Inherited Members
Static Public Attributes inherited from SST::Core::Serialization::serializable
static constexpr uint32_t	NullClsId = std::numeric_limits<uint32_t>::max()
Static Public Attributes inherited from SST::Core::Serialization::serializable_base
static constexpr uint32_t	NullClsId = std::numeric_limits<uint32_t>::max()
Protected Types inherited from SST::Core::Serialization::serializable_base
enum	cxn_flag_t { ConstructorFlag }
Protected Member Functions inherited from SST::Action
void	endSimulation ()
	Called to signal to the Simulation object to end the simulation.
void	endSimulation (SimTime_t end)
	Called to signal to the Simulation object to end the simulation.
Protected Member Functions inherited from SST::Activity
void	setPriority (uint64_t priority)
	Set the priority of the Activity.
std::string	getDeliveryTimeInfo () const
	Gets the delivery time info as a string.
	ImplementVirtualSerializable (SST::Activity)
Static Protected Member Functions inherited from SST::Core::Serialization::serializable_base
static void	serializable_abort (uint32_t line, const char *file, const char *func, const char *obj)

Detailed Description

Exit Event Action.

Causes the simulation to halt

Constructor & Destructor Documentation

Exit()

SST::Exit::Exit	(	int	num_threads,
		bool	single_rank )

Create a new ExitEvent.

Parameters

sim	Simulation object
single_rank	True if there are no parallel ranks

Exit needs to register a handler during constructor time, which requires a simulation object. But the simulation class creates an Exit object during it's construction, meaning that Simulation::getSimulation() won't work yet. So Exit is the one exception to the "constructors shouldn't take simulation pointers" rule. However, it still needs to follow the "classes shouldn't contain pointers back to Simulation" rule.

References SST::Activity::setPriority().

Member Function Documentation

computeEndTime()

SimTime_t SST::Exit::computeEndTime

(

)

Computes the end time of the simulation.

Returns

End time of the simulation

References SST::Action::endSimulation().

execute()

void SST::Exit::execute ( )

overridevirtual

Function which will be called when the time for this Activity comes to pass.

Implements SST::Activity.

getEndTime()

SimTime_t SST::Exit::getEndTime ( )

inline

Gets the end time of the simulation.

Returns

Time when simulation ends

print()

void SST::Exit::print ( const std::string & header, Output & out ) const

inlineoverridevirtual

Parameters

header	String to preface the exit action log
out	SST Output logger object

Returns

void

Reimplemented from SST::Core::MemPoolItem.

References SST::Activity::getDeliveryTime(), SST::Activity::getPriority(), and SST::Output::output().

serialize_order()

void SST::Exit::serialize_order ( SST::Core::Serialization::serializer & ser )

overridevirtual

TODO to enable different partitioning on restart, will need to associate m_thread_counts and m_idSet back to components so that a new Exit event can be generated on restart.

Reimplemented from SST::Action.

setEndTime()

void SST::Exit::setEndTime ( SimTime_t time )

inline

Stores the time the simulation has ended.

Parameters

time	Current simulation time

Returns

void

---

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

• src/sst/core/exit.h
• src/sst/core/exit.cc