geopm_stats_collector.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2024 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef GEOPM_STATS_COLLECTOR_H_INCLUDE
#define GEOPM_STATS_COLLECTOR_H_INCLUDE
#ifdef __cplusplus
extern "C" {
#endif
 
#include "geopm_public.h"
#include "geopm_pio.h"
#include <stddef.h>
 
struct geopm_request_s;
struct geopm_stats_collector_s;
 
enum geopm_sample_stats_e {
    GEOPM_SAMPLE_TIME_TOTAL,
    GEOPM_SAMPLE_COUNT,
    GEOPM_SAMPLE_PERIOD_MEAN,
    GEOPM_SAMPLE_PERIOD_STD,
    GEOPM_NUM_SAMPLE_STATS
};
 
enum geopm_metric_stats_e {
    GEOPM_METRIC_COUNT,
    GEOPM_METRIC_FIRST,
    GEOPM_METRIC_LAST,
    GEOPM_METRIC_MIN,
    GEOPM_METRIC_MAX,
    GEOPM_METRIC_MEAN,
    GEOPM_METRIC_STD,
    GEOPM_NUM_METRIC_STATS
};
 
struct geopm_metric_stats_s {
    char name[GEOPM_NAME_MAX];
    double stats[GEOPM_NUM_METRIC_STATS];
};
 
struct geopm_report_s {
    char host[GEOPM_NAME_MAX];
    char sample_time_first[GEOPM_NAME_MAX];
    double sample_stats[GEOPM_NUM_SAMPLE_STATS];
    size_t num_metric;
    struct geopm_metric_stats_s *metric_stats;
};
 
int GEOPM_PUBLIC
    geopm_stats_collector_create(size_t num_requests, const struct geopm_request_s *requests,
                                 struct geopm_stats_collector_s **collector);
 
int GEOPM_PUBLIC
    geopm_stats_collector_update(struct geopm_stats_collector_s *collector);
 
int GEOPM_PUBLIC
    geopm_stats_collector_update_count(const struct geopm_stats_collector_s *collector,
                                       size_t *update_count);
 
int GEOPM_PUBLIC
    geopm_stats_collector_report_yaml(const struct geopm_stats_collector_s *collector,
                                      size_t *max_report_size, char *report_yaml);
 
int GEOPM_PUBLIC
    geopm_stats_collector_report(const struct geopm_stats_collector_s *collector,
                                 size_t num_requests, struct geopm_report_s *report);
 
int GEOPM_PUBLIC
    geopm_stats_collector_reset(struct geopm_stats_collector_s *collector);
 
int GEOPM_PUBLIC
    geopm_stats_collector_free(struct geopm_stats_collector_s *collector);
 
#ifdef __cplusplus
}
#endif
#endif