23 #ifndef SCOREP_SUBSTRATE_PLUGINS_H
24 #define SCOREP_SUBSTRATE_PLUGINS_H
130 #define SCOREP_SUBSTRATE_PLUGIN_VERSION 3
133 #define SCOREP_SUBSTRATE_PLUGIN_UNDEFINED_MANAGEMENT_FUNCTIONS 99
137 # define EXTERN extern "C"
139 # define EXTERN extern
143 #define SCOREP_SUBSTRATE_PLUGIN_ENTRY( _name ) \
144 EXTERN SCOREP_SubstratePluginInfo \
145 SCOREP_SubstratePlugin_ ## _name ## _get_info( void )
163 const char* ( *SCOREP_GetExperimentDirName )( void );
401 const int* sendcounts,
420 ( *SCOREP_Location_GetName )(
const struct SCOREP_Location* locationData );
463 ( *SCOREP_Location_GetData )(
const struct SCOREP_Location* locationData,
479 SCOREP_CallingContextHandle
558 ( *SCOREP_ParameterHandle_GetName )( SCOREP_ParameterHandle handle );
693 ( *SCOREP_StringHandle_Get )( SCOREP_StringHandle handle );
735 const char* section );
742 const char* fileName,
743 const char* descriptionFormatString,
851 const struct SCOREP_Location* parentLocation );
864 const struct SCOREP_Location* parentLocation,
865 uint32_t forkSequenceCount );
876 const struct SCOREP_Location* parentLocation );
969 const char* relativeSourceDir,
970 const char* targetDir );
SCOREP_AnyHandle SCOREP_RegionHandle
Definition: SCOREP_PublicTypes.h:145
Defines public definitions that are used internally and externally (e.g., by metric plugins...
int(* SCOREP_Ipc_Allgather)(const void *sendbuf, void *recvbuf, int count, SCOREP_Ipc_Datatype datatype)
Definition: SCOREP_SubstratePlugins.h:317
bool(* SCOREP_SamplingSetHandle_IsScoped)(SCOREP_SamplingSetHandle handle)
Definition: SCOREP_SubstratePlugins.h:663
uint64_t(* SCOREP_Location_GetGlobalId)(const struct SCOREP_Location *locationData)
Definition: SCOREP_SubstratePlugins.h:439
Definition: SCOREP_SubstratePlugins.h:153
void(* core_task_create)(const struct SCOREP_Location *location, SCOREP_TaskHandle taskHandle)
Definition: SCOREP_SubstratePlugins.h:905
SCOREP_RegionType
specifies a Region
Definition: SCOREP_PublicTypes.h:471
int(* SCOREP_Ipc_Reduce)(const void *sendbuf, void *recvbuf, int count, SCOREP_Ipc_Datatype datatype, SCOREP_Ipc_Operation operation, int root)
Definition: SCOREP_SubstratePlugins.h:337
uint32_t SCOREP_LineNo
Definition: SCOREP_PublicTypes.h:75
SCOREP_HandleType
Definition: SCOREP_PublicHandles.h:50
SCOREP_CallingContextHandle(* SCOREP_CallingContextHandle_GetParent)(SCOREP_CallingContextHandle handle)
Definition: SCOREP_SubstratePlugins.h:480
int(* SCOREP_Ipc_Gather)(const void *sendbuf, void *recvbuf, int count, SCOREP_Ipc_Datatype datatype, int root)
Definition: SCOREP_SubstratePlugins.h:268
void(* SCOREP_Substrates_Callback)(void)
Definition: SCOREP_SubstrateEvents.h:46
void(* deactivate_cpu_location)(const struct SCOREP_Location *location, const struct SCOREP_Location *parentLocation)
Definition: SCOREP_SubstratePlugins.h:875
void(* write_data)(void)
Definition: SCOREP_SubstratePlugins.h:897
int(* SCOREP_Ipc_Bcast)(void *buf, int count, SCOREP_Ipc_Datatype datatype, int root)
Definition: SCOREP_SubstratePlugins.h:245
void(* SCOREP_Location_SetData)(const struct SCOREP_Location *locationData, size_t plugin_id, void *data)
Definition: SCOREP_SubstratePlugins.h:450
SCOREP_MetricSourceType(* SCOREP_MetricHandle_GetSourceType)(SCOREP_MetricHandle handle)
Definition: SCOREP_SubstratePlugins.h:524
int(* SCOREP_Ipc_Recv)(void *buf, int count, SCOREP_Ipc_Datatype datatype, int source)
Definition: SCOREP_SubstratePlugins.h:216
uint8_t(* SCOREP_SamplingSetHandle_GetNumberOfMetrics)(SCOREP_SamplingSetHandle handle)
Definition: SCOREP_SubstratePlugins.h:642
struct SCOREP_Task * SCOREP_TaskHandle
Definition: SCOREP_PublicTypes.h:172
SCOREP_MetricValueType
Definition: SCOREP_MetricTypes.h:97
void(* finalize)(void)
Definition: SCOREP_SubstratePlugins.h:825
int(* SCOREP_Ipc_GetSize)(void)
Definition: SCOREP_SubstratePlugins.h:172
SCOREP_MetricMode(* SCOREP_MetricHandle_GetMode)(SCOREP_MetricHandle handle)
Definition: SCOREP_SubstratePlugins.h:515
Description of the substrate plugin events header. For information on how to use substrate plugins...
uint32_t(* get_event_functions)(SCOREP_Substrates_Mode mode, SCOREP_Substrates_Callback **functions)
Definition: SCOREP_SubstratePlugins.h:942
int(* SCOREP_Ipc_Scatterv)(const void *sendbuf, const int *sendcounts, void *recvbuf, int recvcount, SCOREP_Ipc_Datatype datatype, int root)
Definition: SCOREP_SubstratePlugins.h:400
void(* SCOREP_Metric_WriteAsynchronousMetrics)(struct SCOREP_Location *location, SCOREP_Substrates_WriteMetricsCb cb)
Tell Score-P to write the current asynchronous metrics to cb.
Definition: SCOREP_SubstratePlugins.h:729
uint32_t plugin_version
Definition: SCOREP_SubstratePlugins.h:794
void(* dump_manifest)(FILE *manifestFile, const char *relativeSourceDir, const char *targetDir)
Definition: SCOREP_SubstratePlugins.h:968
SCOREP_MetricMode
Definition: SCOREP_MetricTypes.h:133
void(* core_task_complete)(const struct SCOREP_Location *location, SCOREP_TaskHandle taskHandle)
Definition: SCOREP_SubstratePlugins.h:915
void(* init_mpp)(void)
Definition: SCOREP_SubstratePlugins.h:820
SCOREP_AnyHandle SCOREP_SourceFileHandle
Definition: SCOREP_PublicTypes.h:108
SCOREP_LineNo(* SCOREP_RegionHandle_GetBeginLine)(SCOREP_RegionHandle handle)
Definition: SCOREP_SubstratePlugins.h:609
int(* SCOREP_Ipc_Send)(const void *buf, int count, SCOREP_Ipc_Datatype datatype, int dest)
Definition: SCOREP_SubstratePlugins.h:197
SCOREP_SamplingSetClass
Class of locations which recorded a sampling set.
Definition: SCOREP_PublicTypes.h:590
SCOREP_AnyHandle SCOREP_ParadigmHandle
Definition: SCOREP_PublicTypes.h:157
SCOREP_ParadigmClass(* SCOREP_ParadigmHandle_GetClass)(SCOREP_ParadigmHandle handle)
Definition: SCOREP_SubstratePlugins.h:533
void(* pre_unify)(void)
Definition: SCOREP_SubstratePlugins.h:890
SCOREP_Substrates_Mode
Definition: SCOREP_SubstrateEvents.h:55
SCOREP_Allocator_MovableMemory SCOREP_AnyHandle
Definition: SCOREP_PublicTypes.h:102
void(* SCOREP_ConfigManifestSectionHeader)(FILE *out, const char *section)
Create formated header in the manifest file.
Definition: SCOREP_SubstratePlugins.h:734
Description of definition handles. This header defines an enumeration to map SCOREP_AnyHandle to spec...
SCOREP_AnyHandle SCOREP_MetricHandle
Definition: SCOREP_PublicTypes.h:120
SCOREP_LocationType(* SCOREP_Location_GetType)(const struct SCOREP_Location *locationData)
Definition: SCOREP_SubstratePlugins.h:412
void(* activate_cpu_location)(const struct SCOREP_Location *location, const struct SCOREP_Location *parentLocation, uint32_t forkSequenceCount)
Definition: SCOREP_SubstratePlugins.h:863
SCOREP_MetricSourceType
Definition: SCOREP_MetricTypes.h:53
SCOREP_RegionHandle(* SCOREP_CallingContextHandle_GetRegion)(SCOREP_CallingContextHandle handle)
Definition: SCOREP_SubstratePlugins.h:472
SCOREP_Ipc_Datatype
specifies an inter process communication data types
Definition: SCOREP_PublicTypes.h:829
int(* SCOREP_Ipc_Allreduce)(const void *sendbuf, void *recvbuf, int count, SCOREP_Ipc_Datatype datatype, SCOREP_Ipc_Operation operation)
Definition: SCOREP_SubstratePlugins.h:359
SCOREP_MetricScope(* SCOREP_SamplingSetHandle_GetScope)(SCOREP_SamplingSetHandle handle)
Definition: SCOREP_SubstratePlugins.h:670
int(* SCOREP_Ipc_Scatter)(const void *sendbuf, void *recvbuf, int count, SCOREP_Ipc_Datatype datatype, int root)
Definition: SCOREP_SubstratePlugins.h:378
SCOREP_LineNo(* SCOREP_RegionHandle_GetEndLine)(SCOREP_RegionHandle handle)
Definition: SCOREP_SubstratePlugins.h:617
SCOREP_MetricValueType(* SCOREP_MetricHandle_GetValueType)(SCOREP_MetricHandle handle)
Definition: SCOREP_SubstratePlugins.h:489
SCOREP_ParadigmClass
defines classes of paradigms that are monitored Types:
Definition: SCOREP_PublicTypes.h:293
int(* init)(void)
Definition: SCOREP_SubstratePlugins.h:801
SCOREP_ParadigmType(* SCOREP_RegionHandle_GetParadigmType)(SCOREP_RegionHandle handle)
Definition: SCOREP_SubstratePlugins.h:635
SCOREP_RegionType(* SCOREP_RegionHandle_GetType)(SCOREP_RegionHandle handle)
Definition: SCOREP_SubstratePlugins.h:626
void(* SCOREP_Metric_WriteSynchronousMetrics)(struct SCOREP_Location *location, uint64_t timestamp, SCOREP_Substrates_WriteMetricsCb cb)
Tell Score-P to write the current synchronous metrics to cb.
Definition: SCOREP_SubstratePlugins.h:717
void(* SCOREP_Metric_WriteStrictlySynchronousMetrics)(struct SCOREP_Location *location, uint64_t timestamp, SCOREP_Substrates_WriteMetricsCb cb)
Tell Score-P to write the current strictly synchronous metrics to cb.
Definition: SCOREP_SubstratePlugins.h:704
bool(* get_requirement)(SCOREP_Substrates_RequirementFlag flag)
Definition: SCOREP_SubstratePlugins.h:962
int(* SCOREP_Ipc_GetRank)(void)
Definition: SCOREP_SubstratePlugins.h:182
SCOREP_Ipc_Operation
specifies an inter process communication operation for reduce function
Definition: SCOREP_PublicTypes.h:857
int(* SCOREP_Ipc_Gatherv)(const void *sendbuf, int sendcount, void *recvbuf, const int *recvcnts, SCOREP_Ipc_Datatype datatype, int root)
Definition: SCOREP_SubstratePlugins.h:294
void(* create_location)(const struct SCOREP_Location *location, const struct SCOREP_Location *parentLocation)
Definition: SCOREP_SubstratePlugins.h:850
SCOREP_ParadigmType(* SCOREP_ParadigmHandle_GetType)(SCOREP_ParadigmHandle handle)
Definition: SCOREP_SubstratePlugins.h:550
SCOREP_Substrates_RequirementFlag
Definition: SCOREP_PublicTypes.h:878
SCOREP_AnyHandle SCOREP_SamplingSetHandle
Definition: SCOREP_PublicTypes.h:133
SCOREP_MetricProfilingType
Definition: SCOREP_MetricTypes.h:76
uint32_t(* SCOREP_RegionHandle_GetId)(SCOREP_RegionHandle handle)
Definition: SCOREP_SubstratePlugins.h:577
uint32_t(* SCOREP_Location_GetId)(const struct SCOREP_Location *locationData)
Definition: SCOREP_SubstratePlugins.h:430
void(* assign_id)(size_t pluginId)
Definition: SCOREP_SubstratePlugins.h:813
Definition: SCOREP_SubstratePlugins.h:788
SCOREP_ParameterType(* SCOREP_ParameterHandle_GetType)(SCOREP_ParameterHandle handle)
Definition: SCOREP_SubstratePlugins.h:568
#define SCOREP_SUBSTRATE_PLUGIN_UNDEFINED_MANAGEMENT_FUNCTIONS
Definition: SCOREP_SubstratePlugins.h:133
void(* undeclared[SCOREP_SUBSTRATE_PLUGIN_UNDEFINED_MANAGEMENT_FUNCTIONS])(void)
Definition: SCOREP_SubstratePlugins.h:981
void(* delete_location)(const struct SCOREP_Location *location)
Definition: SCOREP_SubstratePlugins.h:884
void(* SCOREP_ConfigManifestSectionEntry)(FILE *out, const char *fileName, const char *descriptionFormatString,...)
Create formated entry in the manifest file consisting out of a name and a description, the latter in printf style and terminated with a period.
Definition: SCOREP_SubstratePlugins.h:741
void(* SCOREP_Substrates_WriteMetricsCb)(struct SCOREP_Location *location, uint64_t timestamp, SCOREP_SamplingSetHandle samplingSet, const uint64_t *metricValues)
Definition: SCOREP_SubstrateEvents.h:1469
SCOREP_MetricOccurrence(* SCOREP_SamplingSetHandle_GetMetricOccurrence)(SCOREP_SamplingSetHandle handle)
Definition: SCOREP_SubstratePlugins.h:656
void(* new_definition_handle)(SCOREP_AnyHandle handle, SCOREP_HandleType type)
Definition: SCOREP_SubstratePlugins.h:930
SCOREP_MetricScope
Types to be used in defining the scope of a scoped sampling set.
Definition: SCOREP_PublicTypes.h:602
int(* SCOREP_Ipc_Barrier)(void)
Definition: SCOREP_SubstratePlugins.h:230
SCOREP_MetricProfilingType(* SCOREP_MetricHandle_GetProfilingType)(SCOREP_MetricHandle handle)
Definition: SCOREP_SubstratePlugins.h:506
void(* set_callbacks)(const SCOREP_SubstratePluginCallbacks *callbacks, size_t size)
Definition: SCOREP_SubstratePlugins.h:950
SCOREP_ParadigmType
defines paradigms that are be monitored
Definition: SCOREP_PublicTypes.h:346
SCOREP_ParameterType
defines types to be used in defining a parameter for parameter based profiling (SCOREP_Definitions_Ne...
Definition: SCOREP_PublicTypes.h:363
SCOREP_SamplingSetClass(* SCOREP_SamplingSetHandle_GetSamplingSetClass)(SCOREP_SamplingSetHandle handle)
Definition: SCOREP_SubstratePlugins.h:677
SCOREP_MetricOccurrence
Types to be used in defining the occurrence of a sampling set.
Definition: SCOREP_PublicTypes.h:621
SCOREP_LocationType
Definition: SCOREP_PublicTypes.h:217