metrics.h

Go to the documentation of this file.

// -*-Mode: C++;-*- // technically C99

// * BeginRiceCopyright *****************************************************
//
// $HeadURL$
// $Id$
//
// --------------------------------------------------------------------------
// Part of HPCToolkit (hpctoolkit.org)
//
// Information about sources of support for research and development of
// HPCToolkit is at 'hpctoolkit.org' and in 'README.Acknowledgments'.
// --------------------------------------------------------------------------
//
// Copyright ((c)) 2002-2019, Rice University
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
//   notice, this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright
//   notice, this list of conditions and the following disclaimer in the
//   documentation and/or other materials provided with the distribution.
//
// * Neither the name of Rice University (RICE) nor the names of its
//   contributors may be used to endorse or promote products derived from
//   this software without specific prior written permission.
//
// This software is provided by RICE and contributors "as is" and any
// express or implied warranties, including, but not limited to, the
// implied warranties of merchantability and fitness for a particular
// purpose are disclaimed. In no event shall RICE or contributors be
// liable for any direct, indirect, incidental, special, exemplary, or
// consequential damages (including, but not limited to, procurement of
// substitute goods or services; loss of use, data, or profits; or
// business interruption) however caused and on any theory of liability,
// whether in contract, strict liability, or tort (including negligence
// or otherwise) arising in any way out of the use of this software, even
// if advised of the possibility of such damage.
//
// ******************************************************* EndRiceCopyright *

#ifndef METRICS_H
#define METRICS_H

#include <sys/types.h>
#include <stdbool.h>

#include <lib/prof-lean/hpcio.h>
#include <lib/prof-lean/hpcfmt.h>
#include <lib/prof-lean/hpcrun-fmt.h>

// tallent: I have moved flags into hpcfile_csprof.h.  The flags don't
// really belong there but:
// 1) metrics.c uses hpcfile_hpcrun_data_t to implement metrics
//    info, which already confuses boundaries
// 2) metric info needs to exist in a library so csprof (hpcrun),
//    xcsprof (hpcprof) and hpcfile can use it.  hpcfile at least
//    satisfies this.

#include <stdbool.h>
#include <stdlib.h>
#include <assert.h>

#include <lib/prof-lean/hpcio.h>
#include <lib/prof-lean/hpcfmt.h>
#include <lib/prof-lean/hpcrun-fmt.h>

typedef hpcrun_metricVal_t cct_metric_data_t;

// abstract the metric set
//
typedef struct metric_set_t metric_set_t;

typedef void metric_upd_proc_t(int metric_id, metric_set_t* set, cct_metric_data_t datum);

typedef cct_metric_data_t (*metric_bin_fn)(cct_metric_data_t v1, cct_metric_data_t v2);

typedef struct metric_proc_map_t {
  struct metric_proc_map_t* next;
  metric_upd_proc_t*        proc;
  int                       id;
  int                       kind_idx;     // metrics are divided into "kinds"
  int                       offset;
} metric_proc_map_t;

//
// To accomodate block sparse representation,
// use 'kinds' == dense subarrays of metrics
//
// Sample use:
// Std metrics = 1 class,
// CUDA metrics = another class
//
// To use the mechanism, call hpcrun_metrics_new_kind.
// Then each call to hpcrun_new_metric will yield a slot in the
// new metric kind subarray.
//
// For complicated metric assignment, hpcrun_switch_metric_kind(kind),
// and hpcrun_get_new_metric_of_kind(kind) enable fine-grain control
// of metric sloc allocation
//
// Default case is 1 kind ("STD")
//
// Future expansion to permit different strategies is possible, but
// unimplemented at this time

typedef struct kind_info_t kind_info_t;

kind_info_t* hpcrun_metrics_new_kind();

bool hpcrun_metrics_finalized(void);

extern void hpcrun_finalize_metrics(void);

void hpcrun_pre_allocate_metrics(size_t num);

int hpcrun_get_num_metrics(void);

metric_desc_t* hpcrun_id2metric(int id);

metric_list_t* hpcrun_get_metric_data(void);

metric_desc_p_tbl_t* hpcrun_get_metric_tbl(void);

metric_upd_proc_t* hpcrun_get_metric_proc(int metric_id);

// get a new metric from the cached kind
int hpcrun_new_metric(void);

metric_desc_t* 
hpcrun_set_metric_info_w_fn(int metric_id, const char* name,
                                 MetricFlags_ValFmt_t valFmt, size_t period,
                                 metric_upd_proc_t upd_fn, metric_desc_properties_t prop);

metric_desc_t*
hpcrun_set_metric_and_attributes(int metric_id, const char* name,
    MetricFlags_ValFmt_t valFmt, size_t period, metric_desc_properties_t prop,
    uint8_t show, uint8_t show_percent);

metric_desc_t* 
hpcrun_set_metric_info_and_period(int metric_id, const char* name,
                                       MetricFlags_ValFmt_t valFmt, size_t period, metric_desc_properties_t prop);

metric_desc_t* hpcrun_set_metric_info(int metric_id, const char* name);

void hpcrun_set_metric_name(int metric_id, char* name);

// metric set operations

extern metric_set_t* hpcrun_metric_set_new(void);
extern cct_metric_data_t* hpcrun_metric_set_loc(metric_set_t* s, int id);
extern void hpcrun_metric_std_set(int metric_id, metric_set_t* set,
                                  hpcrun_metricVal_t value);
extern void hpcrun_metric_std_inc(int metric_id, metric_set_t* set,
                                  hpcrun_metricVal_t incr);

// set the minimum value (only applicable for address type value)
void
hpcrun_metric_std_min(int metric_id, metric_set_t *set, hpcrun_metricVal_t val);

// set the maximum value (only applicable for address type value)
void
hpcrun_metric_std_max(int metric_id, metric_set_t *set, hpcrun_metricVal_t val);

//
// copy a metric set
//
extern void hpcrun_metric_set_dense_copy(cct_metric_data_t* dest,
                                         metric_set_t* set,
                                         int num_metrics);

#endif // METRICS_H