SST::BaseComponent Class Reference

Main component object for the simulation. More...

#include <baseComponent.h>

Inheritance diagram for SST::BaseComponent:

Public Member Functions
	BaseComponent (ComponentId_t id)
	BaseComponent (const BaseComponent &)=delete
BaseComponent &	operator= (const BaseComponent &)=delete
const std::string &	getType () const
	Gets the ELI type for this BaseComponent.
ComponentId_t	getId () const
	Get the unique component ID.
uint8_t	getStatisticLoadLevel () const
	Get the BaseComponent Statistic load level.
virtual void	emergencyShutdown ()
	Called when SIGINT or SIGTERM has been seen.
const std::string &	getName () const
	Get the name of the BaseComponent.
const std::string &	getParentComponentName () const
	Get the name of the parent Component for the Component tree.
virtual void	init (unsigned int UNUSED(phase))
	Used during the init phase.
virtual void	complete (unsigned int UNUSED(phase))
	Used during the complete phase after the end of simulation.
virtual void	setup ()
	Called after all components have been constructed and initialization has completed, but before simulation time has begun.
virtual void	finish ()
	Called after complete phase, but before objects are destroyed.
virtual bool	Status ()
	Currently unused function.
virtual void	printStatus (Output &UNUSED(out))
	Called by the Simulation to request that the component print its current status.
UnitAlgebra	getCoreTimeBase () const
	Get the core timebase.
SimTime_t	getCurrentSimCycle () const
	Get the current simulation time as a cycle count.
int	getCurrentPriority () const
	Get the current priority.
UnitAlgebra	getElapsedSimTime () const
	get the elapsed simulation time as a UnitAlgebra
SimTime_t	getEndSimCycle () const
	Get the end simulation time as a cycle count.
UnitAlgebra	getEndSimTime () const
	Get the end simulation time as a UnitAlgebra.
RankInfo	getRank () const
	Get this instance's parallel rank.
RankInfo	getNumRanks () const
	Get the number of parallel ranks in the simulation.
SimTime_t	getCurrentSimTime () const
	Return the simulated time since the simulation began in the default timebase.
SimTime_t	getCurrentSimTime (TimeConverter base) const
	Get the simulated time since the simulation began in units specified by the parameter.
SimTime_t	getCurrentSimTime (const std::string &base) const
	Return the simulated time since the simulation began in the specified timebase.
SimTime_t	getCurrentSimTime (const char *base) const
	Return the simulated time since the simulation began in the specified timebase.
SimTime_t	getCurrentSimTimeNano () const
	Utility function to return the time since the simulation began in nanoseconds.
SimTime_t	getCurrentSimTimeMicro () const
	Utility function to return the time since the simulation began in microseconds.
SimTime_t	getCurrentSimTimeMilli () const
	Utility function to return the time since the simulation began in milliseconds.
double	getRunPhaseElapsedRealTime () const
	Get the amount of real-time spent executing the run phase of the simulation.
double	getInitPhaseElapsedRealTime () const
	Get the amount of real-time spent executing the init phase of the simulation.
double	getCompletePhaseElapsedRealTime () const
	Get the amount of real-time spent executing the complete phase of the simulation.
void	addWatchPoint (WatchPoint *pt)
	Add a watch point to all handlers in the Component Tree.
void	removeWatchPoint (WatchPoint *pt)
	Remove a watch point from all handlers in the Component Tree.
SubComponentSlotInfo *	getSubComponentSlotInfo (const std::string &name, bool fatalOnEmptyIndex=false)
const std::vector< double > &	getCoordinates () const
	Retrieve the X,Y,Z coordinates of this component.
Public Member Functions inherited from SST::Core::Serialization::serializable_base
virtual const char *	cls_name () const =0
virtual void	serialize_order (serializer &ser)=0
virtual uint32_t	cls_id () const =0
virtual std::string	serialization_name () const =0

Static Public Member Functions
static Output &	getSimulationOutput ()
	Get the default simulation Output class instance.

Protected Types
using	StatCreateFunction
Protected Types inherited from SST::Core::Serialization::serializable_base
enum	cxn_flag_t { ConstructorFlag }

Protected Member Functions
bool	isSimulationRunModeInit () const
	Check to see if the run mode was set to INIT.
bool	isSimulationRunModeRun () const
	Check to see if the run mode was set to RUN.
bool	isSimulationRunModeBoth () const
	Check to see if the run mode was set to BOTH.
std::string &	getOutputDirectory () const
	Returns the output directory of the simulation.
void	requireLibrary (const std::string &name)
	Signifies that a library is required for this simulation.
bool	isPortConnected (const std::string &name) const
	Determine if a port name is connected to any links.
Link *	configureLink (const std::string &name, TimeConverter timebase, Event::HandlerBase *handler=nullptr)
	Configure a Link.
Link *	configureLink (const std::string &name, Event::HandlerBase *handler=nullptr)
	Configure a Link.
Link *	configureSelfLink (const std::string &name, TimeConverter timebase, Event::HandlerBase *handler=nullptr)
	Configure a SelfLink (Loopback link).
