Simplified, generic interface to Memory models. More...

#include <simpleMem.h>

Inheritance diagram for SST::Interfaces::SimpleMem:

Data Structures
class	Handler
	Event Handler class with user-data argument. More...

class	Handler< classT, void >
	Event Handler class without user-data. More...

class	HandlerBase
	Functor classes for Clock handling. More...

class	Request
	Represents both memory requests and responses. More...

Public Types
typedef uint64_t	Addr
	All Addresses can be 64-bit.

Public Member Functions
	SimpleMem (SST::ComponentId_t id, Params &UNUSED(params))
	Constructor, designed to be used via 'loadUserSubComponent and loadAnonymousSubComponent'. More...

virtual bool	initialize (const std::string &linkName, HandlerBase *handler=nullptr)=0
	Second half of building the interface. More...

virtual void	sendInitData (Request *req)=0
	Sends a memory-based request during the init() phase.

virtual void	sendInitData (SST::Event *ev)
	Sends a generic Event during the init() phase (Mostly acts as a passthrough) More...

virtual SST::Event *	recvInitData ()
	Receive any data during the init() phase. More...

virtual SST::Link *	getLink (void) const =0
	Returns a handle to the underlying SST::Link.

virtual void	sendRequest (Request *req)=0
	Send a Request to the other side of the link.

virtual Request *	recvResponse (void)=0
	Receive a Request response from the side of the link. More...

Public Member Functions inherited from SST::SubComponent
	SST_ELI_DECLARE_INFO_EXTERN (ELI::ProvidesParams, ELI::ProvidesSubComponentSlots, ELI::ProvidesPorts, ELI::ProvidesStats, ELI::ProvidesInterface) SubComponent(ComponentId_t id)

virtual void	init (unsigned int UNUSED(phase)) override
	Used during the init phase. More...

virtual void	setup () override
	Called after all components have been constructed and initialization has completed, but before simulation time has begun. More...

virtual void	finish () override
	Called after simulation completes, but before objects are destroyed. More...

Public Member Functions inherited from SST::Module
	SST_ELI_DECLARE_CTORS (ELI_CTOR(SST::Params &),) Module()

Public Member Functions inherited from SST::BaseComponent
	BaseComponent (ComponentId_t id)

const std::string &	getType () const

ComponentId_t	getId () const
	Returns unique component ID.

virtual void	emergencyShutdown (void)
	Called when SIGINT or SIGTERM has been seen. More...

const std::string &	getName () const
	Returns component Name.

virtual void	complete (unsigned int UNUSED(phase))
	Used during the init phase. More...

virtual bool	Status ()
	Currently unused function.

virtual void	printStatus (Output &UNUSED(out))
	Called by the Simulation to request that the component print it's current status. More...

SimTime_t	getCurrentSimCycle () const
	Return the current simulation time as a cycle count.

int	getCurrentPriority () const
	Return the current priority.

UnitAlgebra	getElapsedSimTime () const
	Return the elapsed simulation time as a time.

UnitAlgebra	getFinalSimTime () const
	Return the end simulation time as a time.

RankInfo	getRank () const
	Get this instance's parallel rank.

RankInfo	getNumRanks () const
	Get the number of parallel ranks in the simulation.

Output &	getSimulationOutput () const
	Return the base simulation Output class instance.

SimTime_t	getCurrentSimTime (TimeConverter *tc) const
	return the time since the simulation began in units specified by the parameter. More...

SimTime_t	getCurrentSimTime () const
	return the time since the simulation began in the default timebase

SimTime_t	getCurrentSimTime (const std::string &base) const
	return the time since the simulation began in timebase specified More...

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.

SubComponentSlotInfo *	getSubComponentSlotInfo (const std::string &name, bool fatalOnEmptyIndex=false)

const std::vector< double > &	getCoordinates () const
	Retrieve the X,Y,Z coordinates of this component.

Additional Inherited Members
Protected Member Functions inherited from SST::BaseComponent
bool	isPortConnected (const std::string &name) const
	Determine if a port name is connected to any links.

Link *	configureLink (const std::string &name, TimeConverter time_base, Event::HandlerBase handler=nullptr)
	Configure a Link. More...

Link *	configureLink (const std::string &name, const std::string &time_base, Event::HandlerBase *handler=nullptr)
	Configure a Link. More...

Link *	configureLink (const std::string &name, Event::HandlerBase *handler=nullptr)
	Configure a Link. More...

Link *	configureSelfLink (const std::string &name, TimeConverter time_base, Event::HandlerBase handler=nullptr)
	Configure a SelfLink (Loopback link) More...

Link *	configureSelfLink (const std::string &name, const std::string &time_base, Event::HandlerBase *handler=nullptr)
	Configure a SelfLink (Loopback link) More...

Link *	configureSelfLink (const std::string &name, Event::HandlerBase *handler=nullptr)
	Configure a SelfLink (Loopback link) More...

TimeConverter *	registerClock (const std::string &freq, Clock::HandlerBase *handler, bool regAll=true)
	Registers a clock for this component. More...

