Link between two components. More...

#include <link.h>

Inheritance diagram for SST::Link:

Public Member Functions
void	addSendLatency (int cycles, const std::string &timebase)
	Set additional Latency to be added to events being sent out of this link. More...

void	addSendLatency (SimTime_t cycles, TimeConverter *timebase)
	Set additional Latency to be added to events being sent out of this link. More...

void	addRecvLatency (int cycles, const std::string &timebase)
	Set additional Latency to be added on to events coming in on this link. More...

void	addRecvLatency (SimTime_t cycles, TimeConverter *timebase)
	Set additional Latency to be added on to events coming in on this link. More...

void	setFunctor (Event::HandlerBase *functor)
	Set the callback function to be called when a message is delivered. More...

void	replaceFunctor (Event::HandlerBase *functor)
	Replace the callback function to be called when a message is delivered. More...

void	send (SimTime_t delay, TimeConverter tc, Event event)
	Send an event over the link with additional delay. More...

void	send (SimTime_t delay, Event *event)
	Send an event with additional delay. More...

void	send (Event *event)
	Send an event with the Link's default delay. More...

Event *	recv ()
	Retrieve a pending event from the Link. More...

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

TimeConverter *	getDefaultTimeBase ()
	Return the default Time Base for this link. More...

const TimeConverter *	getDefaultTimeBase () const
	Return the default Time Base for this link. More...

LinkId_t	getId ()
	Return the ID of this link. More...

void	sendUntimedData (Event *data)
	Send data during the init() or complete() phase. More...

Event *	recvUntimedData ()
	Receive an event (if any) during the init() or complete() phase. More...

void	sendInitData (Event *init_data)
	Send data during the init() or complete() phase. More...

Event *	recvInitData ()
	Receive an event (if any) during the init() or complete() phase. More...

bool	isConfigured ()
	Return whether link has been configured. More...

Protected Member Functions
void	setAsSyncLink ()

void	setDeliveryInfo (uintptr_t info)
	Set the delivery_info for the link.

void	send_impl (SimTime_t delay, Event *event)
	Send an event over the link with additional delay. More...

Protected Attributes
ActivityQueue *	send_queue
	Queue of events to be received by the owning component.

uintptr_t	delivery_info
	Holds the delivery information. More...

SimTime_t	defaultTimeBase
	Timebase used if no other timebase is specified. More...

SimTime_t	latency
	Latency of the link. More...

Link *	pair_link
	Pointer to the opposite side of this link.

Friends
class	LinkPair

class	RankSync

class	ThreadSync

class	Simulation_impl

class	SyncManager

class	ComponentInfo

class	BaseComponent

Detailed Description

Link between two components.

Carries events

Member Function Documentation

◆ addRecvLatency() [1/2]

void SST::Link::addRecvLatency	(	int	cycles,
		const std::string &	timebase
	)

Set additional Latency to be added on to events coming in on this link.

Parameters

cycles	Number of Cycles to be added
timebase	Base Units of cycles

References SST::TimeLord::getSimCycles(), SST::Simulation_impl::getSimulation(), SST::Simulation_impl::getTimeLord(), latency, and pair_link.

◆ addRecvLatency() [2/2]

void SST::Link::addRecvLatency	(	SimTime_t	cycles,
		TimeConverter *	timebase
	)

Set additional Latency to be added on to events coming in on this link.

Parameters

cycles	Number of Cycles to be added
timebase	Base Units of cycles

References SST::TimeConverter::convertToCoreTime(), latency, and pair_link.

◆ addSendLatency() [1/2]

void SST::Link::addSendLatency	(	int	cycles,
		const std::string &	timebase
	)

Set additional Latency to be added to events being sent out of this link.

Parameters

cycles	Number of Cycles to be added
timebase	Base Units of cycles

References SST::TimeLord::getSimCycles(), SST::Simulation_impl::getSimulation(), SST::Simulation_impl::getTimeLord(), and latency.

