32 #ifndef OTF2_GENERAL_DEFINITIONS_H
33 #define OTF2_GENERAL_DEFINITIONS_H
65 #define OTF2_VERSION_MAJOR 3
67 #define OTF2_VERSION_MINOR 1
69 #define OTF2_VERSION_BUGFIX 0
71 #define OTF2_VERSION_SUFFIX "rc3"
73 #define OTF2_VERSION "3.1-rc3"
83 #define OTF2_UNDEFINED_UINT8 ( ( uint8_t )( ~( ( uint8_t )0u ) ) )
85 #define OTF2_UNDEFINED_INT8 ( ( int8_t )( ~( OTF2_UNDEFINED_UINT8 >> 1 ) ) )
87 #define OTF2_UNDEFINED_UINT16 ( ( uint16_t )( ~( ( uint16_t )0u ) ) )
89 #define OTF2_UNDEFINED_INT16 ( ( int16_t )( ~( OTF2_UNDEFINED_UINT16 >> 1 ) ) )
91 #define OTF2_UNDEFINED_UINT32 ( ( uint32_t )( ~( ( uint32_t )0u ) ) )
93 #define OTF2_UNDEFINED_INT32 ( ( int32_t )( ~( OTF2_UNDEFINED_UINT32 >> 1 ) ) )
95 #define OTF2_UNDEFINED_UINT64 ( ( uint64_t )( ~( ( uint64_t )0u ) ) )
97 #define OTF2_UNDEFINED_INT64 ( ( int64_t )( ~( OTF2_UNDEFINED_UINT64 >> 1 ) ) )
102 #define OTF2_UNDEFINED_TYPE OTF2_UNDEFINED_UINT8
108 #define OTF2_UNDEFINED_TIMESTAMP OTF2_UNDEFINED_UINT64
114 #define OTF2_UNDEFINED_IO_PARADIGM ( ( OTF2_IoParadigmRef )OTF2_UNDEFINED_UINT8 )
120 #define OTF2_UNDEFINED_STRING ( ( OTF2_StringRef )OTF2_UNDEFINED_UINT32 )
126 #define OTF2_UNDEFINED_ATTRIBUTE ( ( OTF2_AttributeRef )OTF2_UNDEFINED_UINT32 )
132 #define OTF2_UNDEFINED_SYSTEM_TREE_NODE ( ( OTF2_SystemTreeNodeRef )OTF2_UNDEFINED_UINT32 )
138 #define OTF2_UNDEFINED_LOCATION_GROUP ( ( OTF2_LocationGroupRef )OTF2_UNDEFINED_UINT32 )
144 #define OTF2_UNDEFINED_LOCATION ( ( OTF2_LocationRef )OTF2_UNDEFINED_UINT64 )
150 #define OTF2_UNDEFINED_REGION ( ( OTF2_RegionRef )OTF2_UNDEFINED_UINT32 )
156 #define OTF2_UNDEFINED_CALLSITE ( ( OTF2_CallsiteRef )OTF2_UNDEFINED_UINT32 )
162 #define OTF2_UNDEFINED_CALLPATH ( ( OTF2_CallpathRef )OTF2_UNDEFINED_UINT32 )
168 #define OTF2_UNDEFINED_GROUP ( ( OTF2_GroupRef )OTF2_UNDEFINED_UINT32 )
174 #define OTF2_UNDEFINED_METRIC_MEMBER ( ( OTF2_MetricMemberRef )OTF2_UNDEFINED_UINT32 )
180 #define OTF2_UNDEFINED_METRIC ( ( OTF2_MetricRef )OTF2_UNDEFINED_UINT32 )
186 #define OTF2_UNDEFINED_COMM ( ( OTF2_CommRef )OTF2_UNDEFINED_UINT32 )
192 #define OTF2_UNDEFINED_PARAMETER ( ( OTF2_ParameterRef )OTF2_UNDEFINED_UINT32 )
198 #define OTF2_UNDEFINED_RMA_WIN ( ( OTF2_RmaWinRef )OTF2_UNDEFINED_UINT32 )
204 #define OTF2_UNDEFINED_CART_DIMENSION ( ( OTF2_CartDimensionRef )OTF2_UNDEFINED_UINT32 )
210 #define OTF2_UNDEFINED_CART_TOPOLOGY ( ( OTF2_CartTopologyRef )OTF2_UNDEFINED_UINT32 )
216 #define OTF2_UNDEFINED_SOURCE_CODE_LOCATION ( ( OTF2_SourceCodeLocationRef )OTF2_UNDEFINED_UINT32 )
222 #define OTF2_UNDEFINED_CALLING_CONTEXT ( ( OTF2_CallingContextRef )OTF2_UNDEFINED_UINT32 )
228 #define OTF2_UNDEFINED_INTERRUPT_GENERATOR ( ( OTF2_InterruptGeneratorRef )OTF2_UNDEFINED_UINT32 )
234 #define OTF2_UNDEFINED_IO_FILE ( ( OTF2_IoFileRef )OTF2_UNDEFINED_UINT32 )
240 #define OTF2_UNDEFINED_IO_HANDLE ( ( OTF2_IoHandleRef )OTF2_UNDEFINED_UINT32 )
278 #define OTF2_CHUNK_SIZE_MIN ( uint64_t )( 256 * 1024 )
282 #define OTF2_CHUNK_SIZE_MAX ( uint64_t )( 1024 * 1024 * 16 )
349 typedef enum OTF2_CallbackCode_enum
Represents the type for a marker file (.marker).
Definition: OTF2_GeneralDefinitions.h:468
Mapping of Attribute identifiers.
Definition: OTF2_GeneralDefinitions.h:521
struct OTF2_MarkerReader_struct OTF2_MarkerReader
OTF2 marker reader handle.
Definition: OTF2_GeneralDefinitions.h:271
OTF2_FlushType_enum
Defines whether the recorded data is flushed to a file or not.
Definition: OTF2_GeneralDefinitions.h:376
Mapping of Comm identifiers.
Definition: OTF2_GeneralDefinitions.h:711
The measurement software.
Definition: OTF2_GeneralDefinitions.h:823
64-bit floating point value
Definition: OTF2_GeneralDefinitions.h:669
struct OTF2_GlobalDefReader_struct OTF2_GlobalDefReader
OTF2 global definition reader handle.
Definition: OTF2_GeneralDefinitions.h:259
Record reading can continue.
Definition: OTF2_GeneralDefinitions.h:352
A communication paradigm across multiple processes.
Definition: OTF2_GeneralDefinitions.h:997
Unsigned 16-bit integer.
Definition: OTF2_GeneralDefinitions.h:621
Mapping of Location identifiers.
Definition: OTF2_GeneralDefinitions.h:525
Mapping of LocationGroup identifiers.
Definition: OTF2_GeneralDefinitions.h:587
uint64_t OTF2_LocationRef
Type used to indicate a reference to a Location definition.
Definition: OTF2_GeneralDefinitions.h:142
uint8_t OTF2_ParadigmProperty
Wrapper for enum OTF2_ParadigmProperty_enum.
Definition: OTF2_GeneralDefinitions.h:1014
Signed 8-bit integer.
Definition: OTF2_GeneralDefinitions.h:639
uint8_t OTF2_Type
Wrapper for enum OTF2_Type_enum.
Definition: OTF2_GeneralDefinitions.h:596
uint8_t OTF2_FileType
Wrapper for enum OTF2_FileType_enum.
Definition: OTF2_GeneralDefinitions.h:433
A threading paradigm which uses the create/wait model.
Definition: OTF2_GeneralDefinitions.h:1005
Definition: OTF2_GeneralDefinitions.h:296
Mapping of RmaWin identifiers.
Definition: OTF2_GeneralDefinitions.h:551
Unsigned 32-bit integer.
Definition: OTF2_GeneralDefinitions.h:627
uint8_t OTF2_Paradigm
Wrapper for enum OTF2_Paradigm_enum.
Definition: OTF2_GeneralDefinitions.h:778
Unified Parallel C (UPC).
Definition: OTF2_GeneralDefinitions.h:869
uint32_t OTF2_StringRef
Type used to indicate a reference to a String definition.
Definition: OTF2_GeneralDefinitions.h:118
uint8_t OTF2_IoParadigmRef
Type used to indicate a reference to a IoParadigm definition.
Definition: OTF2_GeneralDefinitions.h:112
uint8_t OTF2_MappingType
Wrapper for enum OTF2_MappingType_enum.
Definition: OTF2_GeneralDefinitions.h:506
Mapping of Attribute identifiers.
Definition: OTF2_GeneralDefinitions.h:681
Multicore Task API functions.
Definition: OTF2_GeneralDefinitions.h:936
Represents the type for the anchor file (.otf2).
Definition: OTF2_GeneralDefinitions.h:444
User instrumentation.
Definition: OTF2_GeneralDefinitions.h:794
Kokkos API functions and kernels.
Definition: OTF2_GeneralDefinitions.h:972
uint32_t OTF2_ParameterRef
Type used to indicate a reference to a Parameter definition.
Definition: OTF2_GeneralDefinitions.h:190
Do not use any file interface. No data is written to a file.
Definition: OTF2_GeneralDefinitions.h:501
Represents the type for a event file (.evt).
Definition: OTF2_GeneralDefinitions.h:456
Mapping of IoFile identifiers.
Definition: OTF2_GeneralDefinitions.h:757
OpenCL API functions and kernels.
Definition: OTF2_GeneralDefinitions.h:928
False.
Definition: OTF2_GeneralDefinitions.h:424
uint8_t OTF2_Hint
Wrapper for enum OTF2_Hint_enum.
Definition: OTF2_GeneralDefinitions.h:386
HMPP.
Definition: OTF2_GeneralDefinitions.h:839
Mapping of Group identifiers.
Definition: OTF2_GeneralDefinitions.h:699
OTF2_Boolean_enum
A boolean.
Definition: OTF2_GeneralDefinitions.h:420
Mapping of Metric identifiers.
Definition: OTF2_GeneralDefinitions.h:537
Mapping of Region identifiers.
Definition: OTF2_GeneralDefinitions.h:529
Compiler instrumentation.
Definition: OTF2_GeneralDefinitions.h:798
OTF2_ParadigmProperty_enum
List of paradigm properties.
Definition: OTF2_GeneralDefinitions.h:1021
Template for unnamed RmaWin definitions. A unique name can be derived by replacing '${id}' with a uni...
Definition: OTF2_GeneralDefinitions.h:1035
CUDA.
Definition: OTF2_GeneralDefinitions.h:817
Mapping of CallingContext identifiers.
Definition: OTF2_GeneralDefinitions.h:741
Definition: OTF2_GeneralDefinitions.h:408
A threading paradigm which uses the fork/join model.
Definition: OTF2_GeneralDefinitions.h:1001
uint32_t OTF2_InterruptGeneratorRef
Type used to indicate a reference to a InterruptGenerator definition.
Definition: OTF2_GeneralDefinitions.h:226
OTF2_ThumbnailType_enum
Type of definitions used as metric in a thumbnail.
Definition: OTF2_GeneralDefinitions.h:1055
Mapping of Group identifiers.
Definition: OTF2_GeneralDefinitions.h:533
Undefined.
Definition: OTF2_GeneralDefinitions.h:488
Mapping of String identifiers.
Definition: OTF2_GeneralDefinitions.h:517
The referenced definitions are of type Region.
Definition: OTF2_GeneralDefinitions.h:1059
TBB threads.
Definition: OTF2_GeneralDefinitions.h:910
uint8_t OTF2_ParadigmClass
Wrapper for enum OTF2_ParadigmClass_enum.
Definition: OTF2_GeneralDefinitions.h:986
Represents the type for a thumb file (.thumb).
Definition: OTF2_GeneralDefinitions.h:464
OTF2_Compression_enum
Defines which compression is used.
Definition: OTF2_GeneralDefinitions.h:308
Interrupt record reading.
Definition: OTF2_GeneralDefinitions.h:360
HIP API functions and kernels.
Definition: OTF2_GeneralDefinitions.h:963
uint8_t OTF2_ThumbnailType
Wrapper for enum OTF2_ThumbnailType_enum.
Definition: OTF2_GeneralDefinitions.h:1048
uint64_t OTF2_TimeStamp
OTF2 time stamp.
Definition: OTF2_GeneralDefinitions.h:106
Mapping of InterruptGenerator identifiers.
Definition: OTF2_GeneralDefinitions.h:749
POSIX threads.
Definition: OTF2_GeneralDefinitions.h:831
uint32_t OTF2_MetricMemberRef
Type used to indicate a reference to a MetricMember definition.
Definition: OTF2_GeneralDefinitions.h:172
OTF2_Hint_enum
List of possible hints.
Definition: OTF2_GeneralDefinitions.h:393
uint32_t OTF2_IoHandleRef
Type used to indicate a reference to a IoHandle definition.
Definition: OTF2_GeneralDefinitions.h:238
uint8_t OTF2_FlushType
Defines whether the recorded data is flushed to a file or not. Please see OTF2_FlushType_enum for a d...
Definition: OTF2_GeneralDefinitions.h:372
Mapping of IoFile identifiers.
Definition: OTF2_GeneralDefinitions.h:575
OpenACC directives.
Definition: OTF2_GeneralDefinitions.h:919
Max entry.
Definition: OTF2_GeneralDefinitions.h:591
An unknown paradigm.
Definition: OTF2_GeneralDefinitions.h:790
uint32_t OTF2_MetricRef
Type used to indicate a reference to a MetricClass, or a MetricInstance definition.
Definition: OTF2_GeneralDefinitions.h:178
Use the interface of the SIONlib to write many logical files into few physical files.
Definition: OTF2_GeneralDefinitions.h:497
The referenced definitions are of type IoHandle.
Definition: OTF2_GeneralDefinitions.h:1085
Attests that this parallel paradigm only uses RmaWin definitions. The Comm definitions exists only fo...
Definition: OTF2_GeneralDefinitions.h:1043
Recorded data is flushed when running out of memory.
Definition: OTF2_GeneralDefinitions.h:381
Unsigned 64-bit integer.
Definition: OTF2_GeneralDefinitions.h:633
MPI.
Definition: OTF2_GeneralDefinitions.h:810
Mapping of RmaWin identifiers.
Definition: OTF2_GeneralDefinitions.h:725
OTF2_CallbackCode
Return value to indicate that the record reading should be interrupted.
Definition: OTF2_GeneralDefinitions.h:349
Undefined type.
Definition: OTF2_GeneralDefinitions.h:609
Use zlib compression.
Definition: OTF2_GeneralDefinitions.h:317
Qt threads.
Definition: OTF2_GeneralDefinitions.h:894
struct OTF2_SnapReader_struct OTF2_SnapReader
OTF2 local snap reader handle.
Definition: OTF2_GeneralDefinitions.h:263
uint32_t OTF2_CallingContextRef
Type used to indicate a reference to a CallingContext definition.
Definition: OTF2_GeneralDefinitions.h:220
The referenced definitions are of type Comm.
Definition: OTF2_GeneralDefinitions.h:1073
struct OTF2_GlobalSnapReader_struct OTF2_GlobalSnapReader
OTF2 global snap reader handle.
Definition: OTF2_GeneralDefinitions.h:267
OTF2_ParadigmClass_enum
List of paradigm classes.
Definition: OTF2_GeneralDefinitions.h:993
Windows threads.
Definition: OTF2_GeneralDefinitions.h:886
Undefined.
Definition: OTF2_GeneralDefinitions.h:311
Signaling an error in the callback.
Definition: OTF2_GeneralDefinitions.h:363
Mapping of String identifiers.
Definition: OTF2_GeneralDefinitions.h:675
OTF2_FileSubstrate_enum
Defines which file substrate is used.
Definition: OTF2_GeneralDefinitions.h:484
OpenMP target functions and kernels.
Definition: OTF2_GeneralDefinitions.h:981
Compiler feature test macros.
Mapping of IoHandle identifiers.
Definition: OTF2_GeneralDefinitions.h:581
OTF2_MappingType_enum
Possible mappings from local to global identifiers.
Definition: OTF2_GeneralDefinitions.h:513
Mapping of Region identifiers.
Definition: OTF2_GeneralDefinitions.h:693
Use standard posix file interface.
Definition: OTF2_GeneralDefinitions.h:492
struct OTF2_DefReader_struct OTF2_DefReader
OTF2 local definition reader handle.
Definition: OTF2_GeneralDefinitions.h:255
uint8_t OTF2_Boolean
Wrapper for enum OTF2_Boolean_enum.
Definition: OTF2_GeneralDefinitions.h:413
uint32_t OTF2_IoFileRef
Type used to indicate a reference to a IoRegularFile, or a IoDirectory definition.
Definition: OTF2_GeneralDefinitions.h:232
Internal file which holds the SION rank map (.srm).
Definition: OTF2_GeneralDefinitions.h:472
OmpSs.
Definition: OTF2_GeneralDefinitions.h:847
uint32_t OTF2_SystemTreeNodeRef
Type used to indicate a reference to a SystemTreeNode definition.
Definition: OTF2_GeneralDefinitions.h:130
OpenMP.
Definition: OTF2_GeneralDefinitions.h:804
OTF2_FileMode_enum
Defines how to interact with files.
Definition: OTF2_GeneralDefinitions.h:291
Mapping of Comm identifiers.
Definition: OTF2_GeneralDefinitions.h:541
The referenced definitions are of type RmaWin.
Definition: OTF2_GeneralDefinitions.h:1079
uint32_t OTF2_CartTopologyRef
Type used to indicate a reference to a CartTopology definition.
Definition: OTF2_GeneralDefinitions.h:208
Hardware.
Definition: OTF2_GeneralDefinitions.h:853
Entity does not belong to any specific paradigm.
Definition: OTF2_GeneralDefinitions.h:954
uint8_t OTF2_FileSubstrate
Wrapper for enum OTF2_FileSubstrate_enum.
Definition: OTF2_GeneralDefinitions.h:477
No compression is used.
Definition: OTF2_GeneralDefinitions.h:313
The referenced definitions are of type Attribute.
Definition: OTF2_GeneralDefinitions.h:1067
uint8_t OTF2_Compression
Defines which compression is used. Please see OTF2_Compression_enum for a detailed description...
Definition: OTF2_GeneralDefinitions.h:304
Template for unnamed Comm definitions. A unique name can be derived by replacing '${id}' with a uniqu...
Definition: OTF2_GeneralDefinitions.h:1028
Mapping of InterruptGenerator identifiers.
Definition: OTF2_GeneralDefinitions.h:569
uint32_t OTF2_SourceCodeLocationRef
Type used to indicate a reference to a SourceCodeLocation definition.
Definition: OTF2_GeneralDefinitions.h:214
Mapping of SourceCodeLocation identifiers.
Definition: OTF2_GeneralDefinitions.h:557
Represents the type for the global definition file (.def).
Definition: OTF2_GeneralDefinitions.h:448
uint32_t OTF2_CartDimensionRef
Type used to indicate a reference to a CartDimension definition.
Definition: OTF2_GeneralDefinitions.h:202
Definition: OTF2_GeneralDefinitions.h:298
uint32_t OTF2_CommRef
Type used to indicate a reference to a Comm, or a InterComm definition.
Definition: OTF2_GeneralDefinitions.h:184
Mapping of CallingContext identifiers.
Definition: OTF2_GeneralDefinitions.h:563
Represents the type for a local definition file (.def).
Definition: OTF2_GeneralDefinitions.h:452
uint32_t OTF2_RegionRef
Type used to indicate a reference to a Region definition.
Definition: OTF2_GeneralDefinitions.h:148
Functions recorded by sampling, not by any means of instrumentation.
Definition: OTF2_GeneralDefinitions.h:948
Mapping of LocationGroup identifiers.
Definition: OTF2_GeneralDefinitions.h:773
32-bit floating point value
Definition: OTF2_GeneralDefinitions.h:663
Mapping of Location identifiers.
Definition: OTF2_GeneralDefinitions.h:687
Unsigned 8-bit integer.
Definition: OTF2_GeneralDefinitions.h:615
The referenced definitions are of type MetricMember.
Definition: OTF2_GeneralDefinitions.h:1063
Signed 32-bit integer.
Definition: OTF2_GeneralDefinitions.h:651
Definition: OTF2_GeneralDefinitions.h:294
True.
Definition: OTF2_GeneralDefinitions.h:428
uint32_t OTF2_GroupRef
Type used to indicate a reference to a Group definition.
Definition: OTF2_GeneralDefinitions.h:166
uint8_t OTF2_FileMode
Defines how to interact with files. Please see OTF2_FileMode_enum for a detailed description.
Definition: OTF2_GeneralDefinitions.h:287
ACE threads.
Definition: OTF2_GeneralDefinitions.h:902
OTF2_Paradigm_enum
List of known paradigms. Parallel paradigms have their expected paradigm class and known paradigm pro...
Definition: OTF2_GeneralDefinitions.h:786
Mapping of Parameter identifiers.
Definition: OTF2_GeneralDefinitions.h:545
Mapping of SourceCodeLocation identifiers.
Definition: OTF2_GeneralDefinitions.h:733
Mapping of Parameter identifiers.
Definition: OTF2_GeneralDefinitions.h:717
uint32_t OTF2_AttributeRef
Type used to indicate a reference to a Attribute definition.
Definition: OTF2_GeneralDefinitions.h:124
GASPI.
Definition: OTF2_GeneralDefinitions.h:861
Signed 16-bit integer.
Definition: OTF2_GeneralDefinitions.h:645
Mapping of Metric identifiers.
Definition: OTF2_GeneralDefinitions.h:705
Error codes and error handling.
SGI SHMEM, Cray SHMEM, OpenSHMEM.
Definition: OTF2_GeneralDefinitions.h:878
A paradigm which uses external accelerators to offload computation.
Definition: OTF2_GeneralDefinitions.h:1009
Flushing will be suppressed when running out of memory.
Definition: OTF2_GeneralDefinitions.h:379
OTF2_FileType_enum
Defines which file type is used.
Definition: OTF2_GeneralDefinitions.h:440
uint32_t OTF2_RmaWinRef
Type used to indicate a reference to a RmaWin definition.
Definition: OTF2_GeneralDefinitions.h:196
struct OTF2_EvtReader_struct OTF2_EvtReader
OTF2 local event reader handle.
Definition: OTF2_GeneralDefinitions.h:247
Represents the type for a snapshot file (.snap).
Definition: OTF2_GeneralDefinitions.h:460
struct OTF2_GlobalEvtReader_struct OTF2_GlobalEvtReader
OTF2 global event reader handle.
Definition: OTF2_GeneralDefinitions.h:251
Signed 64-bit integer.
Definition: OTF2_GeneralDefinitions.h:657
OTF2_Type_enum
OTF2 basic data types.
Definition: OTF2_GeneralDefinitions.h:603
uint32_t OTF2_CallpathRef
Type used to indicate a reference to a Callpath definition.
Definition: OTF2_GeneralDefinitions.h:160
Mapping of IoHandle identifiers.
Definition: OTF2_GeneralDefinitions.h:765
uint32_t OTF2_CallsiteRef
Type used to indicate a reference to a Callsite definition.
Definition: OTF2_GeneralDefinitions.h:154
uint32_t OTF2_LocationGroupRef
Type used to indicate a reference to a LocationGroup definition.
Definition: OTF2_GeneralDefinitions.h:136