Link *	configureSelfLink (const std::string &name, Event::HandlerBase *handler=nullptr)
	Configure a SelfLink (Loopback link) that uses the (Sub)Component's defaultTimeBase.
TimeConverter	registerClock (TimeConverter tc, Clock::HandlerBase *handler, bool reg_all=true)
	Registers a clock for this component.
void	unregisterClock (TimeConverter tc, Clock::HandlerBase *handler)
	Removes a clock handler from the component.
Cycle_t	reregisterClock (TimeConverter freq, Clock::HandlerBase *handler)
	Reactivates an existing Clock and Handler.
Cycle_t	getNextClockCycle (TimeConverter freq)
	Returns the next Cycle that the TimeConverter would fire.
TimeConverter	registerTimeBase (const std::string &base, bool reg_all=true)
	Registers a default timebase for the component and optionally sets the the component's links to that timebase.
TimeConverter	getTimeConverter (const std::string &base) const
TimeConverter	getTimeConverter (const UnitAlgebra &base) const
bool	isStatisticShared (const std::string &stat_name, bool include_me=false)
void	initiateInteractive (const std::string &msg)
	Tell the simulation object to initiate interactive mode (if currently turned on).
template<typename T>
Statistics::Statistic< T > *	registerStatistic (SST::Params &params, const std::string &stat_name, const std::string &stat_sub_id="")
	Registers a statistic.
template<typename T>
Statistics::Statistic< T > *	registerStatistic (const std::string &stat_name, const std::string &stat_sub_id="")
template<typename... Args>
Statistics::Statistic< std::tuple< Args... > > *	registerMultiStatistic (const std::string &stat_name, const std::string &stat_sub_id="")
template<typename... Args>
Statistics::Statistic< std::tuple< Args... > > *	registerMultiStatistic (SST::Params &params, const std::string &stat_name, const std::string &stat_sub_id="")
template<typename T>
Statistics::Statistic< T > *	registerStatistic (const char *stat_name, const char *stat_sub_id="")
void	performStatisticOutput (Statistics::StatisticBase *stat)
	Called by the Components and Subcomponent to perform a statistic Output.
void	performGlobalStatisticOutput ()
	Performs a global statistic Output.
template<typename T>
T::ProfilePoint *	registerProfilePoint (const std::string &point_name)
	Registers a profiling point.
template<class T, class... ARGS>
T *	loadModule (const std::string &type, Params &params, ARGS... args)
	Loads a module from an element Library.
template<class T, class... ARGS>
T *	loadComponentExtension (ARGS... args)
template<class T>
bool	isSubComponentLoadableUsingAPI (const std::string &type)
	Check to see if a given element type is loadable with a particular API.
template<class T>
bool	isUserSubComponentLoadableUsingAPI (const std::string &slot_name)
	Check to see if the element type loaded by the user into the.
template<class T, class... ARGS>
T *	loadAnonymousSubComponent (const std::string &type, const std::string &slot_name, int slot_num, uint64_t share_flags, Params &params, ARGS... args)
	Loads an anonymous subcomponent (not defined in input file to SST run).
template<class T>
T *	loadUserSubComponent (const std::string &slot_name)
	Loads a user defined subcomponent (defined in input file to SST run).
template<class T, class... ARGS>
T *	loadUserSubComponent (const std::string &slot_name, uint64_t share_flags, ARGS... args)
	Loads a user defined subcomponent (defined in input file to SST run).
void	fatal (uint32_t line, const char *file, const char *func, int exit_code, const char *format,...) const
	Convenience function for reporting fatal conditions.
void	sst_assert (bool condition, uint32_t line, const char *file, const char *func, int exit_code, const char *format,...) const
	Convenience function for testing for and reporting fatal conditions.
bool	isAnonymous ()
bool	isUser ()
void	setDefaultTimeBase (TimeConverter tc)
	Manually set the default defaultTimeBase.
TimeConverter	getDefaultTimeBase ()
const TimeConverter	getDefaultTimeBase () const
bool	doesSubComponentExist (const std::string &type)
uint8_t	getStatisticValidityAndLevel (const std::string &statisticName) const
std::vector< Profile::ComponentProfileTool * >	getComponentProfileTools (const std::string &point)
void	registerAsPrimaryComponent ()
	Register as a primary component, which allows the component to specify when it is and is not OK to end simulation.
void	primaryComponentDoNotEndSim ()
	Tells the simulation that it should not exit.
void	primaryComponentOKToEndSim ()
	Tells the simulation that it is now OK to end simulation.

Friends
class	Component
class	ComponentExtension
class	ComponentInfo
class	SubComponent
class	SubComponentSlotInfo
class	PortModule
class	SST::Statistics::StatisticProcessingEngine
class	SST::Statistics::StatisticBase
class	Core::Serialization::pvt::SerializeBaseComponentHelper

Additional Inherited Members
Static Public Attributes inherited from SST::Core::Serialization::serializable_base
static constexpr uint32_t	NullClsId = std::numeric_limits<uint32_t>::max()
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

