1.4.2 (revision 8839)
SCOREP_User_Types.h
Go to the documentation of this file.
00001 /*
00002  * This file is part of the Score-P software (http://www.score-p.org)
00003  *
00004  * Copyright (c) 2009-2011,
00005  *    RWTH Aachen University, Germany
00006  *
00007  * Copyright (c) 2009-2011,
00008  *    Gesellschaft fuer numerische Simulation mbH Braunschweig, Germany
00009  *
00010  * Copyright (c) 2009-2011,
00011  *    Technische Universitaet Dresden, Germany
00012  *
00013  * Copyright (c) 2009-2011,
00014  *    University of Oregon, Eugene, USA
00015  *
00016  * Copyright (c) 2009-2011,
00017  *    Forschungszentrum Juelich GmbH, Germany
00018  *
00019  * Copyright (c) 2009-2011,
00020  *    German Research School for Simulation Sciences GmbH, Juelich/Aachen, Germany
00021  *
00022  * Copyright (c) 2009-2011,
00023  *    Technische Universitaet Muenchen, Germany
00024  *
00025  * This software may be modified and distributed under the terms of
00026  * a BSD-style license.  See the COPYING file in the package base
00027  * directory for details.
00028  *
00029  */
00030 
00031 #ifndef SCOREP_USER_TYPES_H
00032 #define SCOREP_USER_TYPES_H
00033 
00040 #include <scorep/SCOREP_PublicTypes.h>
00041 
00042 /* **************************************************************************************
00043  * Typedefs
00044  * *************************************************************************************/
00045 
00046 struct SCOREP_User_Region;
00047 
00051 typedef struct SCOREP_User_Region* SCOREP_User_RegionHandle;
00052 
00057 #define SCOREP_USER_INVALID_REGION NULL
00058 
00062 typedef uint32_t SCOREP_User_RegionType;
00063 
00067 typedef uint32_t SCOREP_User_MetricType;
00068 
00072 typedef uint64_t SCOREP_User_ParameterHandle;
00073 
00078 #define SCOREP_USER_INVALID_PARAMETER -1
00079 
00080 /* **************************************************************************************
00081  * Defines for the Region types
00082  * *************************************************************************************/
00083 
00098 #define SCOREP_USER_REGION_TYPE_COMMON 0
00099 
00104 #define SCOREP_USER_REGION_TYPE_FUNCTION 1
00105 
00111 #define SCOREP_USER_REGION_TYPE_LOOP 2
00112 
00117 #define SCOREP_USER_REGION_TYPE_DYNAMIC  4
00118 
00123 #define SCOREP_USER_REGION_TYPE_PHASE    8
00124 
00127 /* **************************************************************************************
00128  * Defines for the data type of a user counter
00129  * *************************************************************************************/
00130 
00140 #define SCOREP_USER_METRIC_TYPE_INT64 0
00141 
00146 #define SCOREP_USER_METRIC_TYPE_UINT64 1
00147 
00152 #define SCOREP_USER_METRIC_TYPE_DOUBLE 2
00153 
00156 /* **************************************************************************************
00157  * Defines for the context of user counters
00158  * *************************************************************************************/
00159 
00168 #define SCOREP_USER_METRIC_CONTEXT_GLOBAL 0
00169 
00174 #define SCOREP_USER_METRIC_CONTEXT_CALLPATH 1
00175 
00178 /* **************************************************************************************
00179  * Default and uninitialized handles
00180  * *************************************************************************************/
00181 
00186 #endif // SCOREP_USER_TYPES_H