4.0-READEX (revision 13792)
SCOREP_PublicTypes.h
Go to the documentation of this file.
1 /*
2  * This file is part of the Score-P software (http://www.score-p.org)
3  *
4  * Copyright (c) 2009-2011,
5  * RWTH Aachen University, Germany
6  *
7  * Copyright (c) 2009-2011,
8  * Gesellschaft fuer numerische Simulation mbH Braunschweig, Germany
9  *
10  * Copyright (c) 2009-2011, 2018,
11  * Technische Universitaet Dresden, Germany
12  *
13  * Copyright (c) 2009-2011,
14  * University of Oregon, Eugene, USA
15  *
16  * Copyright (c) 2009-2011, 2018,
17  * Forschungszentrum Juelich GmbH, Germany
18  *
19  * Copyright (c) 2009-2011,
20  * German Research School for Simulation Sciences GmbH, Juelich/Aachen, Germany
21  *
22  * Copyright (c) 2009-2011,
23  * Technische Universitaet Muenchen, Germany
24  *
25  * This software may be modified and distributed under the terms of
26  * a BSD-style license. See the COPYING file in the package base
27  * directory for details.
28  *
29  */
30 
31 
38 #ifndef SCOREP_PUBLICTYPES_H
39 #define SCOREP_PUBLICTYPES_H
40 
41 #include <stdint.h>
42 
46 
51 typedef uint32_t SCOREP_LineNo;
52 
53 
54 
59 #define SCOREP_INVALID_LINE_NO 0
60 
67 
73 #define SCOREP_MOVABLE_NULL 0
74 
79 
85 
90 #define SCOREP_INVALID_SOURCE_FILE SCOREP_MOVABLE_NULL
91 
97 
102 #define SCOREP_INVALID_METRIC SCOREP_MOVABLE_NULL
103 
104 
110 
114 #define SCOREP_INVALID_SAMPLING_SET SCOREP_MOVABLE_NULL
115 
116 
122 
126 #define SCOREP_INVALID_REGION SCOREP_MOVABLE_NULL
127 
128 
134 
138 #define SCOREP_INVALID_PARADIGM SCOREP_MOVABLE_NULL
139 
140 
141 
145 typedef struct SCOREP_Task* SCOREP_TaskHandle;
146 
152 {
177 
178 
179 
184 #define SCOREP_LOCATION_TYPES \
185  SCOREP_LOCATION_TYPE( CPU_THREAD, "CPU thread" ) \
186  SCOREP_LOCATION_TYPE( GPU, "GPU" ) \
187  SCOREP_LOCATION_TYPE( METRIC, "metric location" ) \
188 
189 
191 {
192  #define SCOREP_LOCATION_TYPE( NAME, name_string ) SCOREP_LOCATION_TYPE_ ## NAME,
194  #undef SCOREP_LOCATION_TYPE
195 
196  SCOREP_NUMBER_OF_LOCATION_TYPES,
199 
203 typedef enum SCOREP_LockType
204 {
212 
215 
219 typedef int SCOREP_MpiRank;
220 
221 
225 typedef uint64_t SCOREP_MpiRequestId;
226 
227 
232 #define SCOREP_INVALID_ROOT_RANK -1
233 
234 
252 #define SCOREP_PARADIGM_CLASSES \
253  SCOREP_PARADIGM_CLASS( MPP, "multi-process", PROCESS ) \
254  SCOREP_PARADIGM_CLASS( THREAD_FORK_JOIN, "fork/join", THREAD_FORK_JOIN ) \
255  SCOREP_PARADIGM_CLASS( THREAD_CREATE_WAIT, "create/wait", THREAD_CREATE_WAIT ) \
256  SCOREP_PARADIGM_CLASS( ACCELERATOR, "accelerator", ACCELERATOR )
257 
258 
260 {
261 #define SCOREP_PARADIGM_CLASS( NAME, name, OTF2_NAME ) \
262  SCOREP_PARADIGM_CLASS_ ## NAME,
263  SCOREP_PARADIGM_CLASSES
264 
265 #undef SCOREP_PARADIGM_CLASS
266 
269 
270 
294 #define SCOREP_PARADIGMS \
295  SCOREP_PARADIGM( MEASUREMENT, "measurement", MEASUREMENT_SYSTEM ) \
296  SCOREP_PARADIGM( USER, "user", USER ) \
297  SCOREP_PARADIGM( COMPILER, "compiler", COMPILER ) \
298  SCOREP_PARADIGM( SAMPLING, "sampling", SAMPLING ) \
299  SCOREP_PARADIGM( MEMORY, "memory", NONE ) \
300  SCOREP_PARADIGM( LIBWRAP, "libwrap", NONE ) \
301  SCOREP_PARADIGM( MPI, "mpi", MPI ) \
302  SCOREP_PARADIGM( SHMEM, "shmem", SHMEM ) \
303  SCOREP_PARADIGM( OPENMP, "openmp", OPENMP ) \
304  SCOREP_PARADIGM( PTHREAD, "pthread", PTHREAD ) \
305  SCOREP_PARADIGM( ORPHAN_THREAD, "orphan thread", UNKNOWN ) \
306  SCOREP_PARADIGM( CUDA, "cuda", CUDA ) \
307  SCOREP_PARADIGM( OPENCL, "opencl", OPENCL ) \
308  SCOREP_PARADIGM( OPENACC, "openacc", OPENACC )
309 
310 
312 {
313 #define SCOREP_PARADIGM( NAME, name_str, OTF2_NAME ) \
314  SCOREP_PARADIGM_ ## NAME,
315  SCOREP_PARADIGMS
316 
317 #undef SCOREP_PARADIGM
318 
321 
329 {
336 
337 
394 #define SCOREP_REGION_TYPES \
395  SCOREP_REGION_TYPE( COLL_ONE2ALL, "one2all" ) \
396  SCOREP_REGION_TYPE( COLL_ALL2ONE, "all2one" ) \
397  SCOREP_REGION_TYPE( COLL_ALL2ALL, "all2all" ) \
398  SCOREP_REGION_TYPE( COLL_OTHER, "other collective" ) \
399  SCOREP_REGION_TYPE( POINT2POINT, "point2point" ) \
400  SCOREP_REGION_TYPE( PARALLEL, "parallel" ) \
401  SCOREP_REGION_TYPE( SECTIONS, "sections" ) \
402  SCOREP_REGION_TYPE( SECTION, "section" ) \
403  SCOREP_REGION_TYPE( WORKSHARE, "workshare" ) \
404  SCOREP_REGION_TYPE( SINGLE, "single" ) \
405  SCOREP_REGION_TYPE( MASTER, "master" ) \
406  SCOREP_REGION_TYPE( CRITICAL, "critical" ) \
407  SCOREP_REGION_TYPE( ATOMIC, "atomic" ) \
408  SCOREP_REGION_TYPE( BARRIER, "barrier" ) \
409  SCOREP_REGION_TYPE( IMPLICIT_BARRIER, "implicit barrier" ) \
410  SCOREP_REGION_TYPE( FLUSH, "flush" ) \
411  SCOREP_REGION_TYPE( CRITICAL_SBLOCK, "critical sblock" ) \
412  SCOREP_REGION_TYPE( SINGLE_SBLOCK, "single sblock" ) \
413  SCOREP_REGION_TYPE( WRAPPER, "wrapper" ) \
414  SCOREP_REGION_TYPE( TASK, "task" ) \
415  SCOREP_REGION_TYPE( TASK_UNTIED, "untied task" ) \
416  SCOREP_REGION_TYPE( TASK_WAIT, "taskwait" ) \
417  SCOREP_REGION_TYPE( TASK_CREATE, "task create" ) \
418  SCOREP_REGION_TYPE( ORDERED, "ordered" ) \
419  SCOREP_REGION_TYPE( ORDERED_SBLOCK, "ordered sblock" ) \
420  SCOREP_REGION_TYPE( ARTIFICIAL, "artificial" ) \
421  SCOREP_REGION_TYPE( RMA, "rma" ) \
422  SCOREP_REGION_TYPE( THREAD_CREATE, "thread create" ) \
423  SCOREP_REGION_TYPE( THREAD_WAIT, "thread wait" ) \
424  SCOREP_REGION_TYPE( ALLOCATE, "allocate" ) \
425  SCOREP_REGION_TYPE( DEALLOCATE, "deallocate" ) \
426  SCOREP_REGION_TYPE( REALLOCATE, "reallocate" )
427 
428 
429 #define SCOREP_REGION_TYPE( NAME, name_str ) \
430  SCOREP_REGION_ ## NAME,
431 
432 typedef enum SCOREP_RegionType
433 {
434  SCOREP_REGION_UNKNOWN = 0,
435  SCOREP_REGION_FUNCTION,
436  SCOREP_REGION_LOOP,
437  SCOREP_REGION_USER,
438  SCOREP_REGION_CODE,
439 
440  SCOREP_REGION_PHASE,
441  SCOREP_REGION_DYNAMIC,
442  SCOREP_REGION_DYNAMIC_PHASE,
443  SCOREP_REGION_DYNAMIC_LOOP,
444  SCOREP_REGION_DYNAMIC_FUNCTION,
445  SCOREP_REGION_DYNAMIC_LOOP_PHASE,
446 
447  SCOREP_REGION_TYPES
448 
451 
452 #undef SCOREP_REGION_TYPE
453 
454 
455 
467 #define SCOREP_RMA_SYNC_TYPES \
468  SCOREP_RMA_SYNC_TYPE( MEMORY, memory, "memory" ) \
469  SCOREP_RMA_SYNC_TYPE( NOTIFY_IN, notify_in, "notify in" ) \
470  SCOREP_RMA_SYNC_TYPE( NOTIFY_OUT, notify_out, "notify out" )
471 
472 typedef enum SCOREP_RmaSyncType
473 {
474 #define SCOREP_RMA_SYNC_TYPE( upper, lower, name ) SCOREP_RMA_SYNC_TYPE_ ## upper,
475  SCOREP_RMA_SYNC_TYPES
476  #undef SCOREP_RMA_SYNC_TYPE
477 
480 
481 
482 
494 #define SCOREP_RMA_SYNC_LEVELS \
495  SCOREP_RMA_SYNC_LEVEL( NONE, none, "none", 0 ) \
496  SCOREP_RMA_SYNC_LEVEL( PROCESS, process, "process", 1 << 0 ) \
497  SCOREP_RMA_SYNC_LEVEL( MEMORY, memory, "memory", 1 << 1 )
498 
500 {
501 #define SCOREP_RMA_SYNC_LEVEL( upper, lower, name, value ) \
502  SCOREP_RMA_SYNC_LEVEL_ ## upper = value,
503 
504  SCOREP_RMA_SYNC_LEVELS
505 #undef SCOREP_RMA_SYNC_LEVEL
507 
508 
526 #define SCOREP_RMA_ATOMIC_TYPES \
527  SCOREP_RMA_ATOMIC_TYPE( ACCUMULATE, accumulate, "accumulate" ) \
528  SCOREP_RMA_ATOMIC_TYPE( INCREMENT, increment, "increment" ) \
529  SCOREP_RMA_ATOMIC_TYPE( TEST_AND_SET, test_and_set, "test and set" ) \
530  SCOREP_RMA_ATOMIC_TYPE( COMPARE_AND_SWAP, compare_and_swap, "compare and swap" ) \
531  SCOREP_RMA_ATOMIC_TYPE( SWAP, swap, "swap" ) \
532  SCOREP_RMA_ATOMIC_TYPE( FETCH_AND_ADD, fetch_and_add, "fetch and add" ) \
533  SCOREP_RMA_ATOMIC_TYPE( FETCH_AND_INCREMENT, fetch_and_increment, "fetch and increment" ) \
534  SCOREP_RMA_ATOMIC_TYPE( ADD, add, "add" )
535 
537 {
538 #define SCOREP_RMA_ATOMIC_TYPE( upper, lower, name ) SCOREP_RMA_ATOMIC_TYPE_ ## upper,
539  SCOREP_RMA_ATOMIC_TYPES
540  #undef SCOREP_RMA_ATOMIC_TYPE
541 
542  SCOREP_INVALID_RMA_ATOMIC_TYPE
544 
545 
551 {
556 
562 typedef enum SCOREP_MetricScope
563 {
572 
575 
582 {
591 
594 
595 
613 #define SCOREP_IPC_DATATYPES \
614  SCOREP_IPC_DATATYPE( BYTE ) \
615  SCOREP_IPC_DATATYPE( CHAR ) \
616  SCOREP_IPC_DATATYPE( UNSIGNED_CHAR ) \
617  SCOREP_IPC_DATATYPE( INT ) \
618  SCOREP_IPC_DATATYPE( UNSIGNED ) \
619  SCOREP_IPC_DATATYPE( INT32_T ) \
620  SCOREP_IPC_DATATYPE( UINT32_T ) \
621  SCOREP_IPC_DATATYPE( INT64_T ) \
622  SCOREP_IPC_DATATYPE( UINT64_T ) \
623  SCOREP_IPC_DATATYPE( DOUBLE )
624 
626 {
627 #define SCOREP_IPC_DATATYPE( datatype ) \
628  SCOREP_IPC_ ## datatype,
629  SCOREP_IPC_DATATYPES
630 #undef SCOREP_IPC_DATATYPE
631  SCOREP_IPC_NUMBER_OF_DATATYPES
633 
646 #define SCOREP_IPC_OPERATIONS \
647  SCOREP_IPC_OPERATION( BAND ) \
648  SCOREP_IPC_OPERATION( BOR ) \
649  SCOREP_IPC_OPERATION( MIN ) \
650  SCOREP_IPC_OPERATION( MAX ) \
651  SCOREP_IPC_OPERATION( SUM )
652 
654 {
655 #define SCOREP_IPC_OPERATION( op ) \
656  SCOREP_IPC_ ## op,
657  SCOREP_IPC_OPERATIONS
658 #undef SCOREP_IPC_OPERATION
659  SCOREP_IPC_NUMBER_OF_OPERATIONS
661 
662 
675 {
682 
685 #endif /* SCOREP_PUBLICTYPES_H */
Definition: SCOREP_PublicTypes.h:573
Definition: SCOREP_PublicTypes.h:592
SCOREP_AnyHandle SCOREP_SamplingSetHandle
Definition: SCOREP_PublicTypes.h:109
struct SCOREP_Task * SCOREP_TaskHandle
Definition: SCOREP_PublicTypes.h:145
#define SCOREP_LOCATION_TYPES
Definition: SCOREP_PublicTypes.h:184
Definition: SCOREP_PublicTypes.h:171
Definition: SCOREP_PublicTypes.h:584
Definition: SCOREP_PublicTypes.h:207
Definition: SCOREP_PublicTypes.h:154
Definition: SCOREP_PublicTypes.h:213
SCOREP_AnyHandle SCOREP_SourceFileHandle
Definition: SCOREP_PublicTypes.h:84
Definition: SCOREP_PublicTypes.h:157
SCOREP_AnyHandle SCOREP_MetricHandle
Definition: SCOREP_PublicTypes.h:96
SCOREP_CollectiveType
Types to specify the used collectives in calls to SCOREP_MpiCollectiveBegin and SCOREP_RmaCollectiveB...
Definition: SCOREP_PublicTypes.h:151
Definition: SCOREP_PublicTypes.h:677
Definition: SCOREP_PublicTypes.h:169
Definition: SCOREP_PublicTypes.h:590
Definition: SCOREP_PublicTypes.h:553
SCOREP_RmaSyncType
Type of direct RMA synchronization call.
Definition: SCOREP_PublicTypes.h:472
Definition: SCOREP_PublicTypes.h:168
SCOREP_Substrates_RequirementFlag
Definition: SCOREP_PublicTypes.h:674
int SCOREP_MpiRank
Definition: SCOREP_PublicTypes.h:219
SCOREP_RmaSyncLevel
specifies a RMA synchronization level, used by RMA records to be passed to SCOREP_Rma*() functions...
Definition: SCOREP_PublicTypes.h:499
SCOREP_AnyHandle SCOREP_ParadigmHandle
Definition: SCOREP_PublicTypes.h:133
Definition: SCOREP_PublicTypes.h:334
SCOREP_ParadigmType
defines paradigms that are be monitored
Definition: SCOREP_PublicTypes.h:311
Definition: SCOREP_PublicTypes.h:174
Definition: SCOREP_PublicTypes.h:156
Definition: SCOREP_PublicTypes.h:170
SCOREP_LockType
Definition: SCOREP_PublicTypes.h:203
Definition: SCOREP_PublicTypes.h:165
Definition: SCOREP_PublicTypes.h:569
Definition: SCOREP_PublicTypes.h:162
Definition: SCOREP_PublicTypes.h:197
Definition: SCOREP_PublicTypes.h:267
Definition: SCOREP_PublicTypes.h:211
Definition: SCOREP_PublicTypes.h:554
Definition: SCOREP_PublicTypes.h:172
Definition: SCOREP_PublicTypes.h:164
Definition: SCOREP_PublicTypes.h:680
Definition: SCOREP_PublicTypes.h:331
Definition: SCOREP_PublicTypes.h:173
Definition: SCOREP_PublicTypes.h:449
uint32_t SCOREP_LineNo
Definition: SCOREP_PublicTypes.h:51
Definition: SCOREP_PublicTypes.h:159
SCOREP_SamplingSetClass
Class of locations which recorded a sampling set.
Definition: SCOREP_PublicTypes.h:550
Definition: SCOREP_PublicTypes.h:166
Definition: SCOREP_PublicTypes.h:160
SCOREP_Ipc_Operation
specifies an inter process communication operation for reduce function
Definition: SCOREP_PublicTypes.h:653
Definition: SCOREP_PublicTypes.h:332
SCOREP_Allocator_MovableMemory SCOREP_AnyHandle
Definition: SCOREP_PublicTypes.h:78
SCOREP_RmaAtomicType
specifies a RMA Atomic Operation Type.
Definition: SCOREP_PublicTypes.h:536
SCOREP_ParameterType
defines types to be used in defining a parameter for parameter based profiling (SCOREP_Definitions_Ne...
Definition: SCOREP_PublicTypes.h:328
Definition: SCOREP_PublicTypes.h:319
Definition: SCOREP_PublicTypes.h:167
Definition: SCOREP_PublicTypes.h:163
Definition: SCOREP_PublicTypes.h:565
Definition: SCOREP_PublicTypes.h:552
SCOREP_ParadigmClass
defines classes of paradigms that are monitored Types:
Definition: SCOREP_PublicTypes.h:259
Definition: SCOREP_PublicTypes.h:155
uint64_t SCOREP_MpiRequestId
Definition: SCOREP_PublicTypes.h:225
Definition: SCOREP_PublicTypes.h:587
SCOREP_Ipc_Datatype
specifies an inter process communication data types
Definition: SCOREP_PublicTypes.h:625
Definition: SCOREP_PublicTypes.h:175
uint32_t SCOREP_Allocator_MovableMemory
Definition: SCOREP_PublicTypes.h:66
Definition: SCOREP_PublicTypes.h:153
Definition: SCOREP_PublicTypes.h:330
SCOREP_AnyHandle SCOREP_RegionHandle
Definition: SCOREP_PublicTypes.h:121
Definition: SCOREP_PublicTypes.h:567
SCOREP_MetricScope
Types to be used in defining the scope of a scoped sampling set.
Definition: SCOREP_PublicTypes.h:562
Definition: SCOREP_PublicTypes.h:478
SCOREP_LocationType
Definition: SCOREP_PublicTypes.h:190
Definition: SCOREP_PublicTypes.h:158
SCOREP_MetricOccurrence
Types to be used in defining the occurrence of a sampling set.
Definition: SCOREP_PublicTypes.h:581
Definition: SCOREP_PublicTypes.h:161
Definition: SCOREP_PublicTypes.h:571
SCOREP_RegionType
specifies a Region
Definition: SCOREP_PublicTypes.h:432