Main component object for the simulation.

Member Typedef Documentation

StatCreateFunction

using SST::BaseComponent::StatCreateFunction

protected

Initial value:

std::function<Statistics::StatisticBase*(BaseComponent*,
       Statistics::StatisticProcessingEngine*, const std::string& , const std::string& , Params&)>

Member Function Documentation

complete()

virtual void SST::BaseComponent::complete ( unsigned int UNUSEDphase )

inlinevirtual

Used during the complete phase after the end of simulation.

The method will be called each phase of complete. Complete phase ends when no components have sent any data.

Parameters

phase

Current phase number

Reimplemented in SST::CoreTestOverhead::OverheadMeasure, and SST::Interfaces::SimpleNetwork.

configureLink() [1/2]

Link * SST::BaseComponent::configureLink ( const std::string & name, Event::HandlerBase * handler = nullptr )

protected

Configure a Link.

Parameters

name	Port Name on which the link to configure is attached.
handler	Optional Handler to be called when an Event is received

Returns

A pointer to the configured link, or nullptr if an error occurred.

References configureLink().

configureLink() [2/2]

Link * SST::BaseComponent::configureLink ( const std::string & name, TimeConverter timebase, Event::HandlerBase * handler = nullptr )

inlineprotected

Configure a Link.

Parameters

name	Port Name on which the link to configure is attached.
timebase	Timebase of the link provided as either a std::string, SST::UnitAlgebra, or SST::TimeConverter
handler	Optional Handler to be called when an Event is received

Returns

A pointer to the configured link, or nullptr if an error occurred.

References SST::TimeConverter::getFactor().

Referenced by configureLink(), configureSelfLink(), and configureSelfLink().

configureSelfLink() [1/2]

Link * SST::BaseComponent::configureSelfLink ( const std::string & name, Event::HandlerBase * handler = nullptr )

protected

Configure a SelfLink (Loopback link) that uses the (Sub)Component's defaultTimeBase.

Parameters

name	Name of the self-link port
handler	Optional Handler to be called when an Event is received

Returns

A pointer to the configured link, or nullptr if an error occurred.

References configureLink(), and configureSelfLink().

configureSelfLink() [2/2]

Link * SST::BaseComponent::configureSelfLink ( const std::string & name, TimeConverter timebase, Event::HandlerBase * handler = nullptr )

inlineprotected

Configure a SelfLink (Loopback link).

Parameters

name	Name of the self-link port
timebase	Timebase of the link. Timebase can be a std::string, SST::UnitAlgebra or SST::TimeConverter
handler	Optional Handler to be called when an Event is received

Returns

A pointer to the configured link, or nullptr if an error occurred.

References configureLink().

Referenced by configureSelfLink().

emergencyShutdown()

virtual void SST::BaseComponent::emergencyShutdown ( )

inlinevirtual

Called when SIGINT or SIGTERM has been seen.

Allows components opportunity to clean up external state.

Reimplemented in SST::CoreTestCheckpoint::coreTestCheckpoint.

fatal()

void SST::BaseComponent::fatal ( uint32_t line, const char * file, const char * func, int exit_code, const char * format, ... ) const

protected

Convenience function for reporting fatal conditions.

The function will create a new Output object and call fatal() using the supplied parameters. Before calling Output::fatal(), the function will also print other information about the (sub)component that called fatal and about the simulation state.

From Output::fatal: Message will be sent to the output location and to stderr. The output will be prepended with the expanded prefix set in the object.

NOTE: fatal() will call MPI_Abort(exit_code) to terminate simulation.

Parameters

line	Line number of calling function (use CALL_INFO macro)
file	File name calling function (use CALL_INFO macro)
func	Function name calling function (use CALL_INFO macro)
exit_code	The exit code used for termination of simulation. will be passed to MPI_Abort()
format	Format string. All valid formats for printf are available.
...	Arguments for format.

References fatal().

Referenced by fatal(), SST::CoreTestMemPoolTest::MemPoolTestComponent::finish(), and registerProfilePoint().

finish()

virtual void SST::BaseComponent::finish ( )

inlinevirtual

Called after complete phase, but before objects are destroyed.

A good place to print out statistics.

Reimplemented in SST::CoreTest::MessageMesh::EnclosingComponent, SST::CoreTestCheckpoint::coreTestCheckpoint, SST::CoreTestClockerComponent::coreTestClockerComponent, SST::CoreTestComponent::coreTestComponent, SST::CoreTestComponent::coreTestComponentExtMain, SST::CoreTestComponent::coreTestLinks, SST::CoreTestDistribComponent::coreTestDistribComponent, SST::CoreTestLookupTableComponent::coreTestLookupTableComponent, SST::CoreTestMemPoolTest::MemPoolTestComponent, SST::CoreTestMessageGeneratorComponent::coreTestMessageGeneratorComponent, SST::CoreTestModule::coreTestModuleLoader, SST::CoreTestOverhead::OverheadMeasure, SST::CoreTestParamComponent::coreTestParamComponent, SST::CoreTestPerfComponent::coreTestPerfComponent, SST::CoreTestRNGComponent::coreTestRNGComponent, SST::CoreTestSharedObjectsComponent::coreTestSharedObjectsComponent, SST::CoreTestStatisticsComponent::StatisticsComponentFloat, SST::CoreTestStatisticsComponent::StatisticsComponentInt, SST::Interfaces::SimpleNetwork, and SST::SubComponent.

