38 #ifndef SCOREP_PUBLICTYPES_H
39 #define SCOREP_PUBLICTYPES_H
58 #define SCOREP_INVALID_EXIT_STATUS ( ( int64_t )( ~( ( ~( ( uint64_t )0u ) ) >> 1 ) ) )
73 #define SCOREP_INVALID_LINE_NO 0
87 #define SCOREP_MOVABLE_NULL 0
104 #define SCOREP_INVALID_SOURCE_FILE SCOREP_MOVABLE_NULL
116 #define SCOREP_INVALID_METRIC SCOREP_MOVABLE_NULL
128 #define SCOREP_INVALID_SAMPLING_SET SCOREP_MOVABLE_NULL
140 #define SCOREP_INVALID_REGION SCOREP_MOVABLE_NULL
152 #define SCOREP_INVALID_PARADIGM SCOREP_MOVABLE_NULL
198 #define SCOREP_LOCATION_TYPES \
199 SCOREP_LOCATION_TYPE( CPU_THREAD, "CPU thread" ) \
200 SCOREP_LOCATION_TYPE( GPU, "GPU" ) \
201 SCOREP_LOCATION_TYPE( METRIC, "metric location" ) \
206 #define SCOREP_LOCATION_TYPE( NAME, name_string ) SCOREP_LOCATION_TYPE_ ## NAME,
208 #undef SCOREP_LOCATION_TYPE
210 SCOREP_NUMBER_OF_LOCATION_TYPES,
246 #define SCOREP_INVALID_ROOT_RANK -1
266 #define SCOREP_PARADIGM_CLASSES \
267 SCOREP_PARADIGM_CLASS( MPP, "multi-process", PROCESS ) \
268 SCOREP_PARADIGM_CLASS( THREAD_FORK_JOIN, "fork/join", THREAD_FORK_JOIN ) \
269 SCOREP_PARADIGM_CLASS( THREAD_CREATE_WAIT, "create/wait", THREAD_CREATE_WAIT ) \
270 SCOREP_PARADIGM_CLASS( ACCELERATOR, "accelerator", ACCELERATOR )
275 #define SCOREP_PARADIGM_CLASS( NAME, name, OTF2_NAME ) \
276 SCOREP_PARADIGM_CLASS_ ## NAME,
277 SCOREP_PARADIGM_CLASSES
279 #undef SCOREP_PARADIGM_CLASS
307 #define SCOREP_PARADIGMS \
308 SCOREP_PARADIGM( MEASUREMENT, "measurement", MEASUREMENT_SYSTEM ) \
309 SCOREP_PARADIGM( USER, "user", USER ) \
310 SCOREP_PARADIGM( COMPILER, "compiler", COMPILER ) \
311 SCOREP_PARADIGM( SAMPLING, "sampling", SAMPLING ) \
312 SCOREP_PARADIGM( MEMORY, "memory", NONE ) \
313 SCOREP_PARADIGM( LIBWRAP, "libwrap", NONE ) \
314 SCOREP_PARADIGM( MPI, "mpi", MPI ) \
315 SCOREP_PARADIGM( SHMEM, "shmem", SHMEM ) \
316 SCOREP_PARADIGM( OPENMP, "openmp", OPENMP ) \
317 SCOREP_PARADIGM( PTHREAD, "pthread", PTHREAD ) \
318 SCOREP_PARADIGM( ORPHAN_THREAD, "orphan thread", UNKNOWN ) \
319 SCOREP_PARADIGM( CUDA, "cuda", CUDA ) \
320 SCOREP_PARADIGM( OPENCL, "opencl", OPENCL ) \
321 SCOREP_PARADIGM( OPENACC, "openacc", OPENACC ) \
322 SCOREP_PARADIGM( IO, "io", NONE )
327 #define SCOREP_PARADIGM( NAME, name_str, OTF2_NAME ) \
328 SCOREP_PARADIGM_ ## NAME,
331 #undef SCOREP_PARADIGM
410 #define SCOREP_REGION_TYPES \
411 SCOREP_REGION_TYPE( COLL_ONE2ALL, "one2all" ) \
412 SCOREP_REGION_TYPE( COLL_ALL2ONE, "all2one" ) \
413 SCOREP_REGION_TYPE( COLL_ALL2ALL, "all2all" ) \
414 SCOREP_REGION_TYPE( COLL_OTHER, "other collective" ) \
415 SCOREP_REGION_TYPE( POINT2POINT, "point2point" ) \
416 SCOREP_REGION_TYPE( PARALLEL, "parallel" ) \
417 SCOREP_REGION_TYPE( SECTIONS, "sections" ) \
418 SCOREP_REGION_TYPE( SECTION, "section" ) \
419 SCOREP_REGION_TYPE( WORKSHARE, "workshare" ) \
420 SCOREP_REGION_TYPE( SINGLE, "single" ) \
421 SCOREP_REGION_TYPE( MASTER, "master" ) \
422 SCOREP_REGION_TYPE( CRITICAL, "critical" ) \
423 SCOREP_REGION_TYPE( ATOMIC, "atomic" ) \
424 SCOREP_REGION_TYPE( BARRIER, "barrier" ) \
425 SCOREP_REGION_TYPE( IMPLICIT_BARRIER, "implicit barrier" ) \
426 SCOREP_REGION_TYPE( FLUSH, "flush" ) \
427 SCOREP_REGION_TYPE( CRITICAL_SBLOCK, "critical sblock" ) \
428 SCOREP_REGION_TYPE( SINGLE_SBLOCK, "single sblock" ) \
429 SCOREP_REGION_TYPE( WRAPPER, "wrapper" ) \
430 SCOREP_REGION_TYPE( TASK, "task" ) \
431 SCOREP_REGION_TYPE( TASK_UNTIED, "untied task" ) \
432 SCOREP_REGION_TYPE( TASK_WAIT, "taskwait" ) \
433 SCOREP_REGION_TYPE( TASK_CREATE, "task create" ) \
434 SCOREP_REGION_TYPE( ORDERED, "ordered" ) \
435 SCOREP_REGION_TYPE( ORDERED_SBLOCK, "ordered sblock" ) \
436 SCOREP_REGION_TYPE( ARTIFICIAL, "artificial" ) \
437 SCOREP_REGION_TYPE( RMA, "rma" ) \
438 SCOREP_REGION_TYPE( THREAD_CREATE, "thread create" ) \
439 SCOREP_REGION_TYPE( THREAD_WAIT, "thread wait" ) \
440 SCOREP_REGION_TYPE( ALLOCATE, "allocate" ) \
441 SCOREP_REGION_TYPE( DEALLOCATE, "deallocate" ) \
442 SCOREP_REGION_TYPE( REALLOCATE, "reallocate" ) \
443 SCOREP_REGION_TYPE( FILE_IO, "file_io" ) \
444 SCOREP_REGION_TYPE( FILE_IO_METADATA, "file_io metadata" )
447 #define SCOREP_REGION_TYPE( NAME, name_str ) \
448 SCOREP_REGION_ ## NAME,
452 SCOREP_REGION_UNKNOWN = 0,
453 SCOREP_REGION_FUNCTION,
459 SCOREP_REGION_DYNAMIC,
460 SCOREP_REGION_DYNAMIC_PHASE,
461 SCOREP_REGION_DYNAMIC_LOOP,
462 SCOREP_REGION_DYNAMIC_FUNCTION,
463 SCOREP_REGION_DYNAMIC_LOOP_PHASE,
470 #undef SCOREP_REGION_TYPE
485 #define SCOREP_RMA_SYNC_TYPES \
486 SCOREP_RMA_SYNC_TYPE( MEMORY, memory, "memory" ) \
487 SCOREP_RMA_SYNC_TYPE( NOTIFY_IN, notify_in, "notify in" ) \
488 SCOREP_RMA_SYNC_TYPE( NOTIFY_OUT, notify_out, "notify out" )
492 #define SCOREP_RMA_SYNC_TYPE( upper, lower, name ) SCOREP_RMA_SYNC_TYPE_ ## upper,
493 SCOREP_RMA_SYNC_TYPES
494 #undef SCOREP_RMA_SYNC_TYPE
512 #define SCOREP_RMA_SYNC_LEVELS \
513 SCOREP_RMA_SYNC_LEVEL( NONE, none, "none", 0 ) \
514 SCOREP_RMA_SYNC_LEVEL( PROCESS, process, "process", 1 << 0 ) \
515 SCOREP_RMA_SYNC_LEVEL( MEMORY, memory, "memory", 1 << 1 )
519 #define SCOREP_RMA_SYNC_LEVEL( upper, lower, name, value ) \
520 SCOREP_RMA_SYNC_LEVEL_ ## upper = value,
522 SCOREP_RMA_SYNC_LEVELS
523 #undef SCOREP_RMA_SYNC_LEVEL
544 #define SCOREP_RMA_ATOMIC_TYPES \
545 SCOREP_RMA_ATOMIC_TYPE( ACCUMULATE, accumulate, "accumulate" ) \
546 SCOREP_RMA_ATOMIC_TYPE( INCREMENT, increment, "increment" ) \
547 SCOREP_RMA_ATOMIC_TYPE( TEST_AND_SET, test_and_set, "test and set" ) \
548 SCOREP_RMA_ATOMIC_TYPE( COMPARE_AND_SWAP, compare_and_swap, "compare and swap" ) \
549 SCOREP_RMA_ATOMIC_TYPE( SWAP, swap, "swap" ) \
550 SCOREP_RMA_ATOMIC_TYPE( FETCH_AND_ADD, fetch_and_add, "fetch and add" ) \
551 SCOREP_RMA_ATOMIC_TYPE( FETCH_AND_INCREMENT, fetch_and_increment, "fetch and increment" ) \
552 SCOREP_RMA_ATOMIC_TYPE( ADD, add, "add" )
556 #define SCOREP_RMA_ATOMIC_TYPE( upper, lower, name ) SCOREP_RMA_ATOMIC_TYPE_ ## upper,
557 SCOREP_RMA_ATOMIC_TYPES
558 #undef SCOREP_RMA_ATOMIC_TYPE
560 SCOREP_INVALID_RMA_ATOMIC_TYPE
613 #define SCOREP_IO_PARADIGMS \
614 SCOREP_IO_PARADIGM( POSIX, posix, "POSIX" ) \
615 SCOREP_IO_PARADIGM( ISOC, isoc, "ISOC" ) \
616 SCOREP_IO_PARADIGM( MPI, mpi, "MPI-IO" )
623 #define SCOREP_IO_PARADIGM( upper, lower, id_name ) SCOREP_IO_PARADIGM_ ## upper,
625 #undef SCOREP_IO_PARADIGM
626 SCOREP_INVALID_IO_PARADIGM_TYPE
630 #define SCOREP_NUM_IO_PARADIGMS SCOREP_INVALID_IO_PARADIGM_TYPE
795 #define SCOREP_IPC_DATATYPES \
796 SCOREP_IPC_DATATYPE( BYTE ) \
797 SCOREP_IPC_DATATYPE( CHAR ) \
798 SCOREP_IPC_DATATYPE( UNSIGNED_CHAR ) \
799 SCOREP_IPC_DATATYPE( INT ) \
800 SCOREP_IPC_DATATYPE( UNSIGNED ) \
801 SCOREP_IPC_DATATYPE( INT32_T ) \
802 SCOREP_IPC_DATATYPE( UINT32_T ) \
803 SCOREP_IPC_DATATYPE( INT64_T ) \
804 SCOREP_IPC_DATATYPE( UINT64_T ) \
805 SCOREP_IPC_DATATYPE( DOUBLE )
809 #define SCOREP_IPC_DATATYPE( datatype ) \
810 SCOREP_IPC_ ## datatype,
812 #undef SCOREP_IPC_DATATYPE
813 SCOREP_IPC_NUMBER_OF_DATATYPES
828 #define SCOREP_IPC_OPERATIONS \
829 SCOREP_IPC_OPERATION( BAND ) \
830 SCOREP_IPC_OPERATION( BOR ) \
831 SCOREP_IPC_OPERATION( MIN ) \
832 SCOREP_IPC_OPERATION( MAX ) \
833 SCOREP_IPC_OPERATION( SUM )
837 #define SCOREP_IPC_OPERATION( op ) \
839 SCOREP_IPC_OPERATIONS
840 #undef SCOREP_IPC_OPERATION
841 SCOREP_IPC_NUMBER_OF_OPERATIONS
Definition: SCOREP_PublicTypes.h:591
Definition: SCOREP_PublicTypes.h:610
SCOREP_AnyHandle SCOREP_SamplingSetHandle
Definition: SCOREP_PublicTypes.h:123
struct SCOREP_Task * SCOREP_TaskHandle
Definition: SCOREP_PublicTypes.h:159
#define SCOREP_LOCATION_TYPES
Definition: SCOREP_PublicTypes.h:198
Definition: SCOREP_PublicTypes.h:185
Definition: SCOREP_PublicTypes.h:602
Definition: SCOREP_PublicTypes.h:221
Definition: SCOREP_PublicTypes.h:168
Definition: SCOREP_PublicTypes.h:227
SCOREP_AnyHandle SCOREP_SourceFileHandle
Definition: SCOREP_PublicTypes.h:98
Definition: SCOREP_PublicTypes.h:171
Synchronization/flush operation (request and completion).
Definition: SCOREP_PublicTypes.h:753
File is only a location in the filesystem tree and is not suitable for reading and writing...
Definition: SCOREP_PublicTypes.h:673
Read-write access.
Definition: SCOREP_PublicTypes.h:644
SCOREP_AnyHandle SCOREP_MetricHandle
Definition: SCOREP_PublicTypes.h:110
Definition: SCOREP_PublicTypes.h:736
SCOREP_CollectiveType
Types to specify the used collectives in calls to SCOREP_MpiCollectiveBegin and SCOREP_RmaCollectiveB...
Definition: SCOREP_PublicTypes.h:165
Open file in append mode which means I/O write operations are automatically performed at the end of t...
Definition: SCOREP_PublicTypes.h:702
Write operation.
Definition: SCOREP_PublicTypes.h:751
Definition: SCOREP_PublicTypes.h:859
Definition: SCOREP_PublicTypes.h:183
Definition: SCOREP_PublicTypes.h:608
Ensure that the file size can be represented by a 64-bit datatype.
Definition: SCOREP_PublicTypes.h:677
Definition: SCOREP_PublicTypes.h:571
SCOREP_RmaSyncType
Type of direct RMA synchronization call.
Definition: SCOREP_PublicTypes.h:490
Definition: SCOREP_PublicTypes.h:182
SCOREP_Substrates_RequirementFlag
Definition: SCOREP_PublicTypes.h:856
Definition: SCOREP_PublicTypes.h:732
int SCOREP_MpiRank
Definition: SCOREP_PublicTypes.h:233
Delete the file when closing the {IoHandle}.
Definition: SCOREP_PublicTypes.h:721
Read operation.
Definition: SCOREP_PublicTypes.h:749
SCOREP_RmaSyncLevel
specifies a RMA synchronization level, used by RMA records to be passed to SCOREP_Rma*() functions...
Definition: SCOREP_PublicTypes.h:517
SCOREP_AnyHandle SCOREP_ParadigmHandle
Definition: SCOREP_PublicTypes.h:147
Definition: SCOREP_PublicTypes.h:348
Definition: SCOREP_PublicTypes.h:860
SCOREP_ParadigmType
defines paradigms that are be monitored
Definition: SCOREP_PublicTypes.h:325
Definition: SCOREP_PublicTypes.h:188
Definition: SCOREP_PublicTypes.h:170
Definition: SCOREP_PublicTypes.h:184
SCOREP_LockType
Definition: SCOREP_PublicTypes.h:217
If the file does not exist, it will be created.
Definition: SCOREP_PublicTypes.h:659
Definition: SCOREP_PublicTypes.h:730
Enable signal-driven I/O.
Definition: SCOREP_PublicTypes.h:707
Definition: SCOREP_PublicTypes.h:734
Definition: SCOREP_PublicTypes.h:179
Definition: SCOREP_PublicTypes.h:587
Gives the advice that this will be the only active {IoHandle} of the {IoParadigmType} which will oper...
Definition: SCOREP_PublicTypes.h:687
Definition: SCOREP_PublicTypes.h:176
Definition: SCOREP_PublicTypes.h:211
Gives the advice that no reposition will happen on this I/O handle. E.g., no seek operation or simila...
Definition: SCOREP_PublicTypes.h:681
Definition: SCOREP_PublicTypes.h:281
SCOREP_IoAccessMode
Definition: SCOREP_PublicTypes.h:635
Definition: SCOREP_PublicTypes.h:225
No special semantics.
Definition: SCOREP_PublicTypes.h:765
Ensure that this call creates the file.
Definition: SCOREP_PublicTypes.h:665
Definition: SCOREP_PublicTypes.h:572
SCOREP_IoSeekOption
Definition: SCOREP_PublicTypes.h:727
The I/O operation was performed in a blocking mode (default).
Definition: SCOREP_PublicTypes.h:767
Definition: SCOREP_PublicTypes.h:186
Definition: SCOREP_PublicTypes.h:740
Definition: SCOREP_PublicTypes.h:178
Definition: SCOREP_PublicTypes.h:862
SCOREP_IoCreationFlag
Definition: SCOREP_PublicTypes.h:654
Definition: SCOREP_PublicTypes.h:345
File is a terminal device and should not be promoted to a controlling terminal, if none existed befor...
Definition: SCOREP_PublicTypes.h:668
SCOREP_IoStatusFlag
Definition: SCOREP_PublicTypes.h:694
Read access to a file won't update its last access time.
Definition: SCOREP_PublicTypes.h:719
Write operations on the file will complete according to the requirements of synchronized I/O file int...
Definition: SCOREP_PublicTypes.h:711
Definition: SCOREP_PublicTypes.h:187
The I/O operation was performed in a non-blocking mode.
Definition: SCOREP_PublicTypes.h:769
Definition: SCOREP_PublicTypes.h:467
uint32_t SCOREP_LineNo
Definition: SCOREP_PublicTypes.h:65
Definition: SCOREP_PublicTypes.h:173
SCOREP_SamplingSetClass
Class of locations which recorded a sampling set.
Definition: SCOREP_PublicTypes.h:568
Definition: SCOREP_PublicTypes.h:180
Execute-only access.
Definition: SCOREP_PublicTypes.h:646
If pathname is a symbolic link, then the open operation will fail.
Definition: SCOREP_PublicTypes.h:670
Definition: SCOREP_PublicTypes.h:174
Enable close-on-exec flag.
Definition: SCOREP_PublicTypes.h:699
SCOREP_Ipc_Operation
specifies an inter process communication operation for reduce function
Definition: SCOREP_PublicTypes.h:835
Definition: SCOREP_PublicTypes.h:346
SCOREP_Allocator_MovableMemory SCOREP_AnyHandle
Definition: SCOREP_PublicTypes.h:92
Create an unnamed temporary file.
Definition: SCOREP_PublicTypes.h:675
SCOREP_RmaAtomicType
specifies a RMA Atomic Operation Type.
Definition: SCOREP_PublicTypes.h:554
SCOREP_ParameterType
defines types to be used in defining a parameter for parameter based profiling (SCOREP_Definitions_Ne...
Definition: SCOREP_PublicTypes.h:342
Definition: SCOREP_PublicTypes.h:333
Definition: SCOREP_PublicTypes.h:181
No flag is set.
Definition: SCOREP_PublicTypes.h:697
Definition: SCOREP_PublicTypes.h:177
Definition: SCOREP_PublicTypes.h:583
The I/O operation was performed collectively over the communicator of the referenced {IoHandle} handl...
Definition: SCOREP_PublicTypes.h:772
Definition: SCOREP_PublicTypes.h:570
SCOREP_IoOperationMode
Definition: SCOREP_PublicTypes.h:746
SCOREP_ParadigmClass
defines classes of paradigms that are monitored Types:
Definition: SCOREP_PublicTypes.h:273
Write operations on the file will complete according to the requirements of synchronized I/O data int...
Definition: SCOREP_PublicTypes.h:714
Truncate file to length 0 if possible.
Definition: SCOREP_PublicTypes.h:661
Definition: SCOREP_PublicTypes.h:169
Unspecified access mode.
Definition: SCOREP_PublicTypes.h:638
uint64_t SCOREP_MpiRequestId
Definition: SCOREP_PublicTypes.h:239
SCOREP_IoOperationFlag
Definition: SCOREP_PublicTypes.h:762
Definition: SCOREP_PublicTypes.h:605
The I/O operation was performed in a non-collective mode. (default)
Definition: SCOREP_PublicTypes.h:774
SCOREP_Ipc_Datatype
specifies an inter process communication data types
Definition: SCOREP_PublicTypes.h:807
Definition: SCOREP_PublicTypes.h:738
Open operation will fail if pathname is not a directory.
Definition: SCOREP_PublicTypes.h:663
Definition: SCOREP_PublicTypes.h:189
Instruct I/O operations to reduce caching effects, e.g., direct file I/O.
Definition: SCOREP_PublicTypes.h:717
uint32_t SCOREP_Allocator_MovableMemory
Definition: SCOREP_PublicTypes.h:80
I/O operations (including the creation) will fail if they would block the issuing process...
Definition: SCOREP_PublicTypes.h:705
int64_t SCOREP_ExitStatus
Definition: SCOREP_PublicTypes.h:51
Definition: SCOREP_PublicTypes.h:167
Definition: SCOREP_PublicTypes.h:858
Definition: SCOREP_PublicTypes.h:344
SCOREP_AnyHandle SCOREP_RegionHandle
Definition: SCOREP_PublicTypes.h:135
Definition: SCOREP_PublicTypes.h:585
SCOREP_MetricScope
Types to be used in defining the scope of a scoped sampling set.
Definition: SCOREP_PublicTypes.h:580
Search-only access.
Definition: SCOREP_PublicTypes.h:648
Definition: SCOREP_PublicTypes.h:496
SCOREP_LocationType
Definition: SCOREP_PublicTypes.h:204
Write-only access.
Definition: SCOREP_PublicTypes.h:642
No flag is set.
Definition: SCOREP_PublicTypes.h:657
Definition: SCOREP_PublicTypes.h:172
SCOREP_MetricOccurrence
Types to be used in defining the occurrence of a sampling set.
Definition: SCOREP_PublicTypes.h:599
Definition: SCOREP_PublicTypes.h:175
Definition: SCOREP_PublicTypes.h:589
Read-only access.
Definition: SCOREP_PublicTypes.h:640
SCOREP_IoParadigmType
Definition: SCOREP_PublicTypes.h:621
SCOREP_RegionType
specifies a Region
Definition: SCOREP_PublicTypes.h:450