TimeConverter *	registerClock (const UnitAlgebra &freq, Clock::HandlerBase *handler, bool regAll=true)
	Registers a clock for this component. More...

TimeConverter *	registerClock (TimeConverter tc, Clock::HandlerBase handler, bool regAll=true)
	Registers a clock for this component. More...

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. More...

Cycle_t	getNextClockCycle (TimeConverter *freq)
	Returns the next Cycle that the TimeConverter would fire.

TimeConverter *	registerOneShot (const std::string &timeDelay, OneShot::HandlerBase *handler)
	Registers a OneShot event for this component. More...

TimeConverter *	registerOneShot (const UnitAlgebra &timeDelay, OneShot::HandlerBase *handler)

TimeConverter *	registerTimeBase (const std::string &base, bool regAll=true)
	Registers a default time base for the component and optionally sets the the component's links to that timebase. More...

TimeConverter *	getTimeConverter (const std::string &base) const

TimeConverter *	getTimeConverter (const UnitAlgebra &base) const

TimeConverter *	getTimeConverterNano () const

TimeConverter *	getTimeConverterMicro () const

TimeConverter *	getTimeConverterMilli () const

bool	isStatisticShared (const std::string &statName, bool include_me=false)

template<typename T >
Statistic< T > *	registerStatistic (SST::Params &params, const std::string &statName, const std::string &statSubId="")
	Registers a statistic. More...

template<typename T >
Statistic< T > *	registerStatistic (const std::string &statName, const std::string &statSubId="")

template<typename... Args>
Statistic< std::tuple< Args...> > *	registerMultiStatistic (const std::string &statName, const std::string &statSubId="")

template<typename... Args>
Statistic< std::tuple< Args...> > *	registerMultiStatistic (SST::Params &params, const std::string &statName, const std::string &statSubId="")

template<typename T >
Statistic< T > *	registerStatistic (const char statName, const char statSubId="")

void	performStatisticOutput (StatisticBase *stat)
	Called by the Components and Subcomponent to perform a statistic Output. More...

void	performGlobalStatisticOutput ()
	Performs a global statistic Output. More...

Module *	loadModule (const std::string &type, Params &params)
	Loads a module from an element Library. More...

template<class T , class... ARGS>
T *	loadModule (const std::string &type, Params &params, ARGS...args)
	Loads a module from an element Library. More...

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. More...

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). More...

template<class T >
T *	loadUserSubComponent (const std::string &slot_name)
	Loads a user defined subcomponent (defined in input file to SST run). More...

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). More...

void	fatal (uint32_t line, const char file, const char func, int exit_code, const char *format,...) const
	Convenience function for reporting fatal conditions. More...

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. More...

bool	isAnonymous ()

bool	isUser ()

void	setDefaultTimeBase (TimeConverter *tc)
	Manually set the default detaulTimeBase.

TimeConverter *	getDefaultTimeBase ()

bool	doesSubComponentExist (const std::string &type)

SharedRegion *	getLocalSharedRegion (const std::string &key, size_t size)
	Find a lookup table.

SharedRegion *	getGlobalSharedRegion (const std::string &key, size_t size, SharedRegionMerger *merger=nullptr)

Simulation *	getSimulation () const

virtual bool	doesComponentInfoStatisticExist (const std::string &statisticName) const

uint8_t	getComponentInfoStatisticEnableLevel (const std::string &statisticName) const

Protected Attributes inherited from SST::BaseComponent
Simulation *	sim

Detailed Description

Simplified, generic interface to Memory models.

Constructor & Destructor Documentation

SST::Interfaces::SimpleMem::SimpleMem	(	SST::ComponentId_t	id,
		Params &	UNUSEDparams
	)

inline

Constructor, designed to be used via 'loadUserSubComponent and loadAnonymousSubComponent'.

Member Function Documentation

virtual bool SST::Interfaces::SimpleMem::initialize	(	const std::string &	linkName,
		HandlerBase *	handler = `nullptr`
	)

pure virtual

Second half of building the interface.

Initialize with link name name, and handler, if any

Returns: true if the link was able to be configured.

virtual SST::Event* SST::Interfaces::SimpleMem::recvInitData ( )

inlinevirtual

Receive any data during the init() phase.

See Also: SST::Link::recvInitData()

References getLink(), and SST::Link::recvInitData().

virtual Request* SST::Interfaces::SimpleMem::recvResponse ( void )

pure virtual

Receive a Request response from the side of the link.

Use this method for polling-based applications. Register a handler for push-based notification of responses.

Returns: nullptr if nothing is available.; Pointer to a Request response (that should be deleted)

virtual void SST::Interfaces::SimpleMem::sendInitData ( SST::Event * ev )

inlinevirtual

Sends a generic Event during the init() phase (Mostly acts as a passthrough)

See Also: SST::Link::sendInitData()

References getLink(), and SST::Link::sendInitData().

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

src/sst/core/interfaces/simpleMem.h

Data Structures

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation