SST 15.0
Structural Simulation Toolkit
SST::Profile::EventHandlerProfileToolTime< T > Class Template Reference

Profile tool that will count the number of times a handler is called. More...

#include <eventHandlerProfileTool.h>

Inheritance diagram for SST::Profile::EventHandlerProfileToolTime< T >:
SST::Profile::EventHandlerProfileTool SST::Profile::ProfileTool SST::Link::AttachPoint

Public Member Functions

 EventHandlerProfileToolTime (const std::string &name, Params &params)
 
uintptr_t registerHandler (const AttachPointMetaData &mdata) override
 
uintptr_t registerLinkAttachTool (const AttachPointMetaData &mdata) override
 Function that will be called when an attach point is registered with the tool implementing the attach point.
 
void beforeHandler (uintptr_t UNUSED(key), const Event *UNUSED(event)) override
 
void afterHandler (uintptr_t key) override
 
void eventSent (uintptr_t key, Event *&UNUSED(ev)) override
 
void outputData (FILE *fp) override
 
- Public Member Functions inherited from SST::Profile::EventHandlerProfileTool
 SST_ELI_DOCUMENT_PARAMS ({ "level", "Level at which to track profile (global, type, component, subcomponent)", "type" }, { "track_ports", "Controls whether to track by individual ports", "false" }, { "profile_sends", "Controls whether sends are profiled (due to location of profiling point in the code, turning on send profiling will incur relatively high overhead)", "false" }, { "profile_receives", "Controls whether receives are profiled", "true" },) enum class Profile_Level
 
 EventHandlerProfileTool (const std::string &name, Params &params)
 
bool profileSends ()
 
bool profileReceives ()
 
void beforeHandler (uintptr_t UNUSED(key), const Event *UNUSED(event)) override
 
void afterHandler (uintptr_t UNUSED(key)) override
 
void eventSent (uintptr_t UNUSED(key), Event *&UNUSED(ev)) override
 
- Public Member Functions inherited from SST::Profile::ProfileTool
std::string getName ()
 

Additional Inherited Members

- Protected Member Functions inherited from SST::Profile::EventHandlerProfileTool
std::string getKeyForHandler (const AttachPointMetaData &mdata)
 
- Protected Attributes inherited from SST::Profile::EventHandlerProfileTool
Profile_Level profile_level_
 
bool track_ports_
 
bool profile_sends_
 
bool profile_receives_
 
- Protected Attributes inherited from SST::Profile::ProfileTool
const std::string name
 

Detailed Description

template<typename T>
class SST::Profile::EventHandlerProfileToolTime< T >

Profile tool that will count the number of times a handler is called.

Member Function Documentation

◆ outputData()

template<typename T>
void SST::Profile::EventHandlerProfileToolTime< T >::outputData ( FILE * fp)
overridevirtual

◆ registerLinkAttachTool()

template<typename T>
uintptr_t SST::Profile::EventHandlerProfileToolTime< T >::registerLinkAttachTool ( const AttachPointMetaData & mdata)
overridevirtual

Function that will be called when an attach point is registered with the tool implementing the attach point.

The metadata passed in will be dependent on what type of tool this is attached to. The uintptr_t returned from this function will be passed into the eventSent() function.

Parameters
mdataMetadata to be passed into the tool
Returns
Opaque key that will be passed back into eventSent() to identify the source of the call

Implements SST::Link::AttachPoint.


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