tools/perf/util/stat.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __PERF_STATS_H
   3 #define __PERF_STATS_H
   4
   5 #include <linux/types.h>
   6 #include <stdio.h>
   7 #include <sys/types.h>
   8 #include <sys/resource.h>
   9 #include "rblist.h"
  10
  11 struct perf_cpu_map;
  12 struct perf_stat_config;
  13 struct timespec;
  14
  15 struct stats {
  16         double n, mean, M2;
  17         u64 max, min;
  18 };
  19
  20 enum perf_stat_evsel_id {
  21         PERF_STAT_EVSEL_ID__NONE = 0,
  22         PERF_STAT_EVSEL_ID__CYCLES_IN_TX,
  23         PERF_STAT_EVSEL_ID__TRANSACTION_START,
  24         PERF_STAT_EVSEL_ID__ELISION_START,
  25         PERF_STAT_EVSEL_ID__CYCLES_IN_TX_CP,
  26         PERF_STAT_EVSEL_ID__TOPDOWN_TOTAL_SLOTS,
  27         PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_ISSUED,
  28         PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_RETIRED,
  29         PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_BUBBLES,
  30         PERF_STAT_EVSEL_ID__TOPDOWN_RECOVERY_BUBBLES,
  31         PERF_STAT_EVSEL_ID__SMI_NUM,
  32         PERF_STAT_EVSEL_ID__APERF,
  33         PERF_STAT_EVSEL_ID__MAX,
  34 };
  35
  36 struct perf_stat_evsel {
  37         struct stats             res_stats[3];
  38         enum perf_stat_evsel_id  id;
  39         u64                     *group_data;
  40 };
  41
  42 enum aggr_mode {
  43         AGGR_NONE,
  44         AGGR_GLOBAL,
  45         AGGR_SOCKET,
  46         AGGR_DIE,
  47         AGGR_CORE,
  48         AGGR_THREAD,
  49         AGGR_UNSET,
  50         AGGR_NODE,
  51 };
  52
  53 enum {
  54         CTX_BIT_USER    = 1 << 0,
  55         CTX_BIT_KERNEL  = 1 << 1,
  56         CTX_BIT_HV      = 1 << 2,
  57         CTX_BIT_HOST    = 1 << 3,
  58         CTX_BIT_IDLE    = 1 << 4,
  59         CTX_BIT_MAX     = 1 << 5,
  60 };
  61
  62 #define NUM_CTX CTX_BIT_MAX
  63
  64 enum stat_type {
  65         STAT_NONE = 0,
  66         STAT_NSECS,
  67         STAT_CYCLES,
  68         STAT_STALLED_CYCLES_FRONT,
  69         STAT_STALLED_CYCLES_BACK,
  70         STAT_BRANCHES,
  71         STAT_CACHEREFS,
  72         STAT_L1_DCACHE,
  73         STAT_L1_ICACHE,
  74         STAT_LL_CACHE,
  75         STAT_ITLB_CACHE,
  76         STAT_DTLB_CACHE,
  77         STAT_CYCLES_IN_TX,
  78         STAT_TRANSACTION,
  79         STAT_ELISION,
  80         STAT_TOPDOWN_TOTAL_SLOTS,
  81         STAT_TOPDOWN_SLOTS_ISSUED,
  82         STAT_TOPDOWN_SLOTS_RETIRED,
  83         STAT_TOPDOWN_FETCH_BUBBLES,
  84         STAT_TOPDOWN_RECOVERY_BUBBLES,
  85         STAT_SMI_NUM,
  86         STAT_APERF,
  87         STAT_MAX
  88 };
  89
  90 struct runtime_stat {
  91         struct rblist value_list;
  92 };
  93
  94 typedef int (*aggr_get_id_t)(struct perf_stat_config *config,
  95                              struct perf_cpu_map *m, int cpu);
  96
  97 struct perf_stat_config {
  98         enum aggr_mode           aggr_mode;
  99         bool                     scale;
 100         bool                     no_inherit;
 101         bool                     identifier;
 102         bool                     csv_output;
 103         bool                     interval_clear;
 104         bool                     metric_only;
 105         bool                     null_run;
 106         bool                     ru_display;
 107         bool                     big_num;
 108         bool                     no_merge;
 109         bool                     walltime_run_table;
 110         bool                     all_kernel;
 111         bool                     all_user;
 112         bool                     percore_show_thread;
 113         FILE                    *output;
 114         unsigned int             interval;
 115         unsigned int             timeout;
 116         unsigned int             initial_delay;
 117         unsigned int             unit_width;
 118         unsigned int             metric_only_len;
 119         int                      times;
 120         int                      run_count;
 121         int                      print_free_counters_hint;
 122         int                      print_mixed_hw_group_error;
 123         struct runtime_stat     *stats;
 124         int                      stats_num;
 125         const char              *csv_sep;
 126         struct stats            *walltime_nsecs_stats;
 127         struct rusage            ru_data;
 128         struct perf_cpu_map             *aggr_map;
 129         aggr_get_id_t            aggr_get_id;
 130         struct perf_cpu_map             *cpus_aggr_map;
 131         u64                     *walltime_run;
 132         struct rblist            metric_events;
 133 };
 134
 135 void update_stats(struct stats *stats, u64 val);
 136 double avg_stats(struct stats *stats);
 137 double stddev_stats(struct stats *stats);
 138 double rel_stddev_stats(double stddev, double avg);
 139
 140 static inline void init_stats(struct stats *stats)
 141 {
 142         stats->n    = 0.0;
 143         stats->mean = 0.0;
 144         stats->M2   = 0.0;
 145         stats->min  = (u64) -1;
 146         stats->max  = 0;
 147 }
 148
 149 struct evsel;
 150 struct evlist;
 151
 152 struct perf_aggr_thread_value {
 153         struct evsel *counter;
 154         int id;
 155         double uval;
 156         u64 val;
 157         u64 run;
 158         u64 ena;
 159 };
 160
 161 bool __perf_evsel_stat__is(struct evsel *evsel,
 162                            enum perf_stat_evsel_id id);
 163
 164 #define perf_stat_evsel__is(evsel, id) \
 165         __perf_evsel_stat__is(evsel, PERF_STAT_EVSEL_ID__ ## id)
 166
 167 extern struct runtime_stat rt_stat;
 168 extern struct stats walltime_nsecs_stats;
 169
 170 typedef void (*print_metric_t)(struct perf_stat_config *config,
 171                                void *ctx, const char *color, const char *unit,
 172                                const char *fmt, double val);
 173 typedef void (*new_line_t)(struct perf_stat_config *config, void *ctx);
 174
 175 void runtime_stat__init(struct runtime_stat *st);
 176 void runtime_stat__exit(struct runtime_stat *st);
 177 void perf_stat__init_shadow_stats(void);
 178 void perf_stat__reset_shadow_stats(void);
 179 void perf_stat__reset_shadow_per_stat(struct runtime_stat *st);
 180 void perf_stat__update_shadow_stats(struct evsel *counter, u64 count,
 181                                     int cpu, struct runtime_stat *st);
 182 struct perf_stat_output_ctx {
 183         void *ctx;
 184         print_metric_t print_metric;
 185         new_line_t new_line;
 186         bool force_header;
 187 };
 188
 189 void perf_stat__print_shadow_stats(struct perf_stat_config *config,
 190                                    struct evsel *evsel,
 191                                    double avg, int cpu,
 192                                    struct perf_stat_output_ctx *out,
 193                                    struct rblist *metric_events,
 194                                    struct runtime_stat *st);
 195 void perf_stat__collect_metric_expr(struct evlist *);
 196
 197 int perf_evlist__alloc_stats(struct evlist *evlist, bool alloc_raw);
 198 void perf_evlist__free_stats(struct evlist *evlist);
 199 void perf_evlist__reset_stats(struct evlist *evlist);
 200 void perf_evlist__reset_prev_raw_counts(struct evlist *evlist);
 201
 202 int perf_stat_process_counter(struct perf_stat_config *config,
 203                               struct evsel *counter);
 204 struct perf_tool;
 205 union perf_event;
 206 struct perf_session;
 207 struct target;
 208
 209 int perf_event__process_stat_event(struct perf_session *session,
 210                                    union perf_event *event);
 211
 212 size_t perf_event__fprintf_stat(union perf_event *event, FILE *fp);
 213 size_t perf_event__fprintf_stat_round(union perf_event *event, FILE *fp);
 214 size_t perf_event__fprintf_stat_config(union perf_event *event, FILE *fp);
 215
 216 int create_perf_stat_counter(struct evsel *evsel,
 217                              struct perf_stat_config *config,
 218                              struct target *target,
 219                              int cpu);
 220 void
 221 perf_evlist__print_counters(struct evlist *evlist,
 222                             struct perf_stat_config *config,
 223                             struct target *_target,
 224                             struct timespec *ts,
 225                             int argc, const char **argv);
 226 #endif