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 "cpumap.h"
  10 #include "rblist.h"
  11 #include "counts.h"
  12
  13 struct perf_cpu_map;
  14 struct perf_stat_config;
  15 struct timespec;
  16
  17 struct stats {
  18         double n, mean, M2;
  19         u64 max, min;
  20 };
  21
  22 enum perf_stat_evsel_id {
  23         PERF_STAT_EVSEL_ID__NONE = 0,
  24         PERF_STAT_EVSEL_ID__CYCLES_IN_TX,
  25         PERF_STAT_EVSEL_ID__TRANSACTION_START,
  26         PERF_STAT_EVSEL_ID__ELISION_START,
  27         PERF_STAT_EVSEL_ID__CYCLES_IN_TX_CP,
  28         PERF_STAT_EVSEL_ID__TOPDOWN_TOTAL_SLOTS,
  29         PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_ISSUED,
  30         PERF_STAT_EVSEL_ID__TOPDOWN_SLOTS_RETIRED,
  31         PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_BUBBLES,
  32         PERF_STAT_EVSEL_ID__TOPDOWN_RECOVERY_BUBBLES,
  33         PERF_STAT_EVSEL_ID__TOPDOWN_RETIRING,
  34         PERF_STAT_EVSEL_ID__TOPDOWN_BAD_SPEC,
  35         PERF_STAT_EVSEL_ID__TOPDOWN_FE_BOUND,
  36         PERF_STAT_EVSEL_ID__TOPDOWN_BE_BOUND,
  37         PERF_STAT_EVSEL_ID__TOPDOWN_HEAVY_OPS,
  38         PERF_STAT_EVSEL_ID__TOPDOWN_BR_MISPREDICT,
  39         PERF_STAT_EVSEL_ID__TOPDOWN_FETCH_LAT,
  40         PERF_STAT_EVSEL_ID__TOPDOWN_MEM_BOUND,
  41         PERF_STAT_EVSEL_ID__SMI_NUM,
  42         PERF_STAT_EVSEL_ID__APERF,
  43         PERF_STAT_EVSEL_ID__MAX,
  44 };
  45
  46 /* hold aggregated event info */
  47 struct perf_stat_aggr {
  48         /* aggregated values */
  49         struct perf_counts_values       counts;
  50         /* number of entries (CPUs) aggregated */
  51         int                             nr;
  52         /* whether any entry has failed to read/process event */
  53         bool                            failed;
  54         /* to mark this data is processed already */
  55         bool                            used;
  56 };
  57
  58 /* per-evsel event stats */
  59 struct perf_stat_evsel {
  60         /* used for repeated runs */
  61         struct stats             res_stats;
  62         /* evsel id for quick check */
  63         enum perf_stat_evsel_id  id;
  64         /* number of allocated 'aggr' */
  65         int                      nr_aggr;
  66         /* aggregated event values */
  67         struct perf_stat_aggr   *aggr;
  68         /* used for group read */
  69         u64                     *group_data;
  70 };
  71
  72 enum aggr_mode {
  73         AGGR_NONE,
  74         AGGR_GLOBAL,
  75         AGGR_SOCKET,
  76         AGGR_DIE,
  77         AGGR_CORE,
  78         AGGR_THREAD,
  79         AGGR_UNSET,
  80         AGGR_NODE,
  81         AGGR_MAX
  82 };
  83
  84 enum {
  85         CTX_BIT_USER    = 1 << 0,
  86         CTX_BIT_KERNEL  = 1 << 1,
  87         CTX_BIT_HV      = 1 << 2,
  88         CTX_BIT_HOST    = 1 << 3,
  89         CTX_BIT_IDLE    = 1 << 4,
  90         CTX_BIT_MAX     = 1 << 5,
  91 };
  92
  93 #define NUM_CTX CTX_BIT_MAX
  94
  95 enum stat_type {
  96         STAT_NONE = 0,
  97         STAT_NSECS,
  98         STAT_CYCLES,
  99         STAT_STALLED_CYCLES_FRONT,
 100         STAT_STALLED_CYCLES_BACK,
 101         STAT_BRANCHES,
 102         STAT_CACHEREFS,
 103         STAT_L1_DCACHE,
 104         STAT_L1_ICACHE,
 105         STAT_LL_CACHE,
 106         STAT_ITLB_CACHE,
 107         STAT_DTLB_CACHE,
 108         STAT_CYCLES_IN_TX,
 109         STAT_TRANSACTION,
 110         STAT_ELISION,
 111         STAT_TOPDOWN_TOTAL_SLOTS,
 112         STAT_TOPDOWN_SLOTS_ISSUED,
 113         STAT_TOPDOWN_SLOTS_RETIRED,
 114         STAT_TOPDOWN_FETCH_BUBBLES,
 115         STAT_TOPDOWN_RECOVERY_BUBBLES,
 116         STAT_TOPDOWN_RETIRING,
 117         STAT_TOPDOWN_BAD_SPEC,
 118         STAT_TOPDOWN_FE_BOUND,
 119         STAT_TOPDOWN_BE_BOUND,
 120         STAT_TOPDOWN_HEAVY_OPS,
 121         STAT_TOPDOWN_BR_MISPREDICT,
 122         STAT_TOPDOWN_FETCH_LAT,
 123         STAT_TOPDOWN_MEM_BOUND,
 124         STAT_SMI_NUM,
 125         STAT_APERF,
 126         STAT_MAX
 127 };
 128
 129 struct runtime_stat {
 130         struct rblist value_list;
 131 };
 132
 133 struct rusage_stats {
 134         struct stats ru_utime_usec_stat;
 135         struct stats ru_stime_usec_stat;
 136 };
 137
 138 typedef struct aggr_cpu_id (*aggr_get_id_t)(struct perf_stat_config *config, struct perf_cpu cpu);
 139
 140 struct perf_stat_config {
 141         enum aggr_mode           aggr_mode;
 142         bool                     scale;
 143         bool                     no_inherit;
 144         bool                     identifier;
 145         bool                     csv_output;
 146         bool                     json_output;
 147         bool                     interval_clear;
 148         bool                     metric_only;
 149         bool                     null_run;
 150         bool                     ru_display;
 151         bool                     big_num;
 152         bool                     no_merge;
 153         bool                     hybrid_merge;
 154         bool                     walltime_run_table;
 155         bool                     all_kernel;
 156         bool                     all_user;
 157         bool                     percore_show_thread;
 158         bool                     summary;
 159         bool                     no_csv_summary;
 160         bool                     metric_no_group;
 161         bool                     metric_no_merge;
 162         bool                     stop_read_counter;
 163         bool                     iostat_run;
 164         char                     *user_requested_cpu_list;
 165         bool                     system_wide;
 166         FILE                    *output;
 167         unsigned int             interval;
 168         unsigned int             timeout;
 169         int                      initial_delay;
 170         unsigned int             unit_width;
 171         unsigned int             metric_only_len;
 172         int                      times;
 173         int                      run_count;
 174         int                      print_free_counters_hint;
 175         int                      print_mixed_hw_group_error;
 176         const char              *csv_sep;
 177         struct stats            *walltime_nsecs_stats;
 178         struct rusage            ru_data;
 179         struct rusage_stats              *ru_stats;
 180         struct cpu_aggr_map     *aggr_map;
 181         aggr_get_id_t            aggr_get_id;
 182         struct cpu_aggr_map     *cpus_aggr_map;
 183         u64                     *walltime_run;
 184         struct rblist            metric_events;
 185         int                      ctl_fd;
 186         int                      ctl_fd_ack;
 187         bool                     ctl_fd_close;
 188         const char              *cgroup_list;
 189         unsigned int            topdown_level;
 190 };
 191
 192 void perf_stat__set_big_num(int set);
 193 void perf_stat__set_no_csv_summary(int set);
 194
 195 void update_stats(struct stats *stats, u64 val);
 196 double avg_stats(struct stats *stats);
 197 double stddev_stats(struct stats *stats);
 198 double rel_stddev_stats(double stddev, double avg);
 199
 200 static inline void init_stats(struct stats *stats)
 201 {
 202         stats->n    = 0.0;
 203         stats->mean = 0.0;
 204         stats->M2   = 0.0;
 205         stats->min  = (u64) -1;
 206         stats->max  = 0;
 207 }
 208
 209 static inline void init_rusage_stats(struct rusage_stats *ru_stats) {
 210         init_stats(&ru_stats->ru_utime_usec_stat);
 211         init_stats(&ru_stats->ru_stime_usec_stat);
 212 }
 213
 214 static inline void update_rusage_stats(struct rusage_stats *ru_stats, struct rusage* rusage) {
 215         const u64 us_to_ns = 1000;
 216         const u64 s_to_ns = 1000000000;
 217         update_stats(&ru_stats->ru_utime_usec_stat,
 218                      (rusage->ru_utime.tv_usec * us_to_ns + rusage->ru_utime.tv_sec * s_to_ns));
 219         update_stats(&ru_stats->ru_stime_usec_stat,
 220                      (rusage->ru_stime.tv_usec * us_to_ns + rusage->ru_stime.tv_sec * s_to_ns));
 221 }
 222
 223 struct evsel;
 224 struct evlist;
 225
 226 bool __perf_stat_evsel__is(struct evsel *evsel, enum perf_stat_evsel_id id);
 227
 228 #define perf_stat_evsel__is(evsel, id) \
 229         __perf_stat_evsel__is(evsel, PERF_STAT_EVSEL_ID__ ## id)
 230
 231 extern struct runtime_stat rt_stat;
 232 extern struct stats walltime_nsecs_stats;
 233 extern struct rusage_stats ru_stats;
 234
 235 typedef void (*print_metric_t)(struct perf_stat_config *config,
 236                                void *ctx, const char *color, const char *unit,
 237                                const char *fmt, double val);
 238 typedef void (*new_line_t)(struct perf_stat_config *config, void *ctx);
 239
 240 void runtime_stat__init(struct runtime_stat *st);
 241 void runtime_stat__exit(struct runtime_stat *st);
 242 void perf_stat__init_shadow_stats(void);
 243 void perf_stat__reset_shadow_stats(void);
 244 void perf_stat__reset_shadow_per_stat(struct runtime_stat *st);
 245 void perf_stat__update_shadow_stats(struct evsel *counter, u64 count,
 246                                     int map_idx, struct runtime_stat *st);
 247 struct perf_stat_output_ctx {
 248         void *ctx;
 249         print_metric_t print_metric;
 250         new_line_t new_line;
 251         bool force_header;
 252 };
 253
 254 void perf_stat__print_shadow_stats(struct perf_stat_config *config,
 255                                    struct evsel *evsel,
 256                                    double avg, int map_idx,
 257                                    struct perf_stat_output_ctx *out,
 258                                    struct rblist *metric_events,
 259                                    struct runtime_stat *st);
 260 void perf_stat__collect_metric_expr(struct evlist *);
 261
 262 int evlist__alloc_stats(struct perf_stat_config *config,
 263                         struct evlist *evlist, bool alloc_raw);
 264 void evlist__free_stats(struct evlist *evlist);
 265 void evlist__reset_stats(struct evlist *evlist);
 266 void evlist__reset_prev_raw_counts(struct evlist *evlist);
 267 void evlist__copy_prev_raw_counts(struct evlist *evlist);
 268 void evlist__save_aggr_prev_raw_counts(struct evlist *evlist);
 269
 270 int evlist__alloc_aggr_stats(struct evlist *evlist, int nr_aggr);
 271 void evlist__reset_aggr_stats(struct evlist *evlist);
 272
 273 int perf_stat_process_counter(struct perf_stat_config *config,
 274                               struct evsel *counter);
 275 void perf_stat_merge_counters(struct perf_stat_config *config, struct evlist *evlist);
 276 void perf_stat_process_percore(struct perf_stat_config *config, struct evlist *evlist);
 277 void perf_stat_process_shadow_stats(struct perf_stat_config *config, struct evlist *evlist);
 278
 279 struct perf_tool;
 280 union perf_event;
 281 struct perf_session;
 282 struct target;
 283
 284 int perf_event__process_stat_event(struct perf_session *session,
 285                                    union perf_event *event);
 286
 287 size_t perf_event__fprintf_stat(union perf_event *event, FILE *fp);
 288 size_t perf_event__fprintf_stat_round(union perf_event *event, FILE *fp);
 289 size_t perf_event__fprintf_stat_config(union perf_event *event, FILE *fp);
 290
 291 int create_perf_stat_counter(struct evsel *evsel,
 292                              struct perf_stat_config *config,
 293                              struct target *target,
 294                              int cpu_map_idx);
 295 void evlist__print_counters(struct evlist *evlist, struct perf_stat_config *config,
 296                             struct target *_target, struct timespec *ts, int argc, const char **argv);
 297
 298 struct metric_expr;
 299 double test_generic_metric(struct metric_expr *mexp, int map_idx, struct runtime_stat *st);
 300 #endif