◆ addSendLatency() [2/2]

void SST::Link::addSendLatency	(	SimTime_t	cycles,
		TimeConverter *	timebase
	)

Set additional Latency to be added to events being sent out of this link.

Parameters

cycles	Number of Cycles to be added
timebase	Base Units of cycles

References SST::TimeConverter::convertToCoreTime(), and latency.

◆ getDefaultTimeBase() [1/2]

TimeConverter * SST::Link::getDefaultTimeBase ( )

Return the default Time Base for this link.

Returns: the default Time Base for this link

References defaultTimeBase, SST::Simulation_impl::getSimulation(), SST::TimeLord::getTimeConverter(), and SST::Simulation_impl::getTimeLord().

◆ getDefaultTimeBase() [2/2]

const TimeConverter * SST::Link::getDefaultTimeBase ( ) const

Return the default Time Base for this link.

Returns: the default Time Base for this link

References defaultTimeBase, SST::Simulation_impl::getSimulation(), SST::TimeLord::getTimeConverter(), and SST::Simulation_impl::getTimeLord().

◆ getId()

LinkId_t SST::Link::getId ( )

inline

Return the ID of this link.

Returns: the unique ID for this link

◆ isConfigured()

bool SST::Link::isConfigured ( )

inline

Return whether link has been configured.

Returns: whether link is configured

◆ recv()

Event * SST::Link::recv ( )

Retrieve a pending event from the Link.

For links which do not have a set event handler, they can be polled with this function. Returns nullptr if there is no pending event. Not available for HANDLER-type links.

Returns: Event if one is available; nullptr if no Event is available

References SST::ActivityQueue::empty(), SST::Output::fatal(), SST::ActivityQueue::front(), SST::Simulation::getCurrentSimCycle(), SST::Activity::getDeliveryTime(), SST::Simulation_impl::getSimulation(), SST::Simulation_impl::getSimulationOutput(), pair_link, SST::ActivityQueue::pop(), and send_queue.

◆ recvInitData()

Event* SST::Link::recvInitData ( )

inline

Receive an event (if any) during the init() or complete() phase.

Same as recvUntimedData()

Returns: Event if one is available; nullptr if no Event is available

References recvUntimedData().

◆ recvUntimedData()

Event * SST::Link::recvUntimedData ( )

Receive an event (if any) during the init() or complete() phase.

Returns: Event if one is available; nullptr if no Event is available

References SST::ActivityQueue::empty(), SST::ActivityQueue::front(), SST::Activity::getDeliveryTime(), SST::Simulation_impl::getSimulation(), pair_link, SST::ActivityQueue::pop(), and send_queue.

Referenced by recvInitData().

◆ replaceFunctor()

void SST::Link::replaceFunctor ( Event::HandlerBase * functor )

Replace the callback function to be called when a message is delivered.

Any previous handler will be deleted. Not available for Polling links.

Parameters

functor Functor to call when message is delivered

References delivery_info, SST::Output::fatal(), SST::Simulation_impl::getSimulation(), SST::Simulation_impl::getSimulationOutput(), and pair_link.

◆ send() [1/3]

void SST::Link::send	(	SimTime_t	delay,
		TimeConverter *	tc,
		Event *	event
	)

inline

Send an event over the link with additional delay.

Sends an event over a link with an additional delay specified with a TimeConverter. I.e. the total delay is the link's delay + the additional specified delay.

Parameters

delay	- additional delay
tc	- time converter to specify units for the additional delay
event	- the Event to send

References SST::TimeConverter::convertToCoreTime(), and send_impl().

◆ send() [2/3]

void SST::Link::send	(	SimTime_t	delay,
		Event *	event
	)

inline

Send an event with additional delay.

Sends an event over a link with additional delay specified by the Link's default timebase.

Parameters

delay	The additional delay, in units of the default Link timebase
event	The event to send

References defaultTimeBase, and send_impl().

◆ send() [3/3]

void SST::Link::send ( Event * event )

