2.0 (revision 4408)
OTF2_Definitions.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-2012,
5  * RWTH Aachen University, Germany
6  *
7  * Copyright (c) 2009-2012,
8  * Gesellschaft fuer numerische Simulation mbH Braunschweig, Germany
9  *
10  * Copyright (c) 2009-2012,
11  * Technische Universitaet Dresden, Germany
12  *
13  * Copyright (c) 2009-2012,
14  * University of Oregon, Eugene, USA
15  *
16  * Copyright (c) 2009-2012,
17  * Forschungszentrum Juelich GmbH, Germany
18  *
19  * Copyright (c) 2009-2012,
20  * German Research School for Simulation Sciences GmbH, Juelich/Aachen, Germany
21  *
22  * Copyright (c) 2009-2012,
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 
32 #ifndef OTF2_DEFINITIONS_H
33 #define OTF2_DEFINITIONS_H
34 
35 
44 #include <otf2/OTF2_ErrorCodes.h>
45 
46 
48 
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif /* __cplusplus */
53 
54 
56 typedef uint8_t OTF2_SystemTreeDomain;
57 
64 {
91 };
92 
93 
95 typedef uint8_t OTF2_LocationGroupType;
96 
103 {
110 };
111 
112 
114 typedef uint8_t OTF2_LocationType;
115 
122 {
135 };
136 
137 
139 typedef uint8_t OTF2_RegionRole;
140 
147 {
277 };
278 
279 
281 typedef uint32_t OTF2_RegionFlag;
282 
289 {
301 };
302 
303 
305 typedef uint8_t OTF2_GroupType;
306 
313 {
356 };
357 
358 
360 typedef uint32_t OTF2_GroupFlag;
361 
368 {
378 };
379 
380 
382 typedef uint8_t OTF2_Base;
383 
390 {
397 };
398 
399 
401 typedef uint8_t OTF2_MetricOccurrence;
402 
409 {
421 };
422 
423 
425 typedef uint8_t OTF2_MetricType;
426 
433 {
446 };
447 
448 
450 typedef uint8_t OTF2_MetricValueProperty;
451 
459 {
470 
474  OTF2_METRIC_VALUE_MASK = 15 /* xxxx1111 */
475 };
476 
477 
479 typedef uint8_t OTF2_MetricTiming;
480 
489 {
506 
510  OTF2_METRIC_TIMING_MASK = 240 /* 1111xxxx */
511 };
512 
513 
515 typedef uint8_t OTF2_MetricMode;
516 
523 {
554 };
555 
556 
558 typedef uint8_t OTF2_MetricScope;
559 
566 {
579 };
580 
581 
583 typedef uint8_t OTF2_RecorderKind;
584 
591 {
607 };
608 
609 
611 typedef uint8_t OTF2_ParameterType;
612 
619 {
629 };
630 
631 
633 typedef uint8_t OTF2_CartPeriodicity;
634 
641 {
648 };
649 
650 
653 
660 {
667 };
668 
669 
670 #ifdef __cplusplus
671 }
672 #endif /* __cplusplus */
673 
674 
675 #endif /* OTF2_DEFINITIONS_H */
Collective 1:N communication operation.
Definition: OTF2_Definitions.h:219
uint32_t OTF2_GroupFlag
Wrapper for enum OTF2_GroupFlag_enum.
Definition: OTF2_Definitions.h:360
Accumulated metric, 'START' timing.
Definition: OTF2_Definitions.h:526
Metric occurs only at a region enter and leave, but does not need to occur at every enter/leave...
Definition: OTF2_Definitions.h:416
Scope of a metric is a generic group of locations.
Definition: OTF2_Definitions.h:578
uint8_t OTF2_ParameterType
Wrapper for enum OTF2_ParameterType_enum.
Definition: OTF2_Definitions.h:611
Explicit barrier.
Definition: OTF2_Definitions.h:195
E.g. OpenMP "flush" construct.
Definition: OTF2_Definitions.h:201
OTF2_CartPeriodicity_enum
Periodicity types of a cartesian topology dimension.
Definition: OTF2_Definitions.h:640
Each time this region is entered it will get an individual call path in the profile.
Definition: OTF2_Definitions.h:296
Cache. Can be L1i, L1d, L2, L3, ...
Definition: OTF2_Definitions.h:83
Scope of a metric is a location group.
Definition: OTF2_Definitions.h:572
uint8_t OTF2_MetricValueProperty
Wrapper for enum OTF2_MetricValueProperty_enum.
Definition: OTF2_Definitions.h:450
A function which waits for the completion of one thread.
Definition: OTF2_Definitions.h:255
OTF2_Base_enum
Metric base types.
Definition: OTF2_Definitions.h:389
uint8_t OTF2_MetricMode
Wrapper for enum OTF2_MetricMode_enum.
Definition: OTF2_Definitions.h:515
OTF2_RecorderKind_enum
List of possible kinds a MetricClass can be recorded by.
Definition: OTF2_Definitions.h:590
E.g. OpenMP "ordered" construct (structured block)
Definition: OTF2_Definitions.h:207
This mask can be used to get lower half-byte in OTF2_MetricMode that is used to indicate metric value...
Definition: OTF2_Definitions.h:474
Relative metric, 'LAST' timing.
Definition: OTF2_Definitions.h:550
This mask can be used to get the upper half-byte in OTF2_MetricMode that is used to indicate metric t...
Definition: OTF2_Definitions.h:510
uint8_t OTF2_Base
Wrapper for enum OTF2_Base_enum.
Definition: OTF2_Definitions.h:382
Scope of a metric is another location.
Definition: OTF2_Definitions.h:569
Metric value is valid from now until the next counter sample, i.e. the future right ahead...
Definition: OTF2_Definitions.h:505
Relative metric, 'NEXT' timing.
Definition: OTF2_Definitions.h:553
Denotes that the interrupts generated are count based.
Definition: OTF2_Definitions.h:666
OTF2_MetricValueProperty_enum
Information about whether the metric value is accumulated, absolute, or relative. Used for the lower ...
Definition: OTF2_Definitions.h:458
uint8_t OTF2_RecorderKind
Wrapper for enum OTF2_RecorderKind_enum.
Definition: OTF2_Definitions.h:583
"untied task" construct (structured block)
Definition: OTF2_Definitions.h:260
Parameter is of type signed 8-byte integer.
Definition: OTF2_Definitions.h:625
Metric value is related to the time interval since the last counter sample of the same metric...
Definition: OTF2_Definitions.h:501
OTF2_MetricOccurrence_enum
Metric occurrence.
Definition: OTF2_Definitions.h:408
Collective N:1 communication operation.
Definition: OTF2_Definitions.h:222
uint8_t OTF2_RegionRole
Wrapper for enum OTF2_RegionRole_enum.
Definition: OTF2_Definitions.h:139
Group of regions.
Definition: OTF2_Definitions.h:322
An entire function/subroutine.
Definition: OTF2_Definitions.h:153
Individual "section" inside an OpenMP "sections" construct.
Definition: OTF2_Definitions.h:171
A function which deallocates memory.
Definition: OTF2_Definitions.h:270
OTF2_GroupType_enum
List of available group types.
Definition: OTF2_Definitions.h:312
Group of metrics.
Definition: OTF2_Definitions.h:325
E.g. OpenMP "single" construct.
Definition: OTF2_Definitions.h:177
Dimension is periodic.
Definition: OTF2_Definitions.h:647
E.g. OpenMP "critical" construct.
Definition: OTF2_Definitions.h:186
Absolute metric (i.e., temperature, rate, mean value, etc.).
Definition: OTF2_Definitions.h:466
Scope of a metric is a system tree node.
Definition: OTF2_Definitions.h:575
Each time this region is entered it will get an individual root node in the profile.
Definition: OTF2_Definitions.h:300
This header file provides general definitions which should be accessible in all internal and external...
All nodes below a node with this attribute encompass a tightly coupled HPC system.
Definition: OTF2_Definitions.h:68
A location group of unknown type.
Definition: OTF2_Definitions.h:106
Decimal base.
Definition: OTF2_Definitions.h:396
A function which changes a previous memory allocation to either increase or decrease the amount...
Definition: OTF2_Definitions.h:276
Metric can occur at any place i.e. it is not related to region enter and leaves.
Definition: OTF2_Definitions.h:420
Any metric of a type not explicitly listed below.
Definition: OTF2_Definitions.h:436
A remote memory access communication operation.
Definition: OTF2_Definitions.h:237
uint8_t OTF2_MetricType
Wrapper for enum OTF2_MetricType_enum.
Definition: OTF2_Definitions.h:425
A region of unknown role.
Definition: OTF2_Definitions.h:150
E.g. OpenMP "single" construct (structured block)
Definition: OTF2_Definitions.h:180
Special group type to efficiently handle self-like communicators (i.e., MPI_COMM_SELF and friends)...
Definition: OTF2_Definitions.h:355
OTF2_LocationType_enum
List of possible definitions of type Location.
Definition: OTF2_Definitions.h:121
A data transfer operation in memory.
Definition: OTF2_Definitions.h:240
Accumulated metric is monotonously increasing (i.e., PAPI counter for number of executed floating poi...
Definition: OTF2_Definitions.h:463
Absolute metric, 'LAST' timing.
Definition: OTF2_Definitions.h:541
"task" construct (creation)
Definition: OTF2_Definitions.h:213
Dimension is not periodic.
Definition: OTF2_Definitions.h:644
E.g. OpenMP "critical" construct (structured block)
Definition: OTF2_Definitions.h:189
E.g. OpenMP "master" construct.
Definition: OTF2_Definitions.h:183
A numa domain. A set of processors around memory which the processors can directly access...
Definition: OTF2_Definitions.h:76
OTF2_ParameterType_enum
List of possible for definitions of type Parameter.
Definition: OTF2_Definitions.h:618
An arbitrary section of code.
Definition: OTF2_Definitions.h:162
uint8_t OTF2_InterruptGeneratorMode
Wrapper for enum OTF2_InterruptGeneratorMode_enum.
Definition: OTF2_Definitions.h:652
Metric value belongs to the time interval since the beginning of the measurement. ...
Definition: OTF2_Definitions.h:493
A location of unknown type.
Definition: OTF2_Definitions.h:125
Core. A computation unit (may be shared by several logical processors).
Definition: OTF2_Definitions.h:87
uint8_t OTF2_LocationType
Wrapper for enum OTF2_LocationType_enum.
Definition: OTF2_Definitions.h:114
uint8_t OTF2_MetricOccurrence
Wrapper for enum OTF2_MetricOccurrence_enum.
Definition: OTF2_Definitions.h:401
uint8_t OTF2_LocationGroupType
Wrapper for enum OTF2_LocationGroupType_enum.
Definition: OTF2_Definitions.h:95
E.g. OpenMP "ordered" construct.
Definition: OTF2_Definitions.h:204
OTF2_MetricScope_enum
List of available metric scopes.
Definition: OTF2_Definitions.h:565
A point-to-point communication function.
Definition: OTF2_Definitions.h:234
OTF2_MetricMode_enum
Metric mode is a combination of value property and timing information.
Definition: OTF2_Definitions.h:522
Accumulated metric, 'POINT' timing.
Definition: OTF2_Definitions.h:529
OTF2_GroupFlag_enum
List of possible flags to specify special characteristics of a Group.
Definition: OTF2_Definitions.h:367
OTF2_MetricType_enum
List of available metric types.
Definition: OTF2_Definitions.h:432
A CPU thread.
Definition: OTF2_Definitions.h:128
Collective M:N communication operation.
Definition: OTF2_Definitions.h:228
OTF2_MetricTiming_enum
Determines when the values have been collected or for which interval of time they are valid...
Definition: OTF2_Definitions.h:488
Parameter is of type string.
Definition: OTF2_Definitions.h:622
uint8_t OTF2_GroupType
Wrapper for enum OTF2_GroupType_enum.
Definition: OTF2_Definitions.h:305
Accumulated metric, 'LAST' timing.
Definition: OTF2_Definitions.h:532
A metric only location e.g. an external device.
Definition: OTF2_Definitions.h:134
Socket, physical package, or chip. In the physical meaning, i.e. that you can add or remove physicall...
Definition: OTF2_Definitions.h:80
This metric class will only be recorded by locations of type OTF2_LOCATION_TYPE_GPU.
Definition: OTF2_Definitions.h:606
A group without special characterization.
Definition: OTF2_Definitions.h:371
E.g. OpenMP "workshare" construct.
Definition: OTF2_Definitions.h:174
"task" construct (structured block)
Definition: OTF2_Definitions.h:210
uint8_t OTF2_MetricScope
Wrapper for enum OTF2_MetricScope_enum.
Definition: OTF2_Definitions.h:558
OTF2_InterruptGeneratorMode_enum
List of possible modes of InterruptGenerator.
Definition: OTF2_Definitions.h:659
Metric value is only valid at a point in time but not necessarily for any interval of time...
Definition: OTF2_Definitions.h:497
Parameter is of type unsigned 8-byte integer.
Definition: OTF2_Definitions.h:628
No specific kind of recorder.
Definition: OTF2_Definitions.h:594
Processing Unit (A non-shared ALU, FPU, ...)
Definition: OTF2_Definitions.h:90
An API function wrapped by Score-P.
Definition: OTF2_Definitions.h:156
A GPU location.
Definition: OTF2_Definitions.h:131
Group of unknown type.
Definition: OTF2_Definitions.h:316
All nodes below a node with this attribute encompass a system where processes can communicate via har...
Definition: OTF2_Definitions.h:72
uint8_t OTF2_CartPeriodicity
Wrapper for enum OTF2_CartPeriodicity_enum.
Definition: OTF2_Definitions.h:633
A loop in the code.
Definition: OTF2_Definitions.h:159
An artificial region, mostly used by the monitor software.
Definition: OTF2_Definitions.h:245
This metric class will only be recorded by locations of type OTF2_LOCATION_TYPE_CPU_THREAD.
Definition: OTF2_Definitions.h:602
Group of locations.
Definition: OTF2_Definitions.h:319
List of locations which participated in the paradigm specified by the group definition.
Definition: OTF2_Definitions.h:344
Binary base.
Definition: OTF2_Definitions.h:393
The metric class will only be recorded via a MetricInstance definitions.
Definition: OTF2_Definitions.h:598
Implicit barrier.
Definition: OTF2_Definitions.h:198
E.g. OpenMP "atomic" construct.
Definition: OTF2_Definitions.h:192
uint32_t OTF2_RegionFlag
Wrapper for enum OTF2_RegionFlag_enum.
Definition: OTF2_Definitions.h:281
Relative metric, 'POINT' timing.
Definition: OTF2_Definitions.h:547
A function which creates one thread.
Definition: OTF2_Definitions.h:250
Absolute metric, 'POINT' timing.
Definition: OTF2_Definitions.h:538
Denotes that the interrupts generated are time based.
Definition: OTF2_Definitions.h:663
A sub-group of the corresponding group definition with type OTF2_GROUP_TYPE_COMM_LOCATIONS and the sa...
Definition: OTF2_Definitions.h:350
"taskwait" construct
Definition: OTF2_Definitions.h:216
OTF2_LocationGroupType_enum
List of possible definitions of type LocationGroup.
Definition: OTF2_Definitions.h:102
Accumulated metric, 'NEXT' timing.
Definition: OTF2_Definitions.h:535
No translation of ranks in event records needs to be done when a group of type OTF2_GROUP_TYPE_COMM_G...
Definition: OTF2_Definitions.h:377
Absolute metric, 'NEXT' timing.
Definition: OTF2_Definitions.h:544
OTF2_RegionRole_enum
List of possible roles of a Region.
Definition: OTF2_Definitions.h:146
OTF2_RegionFlag_enum
List of possible flags to specify special characteristics of a Region.
Definition: OTF2_Definitions.h:288
OTF2_SystemTreeDomain_enum
List of available system tree node domains.
Definition: OTF2_Definitions.h:63
Collective N:N communication operation.
Definition: OTF2_Definitions.h:225
Relative metric.
Definition: OTF2_Definitions.h:469
Error codes and error handling.
E.g. OpenMP "sections" construct.
Definition: OTF2_Definitions.h:168
Any file I/O operation.
Definition: OTF2_Definitions.h:231
E.g. OpenMP "parallel" construct (structured block)
Definition: OTF2_Definitions.h:165
Resource usage counter.
Definition: OTF2_Definitions.h:442
uint8_t OTF2_MetricTiming
Wrapper for enum OTF2_MetricTiming_enum.
Definition: OTF2_Definitions.h:479
A region without special characterization.
Definition: OTF2_Definitions.h:292
PAPI counter.
Definition: OTF2_Definitions.h:439
Metric occurs at every region enter and leave.
Definition: OTF2_Definitions.h:412
A process.
Definition: OTF2_Definitions.h:109
User metrics.
Definition: OTF2_Definitions.h:445
uint8_t OTF2_SystemTreeDomain
Wrapper for enum OTF2_SystemTreeDomain_enum.
Definition: OTF2_Definitions.h:56
A function which allocates memory.
Definition: OTF2_Definitions.h:265