SCOREP_MetricPlugins.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_PLUGINS_H
#define SCOREP_METRIC_PLUGINS_H

#include <stdbool.h>

#include <scorep/SCOREP_MetricTypes.h>


#define SCOREP_METRIC_PLUGIN_VERSION 1

#ifdef __cplusplus
#   define EXTERN extern "C"
#else
#   define EXTERN extern
#endif

#define SCOREP_METRIC_PLUGIN_ENTRY( _name ) \
    EXTERN SCOREP_Metric_Plugin_Info \
    SCOREP_MetricPlugin_ ## _name ## _get_info( void )


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

typedef struct SCOREP_Metric_Plugin_MetricProperties
{
    char* name;
    char* description;
    SCOREP_MetricMode      mode;
    SCOREP_MetricValueType value_type;
    SCOREP_MetricBase      base;
    int64_t                exponent;
    char*                  unit;
} SCOREP_Metric_Plugin_MetricProperties;

typedef struct SCOREP_Metric_Plugin_Info
{
    /*
     * For all plugins
     */

    uint32_t plugin_version;

    SCOREP_MetricPer run_per;

    SCOREP_MetricSynchronicity sync;

    uint64_t delta_t;

    int32_t ( * initialize )( void );

    void ( * finalize )( void );

    SCOREP_Metric_Plugin_MetricProperties* ( *get_event_info )( char* token );

    int32_t ( * add_counter )( char* metric_name );

    uint64_t ( * get_current_value )( int32_t id );

    bool ( * get_optional_value )( int32_t   id,
                                   uint64_t* value );

    void ( * set_clock_function )( uint64_t ( * clock_time )( void ) );

    uint64_t ( * get_all_values )( int32_t                      id,
                                   SCOREP_MetricTimeValuePair** time_value_list );

    /* Since of Score-P metric plugin interface version 1 */

    void ( * synchronize )( bool                             is_responsible,
                            SCOREP_MetricSynchronizationMode sync_mode );


    uint64_t reserved[ 92 ];
} SCOREP_Metric_Plugin_Info;


#endif /* SCOREP_METRIC_PLUGINS_H */