inline

Send an event with the Link's default delay.

Parameters

event The event to send

References send_impl().

◆ send_impl()

void SST::Link::send_impl	(	SimTime_t	delay,
		Event *	event
	)

protected

Send an event over the link with additional delay.

Sends an event over a link with an additional delay specified with a TimeConverter. I.e. the total delay is the link's delay + the additional specified delay.

Parameters

delay	- additional total delay to add
event	- the Event to send

References delivery_info, SST::Output::fatal(), SST::Simulation_impl::getSimulation(), SST::Simulation_impl::getSimulationOutput(), SST::ActivityQueue::insert(), latency, pair_link, and send_queue.

Referenced by send().

◆ sendInitData()

void SST::Link::sendInitData ( Event * init_data )

inline

Send data during the init() or complete() phase.

Same as sendUntimedData()

Parameters

init_data data to send

References sendUntimedData().

◆ sendUntimedData()

void SST::Link::sendUntimedData ( Event * data )

Send data during the init() or complete() phase.

Parameters

data	event to send

References delivery_info, SST::Output::fatal(), SST::Simulation_impl::getSimulation(), SST::Simulation_impl::getSimulationOutput(), SST::ActivityQueue::insert(), pair_link, send_queue, and SST::Activity::setDeliveryTime().

Referenced by sendInitData().

◆ setDefaultTimeBase()

void SST::Link::setDefaultTimeBase ( TimeConverter * tc )

Manually set the default detaulTimeBase.

Parameters

tc	TimeConverter object for the timebase

References defaultTimeBase, and SST::TimeConverter::getFactor().

Referenced by SST::BaseComponent::configureLink().

◆ setFunctor()

void SST::Link::setFunctor ( Event::HandlerBase * functor )

Set the callback function to be called when a message is delivered.

Not available for Polling links.

Parameters

functor Functor to call when message is delivered

References delivery_info, SST::Output::fatal(), SST::Simulation_impl::getSimulation(), SST::Simulation_impl::getSimulationOutput(), and pair_link.

Referenced by SST::BaseComponent::configureLink().

Field Documentation

◆ defaultTimeBase

SimTime_t SST::Link::defaultTimeBase

protected

Timebase used if no other timebase is specified.

Used to specify the units for added delays when sending, such as in Link::send(). Often set by the Component::registerClock() function if the regAll argument is true.

Referenced by getDefaultTimeBase(), send(), and setDefaultTimeBase().

◆ delivery_info

uintptr_t SST::Link::delivery_info

protected

Holds the delivery information.

This is stored as a uintptr_t, but is actually a pointer converted using reinterpret_cast. For links connected to a Component/SubComponent, this holds a pointer to the delivery functor. For links connected to a Sync object, this holds a pointer to the remote link to send the event on after synchronization.

Referenced by replaceFunctor(), send_impl(), sendUntimedData(), setDeliveryInfo(), and setFunctor().

◆ latency

SimTime_t SST::Link::latency

protected

Latency of the link.

It is used by the partitioner as the weight. This latency is added to the delay put on the event by the component.

Referenced by addRecvLatency(), addSendLatency(), and send_impl().

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

src/sst/core/link.h
src/sst/core/link.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Function Documentation

◆ addRecvLatency() [1/2]

◆ addRecvLatency() [2/2]

◆ addSendLatency() [1/2]

◆ addSendLatency() [2/2]

◆ getDefaultTimeBase() [1/2]

◆ getDefaultTimeBase() [2/2]

◆ getId()

◆ isConfigured()

◆ recv()

◆ recvInitData()

◆ recvUntimedData()

◆ replaceFunctor()

◆ send() [1/3]

◆ send() [2/3]

◆ send() [3/3]

◆ send_impl()

◆ sendInitData()

◆ sendUntimedData()

◆ setDefaultTimeBase()

◆ setFunctor()

Field Documentation

◆ defaultTimeBase

◆ delivery_info

◆ latency