7.0 (revision 7784de1c)
SCOREP_User.h File Reference

This file contains the interface for the manual user instrumentation. More...

#include <scorep/SCOREP_User_Variables.h>
#include <scorep/SCOREP_User_Functions.h>

Go to the source code of this file.

Macros

Macros for region instrumentation
#define SCOREP_USER_FUNC_DEFINE()
 
#define SCOREP_USER_OA_PHASE_BEGIN(handle, name, type)
 
#define SCOREP_USER_OA_PHASE_END(handle)   SCOREP_User_OaPhaseEnd( handle );
 
#define SCOREP_USER_REGION_DEFINE(handle)   static SCOREP_User_RegionHandle handle = SCOREP_USER_INVALID_REGION;
 
#define SCOREP_USER_REGION_ENTER(handle)   SCOREP_User_RegionEnter( handle );
 
#define SCOREP_USER_REGION_BEGIN(handle, name, type)
 
#define SCOREP_USER_REGION_INIT(handle, name, type)
 
#define SCOREP_USER_REGION_END(handle)   SCOREP_User_RegionEnd( handle );
 
#define SCOREP_USER_FUNC_BEGIN()
 
#define SCOREP_USER_FUNC_END()   SCOREP_User_RegionEnd( scorep_user_func_handle );
 
#define SCOREP_USER_GLOBAL_REGION_DEFINE(handle)   SCOREP_User_RegionHandle handle = SCOREP_USER_INVALID_REGION;
 
#define SCOREP_USER_GLOBAL_REGION_EXTERNAL(handle)   extern SCOREP_User_RegionHandle handle;
 
Macros for parameter instrumentation
#define SCOREP_USER_PARAMETER_INT64(name, value)
 
#define SCOREP_USER_PARAMETER_UINT64(name, value)
 
#define SCOREP_USER_PARAMETER_STRING(name, value)
 
Macros to provide user metrics
#define SCOREP_USER_METRIC_LOCAL(metricHandle)
 
#define SCOREP_USER_METRIC_GLOBAL(metricHandle)
 
#define SCOREP_USER_METRIC_EXTERNAL(metricHandle)   extern SCOREP_SamplingSetHandle metricHandle;
 
#define SCOREP_USER_METRIC_INIT(metricHandle, name, unit, type, context)   SCOREP_User_InitMetric( &metricHandle, name, unit, type, context );
 
#define SCOREP_USER_METRIC_INT64(metricHandle, value)
 
#define SCOREP_USER_METRIC_UINT64(metricHandle, value)
 
#define SCOREP_USER_METRIC_DOUBLE(metricHandle, value)
 
Macros for creation of user topologies
#define SCOREP_USER_CARTESIAN_TOPOLOGY_CREATE(userTopology, name, nDims)
 
#define SCOREP_USER_CARTESIAN_TOPOLOGY_ADD_DIM(userTopology, size, periodic, name)   SCOREP_User_CartTopologyAddDim( userTopology, size, periodic, name );
 
#define SCOREP_USER_CARTESIAN_TOPOLOGY_INIT(userTopology)   SCOREP_User_CartTopologyInit( userTopology );
 
#define SCOREP_USER_CARTESIAN_TOPOLOGY_SET_COORDS(userTopology, nDims, ...)   SCOREP_User_CartTopologySetCoords( userTopology, nDims, __VA_ARGS__ );
 
#define SCOREP_USER_CARTESIAN_TOPOLOGY_DEFINE(userTopology)
 
C++ specific macros for region instrumentation
#define SCOREP_USER_REGION(name, type)
 
Macros for measurement control
#define SCOREP_RECORDING_ON()   SCOREP_User_EnableRecording();
 
#define SCOREP_RECORDING_OFF()   SCOREP_User_DisableRecording();
 
#define SCOREP_RECORDING_IS_ON()   SCOREP_User_RecordingEnabled()
 

Detailed Description

This file contains the interface for the manual user instrumentation.