getCompletePhaseElapsedRealTime()

double SST::BaseComponent::getCompletePhaseElapsedRealTime

(

)

const

Get the amount of real-time spent executing the complete phase of the simulation.

Returns

Real time in seconds spent executing the complete phase

References getCompletePhaseElapsedRealTime().

Referenced by getCompletePhaseElapsedRealTime().

getCoreTimeBase()

UnitAlgebra SST::BaseComponent::getCoreTimeBase

(

)

const

Get the core timebase.

Returns

Core timebase set at the beginning of the simulation. Returned as a UnitAlgebra

References getCoreTimeBase().

Referenced by getCoreTimeBase().

getCurrentPriority()

int SST::BaseComponent::getCurrentPriority

(

)

const

Get the current priority.

Returns

Current priority for the simulation

References getCurrentPriority().

Referenced by getCurrentPriority().

getCurrentSimCycle()

SimTime_t SST::BaseComponent::getCurrentSimCycle

(

)

const

Get the current simulation time as a cycle count.

Returns

Current simulation cycle for the simulation

References getCurrentSimCycle().

Referenced by getCurrentSimCycle().

getCurrentSimTime() [1/4]

SimTime_t SST::BaseComponent::getCurrentSimTime ( ) const

inline

Return the simulated time since the simulation began in the default timebase.

Returns

Current simulation time in units of the default timebase for the object

References getCurrentSimTime().

Referenced by getCurrentSimTime(), getCurrentSimTime(), getCurrentSimTime(), getCurrentSimTimeMicro(), getCurrentSimTimeMilli(), and getCurrentSimTimeNano().

getCurrentSimTime() [2/4]

SimTime_t SST::BaseComponent::getCurrentSimTime ( const char * base ) const

inline

Return the simulated time since the simulation began in the specified timebase.

NOTE: This version of getCurrentSimTime() exists because both std::string and TimeConverter can be implicitly created with a const char*. Having this implementation removes ambiguity and ensures that a const char* is passed through the std::string version, which can accept timebases that are not representable with TimeConverter due to being smaller than the global timebase.

Parameters

base	Timebase frequency in SI Units

Returns

Current time as a cycle count based on the provided timebase

References getCurrentSimTime().

Referenced by getCurrentSimTime().

getCurrentSimTime() [3/4]

SimTime_t SST::BaseComponent::getCurrentSimTime

(

const std::string &

base

)

const

Return the simulated time since the simulation began in the specified timebase.

NOTE: This version of getCurrentSimTime() can accept a timebase that is not normally representable because it is smaller than the global timebase set by the user. If this happens, the underlying code will use UnitAlgebra to compute the cycle count. Because UnitAlgebra is computationally intense, it is best to avoid this case during the run loop of the simulation.

Parameters

base	Timebase frequency in SI Units

Returns

Current time as a cycle count based on the provided timebase

References getCurrentSimTime(), and SST::Simulation::getTimeLord().

getCurrentSimTime() [4/4]

SimTime_t SST::BaseComponent::getCurrentSimTime

(

TimeConverter

base

)

const

Get the simulated time since the simulation began in units specified by the parameter.

Parameters

tc	TimeConverter specifying the units

Returns

Current time as a cycle count based on the provided timebase

References SST::TimeConverter::convertFromCoreTime(), and getCurrentSimTime().

getCurrentSimTimeMicro()

SimTime_t SST::BaseComponent::getCurrentSimTimeMicro

(

)

const

Utility function to return the time since the simulation began in microseconds.

Returns

Current time as a count of microseconds expired in the simulation

References SST::TimeConverter::convertFromCoreTime(), getCurrentSimTime(), getCurrentSimTimeMicro(), SST::TimeConverter::getFactor(), and SST::Simulation::getTimeLord().

Referenced by getCurrentSimTimeMicro().

getCurrentSimTimeMilli()

SimTime_t SST::BaseComponent::getCurrentSimTimeMilli

(

)

const

Utility function to return the time since the simulation began in milliseconds.

Returns

Current time as a count of milliseconds expired in the simulation

References SST::TimeConverter::convertFromCoreTime(), getCurrentSimTime(), getCurrentSimTimeMilli(), SST::TimeConverter::getFactor(), and SST::Simulation::getTimeLord().

Referenced by SST::CoreTestMessageGeneratorComponent::coreTestMessageGeneratorComponent::finish(), and getCurrentSimTimeMilli().

getCurrentSimTimeNano()

SimTime_t SST::BaseComponent::getCurrentSimTimeNano

