6.0 (revision 14673)
SCOREP_User_Types.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,
11  * Technische Universitaet Dresden, Germany
12  *
13  * Copyright (c) 2009-2011,
14  * University of Oregon, Eugene, USA
15  *
16  * Copyright (c) 2009-2011, 2016,
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 #ifndef SCOREP_USER_TYPES_H
32 #define SCOREP_USER_TYPES_H
33 
41 
42 /* **************************************************************************************
43  * Typedefs
44  * *************************************************************************************/
45 
46 struct SCOREP_User_Region;
47 
51 typedef struct SCOREP_User_Region* SCOREP_User_RegionHandle;
52 
57 #define SCOREP_USER_INVALID_REGION NULL
58 
62 typedef uint32_t SCOREP_User_RegionType;
63 
67 typedef uint32_t SCOREP_User_MetricType;
68 
72 typedef uint64_t SCOREP_User_ParameterHandle;
73 
78 #define SCOREP_USER_INVALID_PARAMETER -1
79 
84 #define SCOREP_USER_INVALID_TOPOLOGY -1
85 
88 typedef struct SCOREP_User_Topology* SCOREP_User_CartesianTopologyHandle;
89 #define SCOREP_USER_INVALID_CARTESIAN_TOPOLOGY NULL
90 
91 /* **************************************************************************************
92  * Defines for the Region types
93  * *************************************************************************************/
94 
109 #define SCOREP_USER_REGION_TYPE_COMMON 0
110 
115 #define SCOREP_USER_REGION_TYPE_FUNCTION 1
116 
122 #define SCOREP_USER_REGION_TYPE_LOOP 2
123 
128 #define SCOREP_USER_REGION_TYPE_DYNAMIC 4
129 
134 #define SCOREP_USER_REGION_TYPE_PHASE 8
135 
138 /* **************************************************************************************
139  * Defines for the data type of a user counter
140  * *************************************************************************************/
141 
151 #define SCOREP_USER_METRIC_TYPE_INT64 0
152 
157 #define SCOREP_USER_METRIC_TYPE_UINT64 1
158 
163 #define SCOREP_USER_METRIC_TYPE_DOUBLE 2
164 
167 /* **************************************************************************************
168  * Defines for the context of user counters
169  * *************************************************************************************/
170 
179 #define SCOREP_USER_METRIC_CONTEXT_GLOBAL 0
180 
185 #define SCOREP_USER_METRIC_CONTEXT_CALLPATH 1
186 
189 /* **************************************************************************************
190  * Default and uninitialized handles
191  * *************************************************************************************/
192 
197 #endif /* SCOREP_USER_TYPES_H */
Defines public definitions that are used internally and externally (e.g., by metric plugins...
struct SCOREP_User_Topology * SCOREP_User_CartesianTopologyHandle
Definition: SCOREP_User_Types.h:88
struct SCOREP_User_Region * SCOREP_User_RegionHandle
Definition: SCOREP_User_Types.h:51
uint32_t SCOREP_User_MetricType
Definition: SCOREP_User_Types.h:67
uint64_t SCOREP_User_ParameterHandle
Definition: SCOREP_User_Types.h:72
uint32_t SCOREP_User_RegionType
Definition: SCOREP_User_Types.h:62