SCOREP_MetricTypes.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_METRIC_TYPES_H
#define SCOREP_METRIC_TYPES_H

#include <stdint.h>

/* *********************************************************************
 * Type definitions
 **********************************************************************/



typedef enum SCOREP_MetricSourceType
{
    SCOREP_METRIC_SOURCE_TYPE_PAPI   = 0,
    SCOREP_METRIC_SOURCE_TYPE_RUSAGE = 1,
    SCOREP_METRIC_SOURCE_TYPE_USER   = 2,
    SCOREP_METRIC_SOURCE_TYPE_OTHER  = 3,
    SCOREP_METRIC_SOURCE_TYPE_TASK   = 4,
    SCOREP_METRIC_SOURCE_TYPE_PLUGIN = 5,
    SCOREP_METRIC_SOURCE_TYPE_PERF   = 6,

    SCOREP_INVALID_METRIC_SOURCE_TYPE 
} SCOREP_MetricSourceType;

typedef enum SCOREP_MetricProfilingType
{
    SCOREP_METRIC_PROFILING_TYPE_EXCLUSIVE = 0,
    SCOREP_METRIC_PROFILING_TYPE_INCLUSIVE = 1,
    SCOREP_METRIC_PROFILING_TYPE_SIMPLE    = 2,
    SCOREP_METRIC_PROFILING_TYPE_MAX       = 3,
    SCOREP_METRIC_PROFILING_TYPE_MIN       = 4,

    SCOREP_INVALID_METRIC_PROFILING_TYPE 
} SCOREP_MetricProfilingType;

typedef enum SCOREP_MetricValueType
{
    SCOREP_METRIC_VALUE_INT64,
    SCOREP_METRIC_VALUE_UINT64,
    SCOREP_METRIC_VALUE_DOUBLE,

    SCOREP_INVALID_METRIC_VALUE_TYPE 
} SCOREP_MetricValueType;

typedef enum SCOREP_MetricMode
{
    SCOREP_METRIC_MODE_ACCUMULATED_START = 0,
    SCOREP_METRIC_MODE_ACCUMULATED_POINT = 1,
    SCOREP_METRIC_MODE_ACCUMULATED_LAST  = 2,
    SCOREP_METRIC_MODE_ACCUMULATED_NEXT  = 3,

    SCOREP_METRIC_MODE_ABSOLUTE_POINT    = 4,
    SCOREP_METRIC_MODE_ABSOLUTE_LAST     = 5,
    SCOREP_METRIC_MODE_ABSOLUTE_NEXT     = 6,

    SCOREP_METRIC_MODE_RELATIVE_POINT    = 7,
    SCOREP_METRIC_MODE_RELATIVE_LAST     = 8,
    SCOREP_METRIC_MODE_RELATIVE_NEXT     = 9,

    SCOREP_INVALID_METRIC_MODE 
} SCOREP_MetricMode;

typedef enum SCOREP_MetricBase
{
    SCOREP_METRIC_BASE_BINARY  = 0,
    SCOREP_METRIC_BASE_DECIMAL = 1,

    SCOREP_INVALID_METRIC_BASE 
} SCOREP_MetricBase;

typedef struct SCOREP_Metric_Properties
{
    const char*                name;
    const char*                description;
    SCOREP_MetricSourceType    source_type;
    SCOREP_MetricMode          mode;
    SCOREP_MetricValueType     value_type;
    SCOREP_MetricBase          base;
    int64_t                    exponent;
    const char*                unit;
    SCOREP_MetricProfilingType profiling_type;
} SCOREP_Metric_Properties;

typedef enum SCOREP_MetricPer
{
    SCOREP_METRIC_PER_THREAD = 0,
    SCOREP_METRIC_PER_PROCESS,
    SCOREP_METRIC_PER_HOST,
    SCOREP_METRIC_ONCE,

    SCOREP_METRIC_PER_MAX 
} SCOREP_MetricPer;

typedef enum SCOREP_MetricSynchronicity
{
    SCOREP_METRIC_STRICTLY_SYNC = 0,
    SCOREP_METRIC_SYNC,
    SCOREP_METRIC_ASYNC_EVENT,
    SCOREP_METRIC_ASYNC,

    SCOREP_METRIC_SYNC_TYPE_MAX 
} SCOREP_MetricSynchronicity;

typedef struct SCOREP_MetricTimeValuePair
{
    uint64_t timestamp;
    uint64_t value;
} SCOREP_MetricTimeValuePair;

typedef enum SCOREP_MetricSynchronizationMode
{
    SCOREP_METRIC_SYNCHRONIZATION_MODE_BEGIN,
    SCOREP_METRIC_SYNCHRONIZATION_MODE_BEGIN_MPP,
    SCOREP_METRIC_SYNCHRONIZATION_MODE_END,

    SCOREP_METRIC_SYNCHRONIZATION_MODE_MAX 
} SCOREP_MetricSynchronizationMode;


#endif /* SCOREP_METRIC_TYPES_H */