(

)

const

Utility function to return the time since the simulation began in nanoseconds.

Returns

Current time as a count of nanoseconds expired in the simulation

References SST::TimeConverter::convertFromCoreTime(), getCurrentSimTime(), getCurrentSimTimeNano(), SST::TimeConverter::getFactor(), and SST::Simulation::getTimeLord().

Referenced by getCurrentSimTimeNano().

getElapsedSimTime()

UnitAlgebra SST::BaseComponent::getElapsedSimTime

(

)

const

get the elapsed simulation time as a UnitAlgebra

Returns

Time in seconds as a UnitAlgebra

References getElapsedSimTime().

Referenced by getElapsedSimTime().

getEndSimCycle()

SimTime_t SST::BaseComponent::getEndSimCycle

(

)

const

Get the end simulation time as a cycle count.

Returns

End simulation time as cycle count

References getEndSimCycle().

Referenced by getEndSimCycle().

getEndSimTime()

UnitAlgebra SST::BaseComponent::getEndSimTime

(

)

const

Get the end simulation time as a UnitAlgebra.

Returns

End time in seconds as a UnitAlgebra

References getEndSimTime().

Referenced by getEndSimTime().

getId()

ComponentId_t SST::BaseComponent::getId ( ) const

inline

Get the unique component ID.

Returns

ID of BaseComponent

Referenced by registerProfilePoint().

getInitPhaseElapsedRealTime()

double SST::BaseComponent::getInitPhaseElapsedRealTime

(

)

const

Get the amount of real-time spent executing the init phase of the simulation.

Returns

Real time in seconds spent executing the init phase

References getInitPhaseElapsedRealTime().

Referenced by getInitPhaseElapsedRealTime().

getName()

const std::string & SST::BaseComponent::getName ( ) const

inline

Get the name of the BaseComponent.

Returns

BaseComponent's name

Referenced by SST::Simulation::checkpoint_append_registry(), SST::CoreTestCheckpoint::coreTestCheckpoint::emergencyShutdown(), SST::CoreTestCheckpoint::coreTestCheckpoint::finish(), primaryComponentDoNotEndSim(), primaryComponentOKToEndSim(), registerAsPrimaryComponent(), registerProfilePoint(), and SST::CoreTestCheckpoint::coreTestCheckpoint::setup().

getNextClockCycle()

Cycle_t SST::BaseComponent::getNextClockCycle ( TimeConverter freq )

protected

Returns the next Cycle that the TimeConverter would fire.

If called prior to the simulation run loop, next Cycle is 0. If called after the simulation run loop completes (e.g., during complete() or finish()), next Cycle is one past the end time of the simulation. See Note in reregisterClock() for additional guidance when calling this function after simulation ends.

Parameters

freq	Frequency of the clock

Returns

Cycle count that will be passed into the next call to this clock's handler functions

References getNextClockCycle().

Referenced by getNextClockCycle().

getNumRanks()

RankInfo SST::BaseComponent::getNumRanks

(

)

const

Get the number of parallel ranks in the simulation.

Returns

Number of ranks in simulation

References getNumRanks().

Referenced by getNumRanks().

getOutputDirectory()

std::string & SST::BaseComponent::getOutputDirectory ( ) const

protected

Returns the output directory of the simulation.

Returns

Directory in which simulation outputs should be placed. Returns empty string if output directory not set by user.

References getOutputDirectory().

Referenced by getOutputDirectory().

getParentComponentName()

const std::string & SST::BaseComponent::getParentComponentName ( ) const

inline

Get the name of the parent Component for the Component tree.

If called on a Component, returns the name of that Component.

Returns

The name of the parent Component for the Component tree.

getRank()

RankInfo SST::BaseComponent::getRank

(

)

const

Get this instance's parallel rank.

Returns

Get the rank for this objects partition

References getRank().

Referenced by getRank().

getRunPhaseElapsedRealTime()

double SST::BaseComponent::getRunPhaseElapsedRealTime

(

)

const

Get the amount of real-time spent executing the run phase of the simulation.

Returns

Real time in seconds spent executing the run phase

References getRunPhaseElapsedRealTime().

Referenced by SST::CoreTestMemPoolTest::MemPoolTestComponent::finish(), and getRunPhaseElapsedRealTime().

getSimulationOutput()

Output & SST::BaseComponent::getSimulationOutput ( )

static

Get the default simulation Output class instance.

Elements do not have to use this Output object and can create their own to use instead.

Returns

Default Output object for this partition

References getSimulationOutput(), and SST::Simulation::getSimulationOutput().

Referenced by SST::CoreTestMemPoolTest::MemPoolTestComponent::finish(), and getSimulationOutput().

getStatisticLoadLevel()

uint8_t SST::BaseComponent::getStatisticLoadLevel ( ) const

inline

Get the BaseComponent Statistic load level.

Returns

Statistic load level of BaseComponent

getType()

const std::string & SST::BaseComponent::getType ( ) const

inline

Gets the ELI type for this BaseComponent.

Returns

