SCOREP_User_Types.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: (c) 2009 RWTH Aachen University <rwth-aachen.de>
 * SPDX-FileCopyrightText: (c) 2009 Gesellschaft für numerische Simulation mbH Braunschweig <gns-mbh.com>
 * SPDX-FileCopyrightText: (c) 2009 Technische Universität Dresden <tu-dresden.de>
 * SPDX-FileCopyrightText: (c) 2009 University of Oregon <uoregon.edu>
 * SPDX-FileCopyrightText: (c) 2009 Forschungszentrum Jülich GmbH <fz-juelich.de>
 * SPDX-FileCopyrightText: (c) 2009 German Research School for Simulation Sciences GmbH
 * SPDX-FileCopyrightText: (c) 2009 Technische Universität München <tum.de>
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */

#ifndef SCOREP_USER_TYPES_H
#define SCOREP_USER_TYPES_H

#include <scorep/SCOREP_PublicTypes.h>

/* **************************************************************************************
 * Typedefs
 * *************************************************************************************/

struct SCOREP_User_Region;

typedef struct SCOREP_User_Region* SCOREP_User_RegionHandle;

#define SCOREP_USER_INVALID_REGION NULL

typedef uint32_t SCOREP_User_RegionType;

typedef uint32_t SCOREP_User_MetricType;

typedef uint64_t SCOREP_User_ParameterHandle;

#define SCOREP_USER_INVALID_PARAMETER -1

#define SCOREP_USER_INVALID_TOPOLOGY -1

typedef struct SCOREP_User_Topology* SCOREP_User_CartesianTopologyHandle;
#define SCOREP_USER_INVALID_CARTESIAN_TOPOLOGY NULL

/* **************************************************************************************
 * Defines for the Region types
 * *************************************************************************************/

#define SCOREP_USER_REGION_TYPE_COMMON 0

#define SCOREP_USER_REGION_TYPE_FUNCTION 1

#define SCOREP_USER_REGION_TYPE_LOOP 2

#define SCOREP_USER_REGION_TYPE_DYNAMIC  4

#define SCOREP_USER_REGION_TYPE_PHASE    8

/* **************************************************************************************
 * Defines for the data type of a user counter
 * *************************************************************************************/

#define SCOREP_USER_METRIC_TYPE_INT64 0

#define SCOREP_USER_METRIC_TYPE_UINT64 1

#define SCOREP_USER_METRIC_TYPE_DOUBLE 2

/* **************************************************************************************
 * Defines for the context of user counters
 * *************************************************************************************/

#define SCOREP_USER_METRIC_CONTEXT_GLOBAL 0

#define SCOREP_USER_METRIC_CONTEXT_CALLPATH 1

/* **************************************************************************************
 * Default and uninitialized handles
 * *************************************************************************************/

#endif /* SCOREP_USER_TYPES_H */