tools/perf/builtin-diff.c

   1 /*
   2  * builtin-diff.c
   3  *
   4  * Builtin diff command: Analyze two perf.data input files, look up and read
   5  * DSOs and symbol information, sort them and produce a diff.
   6  */
   7 #include "builtin.h"
   8
   9 #include "util/debug.h"
  10 #include "util/event.h"
  11 #include "util/hist.h"
  12 #include "util/evsel.h"
  13 #include "util/evlist.h"
  14 #include "util/session.h"
  15 #include "util/tool.h"
  16 #include "util/sort.h"
  17 #include "util/symbol.h"
  18 #include "util/util.h"
  19 #include "util/data.h"
  20
  21 #include <stdlib.h>
  22 #include <math.h>
  23
  24 /* Diff command specific HPP columns. */
  25 enum {
  26         PERF_HPP_DIFF__BASELINE,
  27         PERF_HPP_DIFF__PERIOD,
  28         PERF_HPP_DIFF__PERIOD_BASELINE,
  29         PERF_HPP_DIFF__DELTA,
  30         PERF_HPP_DIFF__RATIO,
  31         PERF_HPP_DIFF__WEIGHTED_DIFF,
  32         PERF_HPP_DIFF__FORMULA,
  33
  34         PERF_HPP_DIFF__MAX_INDEX
  35 };
  36
  37 struct diff_hpp_fmt {
  38         struct perf_hpp_fmt      fmt;
  39         int                      idx;
  40         char                    *header;
  41         int                      header_width;
  42 };
  43
  44 struct data__file {
  45         struct perf_session     *session;
  46         struct perf_data_file   file;
  47         int                      idx;
  48         struct hists            *hists;
  49         struct diff_hpp_fmt      fmt[PERF_HPP_DIFF__MAX_INDEX];
  50 };
  51
  52 static struct data__file *data__files;
  53 static int data__files_cnt;
  54
  55 #define data__for_each_file_start(i, d, s)      \
  56         for (i = s, d = &data__files[s];        \
  57              i < data__files_cnt;               \
  58              i++, d = &data__files[i])
  59
  60 #define data__for_each_file(i, d) data__for_each_file_start(i, d, 0)
  61 #define data__for_each_file_new(i, d) data__for_each_file_start(i, d, 1)
  62
  63 static bool force;
  64 static bool show_period;
  65 static bool show_formula;
  66 static bool show_baseline_only;
  67 static unsigned int sort_compute;
  68
  69 static s64 compute_wdiff_w1;
  70 static s64 compute_wdiff_w2;
  71
  72 enum {
  73         COMPUTE_DELTA,
  74         COMPUTE_RATIO,
  75         COMPUTE_WEIGHTED_DIFF,
  76         COMPUTE_MAX,
  77 };
  78
  79 const char *compute_names[COMPUTE_MAX] = {
  80         [COMPUTE_DELTA] = "delta",
  81         [COMPUTE_RATIO] = "ratio",
  82         [COMPUTE_WEIGHTED_DIFF] = "wdiff",
  83 };
  84
  85 static int compute;
  86
  87 static int compute_2_hpp[COMPUTE_MAX] = {
  88         [COMPUTE_DELTA]         = PERF_HPP_DIFF__DELTA,
  89         [COMPUTE_RATIO]         = PERF_HPP_DIFF__RATIO,
  90         [COMPUTE_WEIGHTED_DIFF] = PERF_HPP_DIFF__WEIGHTED_DIFF,
  91 };
  92
  93 #define MAX_COL_WIDTH 70
  94
  95 static struct header_column {
  96         const char *name;
  97         int width;
  98 } columns[PERF_HPP_DIFF__MAX_INDEX] = {
  99         [PERF_HPP_DIFF__BASELINE] = {
 100                 .name  = "Baseline",
 101         },
 102         [PERF_HPP_DIFF__PERIOD] = {
 103                 .name  = "Period",
 104                 .width = 14,
 105         },
 106         [PERF_HPP_DIFF__PERIOD_BASELINE] = {
 107                 .name  = "Base period",
 108                 .width = 14,
 109         },
 110         [PERF_HPP_DIFF__DELTA] = {
 111                 .name  = "Delta",
 112                 .width = 7,
 113         },
 114         [PERF_HPP_DIFF__RATIO] = {
 115                 .name  = "Ratio",
 116                 .width = 14,
 117         },
 118         [PERF_HPP_DIFF__WEIGHTED_DIFF] = {
 119                 .name  = "Weighted diff",
 120                 .width = 14,
 121         },
 122         [PERF_HPP_DIFF__FORMULA] = {
 123                 .name  = "Formula",
 124                 .width = MAX_COL_WIDTH,
 125         }
 126 };
 127
 128 static int setup_compute_opt_wdiff(char *opt)
 129 {
 130         char *w1_str = opt;
 131         char *w2_str;
 132
 133         int ret = -EINVAL;
 134
 135         if (!opt)
 136                 goto out;
 137
 138         w2_str = strchr(opt, ',');
 139         if (!w2_str)
 140                 goto out;
 141
 142         *w2_str++ = 0x0;
 143         if (!*w2_str)
 144                 goto out;
 145
 146         compute_wdiff_w1 = strtol(w1_str, NULL, 10);
 147         compute_wdiff_w2 = strtol(w2_str, NULL, 10);
 148
 149         if (!compute_wdiff_w1 || !compute_wdiff_w2)
 150                 goto out;
 151
 152         pr_debug("compute wdiff w1(%" PRId64 ") w2(%" PRId64 ")\n",
 153                   compute_wdiff_w1, compute_wdiff_w2);
 154
 155         ret = 0;
 156
 157  out:
 158         if (ret)
 159                 pr_err("Failed: wrong weight data, use 'wdiff:w1,w2'\n");
 160
 161         return ret;
 162 }
 163
 164 static int setup_compute_opt(char *opt)
 165 {
 166         if (compute == COMPUTE_WEIGHTED_DIFF)
 167                 return setup_compute_opt_wdiff(opt);
 168
 169         if (opt) {
 170                 pr_err("Failed: extra option specified '%s'", opt);
 171                 return -EINVAL;
 172         }
 173
 174         return 0;
 175 }
 176
 177 static int setup_compute(const struct option *opt, const char *str,
 178                          int unset __maybe_unused)
 179 {
 180         int *cp = (int *) opt->value;
 181         char *cstr = (char *) str;
 182         char buf[50];
 183         unsigned i;
 184         char *option;
 185
 186         if (!str) {
 187                 *cp = COMPUTE_DELTA;
 188                 return 0;
 189         }
 190
 191         option = strchr(str, ':');
 192         if (option) {
 193                 unsigned len = option++ - str;
 194
 195                 /*
 196                  * The str data are not writeable, so we need
 197                  * to use another buffer.
 198                  */
 199
 200                 /* No option value is longer. */
 201                 if (len >= sizeof(buf))
 202                         return -EINVAL;
 203
 204                 strncpy(buf, str, len);
 205                 buf[len] = 0x0;
 206                 cstr = buf;
 207         }
 208
 209         for (i = 0; i < COMPUTE_MAX; i++)
 210                 if (!strcmp(cstr, compute_names[i])) {
 211                         *cp = i;
 212                         return setup_compute_opt(option);
 213                 }
 214
 215         pr_err("Failed: '%s' is not computation method "
 216                "(use 'delta','ratio' or 'wdiff')\n", str);
 217         return -EINVAL;
 218 }
 219
 220 static double period_percent(struct hist_entry *he, u64 period)
 221 {
 222         u64 total = hists__total_period(he->hists);
 223
 224         return (period * 100.0) / total;
 225 }
 226
 227 static double compute_delta(struct hist_entry *he, struct hist_entry *pair)
 228 {
 229         double old_percent = period_percent(he, he->stat.period);
 230         double new_percent = period_percent(pair, pair->stat.period);
 231
 232         pair->diff.period_ratio_delta = new_percent - old_percent;
 233         pair->diff.computed = true;
 234         return pair->diff.period_ratio_delta;
 235 }
 236
 237 static double compute_ratio(struct hist_entry *he, struct hist_entry *pair)
 238 {
 239         double old_period = he->stat.period ?: 1;
 240         double new_period = pair->stat.period;
 241
 242         pair->diff.computed = true;
 243         pair->diff.period_ratio = new_period / old_period;
 244         return pair->diff.period_ratio;
 245 }
 246
 247 static s64 compute_wdiff(struct hist_entry *he, struct hist_entry *pair)
 248 {
 249         u64 old_period = he->stat.period;
 250         u64 new_period = pair->stat.period;
 251
 252         pair->diff.computed = true;
 253         pair->diff.wdiff = new_period * compute_wdiff_w2 -
 254                            old_period * compute_wdiff_w1;
 255
 256         return pair->diff.wdiff;
 257 }
 258
 259 static int formula_delta(struct hist_entry *he, struct hist_entry *pair,
 260                          char *buf, size_t size)
 261 {
 262         u64 he_total = he->hists->stats.total_period;
 263         u64 pair_total = pair->hists->stats.total_period;
 264
 265         if (symbol_conf.filter_relative) {
 266                 he_total = he->hists->stats.total_non_filtered_period;
 267                 pair_total = pair->hists->stats.total_non_filtered_period;
 268         }
 269         return scnprintf(buf, size,
 270                          "(%" PRIu64 " * 100 / %" PRIu64 ") - "
 271                          "(%" PRIu64 " * 100 / %" PRIu64 ")",
 272                          pair->stat.period, pair_total,
 273                          he->stat.period, he_total);
 274 }
 275
 276 static int formula_ratio(struct hist_entry *he, struct hist_entry *pair,
 277                          char *buf, size_t size)
 278 {
 279         double old_period = he->stat.period;
 280         double new_period = pair->stat.period;
 281
 282         return scnprintf(buf, size, "%.0F / %.0F", new_period, old_period);
 283 }
 284
 285 static int formula_wdiff(struct hist_entry *he, struct hist_entry *pair,
 286                          char *buf, size_t size)
 287 {
 288         u64 old_period = he->stat.period;
 289         u64 new_period = pair->stat.period;
 290
 291         return scnprintf(buf, size,
 292                   "(%" PRIu64 " * " "%" PRId64 ") - (%" PRIu64 " * " "%" PRId64 ")",
 293                   new_period, compute_wdiff_w2, old_period, compute_wdiff_w1);
 294 }
 295
 296 static int formula_fprintf(struct hist_entry *he, struct hist_entry *pair,
 297                            char *buf, size_t size)
 298 {
 299         switch (compute) {
 300         case COMPUTE_DELTA:
 301                 return formula_delta(he, pair, buf, size);
 302         case COMPUTE_RATIO:
 303                 return formula_ratio(he, pair, buf, size);
 304         case COMPUTE_WEIGHTED_DIFF:
 305                 return formula_wdiff(he, pair, buf, size);
 306         default:
 307                 BUG_ON(1);
 308         }
 309
 310         return -1;
 311 }
 312
 313 static int hists__add_entry(struct hists *hists,
 314                             struct addr_location *al, u64 period,
 315                             u64 weight, u64 transaction)
 316 {
 317         if (__hists__add_entry(hists, al, NULL, NULL, NULL, period, weight,
 318                                transaction, true) != NULL)
 319                 return 0;
 320         return -ENOMEM;
 321 }
 322
 323 static int diff__process_sample_event(struct perf_tool *tool __maybe_unused,
 324                                       union perf_event *event,
 325                                       struct perf_sample *sample,
 326                                       struct perf_evsel *evsel,
 327                                       struct machine *machine)
 328 {
 329         struct addr_location al;
 330         struct hists *hists = evsel__hists(evsel);
 331
 332         if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
 333                 pr_warning("problem processing %d event, skipping it.\n",
 334                            event->header.type);
 335                 return -1;
 336         }
 337
 338         if (hists__add_entry(hists, &al, sample->period,
 339                              sample->weight, sample->transaction)) {
 340                 pr_warning("problem incrementing symbol period, skipping event\n");
 341                 return -1;
 342         }
 343
 344         /*
 345          * The total_period is updated here before going to the output
 346          * tree since normally only the baseline hists will call
 347          * hists__output_resort() and precompute needs the total
 348          * period in order to sort entries by percentage delta.
 349          */
 350         hists->stats.total_period += sample->period;
 351         if (!al.filtered)
 352                 hists->stats.total_non_filtered_period += sample->period;
 353
 354         return 0;
 355 }
 356
 357 static struct perf_tool tool = {
 358         .sample = diff__process_sample_event,
 359         .mmap   = perf_event__process_mmap,
 360         .mmap2  = perf_event__process_mmap2,
 361         .comm   = perf_event__process_comm,
 362         .exit   = perf_event__process_exit,
 363         .fork   = perf_event__process_fork,
 364         .lost   = perf_event__process_lost,
 365         .ordered_events = true,
 366         .ordering_requires_timestamps = true,
 367 };
 368
 369 static struct perf_evsel *evsel_match(struct perf_evsel *evsel,
 370                                       struct perf_evlist *evlist)
 371 {
 372         struct perf_evsel *e;
 373
 374         evlist__for_each(evlist, e) {
 375                 if (perf_evsel__match2(evsel, e))
 376                         return e;
 377         }
 378
 379         return NULL;
 380 }
 381
 382 static void perf_evlist__collapse_resort(struct perf_evlist *evlist)
 383 {
 384         struct perf_evsel *evsel;
 385
 386         evlist__for_each(evlist, evsel) {
 387                 struct hists *hists = evsel__hists(evsel);
 388
 389                 hists__collapse_resort(hists, NULL);
 390         }
 391 }
 392
 393 static struct data__file *fmt_to_data_file(struct perf_hpp_fmt *fmt)
 394 {
 395         struct diff_hpp_fmt *dfmt = container_of(fmt, struct diff_hpp_fmt, fmt);
 396         void *ptr = dfmt - dfmt->idx;
 397         struct data__file *d = container_of(ptr, struct data__file, fmt);
 398
 399         return d;
 400 }
 401
 402 static struct hist_entry*
 403 get_pair_data(struct hist_entry *he, struct data__file *d)
 404 {
 405         if (hist_entry__has_pairs(he)) {
 406                 struct hist_entry *pair;
 407
 408                 list_for_each_entry(pair, &he->pairs.head, pairs.node)
 409                         if (pair->hists == d->hists)
 410                                 return pair;
 411         }
 412
 413         return NULL;
 414 }
 415
 416 static struct hist_entry*
 417 get_pair_fmt(struct hist_entry *he, struct diff_hpp_fmt *dfmt)
 418 {
 419         struct data__file *d = fmt_to_data_file(&dfmt->fmt);
 420
 421         return get_pair_data(he, d);
 422 }
 423
 424 static void hists__baseline_only(struct hists *hists)
 425 {
 426         struct rb_root *root;
 427         struct rb_node *next;
 428
 429         if (sort__need_collapse)
 430                 root = &hists->entries_collapsed;
 431         else
 432                 root = hists->entries_in;
 433
 434         next = rb_first(root);
 435         while (next != NULL) {
 436                 struct hist_entry *he = rb_entry(next, struct hist_entry, rb_node_in);
 437
 438                 next = rb_next(&he->rb_node_in);
 439                 if (!hist_entry__next_pair(he)) {
 440                         rb_erase(&he->rb_node_in, root);
 441                         hist_entry__delete(he);
 442                 }
 443         }
 444 }
 445
 446 static void hists__precompute(struct hists *hists)
 447 {
 448         struct rb_root *root;
 449         struct rb_node *next;
 450
 451         if (sort__need_collapse)
 452                 root = &hists->entries_collapsed;
 453         else
 454                 root = hists->entries_in;
 455
 456         next = rb_first(root);
 457         while (next != NULL) {
 458                 struct hist_entry *he, *pair;
 459                 struct data__file *d;
 460                 int i;
 461
 462                 he   = rb_entry(next, struct hist_entry, rb_node_in);
 463                 next = rb_next(&he->rb_node_in);
 464
 465                 data__for_each_file_new(i, d) {
 466                         pair = get_pair_data(he, d);
 467                         if (!pair)
 468                                 continue;
 469
 470                         switch (compute) {
 471                         case COMPUTE_DELTA:
 472                                 compute_delta(he, pair);
 473                                 break;
 474                         case COMPUTE_RATIO:
 475                                 compute_ratio(he, pair);
 476                                 break;
 477                         case COMPUTE_WEIGHTED_DIFF:
 478                                 compute_wdiff(he, pair);
 479                                 break;
 480                         default:
 481                                 BUG_ON(1);
 482                         }
 483                 }
 484         }
 485 }
 486
 487 static int64_t cmp_doubles(double l, double r)
 488 {
 489         if (l > r)
 490                 return -1;
 491         else if (l < r)
 492                 return 1;
 493         else
 494                 return 0;
 495 }
 496
 497 static int64_t
 498 __hist_entry__cmp_compute(struct hist_entry *left, struct hist_entry *right,
 499                         int c)
 500 {
 501         switch (c) {
 502         case COMPUTE_DELTA:
 503         {
 504                 double l = left->diff.period_ratio_delta;
 505                 double r = right->diff.period_ratio_delta;
 506
 507                 return cmp_doubles(l, r);
 508         }
 509         case COMPUTE_RATIO:
 510         {
 511                 double l = left->diff.period_ratio;
 512                 double r = right->diff.period_ratio;
 513
 514                 return cmp_doubles(l, r);
 515         }
 516         case COMPUTE_WEIGHTED_DIFF:
 517         {
 518                 s64 l = left->diff.wdiff;
 519                 s64 r = right->diff.wdiff;
 520
 521                 return r - l;
 522         }
 523         default:
 524                 BUG_ON(1);
 525         }
 526
 527         return 0;
 528 }
 529
 530 static int64_t
 531 hist_entry__cmp_compute(struct hist_entry *left, struct hist_entry *right,
 532                         int c, int sort_idx)
 533 {
 534         bool pairs_left  = hist_entry__has_pairs(left);
 535         bool pairs_right = hist_entry__has_pairs(right);
 536         struct hist_entry *p_right, *p_left;
 537
 538         if (!pairs_left && !pairs_right)
 539                 return 0;
 540
 541         if (!pairs_left || !pairs_right)
 542                 return pairs_left ? -1 : 1;
 543
 544         p_left  = get_pair_data(left,  &data__files[sort_idx]);
 545         p_right = get_pair_data(right, &data__files[sort_idx]);
 546
 547         if (!p_left && !p_right)
 548                 return 0;
 549
 550         if (!p_left || !p_right)
 551                 return p_left ? -1 : 1;
 552
 553         /*
 554          * We have 2 entries of same kind, let's
 555          * make the data comparison.
 556          */
 557         return __hist_entry__cmp_compute(p_left, p_right, c);
 558 }
 559
 560 static int64_t
 561 hist_entry__cmp_compute_idx(struct hist_entry *left, struct hist_entry *right,
 562                             int c, int sort_idx)
 563 {
 564         struct hist_entry *p_right, *p_left;
 565
 566         p_left  = get_pair_data(left,  &data__files[sort_idx]);
 567         p_right = get_pair_data(right, &data__files[sort_idx]);
 568
 569         if (!p_left && !p_right)
 570                 return 0;
 571
 572         if (!p_left || !p_right)
 573                 return p_left ? -1 : 1;
 574
 575         if (c != COMPUTE_DELTA) {
 576                 /*
 577                  * The delta can be computed without the baseline, but
 578                  * others are not.  Put those entries which have no
 579                  * values below.
 580                  */
 581                 if (left->dummy && right->dummy)
 582                         return 0;
 583
 584                 if (left->dummy || right->dummy)
 585                         return left->dummy ? 1 : -1;
 586         }
 587
 588         return __hist_entry__cmp_compute(p_left, p_right, c);
 589 }
 590
 591 static int64_t
 592 hist_entry__cmp_nop(struct perf_hpp_fmt *fmt __maybe_unused,
 593                     struct hist_entry *left __maybe_unused,
 594                     struct hist_entry *right __maybe_unused)
 595 {
 596         return 0;
 597 }
 598
 599 static int64_t
 600 hist_entry__cmp_baseline(struct perf_hpp_fmt *fmt __maybe_unused,
 601                          struct hist_entry *left, struct hist_entry *right)
 602 {
 603         if (left->stat.period == right->stat.period)
 604                 return 0;
 605         return left->stat.period > right->stat.period ? 1 : -1;
 606 }
 607
 608 static int64_t
 609 hist_entry__cmp_delta(struct perf_hpp_fmt *fmt,
 610                       struct hist_entry *left, struct hist_entry *right)
 611 {
 612         struct data__file *d = fmt_to_data_file(fmt);
 613
 614         return hist_entry__cmp_compute(right, left, COMPUTE_DELTA, d->idx);
 615 }
 616
 617 static int64_t
 618 hist_entry__cmp_ratio(struct perf_hpp_fmt *fmt,
 619                       struct hist_entry *left, struct hist_entry *right)
 620 {
 621         struct data__file *d = fmt_to_data_file(fmt);
 622
 623         return hist_entry__cmp_compute(right, left, COMPUTE_RATIO, d->idx);
 624 }
 625
 626 static int64_t
 627 hist_entry__cmp_wdiff(struct perf_hpp_fmt *fmt,
 628                       struct hist_entry *left, struct hist_entry *right)
 629 {
 630         struct data__file *d = fmt_to_data_file(fmt);
 631
 632         return hist_entry__cmp_compute(right, left, COMPUTE_WEIGHTED_DIFF, d->idx);
 633 }
 634
 635 static int64_t
 636 hist_entry__cmp_delta_idx(struct perf_hpp_fmt *fmt __maybe_unused,
 637                           struct hist_entry *left, struct hist_entry *right)
 638 {
 639         return hist_entry__cmp_compute_idx(right, left, COMPUTE_DELTA,
 640                                            sort_compute);
 641 }
 642
 643 static int64_t
 644 hist_entry__cmp_ratio_idx(struct perf_hpp_fmt *fmt __maybe_unused,
 645                           struct hist_entry *left, struct hist_entry *right)
 646 {
 647         return hist_entry__cmp_compute_idx(right, left, COMPUTE_RATIO,
 648                                            sort_compute);
 649 }
 650
 651 static int64_t
 652 hist_entry__cmp_wdiff_idx(struct perf_hpp_fmt *fmt __maybe_unused,
 653                           struct hist_entry *left, struct hist_entry *right)
 654 {
 655         return hist_entry__cmp_compute_idx(right, left, COMPUTE_WEIGHTED_DIFF,
 656                                            sort_compute);
 657 }
 658
 659 static void hists__process(struct hists *hists)
 660 {
 661         if (show_baseline_only)
 662                 hists__baseline_only(hists);
 663
 664         hists__precompute(hists);
 665         hists__output_resort(hists, NULL);
 666
 667         hists__fprintf(hists, true, 0, 0, 0, stdout);
 668 }
 669
 670 static void data__fprintf(void)
 671 {
 672         struct data__file *d;
 673         int i;
 674
 675         fprintf(stdout, "# Data files:\n");
 676
 677         data__for_each_file(i, d)
 678                 fprintf(stdout, "#  [%d] %s %s\n",
 679                         d->idx, d->file.path,
 680                         !d->idx ? "(Baseline)" : "");
 681
 682         fprintf(stdout, "#\n");
 683 }
 684
 685 static void data_process(void)
 686 {
 687         struct perf_evlist *evlist_base = data__files[0].session->evlist;
 688         struct perf_evsel *evsel_base;
 689         bool first = true;
 690
 691         evlist__for_each(evlist_base, evsel_base) {
 692                 struct hists *hists_base = evsel__hists(evsel_base);
 693                 struct data__file *d;
 694                 int i;
 695
 696                 data__for_each_file_new(i, d) {
 697                         struct perf_evlist *evlist = d->session->evlist;
 698                         struct perf_evsel *evsel;
 699                         struct hists *hists;
 700
 701                         evsel = evsel_match(evsel_base, evlist);
 702                         if (!evsel)
 703                                 continue;
 704
 705                         hists = evsel__hists(evsel);
 706                         d->hists = hists;
 707
 708                         hists__match(hists_base, hists);
 709
 710                         if (!show_baseline_only)
 711                                 hists__link(hists_base, hists);
 712                 }
 713
 714                 fprintf(stdout, "%s# Event '%s'\n#\n", first ? "" : "\n",
 715                         perf_evsel__name(evsel_base));
 716
 717                 first = false;
 718
 719                 if (verbose || data__files_cnt > 2)
 720                         data__fprintf();
 721
 722                 hists__process(hists_base);
 723         }
 724 }
 725
 726 static void data__free(struct data__file *d)
 727 {
 728         int col;
 729
 730         for (col = 0; col < PERF_HPP_DIFF__MAX_INDEX; col++) {
 731                 struct diff_hpp_fmt *fmt = &d->fmt[col];
 732
 733                 zfree(&fmt->header);
 734         }
 735 }
 736
 737 static int __cmd_diff(void)
 738 {
 739         struct data__file *d;
 740         int ret = -EINVAL, i;
 741
 742         data__for_each_file(i, d) {
 743                 d->session = perf_session__new(&d->file, false, &tool);
 744                 if (!d->session) {
 745                         pr_err("Failed to open %s\n", d->file.path);
 746                         ret = -1;
 747                         goto out_delete;
 748                 }
 749
 750                 ret = perf_session__process_events(d->session, &tool);
 751                 if (ret) {
 752                         pr_err("Failed to process %s\n", d->file.path);
 753                         goto out_delete;
 754                 }
 755
 756                 perf_evlist__collapse_resort(d->session->evlist);
 757         }
 758
 759         data_process();
 760
 761  out_delete:
 762         data__for_each_file(i, d) {
 763                 if (d->session)
 764                         perf_session__delete(d->session);
 765
 766                 data__free(d);
 767         }
 768
 769         free(data__files);
 770         return ret;
 771 }
 772
 773 static const char * const diff_usage[] = {
 774         "perf diff [<options>] [old_file] [new_file]",
 775         NULL,
 776 };
 777
 778 static const struct option options[] = {
 779         OPT_INCR('v', "verbose", &verbose,
 780                     "be more verbose (show symbol address, etc)"),
 781         OPT_BOOLEAN('b', "baseline-only", &show_baseline_only,
 782                     "Show only items with match in baseline"),
 783         OPT_CALLBACK('c', "compute", &compute,
 784                      "delta,ratio,wdiff:w1,w2 (default delta)",
 785                      "Entries differential computation selection",
 786                      setup_compute),
 787         OPT_BOOLEAN('p', "period", &show_period,
 788                     "Show period values."),
 789         OPT_BOOLEAN('F', "formula", &show_formula,
 790                     "Show formula."),
 791         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 792                     "dump raw trace in ASCII"),
 793         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
 794         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 795                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 796         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 797                    "only consider symbols in these dsos"),
 798         OPT_STRING('C', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
 799                    "only consider symbols in these comms"),
 800         OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
 801                    "only consider these symbols"),
 802         OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
 803                    "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
 804                    " Please refer the man page for the complete list."),
 805         OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
 806                    "separator for columns, no spaces will be added between "
 807                    "columns '.' is reserved."),
 808         OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
 809                     "Look for files with symbols relative to this directory"),
 810         OPT_UINTEGER('o', "order", &sort_compute, "Specify compute sorting."),
 811         OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
 812                      "How to display percentage of filtered entries", parse_filter_percentage),
 813         OPT_END()
 814 };
 815
 816 static double baseline_percent(struct hist_entry *he)
 817 {
 818         u64 total = hists__total_period(he->hists);
 819
 820         return 100.0 * he->stat.period / total;
 821 }
 822
 823 static int hpp__color_baseline(struct perf_hpp_fmt *fmt,
 824                                struct perf_hpp *hpp, struct hist_entry *he)
 825 {
 826         struct diff_hpp_fmt *dfmt =
 827                 container_of(fmt, struct diff_hpp_fmt, fmt);
 828         double percent = baseline_percent(he);
 829         char pfmt[20] = " ";
 830
 831         if (!he->dummy) {
 832                 scnprintf(pfmt, 20, "%%%d.2f%%%%", dfmt->header_width - 1);
 833                 return percent_color_snprintf(hpp->buf, hpp->size,
 834                                               pfmt, percent);
 835         } else
 836                 return scnprintf(hpp->buf, hpp->size, "%*s",
 837                                  dfmt->header_width, pfmt);
 838 }
 839
 840 static int hpp__entry_baseline(struct hist_entry *he, char *buf, size_t size)
 841 {
 842         double percent = baseline_percent(he);
 843         const char *fmt = symbol_conf.field_sep ? "%.2f" : "%6.2f%%";
 844         int ret = 0;
 845
 846         if (!he->dummy)
 847                 ret = scnprintf(buf, size, fmt, percent);
 848
 849         return ret;
 850 }
 851
 852 static int __hpp__color_compare(struct perf_hpp_fmt *fmt,
 853                                 struct perf_hpp *hpp, struct hist_entry *he,
 854                                 int comparison_method)
 855 {
 856         struct diff_hpp_fmt *dfmt =
 857                 container_of(fmt, struct diff_hpp_fmt, fmt);
 858         struct hist_entry *pair = get_pair_fmt(he, dfmt);
 859         double diff;
 860         s64 wdiff;
 861         char pfmt[20] = " ";
 862
 863         if (!pair)
 864                 goto no_print;
 865
 866         switch (comparison_method) {
 867         case COMPUTE_DELTA:
 868                 if (pair->diff.computed)
 869                         diff = pair->diff.period_ratio_delta;
 870                 else
 871                         diff = compute_delta(he, pair);
 872
 873                 scnprintf(pfmt, 20, "%%%+d.2f%%%%", dfmt->header_width - 1);
 874                 return percent_color_snprintf(hpp->buf, hpp->size,
 875                                         pfmt, diff);
 876         case COMPUTE_RATIO:
 877                 if (he->dummy)
 878                         goto dummy_print;
 879                 if (pair->diff.computed)
 880                         diff = pair->diff.period_ratio;
 881                 else
 882                         diff = compute_ratio(he, pair);
 883
 884                 scnprintf(pfmt, 20, "%%%d.6f", dfmt->header_width);
 885                 return value_color_snprintf(hpp->buf, hpp->size,
 886                                         pfmt, diff);
 887         case COMPUTE_WEIGHTED_DIFF:
 888                 if (he->dummy)
 889                         goto dummy_print;
 890                 if (pair->diff.computed)
 891                         wdiff = pair->diff.wdiff;
 892                 else
 893                         wdiff = compute_wdiff(he, pair);
 894
 895                 scnprintf(pfmt, 20, "%%14ld", dfmt->header_width);
 896                 return color_snprintf(hpp->buf, hpp->size,
 897                                 get_percent_color(wdiff),
 898                                 pfmt, wdiff);
 899         default:
 900                 BUG_ON(1);
 901         }
 902 dummy_print:
 903         return scnprintf(hpp->buf, hpp->size, "%*s",
 904                         dfmt->header_width, "N/A");
 905 no_print:
 906         return scnprintf(hpp->buf, hpp->size, "%*s",
 907                         dfmt->header_width, pfmt);
 908 }
 909
 910 static int hpp__color_delta(struct perf_hpp_fmt *fmt,
 911                         struct perf_hpp *hpp, struct hist_entry *he)
 912 {
 913         return __hpp__color_compare(fmt, hpp, he, COMPUTE_DELTA);
 914 }
 915
 916 static int hpp__color_ratio(struct perf_hpp_fmt *fmt,
 917                         struct perf_hpp *hpp, struct hist_entry *he)
 918 {
 919         return __hpp__color_compare(fmt, hpp, he, COMPUTE_RATIO);
 920 }
 921
 922 static int hpp__color_wdiff(struct perf_hpp_fmt *fmt,
 923                         struct perf_hpp *hpp, struct hist_entry *he)
 924 {
 925         return __hpp__color_compare(fmt, hpp, he, COMPUTE_WEIGHTED_DIFF);
 926 }
 927
 928 static void
 929 hpp__entry_unpair(struct hist_entry *he, int idx, char *buf, size_t size)
 930 {
 931         switch (idx) {
 932         case PERF_HPP_DIFF__PERIOD_BASELINE:
 933                 scnprintf(buf, size, "%" PRIu64, he->stat.period);
 934                 break;
 935
 936         default:
 937                 break;
 938         }
 939 }
 940
 941 static void
 942 hpp__entry_pair(struct hist_entry *he, struct hist_entry *pair,
 943                 int idx, char *buf, size_t size)
 944 {
 945         double diff;
 946         double ratio;
 947         s64 wdiff;
 948
 949         switch (idx) {
 950         case PERF_HPP_DIFF__DELTA:
 951                 if (pair->diff.computed)
 952                         diff = pair->diff.period_ratio_delta;
 953                 else
 954                         diff = compute_delta(he, pair);
 955
 956                 scnprintf(buf, size, "%+4.2F%%", diff);
 957                 break;
 958
 959         case PERF_HPP_DIFF__RATIO:
 960                 /* No point for ratio number if we are dummy.. */
 961                 if (he->dummy) {
 962                         scnprintf(buf, size, "N/A");
 963                         break;
 964                 }
 965
 966                 if (pair->diff.computed)
 967                         ratio = pair->diff.period_ratio;
 968                 else
 969                         ratio = compute_ratio(he, pair);
 970
 971                 if (ratio > 0.0)
 972                         scnprintf(buf, size, "%14.6F", ratio);
 973                 break;
 974
 975         case PERF_HPP_DIFF__WEIGHTED_DIFF:
 976                 /* No point for wdiff number if we are dummy.. */
 977                 if (he->dummy) {
 978                         scnprintf(buf, size, "N/A");
 979                         break;
 980                 }
 981
 982                 if (pair->diff.computed)
 983                         wdiff = pair->diff.wdiff;
 984                 else
 985                         wdiff = compute_wdiff(he, pair);
 986
 987                 if (wdiff != 0)
 988                         scnprintf(buf, size, "%14ld", wdiff);
 989                 break;
 990
 991         case PERF_HPP_DIFF__FORMULA:
 992                 formula_fprintf(he, pair, buf, size);
 993                 break;
 994
 995         case PERF_HPP_DIFF__PERIOD:
 996                 scnprintf(buf, size, "%" PRIu64, pair->stat.period);
 997                 break;
 998
 999         default:
1000                 BUG_ON(1);
1001         };
1002 }
1003
1004 static void
1005 __hpp__entry_global(struct hist_entry *he, struct diff_hpp_fmt *dfmt,
1006                     char *buf, size_t size)
1007 {
1008         struct hist_entry *pair = get_pair_fmt(he, dfmt);
1009         int idx = dfmt->idx;
1010
1011         /* baseline is special */
1012         if (idx == PERF_HPP_DIFF__BASELINE)
1013                 hpp__entry_baseline(he, buf, size);
1014         else {
1015                 if (pair)
1016                         hpp__entry_pair(he, pair, idx, buf, size);
1017                 else
1018                         hpp__entry_unpair(he, idx, buf, size);
1019         }
1020 }
1021
1022 static int hpp__entry_global(struct perf_hpp_fmt *_fmt, struct perf_hpp *hpp,
1023                              struct hist_entry *he)
1024 {
1025         struct diff_hpp_fmt *dfmt =
1026                 container_of(_fmt, struct diff_hpp_fmt, fmt);
1027         char buf[MAX_COL_WIDTH] = " ";
1028
1029         __hpp__entry_global(he, dfmt, buf, MAX_COL_WIDTH);
1030
1031         if (symbol_conf.field_sep)
1032                 return scnprintf(hpp->buf, hpp->size, "%s", buf);
1033         else
1034                 return scnprintf(hpp->buf, hpp->size, "%*s",
1035                                  dfmt->header_width, buf);
1036 }
1037
1038 static int hpp__header(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
1039                        struct perf_evsel *evsel __maybe_unused)
1040 {
1041         struct diff_hpp_fmt *dfmt =
1042                 container_of(fmt, struct diff_hpp_fmt, fmt);
1043
1044         BUG_ON(!dfmt->header);
1045         return scnprintf(hpp->buf, hpp->size, dfmt->header);
1046 }
1047
1048 static int hpp__width(struct perf_hpp_fmt *fmt,
1049                       struct perf_hpp *hpp __maybe_unused,
1050                       struct perf_evsel *evsel __maybe_unused)
1051 {
1052         struct diff_hpp_fmt *dfmt =
1053                 container_of(fmt, struct diff_hpp_fmt, fmt);
1054
1055         BUG_ON(dfmt->header_width <= 0);
1056         return dfmt->header_width;
1057 }
1058
1059 static void init_header(struct data__file *d, struct diff_hpp_fmt *dfmt)
1060 {
1061 #define MAX_HEADER_NAME 100
1062         char buf_indent[MAX_HEADER_NAME];
1063         char buf[MAX_HEADER_NAME];
1064         const char *header = NULL;
1065         int width = 0;
1066
1067         BUG_ON(dfmt->idx >= PERF_HPP_DIFF__MAX_INDEX);
1068         header = columns[dfmt->idx].name;
1069         width  = columns[dfmt->idx].width;
1070
1071         /* Only our defined HPP fmts should appear here. */
1072         BUG_ON(!header);
1073
1074         if (data__files_cnt > 2)
1075                 scnprintf(buf, MAX_HEADER_NAME, "%s/%d", header, d->idx);
1076
1077 #define NAME (data__files_cnt > 2 ? buf : header)
1078         dfmt->header_width = width;
1079         width = (int) strlen(NAME);
1080         if (dfmt->header_width < width)
1081                 dfmt->header_width = width;
1082
1083         scnprintf(buf_indent, MAX_HEADER_NAME, "%*s",
1084                   dfmt->header_width, NAME);
1085
1086         dfmt->header = strdup(buf_indent);
1087 #undef MAX_HEADER_NAME
1088 #undef NAME
1089 }
1090
1091 static void data__hpp_register(struct data__file *d, int idx)
1092 {
1093         struct diff_hpp_fmt *dfmt = &d->fmt[idx];
1094         struct perf_hpp_fmt *fmt = &dfmt->fmt;
1095
1096         dfmt->idx = idx;
1097
1098         fmt->header = hpp__header;
1099         fmt->width  = hpp__width;
1100         fmt->entry  = hpp__entry_global;
1101         fmt->cmp    = hist_entry__cmp_nop;
1102         fmt->collapse = hist_entry__cmp_nop;
1103
1104         /* TODO more colors */
1105         switch (idx) {
1106         case PERF_HPP_DIFF__BASELINE:
1107                 fmt->color = hpp__color_baseline;
1108                 fmt->sort  = hist_entry__cmp_baseline;
1109                 break;
1110         case PERF_HPP_DIFF__DELTA:
1111                 fmt->color = hpp__color_delta;
1112                 fmt->sort  = hist_entry__cmp_delta;
1113                 break;
1114         case PERF_HPP_DIFF__RATIO:
1115                 fmt->color = hpp__color_ratio;
1116                 fmt->sort  = hist_entry__cmp_ratio;
1117                 break;
1118         case PERF_HPP_DIFF__WEIGHTED_DIFF:
1119                 fmt->color = hpp__color_wdiff;
1120                 fmt->sort  = hist_entry__cmp_wdiff;
1121                 break;
1122         default:
1123                 fmt->sort  = hist_entry__cmp_nop;
1124                 break;
1125         }
1126
1127         init_header(d, dfmt);
1128         perf_hpp__column_register(fmt);
1129         perf_hpp__register_sort_field(fmt);
1130 }
1131
1132 static int ui_init(void)
1133 {
1134         struct data__file *d;
1135         struct perf_hpp_fmt *fmt;
1136         int i;
1137
1138         data__for_each_file(i, d) {
1139
1140                 /*
1141                  * Baseline or compute realted columns:
1142                  *
1143                  *   PERF_HPP_DIFF__BASELINE
1144                  *   PERF_HPP_DIFF__DELTA
1145                  *   PERF_HPP_DIFF__RATIO
1146                  *   PERF_HPP_DIFF__WEIGHTED_DIFF
1147                  */
1148                 data__hpp_register(d, i ? compute_2_hpp[compute] :
1149                                           PERF_HPP_DIFF__BASELINE);
1150
1151                 /*
1152                  * And the rest:
1153                  *
1154                  * PERF_HPP_DIFF__FORMULA
1155                  * PERF_HPP_DIFF__PERIOD
1156                  * PERF_HPP_DIFF__PERIOD_BASELINE
1157                  */
1158                 if (show_formula && i)
1159                         data__hpp_register(d, PERF_HPP_DIFF__FORMULA);
1160
1161                 if (show_period)
1162                         data__hpp_register(d, i ? PERF_HPP_DIFF__PERIOD :
1163                                                   PERF_HPP_DIFF__PERIOD_BASELINE);
1164         }
1165
1166         if (!sort_compute)
1167                 return 0;
1168
1169         /*
1170          * Prepend an fmt to sort on columns at 'sort_compute' first.
1171          * This fmt is added only to the sort list but not to the
1172          * output fields list.
1173          *
1174          * Note that this column (data) can be compared twice - one
1175          * for this 'sort_compute' fmt and another for the normal
1176          * diff_hpp_fmt.  But it shouldn't a problem as most entries
1177          * will be sorted out by first try or baseline and comparing
1178          * is not a costly operation.
1179          */
1180         fmt = zalloc(sizeof(*fmt));
1181         if (fmt == NULL) {
1182                 pr_err("Memory allocation failed\n");
1183                 return -1;
1184         }
1185
1186         fmt->cmp      = hist_entry__cmp_nop;
1187         fmt->collapse = hist_entry__cmp_nop;
1188
1189         switch (compute) {
1190         case COMPUTE_DELTA:
1191                 fmt->sort = hist_entry__cmp_delta_idx;
1192                 break;
1193         case COMPUTE_RATIO:
1194                 fmt->sort = hist_entry__cmp_ratio_idx;
1195                 break;
1196         case COMPUTE_WEIGHTED_DIFF:
1197                 fmt->sort = hist_entry__cmp_wdiff_idx;
1198                 break;
1199         default:
1200                 BUG_ON(1);
1201         }
1202
1203         list_add(&fmt->sort_list, &perf_hpp__sort_list);
1204         return 0;
1205 }
1206
1207 static int data_init(int argc, const char **argv)
1208 {
1209         struct data__file *d;
1210         static const char *defaults[] = {
1211                 "perf.data.old",
1212                 "perf.data",
1213         };
1214         bool use_default = true;
1215         int i;
1216
1217         data__files_cnt = 2;
1218
1219         if (argc) {
1220                 if (argc == 1)
1221                         defaults[1] = argv[0];
1222                 else {
1223                         data__files_cnt = argc;
1224                         use_default = false;
1225                 }
1226         } else if (perf_guest) {
1227                 defaults[0] = "perf.data.host";
1228                 defaults[1] = "perf.data.guest";
1229         }
1230
1231         if (sort_compute >= (unsigned int) data__files_cnt) {
1232                 pr_err("Order option out of limit.\n");
1233                 return -EINVAL;
1234         }
1235
1236         data__files = zalloc(sizeof(*data__files) * data__files_cnt);
1237         if (!data__files)
1238                 return -ENOMEM;
1239
1240         data__for_each_file(i, d) {
1241                 struct perf_data_file *file = &d->file;
1242
1243                 file->path  = use_default ? defaults[i] : argv[i];
1244                 file->mode  = PERF_DATA_MODE_READ,
1245                 file->force = force,
1246
1247                 d->idx  = i;
1248         }
1249
1250         return 0;
1251 }
1252
1253 int cmd_diff(int argc, const char **argv, const char *prefix __maybe_unused)
1254 {
1255         int ret = hists__init();
1256
1257         if (ret < 0)
1258                 return ret;
1259
1260         perf_config(perf_default_config, NULL);
1261
1262         argc = parse_options(argc, argv, options, diff_usage, 0);
1263
1264         if (symbol__init(NULL) < 0)
1265                 return -1;
1266
1267         if (data_init(argc, argv) < 0)
1268                 return -1;
1269
1270         if (ui_init() < 0)
1271                 return -1;
1272
1273         sort__mode = SORT_MODE__DIFF;
1274
1275         if (setup_sorting() < 0)
1276                 usage_with_options(diff_usage, options);
1277
1278         setup_pager();
1279
1280         sort__setup_elide(NULL);
1281
1282         return __cmd_diff();
1283 }