ELI type as a string

Referenced by registerProfilePoint().

init()

virtual void SST::BaseComponent::init ( unsigned int UNUSEDphase )

inlinevirtual

Used during the init phase.

The method will be called each phase of initialization. Initialization ends when no components have sent any data.

Parameters

phase

Current phase number

Reimplemented in SST::CoreTestOverhead::OverheadMeasure, SST::Interfaces::SimpleNetwork, and SST::SubComponent.

initiateInteractive()

void SST::BaseComponent::initiateInteractive ( const std::string & msg )

protected

Tell the simulation object to initiate interactive mode (if currently turned on).

Parameters

msg	Message to print when interactive mode is entered

References initiateInteractive().

Referenced by initiateInteractive().

isPortConnected()

bool SST::BaseComponent::isPortConnected ( const std::string & name ) const

protected

Determine if a port name is connected to any links.

Parameters

name	Name of the port

Returns

True if port is connected, false otherwise

References isPortConnected().

Referenced by isPortConnected().

isSimulationRunModeBoth()

bool SST::BaseComponent::isSimulationRunModeBoth ( ) const

protected

Check to see if the run mode was set to BOTH.

Returns

True if simulation run mode is set to BOTH

References isSimulationRunModeBoth().

Referenced by isSimulationRunModeBoth().

isSimulationRunModeInit()

bool SST::BaseComponent::isSimulationRunModeInit ( ) const

protected

Check to see if the run mode was set to INIT.

Returns

True if simulation run mode is set to INIT

References isSimulationRunModeInit().

Referenced by isSimulationRunModeInit().

isSimulationRunModeRun()

bool SST::BaseComponent::isSimulationRunModeRun ( ) const

protected

Check to see if the run mode was set to RUN.

Returns

True if simulation run mode is set to RUN

References isSimulationRunModeRun().

Referenced by isSimulationRunModeRun().

isSubComponentLoadableUsingAPI()

template<class T>

bool SST::BaseComponent::isSubComponentLoadableUsingAPI ( const std::string & type )

inlineprotected

Check to see if a given element type is loadable with a particular API.

Parameters

name	Name of element to check in lib.name format

Returns

True if loadable as the API specified as the template parameter

Referenced by loadAnonymousSubComponent().

isUserSubComponentLoadableUsingAPI()

template<class T>

bool SST::BaseComponent::isUserSubComponentLoadableUsingAPI ( const std::string & slot_name )

inlineprotected

Check to see if the element type loaded by the user into the.

specified slot is loadable with a particular API. This will only check slot index 0. If you need to check other slots, please use the SubComponentSlotInfo.

Parameters

slot_name

Name of slot to check

Returns

True if loadable as the API specified as the template parameter

References SST::Output::fatal(), and SST::Output::STDERR.

loadAnonymousSubComponent()

template<class T, class... ARGS>

T * SST::BaseComponent::loadAnonymousSubComponent ( const std::string & type, const std::string & slot_name, int slot_num, uint64_t share_flags, Params & params, ARGS... args )

inlineprotected

Loads an anonymous subcomponent (not defined in input file to SST run).

Parameters

type	type of subcomponent to load in lib.name format
slot_name	name of the slot to load subcomponent into
slot_num	index of the slot to load subcomponent into
share_flags	Share flags to be used by subcomponent
params	Params object to be passed to subcomponent
args	Arguments to be passed to constructor. This signature is defined in the API definition

For ease in backward compatibility to old API, this call will try to load using new API and will fallback to old if unsuccessful.

References isSubComponentLoadableUsingAPI().

loadModule()

template<class T, class... ARGS>

T * SST::BaseComponent::loadModule ( const std::string & type, Params & params, ARGS... args )

inlineprotected

Loads a module from an element Library.

Parameters

type	Fully Qualified library.moduleName
params	Parameters the module should use for configuration

Returns

Handle to new instance of module, or nullptr on failure.

loadUserSubComponent() [1/2]

template<class T>

T * SST::BaseComponent::loadUserSubComponent ( const std::string & slot_name )

inlineprotected

Loads a user defined subcomponent (defined in input file to SST run).

This version does not allow share flags (set to SHARE_NONE) or constructor arguments.

Parameters

slot_name

name of the slot to load subcomponent into

For ease in backward compatibility to old API, this call will try to load using new API and will fallback to old if unsuccessful.

References loadUserSubComponent().

Referenced by loadUserSubComponent().

loadUserSubComponent() [2/2]

template<class T, class... ARGS>

T * SST::BaseComponent::loadUserSubComponent ( const std::string & slot_name, uint64_t share_flags, ARGS... args )

inlineprotected

Loads a user defined subcomponent (defined in input file to SST run).

Parameters

slot_name	name of the slot to load subcomponent into
share_flags	Share flags to be used by subcomponent
args	Arguments to be passed to constructor. This signature is defined in the API definition

For ease in backward compatibility to old API, this call will try to load using new API and will fallback to old if unsuccessful.

References SST::Output::fatal(), and SST::Output::STDERR.

