tools/perf/util/stat.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <errno.h>
   3 #include <inttypes.h>
   4 #include <math.h>
   5 #include <string.h>
   6 #include "counts.h"
   7 #include "cpumap.h"
   8 #include "debug.h"
   9 #include "header.h"
  10 #include "stat.h"
  11 #include "session.h"
  12 #include "target.h"
  13 #include "evlist.h"
  14 #include "evsel.h"
  15 #include "thread_map.h"
  16 #include <linux/zalloc.h>
  17
  18 void update_stats(struct stats *stats, u64 val)
  19 {
  20         double delta;
  21
  22         stats->n++;
  23         delta = val - stats->mean;
  24         stats->mean += delta / stats->n;
  25         stats->M2 += delta*(val - stats->mean);
  26
  27         if (val > stats->max)
  28                 stats->max = val;
  29
  30         if (val < stats->min)
  31                 stats->min = val;
  32 }
  33
  34 double avg_stats(struct stats *stats)
  35 {
  36         return stats->mean;
  37 }
  38
  39 /*
  40  * http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance
  41  *
  42  *       (\Sum n_i^2) - ((\Sum n_i)^2)/n
  43  * s^2 = -------------------------------
  44  *                  n - 1
  45  *
  46  * http://en.wikipedia.org/wiki/Stddev
  47  *
  48  * The std dev of the mean is related to the std dev by:
  49  *
  50  *             s
  51  * s_mean = -------
  52  *          sqrt(n)
  53  *
  54  */
  55 double stddev_stats(struct stats *stats)
  56 {
  57         double variance, variance_mean;
  58
  59         if (stats->n < 2)
  60                 return 0.0;
  61
  62         variance = stats->M2 / (stats->n - 1);
  63         variance_mean = variance / stats->n;
  64
  65         return sqrt(variance_mean);
  66 }
  67
  68 double rel_stddev_stats(double stddev, double avg)
  69 {
  70         double pct = 0.0;
  71
  72         if (avg)
  73                 pct = 100.0 * stddev/avg;
  74
  75         return pct;
  76 }
  77
  78 bool __perf_evsel_stat__is(struct evsel *evsel,
  79                            enum perf_stat_evsel_id id)
  80 {
  81         struct perf_stat_evsel *ps = evsel->stats;
  82
  83         return ps->id == id;
  84 }
  85
  86 #define ID(id, name) [PERF_STAT_EVSEL_ID__##id] = #name
  87 static const char *id_str[PERF_STAT_EVSEL_ID__MAX] = {
  88         ID(NONE,                x),
  89         ID(CYCLES_IN_TX,        cpu/cycles-t/),
  90         ID(TRANSACTION_START,   cpu/tx-start/),
  91         ID(ELISION_START,       cpu/el-start/),
  92         ID(CYCLES_IN_TX_CP,     cpu/cycles-ct/),
  93         ID(TOPDOWN_TOTAL_SLOTS, topdown-total-slots),
  94         ID(TOPDOWN_SLOTS_ISSUED, topdown-slots-issued),
  95         ID(TOPDOWN_SLOTS_RETIRED, topdown-slots-retired),
  96         ID(TOPDOWN_FETCH_BUBBLES, topdown-fetch-bubbles),
  97         ID(TOPDOWN_RECOVERY_BUBBLES, topdown-recovery-bubbles),
  98         ID(SMI_NUM, msr/smi/),
  99         ID(APERF, msr/aperf/),
 100 };
 101 #undef ID
 102
 103 static void perf_stat_evsel_id_init(struct evsel *evsel)
 104 {
 105         struct perf_stat_evsel *ps = evsel->stats;
 106         int i;
 107
 108         /* ps->id is 0 hence PERF_STAT_EVSEL_ID__NONE by default */
 109
 110         for (i = 0; i < PERF_STAT_EVSEL_ID__MAX; i++) {
 111                 if (!strcmp(evsel__name(evsel), id_str[i])) {
 112                         ps->id = i;
 113                         break;
 114                 }
 115         }
 116 }
 117
 118 static void evsel__reset_stat_priv(struct evsel *evsel)
 119 {
 120         int i;
 121         struct perf_stat_evsel *ps = evsel->stats;
 122
 123         for (i = 0; i < 3; i++)
 124                 init_stats(&ps->res_stats[i]);
 125
 126         perf_stat_evsel_id_init(evsel);
 127 }
 128
 129 static int evsel__alloc_stat_priv(struct evsel *evsel)
 130 {
 131         evsel->stats = zalloc(sizeof(struct perf_stat_evsel));
 132         if (evsel->stats == NULL)
 133                 return -ENOMEM;
 134         evsel__reset_stat_priv(evsel);
 135         return 0;
 136 }
 137
 138 static void evsel__free_stat_priv(struct evsel *evsel)
 139 {
 140         struct perf_stat_evsel *ps = evsel->stats;
 141
 142         if (ps)
 143                 zfree(&ps->group_data);
 144         zfree(&evsel->stats);
 145 }
 146
 147 static int evsel__alloc_prev_raw_counts(struct evsel *evsel, int ncpus, int nthreads)
 148 {
 149         struct perf_counts *counts;
 150
 151         counts = perf_counts__new(ncpus, nthreads);
 152         if (counts)
 153                 evsel->prev_raw_counts = counts;
 154
 155         return counts ? 0 : -ENOMEM;
 156 }
 157
 158 static void evsel__free_prev_raw_counts(struct evsel *evsel)
 159 {
 160         perf_counts__delete(evsel->prev_raw_counts);
 161         evsel->prev_raw_counts = NULL;
 162 }
 163
 164 static void evsel__reset_prev_raw_counts(struct evsel *evsel)
 165 {
 166         if (evsel->prev_raw_counts) {
 167                 evsel->prev_raw_counts->aggr.val = 0;
 168                 evsel->prev_raw_counts->aggr.ena = 0;
 169                 evsel->prev_raw_counts->aggr.run = 0;
 170        }
 171 }
 172
 173 static int evsel__alloc_stats(struct evsel *evsel, bool alloc_raw)
 174 {
 175         int ncpus = evsel__nr_cpus(evsel);
 176         int nthreads = perf_thread_map__nr(evsel->core.threads);
 177
 178         if (evsel__alloc_stat_priv(evsel) < 0 ||
 179             evsel__alloc_counts(evsel, ncpus, nthreads) < 0 ||
 180             (alloc_raw && evsel__alloc_prev_raw_counts(evsel, ncpus, nthreads) < 0))
 181                 return -ENOMEM;
 182
 183         return 0;
 184 }
 185
 186 int perf_evlist__alloc_stats(struct evlist *evlist, bool alloc_raw)
 187 {
 188         struct evsel *evsel;
 189
 190         evlist__for_each_entry(evlist, evsel) {
 191                 if (evsel__alloc_stats(evsel, alloc_raw))
 192                         goto out_free;
 193         }
 194
 195         return 0;
 196
 197 out_free:
 198         perf_evlist__free_stats(evlist);
 199         return -1;
 200 }
 201
 202 void perf_evlist__free_stats(struct evlist *evlist)
 203 {
 204         struct evsel *evsel;
 205
 206         evlist__for_each_entry(evlist, evsel) {
 207                 evsel__free_stat_priv(evsel);
 208                 evsel__free_counts(evsel);
 209                 evsel__free_prev_raw_counts(evsel);
 210         }
 211 }
 212
 213 void perf_evlist__reset_stats(struct evlist *evlist)
 214 {
 215         struct evsel *evsel;
 216
 217         evlist__for_each_entry(evlist, evsel) {
 218                 evsel__reset_stat_priv(evsel);
 219                 evsel__reset_counts(evsel);
 220         }
 221 }
 222
 223 void perf_evlist__reset_prev_raw_counts(struct evlist *evlist)
 224 {
 225         struct evsel *evsel;
 226
 227         evlist__for_each_entry(evlist, evsel)
 228                 evsel__reset_prev_raw_counts(evsel);
 229 }
 230
 231 static void zero_per_pkg(struct evsel *counter)
 232 {
 233         if (counter->per_pkg_mask)
 234                 memset(counter->per_pkg_mask, 0, cpu__max_cpu());
 235 }
 236
 237 static int check_per_pkg(struct evsel *counter,
 238                          struct perf_counts_values *vals, int cpu, bool *skip)
 239 {
 240         unsigned long *mask = counter->per_pkg_mask;
 241         struct perf_cpu_map *cpus = evsel__cpus(counter);
 242         int s;
 243
 244         *skip = false;
 245
 246         if (!counter->per_pkg)
 247                 return 0;
 248
 249         if (perf_cpu_map__empty(cpus))
 250                 return 0;
 251
 252         if (!mask) {
 253                 mask = zalloc(cpu__max_cpu());
 254                 if (!mask)
 255                         return -ENOMEM;
 256
 257                 counter->per_pkg_mask = mask;
 258         }
 259
 260         /*
 261          * we do not consider an event that has not run as a good
 262          * instance to mark a package as used (skip=1). Otherwise
 263          * we may run into a situation where the first CPU in a package
 264          * is not running anything, yet the second is, and this function
 265          * would mark the package as used after the first CPU and would
 266          * not read the values from the second CPU.
 267          */
 268         if (!(vals->run && vals->ena))
 269                 return 0;
 270
 271         s = cpu_map__get_socket(cpus, cpu, NULL);
 272         if (s < 0)
 273                 return -1;
 274
 275         *skip = test_and_set_bit(s, mask) == 1;
 276         return 0;
 277 }
 278
 279 static int
 280 process_counter_values(struct perf_stat_config *config, struct evsel *evsel,
 281                        int cpu, int thread,
 282                        struct perf_counts_values *count)
 283 {
 284         struct perf_counts_values *aggr = &evsel->counts->aggr;
 285         static struct perf_counts_values zero;
 286         bool skip = false;
 287
 288         if (check_per_pkg(evsel, count, cpu, &skip)) {
 289                 pr_err("failed to read per-pkg counter\n");
 290                 return -1;
 291         }
 292
 293         if (skip)
 294                 count = &zero;
 295
 296         switch (config->aggr_mode) {
 297         case AGGR_THREAD:
 298         case AGGR_CORE:
 299         case AGGR_DIE:
 300         case AGGR_SOCKET:
 301         case AGGR_NODE:
 302         case AGGR_NONE:
 303                 if (!evsel->snapshot)
 304                         evsel__compute_deltas(evsel, cpu, thread, count);
 305                 perf_counts_values__scale(count, config->scale, NULL);
 306                 if ((config->aggr_mode == AGGR_NONE) && (!evsel->percore)) {
 307                         perf_stat__update_shadow_stats(evsel, count->val,
 308                                                        cpu, &rt_stat);
 309                 }
 310
 311                 if (config->aggr_mode == AGGR_THREAD) {
 312                         if (config->stats)
 313                                 perf_stat__update_shadow_stats(evsel,
 314                                         count->val, 0, &config->stats[thread]);
 315                         else
 316                                 perf_stat__update_shadow_stats(evsel,
 317                                         count->val, 0, &rt_stat);
 318                 }
 319                 break;
 320         case AGGR_GLOBAL:
 321                 aggr->val += count->val;
 322                 aggr->ena += count->ena;
 323                 aggr->run += count->run;
 324         case AGGR_UNSET:
 325         default:
 326                 break;
 327         }
 328
 329         return 0;
 330 }
 331
 332 static int process_counter_maps(struct perf_stat_config *config,
 333                                 struct evsel *counter)
 334 {
 335         int nthreads = perf_thread_map__nr(counter->core.threads);
 336         int ncpus = evsel__nr_cpus(counter);
 337         int cpu, thread;
 338
 339         if (counter->core.system_wide)
 340                 nthreads = 1;
 341
 342         for (thread = 0; thread < nthreads; thread++) {
 343                 for (cpu = 0; cpu < ncpus; cpu++) {
 344                         if (process_counter_values(config, counter, cpu, thread,
 345                                                    perf_counts(counter->counts, cpu, thread)))
 346                                 return -1;
 347                 }
 348         }
 349
 350         return 0;
 351 }
 352
 353 int perf_stat_process_counter(struct perf_stat_config *config,
 354                               struct evsel *counter)
 355 {
 356         struct perf_counts_values *aggr = &counter->counts->aggr;
 357         struct perf_stat_evsel *ps = counter->stats;
 358         u64 *count = counter->counts->aggr.values;
 359         int i, ret;
 360
 361         aggr->val = aggr->ena = aggr->run = 0;
 362
 363         /*
 364          * We calculate counter's data every interval,
 365          * and the display code shows ps->res_stats
 366          * avg value. We need to zero the stats for
 367          * interval mode, otherwise overall avg running
 368          * averages will be shown for each interval.
 369          */
 370         if (config->interval) {
 371                 for (i = 0; i < 3; i++)
 372                         init_stats(&ps->res_stats[i]);
 373         }
 374
 375         if (counter->per_pkg)
 376                 zero_per_pkg(counter);
 377
 378         ret = process_counter_maps(config, counter);
 379         if (ret)
 380                 return ret;
 381
 382         if (config->aggr_mode != AGGR_GLOBAL)
 383                 return 0;
 384
 385         if (!counter->snapshot)
 386                 evsel__compute_deltas(counter, -1, -1, aggr);
 387         perf_counts_values__scale(aggr, config->scale, &counter->counts->scaled);
 388
 389         for (i = 0; i < 3; i++)
 390                 update_stats(&ps->res_stats[i], count[i]);
 391
 392         if (verbose > 0) {
 393                 fprintf(config->output, "%s: %" PRIu64 " %" PRIu64 " %" PRIu64 "\n",
 394                         evsel__name(counter), count[0], count[1], count[2]);
 395         }
 396
 397         /*
 398          * Save the full runtime - to allow normalization during printout:
 399          */
 400         perf_stat__update_shadow_stats(counter, *count, 0, &rt_stat);
 401
 402         return 0;
 403 }
 404
 405 int perf_event__process_stat_event(struct perf_session *session,
 406                                    union perf_event *event)
 407 {
 408         struct perf_counts_values count;
 409         struct perf_record_stat *st = &event->stat;
 410         struct evsel *counter;
 411
 412         count.val = st->val;
 413         count.ena = st->ena;
 414         count.run = st->run;
 415
 416         counter = perf_evlist__id2evsel(session->evlist, st->id);
 417         if (!counter) {
 418                 pr_err("Failed to resolve counter for stat event.\n");
 419                 return -EINVAL;
 420         }
 421
 422         *perf_counts(counter->counts, st->cpu, st->thread) = count;
 423         counter->supported = true;
 424         return 0;
 425 }
 426
 427 size_t perf_event__fprintf_stat(union perf_event *event, FILE *fp)
 428 {
 429         struct perf_record_stat *st = (struct perf_record_stat *)event;
 430         size_t ret;
 431
 432         ret  = fprintf(fp, "\n... id %" PRI_lu64 ", cpu %d, thread %d\n",
 433                        st->id, st->cpu, st->thread);
 434         ret += fprintf(fp, "... value %" PRI_lu64 ", enabled %" PRI_lu64 ", running %" PRI_lu64 "\n",
 435                        st->val, st->ena, st->run);
 436
 437         return ret;
 438 }
 439
 440 size_t perf_event__fprintf_stat_round(union perf_event *event, FILE *fp)
 441 {
 442         struct perf_record_stat_round *rd = (struct perf_record_stat_round *)event;
 443         size_t ret;
 444
 445         ret = fprintf(fp, "\n... time %" PRI_lu64 ", type %s\n", rd->time,
 446                       rd->type == PERF_STAT_ROUND_TYPE__FINAL ? "FINAL" : "INTERVAL");
 447
 448         return ret;
 449 }
 450
 451 size_t perf_event__fprintf_stat_config(union perf_event *event, FILE *fp)
 452 {
 453         struct perf_stat_config sc;
 454         size_t ret;
 455
 456         perf_event__read_stat_config(&sc, &event->stat_config);
 457
 458         ret  = fprintf(fp, "\n");
 459         ret += fprintf(fp, "... aggr_mode %d\n", sc.aggr_mode);
 460         ret += fprintf(fp, "... scale     %d\n", sc.scale);
 461         ret += fprintf(fp, "... interval  %u\n", sc.interval);
 462
 463         return ret;
 464 }
 465
 466 int create_perf_stat_counter(struct evsel *evsel,
 467                              struct perf_stat_config *config,
 468                              struct target *target,
 469                              int cpu)
 470 {
 471         struct perf_event_attr *attr = &evsel->core.attr;
 472         struct evsel *leader = evsel->leader;
 473
 474         attr->read_format = PERF_FORMAT_TOTAL_TIME_ENABLED |
 475                             PERF_FORMAT_TOTAL_TIME_RUNNING;
 476
 477         /*
 478          * The event is part of non trivial group, let's enable
 479          * the group read (for leader) and ID retrieval for all
 480          * members.
 481          */
 482         if (leader->core.nr_members > 1)
 483                 attr->read_format |= PERF_FORMAT_ID|PERF_FORMAT_GROUP;
 484
 485         attr->inherit = !config->no_inherit;
 486
 487         /*
 488          * Some events get initialized with sample_(period/type) set,
 489          * like tracepoints. Clear it up for counting.
 490          */
 491         attr->sample_period = 0;
 492
 493         if (config->identifier)
 494                 attr->sample_type = PERF_SAMPLE_IDENTIFIER;
 495
 496         if (config->all_user) {
 497                 attr->exclude_kernel = 1;
 498                 attr->exclude_user   = 0;
 499         }
 500
 501         if (config->all_kernel) {
 502                 attr->exclude_kernel = 0;
 503                 attr->exclude_user   = 1;
 504         }
 505
 506         /*
 507          * Disabling all counters initially, they will be enabled
 508          * either manually by us or by kernel via enable_on_exec
 509          * set later.
 510          */
 511         if (evsel__is_group_leader(evsel)) {
 512                 attr->disabled = 1;
 513
 514                 /*
 515                  * In case of initial_delay we enable tracee
 516                  * events manually.
 517                  */
 518                 if (target__none(target) && !config->initial_delay)
 519                         attr->enable_on_exec = 1;
 520         }
 521
 522         if (target__has_cpu(target) && !target__has_per_thread(target))
 523                 return evsel__open_per_cpu(evsel, evsel__cpus(evsel), cpu);
 524
 525         return evsel__open_per_thread(evsel, evsel->core.threads);
 526 }