32 #ifndef OTF2_GENERAL_DEFINITIONS_H
33 #define OTF2_GENERAL_DEFINITIONS_H
62 #define OTF2_VERSION_MAJOR 2
64 #define OTF2_VERSION_MINOR 0
66 #define OTF2_VERSION_BUGFIX 0
68 #define OTF2_VERSION_SUFFIX ""
70 #define OTF2_VERSION "2.0"
80 #define OTF2_UNDEFINED_UINT8 ( ( uint8_t )( ~( ( uint8_t )0u ) ) )
82 #define OTF2_UNDEFINED_UINT16 ( ( uint16_t )( ~( ( uint16_t )0u ) ) )
84 #define OTF2_UNDEFINED_UINT32 ( ( uint32_t )( ~( ( uint32_t )0u ) ) )
86 #define OTF2_UNDEFINED_UINT64 ( ( uint64_t )( ~( ( uint64_t )0u ) ) )
91 #define OTF2_UNDEFINED_TYPE OTF2_UNDEFINED_UINT8
97 #define OTF2_UNDEFINED_TIMESTAMP OTF2_UNDEFINED_UINT64
103 #define OTF2_UNDEFINED_STRING ( ( OTF2_StringRef )OTF2_UNDEFINED_UINT32 )
109 #define OTF2_UNDEFINED_ATTRIBUTE ( ( OTF2_AttributeRef )OTF2_UNDEFINED_UINT32 )
115 #define OTF2_UNDEFINED_SYSTEM_TREE_NODE ( ( OTF2_SystemTreeNodeRef )OTF2_UNDEFINED_UINT32 )
121 #define OTF2_UNDEFINED_LOCATION_GROUP ( ( OTF2_LocationGroupRef )OTF2_UNDEFINED_UINT32 )
127 #define OTF2_UNDEFINED_LOCATION ( ( OTF2_LocationRef )OTF2_UNDEFINED_UINT64 )
133 #define OTF2_UNDEFINED_REGION ( ( OTF2_RegionRef )OTF2_UNDEFINED_UINT32 )
139 #define OTF2_UNDEFINED_CALLSITE ( ( OTF2_CallsiteRef )OTF2_UNDEFINED_UINT32 )
145 #define OTF2_UNDEFINED_CALLPATH ( ( OTF2_CallpathRef )OTF2_UNDEFINED_UINT32 )
151 #define OTF2_UNDEFINED_GROUP ( ( OTF2_GroupRef )OTF2_UNDEFINED_UINT32 )
157 #define OTF2_UNDEFINED_METRIC_MEMBER ( ( OTF2_MetricMemberRef )OTF2_UNDEFINED_UINT32 )
163 #define OTF2_UNDEFINED_METRIC ( ( OTF2_MetricRef )OTF2_UNDEFINED_UINT32 )
169 #define OTF2_UNDEFINED_COMM ( ( OTF2_CommRef )OTF2_UNDEFINED_UINT32 )
175 #define OTF2_UNDEFINED_PARAMETER ( ( OTF2_ParameterRef )OTF2_UNDEFINED_UINT32 )
181 #define OTF2_UNDEFINED_RMA_WIN ( ( OTF2_RmaWinRef )OTF2_UNDEFINED_UINT32 )
187 #define OTF2_UNDEFINED_CART_DIMENSION ( ( OTF2_CartDimensionRef )OTF2_UNDEFINED_UINT32 )
193 #define OTF2_UNDEFINED_CART_TOPOLOGY ( ( OTF2_CartTopologyRef )OTF2_UNDEFINED_UINT32 )
199 #define OTF2_UNDEFINED_SOURCE_CODE_LOCATION ( ( OTF2_SourceCodeLocationRef )OTF2_UNDEFINED_UINT32 )
205 #define OTF2_UNDEFINED_CALLING_CONTEXT ( ( OTF2_CallingContextRef )OTF2_UNDEFINED_UINT32 )
211 #define OTF2_UNDEFINED_INTERRUPT_GENERATOR ( ( OTF2_InterruptGeneratorRef )OTF2_UNDEFINED_UINT32 )
249 #define OTF2_CHUNK_SIZE_MIN ( uint64_t )( 256 * 1024 )
253 #define OTF2_CHUNK_SIZE_MAX ( uint64_t )( 1024 * 1024 * 16 )
318 typedef enum OTF2_CallbackCode_enum
Represents the type for a marker file (.marker).
Definition: OTF2_GeneralDefinitions.h:430
Mapping of Attribute identifiers.
Definition: OTF2_GeneralDefinitions.h:478
struct OTF2_MarkerReader_struct OTF2_MarkerReader
OTF2 marker reader handle.
Definition: OTF2_GeneralDefinitions.h:242
OTF2_FlushType_enum
Defines whether the recorded data is flushed to a file or not.
Definition: OTF2_GeneralDefinitions.h:345
Mapping of Comm identifiers.
Definition: OTF2_GeneralDefinitions.h:623
The measurement software.
Definition: OTF2_GeneralDefinitions.h:700
64-bit floating point value
Definition: OTF2_GeneralDefinitions.h:588
struct OTF2_GlobalDefReader_struct OTF2_GlobalDefReader
OTF2 global definition reader handle.
Definition: OTF2_GeneralDefinitions.h:230
Record reading can continue.
Definition: OTF2_GeneralDefinitions.h:321
A communication paradigm across multiple processes.
Definition: OTF2_GeneralDefinitions.h:831
Unsigned 16-bit integer.
Definition: OTF2_GeneralDefinitions.h:548
Mapping of Location identifiers.
Definition: OTF2_GeneralDefinitions.h:481
uint64_t OTF2_LocationRef
Type used to indicate a reference to a Location definition.
Definition: OTF2_GeneralDefinitions.h:125
uint8_t OTF2_ParadigmProperty
Wrapper for enum OTF2_ParadigmProperty_enum.
Definition: OTF2_GeneralDefinitions.h:845
Signed 8-bit integer.
Definition: OTF2_GeneralDefinitions.h:563
uint8_t OTF2_Type
Wrapper for enum OTF2_Type_enum.
Definition: OTF2_GeneralDefinitions.h:525
uint8_t OTF2_FileType
Wrapper for enum OTF2_FileType_enum.
Definition: OTF2_GeneralDefinitions.h:401
A threading paradigm which uses the create/wait model.
Definition: OTF2_GeneralDefinitions.h:837
Definition: OTF2_GeneralDefinitions.h:267
Mapping of RmaWin identifiers.
Definition: OTF2_GeneralDefinitions.h:501
Unsigned 32-bit integer.
Definition: OTF2_GeneralDefinitions.h:553
uint8_t OTF2_Paradigm
Wrapper for enum OTF2_Paradigm_enum.
Definition: OTF2_GeneralDefinitions.h:661
Unified Parallel C (UPC).
Definition: OTF2_GeneralDefinitions.h:740
uint32_t OTF2_StringRef
Type used to indicate a reference to a String definition.
Definition: OTF2_GeneralDefinitions.h:101
uint8_t OTF2_MappingType
Wrapper for enum OTF2_MappingType_enum.
Definition: OTF2_GeneralDefinitions.h:464
Mapping of Attribute identifiers.
Definition: OTF2_GeneralDefinitions.h:598
Multicore Task API functions.
Definition: OTF2_GeneralDefinitions.h:799
Represents the type for the anchor file (.otf2).
Definition: OTF2_GeneralDefinitions.h:412
User instrumentation.
Definition: OTF2_GeneralDefinitions.h:676
uint32_t OTF2_ParameterRef
Type used to indicate a reference to a Parameter definition.
Definition: OTF2_GeneralDefinitions.h:173
Do not use any file interface. No data is written to a file.
Definition: OTF2_GeneralDefinitions.h:459
Represents the type for a event file (.evt).
Definition: OTF2_GeneralDefinitions.h:421
OpenCL API functions and kernels.
Definition: OTF2_GeneralDefinitions.h:792
False.
Definition: OTF2_GeneralDefinitions.h:393
uint8_t OTF2_Hint
Wrapper for enum OTF2_Hint_enum.
Definition: OTF2_GeneralDefinitions.h:355
HMPP.
Definition: OTF2_GeneralDefinitions.h:714
Mapping of Group identifiers.
Definition: OTF2_GeneralDefinitions.h:613
OTF2_Boolean_enum
A boolean.
Definition: OTF2_GeneralDefinitions.h:389
Mapping of Metric identifiers.
Definition: OTF2_GeneralDefinitions.h:490
Mapping of Region identifiers.
Definition: OTF2_GeneralDefinitions.h:484
Compiler instrumentation.
Definition: OTF2_GeneralDefinitions.h:679
OTF2_ParadigmProperty_enum
List of paradigm properties.
Definition: OTF2_GeneralDefinitions.h:852
Template for unnamed RmaWin definitions. A unique name can be derived by replacing '${id}' with a uni...
Definition: OTF2_GeneralDefinitions.h:865
CUDA.
Definition: OTF2_GeneralDefinitions.h:695
Mapping of CallingContext identifiers.
Definition: OTF2_GeneralDefinitions.h:649
Definition: OTF2_GeneralDefinitions.h:377
A threading paradigm which uses the fork/join model.
Definition: OTF2_GeneralDefinitions.h:834
uint32_t OTF2_InterruptGeneratorRef
Type used to indicate a reference to a InterruptGenerator definition.
Definition: OTF2_GeneralDefinitions.h:209
OTF2_ThumbnailType_enum
Type of definitions used as metric in a thumbnail.
Definition: OTF2_GeneralDefinitions.h:884
Mapping of Group identifiers.
Definition: OTF2_GeneralDefinitions.h:487
Undefined.
Definition: OTF2_GeneralDefinitions.h:449
Mapping of String identifiers.
Definition: OTF2_GeneralDefinitions.h:475
The referenced definitions are of type Region.
Definition: OTF2_GeneralDefinitions.h:888
TBB threads.
Definition: OTF2_GeneralDefinitions.h:776
uint8_t OTF2_ParadigmClass
Wrapper for enum OTF2_ParadigmClass_enum.
Definition: OTF2_GeneralDefinitions.h:820
Represents the type for a thumb file (.thumb).
Definition: OTF2_GeneralDefinitions.h:427
OTF2_Compression_enum
Defines which compression is used.
Definition: OTF2_GeneralDefinitions.h:279
Interrupt record reading.
Definition: OTF2_GeneralDefinitions.h:329
uint8_t OTF2_ThumbnailType
Wrapper for enum OTF2_ThumbnailType_enum.
Definition: OTF2_GeneralDefinitions.h:877
uint64_t OTF2_TimeStamp
OTF2 time stamp.
Definition: OTF2_GeneralDefinitions.h:95
Mapping of InterruptGenerator identifiers.
Definition: OTF2_GeneralDefinitions.h:656
POSIX threads.
Definition: OTF2_GeneralDefinitions.h:707
uint32_t OTF2_MetricMemberRef
Type used to indicate a reference to a MetricMember definition.
Definition: OTF2_GeneralDefinitions.h:155
OTF2_Hint_enum
List of possible hints.
Definition: OTF2_GeneralDefinitions.h:362
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:341
OpenACC directives.
Definition: OTF2_GeneralDefinitions.h:784
Max entry.
Definition: OTF2_GeneralDefinitions.h:520
An unknown paradigm.
Definition: OTF2_GeneralDefinitions.h:673
uint32_t OTF2_MetricRef
Type used to indicate a reference to a MetricClass, or a MetricInstance definition.
Definition: OTF2_GeneralDefinitions.h:161
Use the interface of the SIONlib to write many logical files into few physical files.
Definition: OTF2_GeneralDefinitions.h:456
Attests that this parallel paradigm only uses RmaWin definitions. The Comm definitions exists only fo...
Definition: OTF2_GeneralDefinitions.h:872
Recorded data is flushed when running out of memory.
Definition: OTF2_GeneralDefinitions.h:350
Unsigned 64-bit integer.
Definition: OTF2_GeneralDefinitions.h:558
MPI.
Definition: OTF2_GeneralDefinitions.h:689
Mapping of RmaWin identifiers.
Definition: OTF2_GeneralDefinitions.h:635
OTF2_CallbackCode
Return value to indicate that the record reading should be interrupted.
Definition: OTF2_GeneralDefinitions.h:318
Undefined type.
Definition: OTF2_GeneralDefinitions.h:538
Use zlib compression.
Definition: OTF2_GeneralDefinitions.h:286
Qt threads.
Definition: OTF2_GeneralDefinitions.h:762
struct OTF2_SnapReader_struct OTF2_SnapReader
OTF2 local snap reader handle.
Definition: OTF2_GeneralDefinitions.h:234
uint32_t OTF2_CallingContextRef
Type used to indicate a reference to a CallingContext definition.
Definition: OTF2_GeneralDefinitions.h:203
struct OTF2_GlobalSnapReader_struct OTF2_GlobalSnapReader
OTF2 global snap reader handle.
Definition: OTF2_GeneralDefinitions.h:238
OTF2_ParadigmClass_enum
List of paradigm classes.
Definition: OTF2_GeneralDefinitions.h:827
Windows threads.
Definition: OTF2_GeneralDefinitions.h:755
Undefined.
Definition: OTF2_GeneralDefinitions.h:282
Signaling an error in the callback.
Definition: OTF2_GeneralDefinitions.h:332
Mapping of String identifiers.
Definition: OTF2_GeneralDefinitions.h:593
OTF2_FileSubstrate_enum
Defines which file substrate is used.
Definition: OTF2_GeneralDefinitions.h:445
OTF2_MappingType_enum
Possible mappings from local to global identifiers.
Definition: OTF2_GeneralDefinitions.h:471
Mapping of Region identifiers.
Definition: OTF2_GeneralDefinitions.h:608
Use standard posix file interface.
Definition: OTF2_GeneralDefinitions.h:452
struct OTF2_DefReader_struct OTF2_DefReader
OTF2 local definition reader handle.
Definition: OTF2_GeneralDefinitions.h:226
uint8_t OTF2_Boolean
Wrapper for enum OTF2_Boolean_enum.
Definition: OTF2_GeneralDefinitions.h:382
Internal file which holds the SION rank map (.srm).
Definition: OTF2_GeneralDefinitions.h:433
OmpSs.
Definition: OTF2_GeneralDefinitions.h:721
uint32_t OTF2_SystemTreeNodeRef
Type used to indicate a reference to a SystemTreeNode definition.
Definition: OTF2_GeneralDefinitions.h:113
OpenMP.
Definition: OTF2_GeneralDefinitions.h:684
OTF2_FileMode_enum
Defines how to interact with files.
Definition: OTF2_GeneralDefinitions.h:262
Mapping of Comm identifiers.
Definition: OTF2_GeneralDefinitions.h:493
uint32_t OTF2_CartTopologyRef
Type used to indicate a reference to a CartTopology definition.
Definition: OTF2_GeneralDefinitions.h:191
Hardware.
Definition: OTF2_GeneralDefinitions.h:726
Entity does not belong to any specific paradigm.
Definition: OTF2_GeneralDefinitions.h:815
uint8_t OTF2_FileSubstrate
Wrapper for enum OTF2_FileSubstrate_enum.
Definition: OTF2_GeneralDefinitions.h:438
No compression is used.
Definition: OTF2_GeneralDefinitions.h:284
The referenced definitions are of type Attribute.
Definition: OTF2_GeneralDefinitions.h:894
uint8_t OTF2_Compression
Defines which compression is used. Please see OTF2_Compression_enum for a detailed description...
Definition: OTF2_GeneralDefinitions.h:275
Template for unnamed Comm definitions. A unique name can be derived by replacing '${id}' with a uniqu...
Definition: OTF2_GeneralDefinitions.h:859
Mapping of InterruptGenerator identifiers.
Definition: OTF2_GeneralDefinitions.h:516
uint32_t OTF2_SourceCodeLocationRef
Type used to indicate a reference to a SourceCodeLocation definition.
Definition: OTF2_GeneralDefinitions.h:197
Mapping of SourceCodeLocation identifiers.
Definition: OTF2_GeneralDefinitions.h:506
Represents the type for the global definition file (.def).
Definition: OTF2_GeneralDefinitions.h:415
uint32_t OTF2_CartDimensionRef
Type used to indicate a reference to a CartDimension definition.
Definition: OTF2_GeneralDefinitions.h:185
Definition: OTF2_GeneralDefinitions.h:269
uint32_t OTF2_CommRef
Type used to indicate a reference to a Comm definition.
Definition: OTF2_GeneralDefinitions.h:167
Mapping of CallingContext identifiers.
Definition: OTF2_GeneralDefinitions.h:511
Represents the type for a local definition file (.def).
Definition: OTF2_GeneralDefinitions.h:418
uint32_t OTF2_RegionRef
Type used to indicate a reference to a Region definition.
Definition: OTF2_GeneralDefinitions.h:131
Functions recorded by sampling, not by any means of instrumentation.
Definition: OTF2_GeneralDefinitions.h:810
32-bit floating point value
Definition: OTF2_GeneralDefinitions.h:583
Mapping of Location identifiers.
Definition: OTF2_GeneralDefinitions.h:603
Unsigned 8-bit integer.
Definition: OTF2_GeneralDefinitions.h:543
The referenced definitions are of type MetricMember.
Definition: OTF2_GeneralDefinitions.h:891
Signed 32-bit integer.
Definition: OTF2_GeneralDefinitions.h:573
Definition: OTF2_GeneralDefinitions.h:265
True.
Definition: OTF2_GeneralDefinitions.h:396
uint32_t OTF2_GroupRef
Type used to indicate a reference to a Group definition.
Definition: OTF2_GeneralDefinitions.h:149
uint8_t OTF2_FileMode
Defines how to interact with files. Please see OTF2_FileMode_enum for a detailed description.
Definition: OTF2_GeneralDefinitions.h:258
ACE threads.
Definition: OTF2_GeneralDefinitions.h:769
OTF2_Paradigm_enum
List of known paradigms. Parallel paradigms have their expected paradigm class and known paradigm pro...
Definition: OTF2_GeneralDefinitions.h:669
Mapping of Parameter identifiers.
Definition: OTF2_GeneralDefinitions.h:496
Mapping of SourceCodeLocation identifiers.
Definition: OTF2_GeneralDefinitions.h:642
Mapping of Parameter identifiers.
Definition: OTF2_GeneralDefinitions.h:628
uint32_t OTF2_AttributeRef
Type used to indicate a reference to a Attribute definition.
Definition: OTF2_GeneralDefinitions.h:107
GASPI.
Definition: OTF2_GeneralDefinitions.h:733
Signed 16-bit integer.
Definition: OTF2_GeneralDefinitions.h:568
Mapping of Metric identifiers.
Definition: OTF2_GeneralDefinitions.h:618
Error codes and error handling.
SGI SHMEM, Cray SHMEM, OpenSHMEM.
Definition: OTF2_GeneralDefinitions.h:748
A paradigm which uses external accelerators to offload computation.
Definition: OTF2_GeneralDefinitions.h:840
Flushing will be suppressed when running out of memory.
Definition: OTF2_GeneralDefinitions.h:348
OTF2_FileType_enum
Defines which file type is used.
Definition: OTF2_GeneralDefinitions.h:408
uint32_t OTF2_RmaWinRef
Type used to indicate a reference to a RmaWin definition.
Definition: OTF2_GeneralDefinitions.h:179
struct OTF2_EvtReader_struct OTF2_EvtReader
OTF2 local event reader handle.
Definition: OTF2_GeneralDefinitions.h:218
Represents the type for a snapshot file (.snap).
Definition: OTF2_GeneralDefinitions.h:424
struct OTF2_GlobalEvtReader_struct OTF2_GlobalEvtReader
OTF2 global event reader handle.
Definition: OTF2_GeneralDefinitions.h:222
Signed 64-bit integer.
Definition: OTF2_GeneralDefinitions.h:578
OTF2_Type_enum
OTF2 basic data types.
Definition: OTF2_GeneralDefinitions.h:532
uint32_t OTF2_CallpathRef
Type used to indicate a reference to a Callpath definition.
Definition: OTF2_GeneralDefinitions.h:143
uint32_t OTF2_CallsiteRef
Type used to indicate a reference to a Callsite definition.
Definition: OTF2_GeneralDefinitions.h:137
uint32_t OTF2_LocationGroupRef
Type used to indicate a reference to a LocationGroup definition.
Definition: OTF2_GeneralDefinitions.h:119