performGlobalStatisticOutput()

void SST::BaseComponent::performGlobalStatisticOutput ( )

protected

Performs a global statistic Output.

This routine will force ALL Components and Subcomponents to output their statistic information. This may lead to unexpected results if the statistic counts or data is reset on output.

NOTE: Currently, this function will only output statistics that are on the same rank.

References performGlobalStatisticOutput().

Referenced by performGlobalStatisticOutput().

performStatisticOutput()

void SST::BaseComponent::performStatisticOutput ( Statistics::StatisticBase * stat )

protected

Called by the Components and Subcomponent to perform a statistic Output.

Parameters

stat	Pointer to the statistic.

References performStatisticOutput().

Referenced by performStatisticOutput().

primaryComponentDoNotEndSim()

void SST::BaseComponent::primaryComponentDoNotEndSim ( )

protected

Tells the simulation that it should not exit.

The component will remain in this state until a call to primaryComponentOKToEndSim(). A component may reenter the DoNotEndSime state by calling this function after calling primaryComponentOKToEndSim(), in which case, another call to primaryComponentOKToEndSim() will need to be called to end the simulation.

Calls to this function when already in the DoNotEndSime state, will be functionally ignored, but will generate a warning if verbose is turned on.

Calls to this function on non-primary components will be ignored and will generate a warning if verbose is turned on.

See also

BaseComponent::registerAsPrimaryComponent()

BaseComponent::primaryComponentOKToEndSim()

References getName(), and primaryComponentDoNotEndSim().

Referenced by primaryComponentDoNotEndSim().

primaryComponentOKToEndSim()

void SST::BaseComponent::primaryComponentOKToEndSim ( )

protected

Tells the simulation that it is now OK to end simulation.

Simulation will not end until all primary components that have called primaryComponentDoNotEndSim() have called this function.

Calls to this function when already in the OKToEndSim state, will be functionally ignored, but will generate a warning if verbose is turned on.

Calls to this function on non-primary components will be ignored and will generate a warning if verbose is turned on.

See also

BaseComponent::registerAsPrimaryComponent()

BaseComponent::primaryComponentDoNotEndSim()

References getName(), and primaryComponentOKToEndSim().

Referenced by primaryComponentOKToEndSim().

printStatus()

virtual void SST::BaseComponent::printStatus ( Output & UNUSEDout )

inlinevirtual

Called by the Simulation to request that the component print its current status.

Useful for debugging.

Parameters

out	The Output class which should be used to print component status.

registerAsPrimaryComponent()

void SST::BaseComponent::registerAsPrimaryComponent ( )

protected

Register as a primary component, which allows the component to specify when it is and is not OK to end simulation.

The simulator will not end simulation through use of the Exit object while any primary component has specified primaryComponentDoNotEndSim(). However, it is still possible for Actions other than Exit to end simulation. Once all primary components have specified primaryComponentOKToEndSim(), the Exit object will trigger and end simulation.

This must be called during simulation wireup (i.e during the constructor for the component), or a fatal error will occur.

If no component registers as a primary component, then the Exit object will not be used for that simulation and simulation termination must be accomplished through some other mechanism (e.g. –stopAt flag, or some other Action object).

See also

BaseComponent::primaryComponentDoNotEndSim()

BaseComponent::primaryComponentOKToEndSim()

References getName(), and registerAsPrimaryComponent().

Referenced by registerAsPrimaryComponent().

registerClock()

TimeConverter SST::BaseComponent::registerClock ( TimeConverter tc, Clock::HandlerBase * handler, bool reg_all = true )

protected

Registers a clock for this component.

Parameters

tc	TimeConverter object specifying the clock frequency. May be specified as a TimeConverter, std::string or UnitAlgebra
handler	Pointer to Clock::HandlerBase which is to be invoked at the specified interval
reg_all	Should this clock period be used as the default timebase for all of the links connected to this component

Returns

The TimeConverter object representing the clock frequency

References registerClock().

Referenced by registerClock().

registerProfilePoint()

template<typename T>

T::ProfilePoint * SST::BaseComponent::registerProfilePoint ( const std::string & point_name )

inlineprotected

Registers a profiling point.

This function will register a profiling point.

Parameters

point_name

Name of point to register

Returns

Either a pointer to a created T::ProfilePoint or nullptr if not enabled.

References fatal(), getId(), getName(), and getType().

registerStatistic()

template<typename T>

Statistics::Statistic< T > * SST::BaseComponent::registerStatistic ( SST::Params & params, const std::string & stat_name, const std::string & stat_sub_id = "" )

inlineprotected

Registers a statistic.

If Statistic is allowed to run (controlled by Python runtime parameters), then a statistic will be created and returned. If not allowed to run, then a NullStatistic will be returned. In either case, the returned value should be used for all future Statistic calls. The type of Statistic and the Collection Rate is set by Python runtime parameters. If no type is defined, then an Accumulator Statistic will be provided by default. If rate set to 0 or not provided, then the statistic will output results only at end of sim (if output is enabled).

Parameters

params	Parameter set to be passed to the statistic constructor.
stat_name	Primary name of the statistic. This name must match the defined ElementInfoStatistic in the component, and must also be enabled in the Python input file.
stat_sub_id	An additional sub name for the statistic

Returns

Either a created statistic of desired type or a NullStatistic depending upon runtime settings.

registerTimeBase()

TimeConverter SST::BaseComponent::registerTimeBase ( const std::string & base, bool reg_all = true )

protected

Registers a default timebase for the component and optionally sets the the component's links to that timebase.

Useful for components which do not have a clock, but would like a default timebase.

Parameters

base	Frequency for the clock in SI units
reg_all	Should this clock period be used as the default timebase for all of the links connected to this component

References SST::Simulation::getTimeLord(), and registerTimeBase().

Referenced by registerTimeBase().

requireLibrary()

void SST::BaseComponent::requireLibrary ( const std::string & name )

protected

Signifies that a library is required for this simulation.

Causes the Factory to verify that the required library is loaded.

NOTE: This function should rarely be required, as most dependencies are automatically detected in the simulator core. However, if the component uses an event from another library that is not wholly defined in a header file, this call may be required to ensure that all the code from the event is loaded. Similarly, if you use a class from another library that does not have ELI information, this call may also be required to make sure all dependencies are loaded.

Parameters

name	Name of library this BaseComponent depends on

References requireLibrary().

Referenced by requireLibrary().

reregisterClock()

Cycle_t SST::BaseComponent::reregisterClock ( TimeConverter freq, Clock::HandlerBase * handler )

protected

Reactivates an existing Clock and Handler.

Returns

Time of next time clock handler will fire

Note: If called after the simulation run loop (e.g., in finish() or complete()), will return the next time of the clock past when the simulation ended. There can be a small lag between simulation end and detection of simulation end during which clocks can run a few extra cycles. As a result, the return value just prior to simulation end may be greater than the value returned after simulation end.

References reregisterClock().

Referenced by reregisterClock().

setup()

virtual void SST::BaseComponent::setup ( )

inlinevirtual

Called after all components have been constructed and initialization has completed, but before simulation time has begun.

Reimplemented in SST::CoreTest::MessageMesh::EnclosingComponent, SST::CoreTestCheckpoint::coreTestCheckpoint, SST::CoreTestClockerComponent::coreTestClockerComponent, SST::CoreTestComponent::coreTestComponent, SST::CoreTestComponent::coreTestComponentExtMain, SST::CoreTestComponent::coreTestLinks, SST::CoreTestDistribComponent::coreTestDistribComponent, SST::CoreTestLookupTableComponent::coreTestLookupTableComponent, SST::CoreTestMemPoolTest::MemPoolTestComponent, SST::CoreTestMessageGeneratorComponent::coreTestMessageGeneratorComponent, SST::CoreTestModule::coreTestModuleLoader, SST::CoreTestOverhead::OverheadMeasure, SST::CoreTestParamComponent::coreTestParamComponent, SST::CoreTestPerfComponent::coreTestPerfComponent, SST::CoreTestRNGComponent::coreTestRNGComponent, SST::CoreTestSharedObjectsComponent::coreTestSharedObjectsComponent, SST::CoreTestStatisticsComponent::StatisticsComponentFloat, SST::CoreTestStatisticsComponent::StatisticsComponentInt, SST::Interfaces::SimpleNetwork, and SST::SubComponent.

sst_assert()

void SST::BaseComponent::sst_assert ( bool condition, uint32_t line, const char * file, const char * func, int exit_code, const char * format, ... ) const

protected

Convenience function for testing for and reporting fatal conditions.

If the condition holds, fatal() will be called, otherwise, the function will return. The function will create a new Output object and call fatal() using the supplied parameters. Before calling Output::fatal(), the function will also print other information about the (sub)component that called fatal and about the simulation state.

From Output::fatal: Message will be sent to the output location and to stderr. The output will be prepended with the expanded prefix set in the object. NOTE: fatal() will call MPI_Abort(exit_code) to terminate simulation.

Parameters

condition	on which to call fatal(); fatal() is called if the bool is false.
line	Line number of calling function (use CALL_INFO macro)
file	File name calling function (use CALL_INFO macro)
func	Function name calling function (use CALL_INFO macro)
exit_code	The exit code used for termination of simulation. will be passed to MPI_Abort()
format	Format string. All valid formats for printf are available.
...	Arguments for format.

References sst_assert().

Referenced by sst_assert().

unregisterClock()

void SST::BaseComponent::unregisterClock ( TimeConverter tc, Clock::HandlerBase * handler )

protected

Removes a clock handler from the component.

NOTE: This operation needs to search the list until it finds the specified handler, which can be a slow operation for long lists. Consider using the return value from the clock handler to control whether a handler is removed from the list or not.

Parameters

tc	TimeConverter representing the period of the clock
handler	Handler to remove from the list

References unregisterClock().

Referenced by unregisterClock().

---

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

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