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         .comm   = perf_event__process_comm,
 361         .exit   = perf_event__process_exit,
 362         .fork   = perf_event__process_fork,
 363         .lost   = perf_event__process_lost,
 364         .ordered_events = true,
 365         .ordering_requires_timestamps = true,
 366 };
 367
 368 static struct perf_evsel *evsel_match(struct perf_evsel *evsel,
 369                                       struct perf_evlist *evlist)
 370 {
 371         struct perf_evsel *e;
 372
 373         evlist__for_each(evlist, e) {
 374                 if (perf_evsel__match2(evsel, e))
 375                         return e;
 376         }
 377
 378         return NULL;
 379 }
 380
 381 static void perf_evlist__collapse_resort(struct perf_evlist *evlist)
 382 {
 383         struct perf_evsel *evsel;
 384
 385         evlist__for_each(evlist, evsel) {
 386                 struct hists *hists = evsel__hists(evsel);
 387
 388                 hists__collapse_resort(hists, NULL);
 389         }
 390 }
 391
 392 static struct hist_entry*
 393 get_pair_data(struct hist_entry *he, struct data__file *d)
 394 {
 395         if (hist_entry__has_pairs(he)) {
 396                 struct hist_entry *pair;
 397
 398                 list_for_each_entry(pair, &he->pairs.head, pairs.node)
 399                         if (pair->hists == d->hists)
 400                                 return pair;
 401         }
 402
 403         return NULL;
 404 }
 405
 406 static struct hist_entry*
 407 get_pair_fmt(struct hist_entry *he, struct diff_hpp_fmt *dfmt)
 408 {
 409         void *ptr = dfmt - dfmt->idx;
 410         struct data__file *d = container_of(ptr, struct data__file, fmt);
 411
 412         return get_pair_data(he, d);
 413 }
 414
 415 static void hists__baseline_only(struct hists *hists)
 416 {
 417         struct rb_root *root;
 418         struct rb_node *next;
 419
 420         if (sort__need_collapse)
 421                 root = &hists->entries_collapsed;
 422         else
 423                 root = hists->entries_in;
 424
 425         next = rb_first(root);
 426         while (next != NULL) {
 427                 struct hist_entry *he = rb_entry(next, struct hist_entry, rb_node_in);
 428
 429                 next = rb_next(&he->rb_node_in);
 430                 if (!hist_entry__next_pair(he)) {
 431                         rb_erase(&he->rb_node_in, root);
 432                         hist_entry__free(he);
 433                 }
 434         }
 435 }
 436
 437 static void hists__precompute(struct hists *hists)
 438 {
 439         struct rb_root *root;
 440         struct rb_node *next;
 441
 442         if (sort__need_collapse)
 443                 root = &hists->entries_collapsed;
 444         else
 445                 root = hists->entries_in;
 446
 447         next = rb_first(root);
 448         while (next != NULL) {
 449                 struct hist_entry *he, *pair;
 450
 451                 he   = rb_entry(next, struct hist_entry, rb_node_in);
 452                 next = rb_next(&he->rb_node_in);
 453
 454                 pair = get_pair_data(he, &data__files[sort_compute]);
 455                 if (!pair)
 456                         continue;
 457
 458                 switch (compute) {
 459                 case COMPUTE_DELTA:
 460                         compute_delta(he, pair);
 461                         break;
 462                 case COMPUTE_RATIO:
 463                         compute_ratio(he, pair);
 464                         break;
 465                 case COMPUTE_WEIGHTED_DIFF:
 466                         compute_wdiff(he, pair);
 467                         break;
 468                 default:
 469                         BUG_ON(1);
 470                 }
 471         }
 472 }
 473
 474 static int64_t cmp_doubles(double l, double r)
 475 {
 476         if (l > r)
 477                 return -1;
 478         else if (l < r)
 479                 return 1;
 480         else
 481                 return 0;
 482 }
 483
 484 static int64_t
 485 __hist_entry__cmp_compute(struct hist_entry *left, struct hist_entry *right,
 486                         int c)
 487 {
 488         switch (c) {
 489         case COMPUTE_DELTA:
 490         {
 491                 double l = left->diff.period_ratio_delta;
 492                 double r = right->diff.period_ratio_delta;
 493
 494                 return cmp_doubles(l, r);
 495         }
 496         case COMPUTE_RATIO:
 497         {
 498                 double l = left->diff.period_ratio;
 499                 double r = right->diff.period_ratio;
 500
 501                 return cmp_doubles(l, r);
 502         }
 503         case COMPUTE_WEIGHTED_DIFF:
 504         {
 505                 s64 l = left->diff.wdiff;
 506                 s64 r = right->diff.wdiff;
 507
 508                 return r - l;
 509         }
 510         default:
 511                 BUG_ON(1);
 512         }
 513
 514         return 0;
 515 }
 516
 517 static int64_t
 518 hist_entry__cmp_compute(struct hist_entry *left, struct hist_entry *right,
 519                         int c)
 520 {
 521         bool pairs_left  = hist_entry__has_pairs(left);
 522         bool pairs_right = hist_entry__has_pairs(right);
 523         struct hist_entry *p_right, *p_left;
 524
 525         if (!pairs_left && !pairs_right)
 526                 return 0;
 527
 528         if (!pairs_left || !pairs_right)
 529                 return pairs_left ? -1 : 1;
 530
 531         p_left  = get_pair_data(left,  &data__files[sort_compute]);
 532         p_right = get_pair_data(right, &data__files[sort_compute]);
 533
 534         if (!p_left && !p_right)
 535                 return 0;
 536
 537         if (!p_left || !p_right)
 538                 return p_left ? -1 : 1;
 539
 540         /*
 541          * We have 2 entries of same kind, let's
 542          * make the data comparison.
 543          */
 544         return __hist_entry__cmp_compute(p_left, p_right, c);
 545 }
 546
 547 static void insert_hist_entry_by_compute(struct rb_root *root,
 548                                          struct hist_entry *he,
 549                                          int c)
 550 {
 551         struct rb_node **p = &root->rb_node;
 552         struct rb_node *parent = NULL;
 553         struct hist_entry *iter;
 554
 555         while (*p != NULL) {
 556                 parent = *p;
 557                 iter = rb_entry(parent, struct hist_entry, rb_node);
 558                 if (hist_entry__cmp_compute(he, iter, c) < 0)
 559                         p = &(*p)->rb_left;
 560                 else
 561                         p = &(*p)->rb_right;
 562         }
 563
 564         rb_link_node(&he->rb_node, parent, p);
 565         rb_insert_color(&he->rb_node, root);
 566 }
 567
 568 static void hists__compute_resort(struct hists *hists)
 569 {
 570         struct rb_root *root;
 571         struct rb_node *next;
 572
 573         if (sort__need_collapse)
 574                 root = &hists->entries_collapsed;
 575         else
 576                 root = hists->entries_in;
 577
 578         hists->entries = RB_ROOT;
 579         next = rb_first(root);
 580
 581         hists__reset_stats(hists);
 582         hists__reset_col_len(hists);
 583
 584         while (next != NULL) {
 585                 struct hist_entry *he;
 586
 587                 he = rb_entry(next, struct hist_entry, rb_node_in);
 588                 next = rb_next(&he->rb_node_in);
 589
 590                 insert_hist_entry_by_compute(&hists->entries, he, compute);
 591                 hists__inc_stats(hists, he);
 592
 593                 if (!he->filtered)
 594                         hists__calc_col_len(hists, he);
 595         }
 596 }
 597
 598 static void hists__process(struct hists *hists)
 599 {
 600         if (show_baseline_only)
 601                 hists__baseline_only(hists);
 602
 603         if (sort_compute) {
 604                 hists__precompute(hists);
 605                 hists__compute_resort(hists);
 606         } else {
 607                 hists__output_resort(hists);
 608         }
 609
 610         hists__fprintf(hists, true, 0, 0, 0, stdout);
 611 }
 612
 613 static void data__fprintf(void)
 614 {
 615         struct data__file *d;
 616         int i;
 617
 618         fprintf(stdout, "# Data files:\n");
 619
 620         data__for_each_file(i, d)
 621                 fprintf(stdout, "#  [%d] %s %s\n",
 622                         d->idx, d->file.path,
 623                         !d->idx ? "(Baseline)" : "");
 624
 625         fprintf(stdout, "#\n");
 626 }
 627
 628 static void data_process(void)
 629 {
 630         struct perf_evlist *evlist_base = data__files[0].session->evlist;
 631         struct perf_evsel *evsel_base;
 632         bool first = true;
 633
 634         evlist__for_each(evlist_base, evsel_base) {
 635                 struct hists *hists_base = evsel__hists(evsel_base);
 636                 struct data__file *d;
 637                 int i;
 638
 639                 data__for_each_file_new(i, d) {
 640                         struct perf_evlist *evlist = d->session->evlist;
 641                         struct perf_evsel *evsel;
 642                         struct hists *hists;
 643
 644                         evsel = evsel_match(evsel_base, evlist);
 645                         if (!evsel)
 646                                 continue;
 647
 648                         hists = evsel__hists(evsel);
 649                         d->hists = hists;
 650
 651                         hists__match(hists_base, hists);
 652
 653                         if (!show_baseline_only)
 654                                 hists__link(hists_base, hists);
 655                 }
 656
 657                 fprintf(stdout, "%s# Event '%s'\n#\n", first ? "" : "\n",
 658                         perf_evsel__name(evsel_base));
 659
 660                 first = false;
 661
 662                 if (verbose || data__files_cnt > 2)
 663                         data__fprintf();
 664
 665                 hists__process(hists_base);
 666         }
 667 }
 668
 669 static void data__free(struct data__file *d)
 670 {
 671         int col;
 672
 673         for (col = 0; col < PERF_HPP_DIFF__MAX_INDEX; col++) {
 674                 struct diff_hpp_fmt *fmt = &d->fmt[col];
 675
 676                 zfree(&fmt->header);
 677         }
 678 }
 679
 680 static int __cmd_diff(void)
 681 {
 682         struct data__file *d;
 683         int ret = -EINVAL, i;
 684
 685         data__for_each_file(i, d) {
 686                 d->session = perf_session__new(&d->file, false, &tool);
 687                 if (!d->session) {
 688                         pr_err("Failed to open %s\n", d->file.path);
 689                         ret = -1;
 690                         goto out_delete;
 691                 }
 692
 693                 ret = perf_session__process_events(d->session, &tool);
 694                 if (ret) {
 695                         pr_err("Failed to process %s\n", d->file.path);
 696                         goto out_delete;
 697                 }
 698
 699                 perf_evlist__collapse_resort(d->session->evlist);
 700         }
 701
 702         data_process();
 703
 704  out_delete:
 705         data__for_each_file(i, d) {
 706                 if (d->session)
 707                         perf_session__delete(d->session);
 708
 709                 data__free(d);
 710         }
 711
 712         free(data__files);
 713         return ret;
 714 }
 715
 716 static const char * const diff_usage[] = {
 717         "perf diff [<options>] [old_file] [new_file]",
 718         NULL,
 719 };
 720
 721 static const struct option options[] = {
 722         OPT_INCR('v', "verbose", &verbose,
 723                     "be more verbose (show symbol address, etc)"),
 724         OPT_BOOLEAN('b', "baseline-only", &show_baseline_only,
 725                     "Show only items with match in baseline"),
 726         OPT_CALLBACK('c', "compute", &compute,
 727                      "delta,ratio,wdiff:w1,w2 (default delta)",
 728                      "Entries differential computation selection",
 729                      setup_compute),
 730         OPT_BOOLEAN('p', "period", &show_period,
 731                     "Show period values."),
 732         OPT_BOOLEAN('F', "formula", &show_formula,
 733                     "Show formula."),
 734         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 735                     "dump raw trace in ASCII"),
 736         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
 737         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 738                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 739         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 740                    "only consider symbols in these dsos"),
 741         OPT_STRING('C', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
 742                    "only consider symbols in these comms"),
 743         OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
 744                    "only consider these symbols"),
 745         OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
 746                    "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
 747                    " Please refer the man page for the complete list."),
 748         OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
 749                    "separator for columns, no spaces will be added between "
 750                    "columns '.' is reserved."),
 751         OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
 752                     "Look for files with symbols relative to this directory"),
 753         OPT_UINTEGER('o', "order", &sort_compute, "Specify compute sorting."),
 754         OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
 755                      "How to display percentage of filtered entries", parse_filter_percentage),
 756         OPT_END()
 757 };
 758
 759 static double baseline_percent(struct hist_entry *he)
 760 {
 761         u64 total = hists__total_period(he->hists);
 762
 763         return 100.0 * he->stat.period / total;
 764 }
 765
 766 static int hpp__color_baseline(struct perf_hpp_fmt *fmt,
 767                                struct perf_hpp *hpp, struct hist_entry *he)
 768 {
 769         struct diff_hpp_fmt *dfmt =
 770                 container_of(fmt, struct diff_hpp_fmt, fmt);
 771         double percent = baseline_percent(he);
 772         char pfmt[20] = " ";
 773
 774         if (!he->dummy) {
 775                 scnprintf(pfmt, 20, "%%%d.2f%%%%", dfmt->header_width - 1);
 776                 return percent_color_snprintf(hpp->buf, hpp->size,
 777                                               pfmt, percent);
 778         } else
 779                 return scnprintf(hpp->buf, hpp->size, "%*s",
 780                                  dfmt->header_width, pfmt);
 781 }
 782
 783 static int hpp__entry_baseline(struct hist_entry *he, char *buf, size_t size)
 784 {
 785         double percent = baseline_percent(he);
 786         const char *fmt = symbol_conf.field_sep ? "%.2f" : "%6.2f%%";
 787         int ret = 0;
 788
 789         if (!he->dummy)
 790                 ret = scnprintf(buf, size, fmt, percent);
 791
 792         return ret;
 793 }
 794
 795 static int __hpp__color_compare(struct perf_hpp_fmt *fmt,
 796                                 struct perf_hpp *hpp, struct hist_entry *he,
 797                                 int comparison_method)
 798 {
 799         struct diff_hpp_fmt *dfmt =
 800                 container_of(fmt, struct diff_hpp_fmt, fmt);
 801         struct hist_entry *pair = get_pair_fmt(he, dfmt);
 802         double diff;
 803         s64 wdiff;
 804         char pfmt[20] = " ";
 805
 806         if (!pair)
 807                 goto dummy_print;
 808
 809         switch (comparison_method) {
 810         case COMPUTE_DELTA:
 811                 if (pair->diff.computed)
 812                         diff = pair->diff.period_ratio_delta;
 813                 else
 814                         diff = compute_delta(he, pair);
 815
 816                 if (fabs(diff) < 0.01)
 817                         goto dummy_print;
 818                 scnprintf(pfmt, 20, "%%%+d.2f%%%%", dfmt->header_width - 1);
 819                 return percent_color_snprintf(hpp->buf, hpp->size,
 820                                         pfmt, diff);
 821         case COMPUTE_RATIO:
 822                 if (he->dummy)
 823                         goto dummy_print;
 824                 if (pair->diff.computed)
 825                         diff = pair->diff.period_ratio;
 826                 else
 827                         diff = compute_ratio(he, pair);
 828
 829                 scnprintf(pfmt, 20, "%%%d.6f", dfmt->header_width);
 830                 return value_color_snprintf(hpp->buf, hpp->size,
 831                                         pfmt, diff);
 832         case COMPUTE_WEIGHTED_DIFF:
 833                 if (he->dummy)
 834                         goto dummy_print;
 835                 if (pair->diff.computed)
 836                         wdiff = pair->diff.wdiff;
 837                 else
 838                         wdiff = compute_wdiff(he, pair);
 839
 840                 scnprintf(pfmt, 20, "%%14ld", dfmt->header_width);
 841                 return color_snprintf(hpp->buf, hpp->size,
 842                                 get_percent_color(wdiff),
 843                                 pfmt, wdiff);
 844         default:
 845                 BUG_ON(1);
 846         }
 847 dummy_print:
 848         return scnprintf(hpp->buf, hpp->size, "%*s",
 849                         dfmt->header_width, pfmt);
 850 }
 851
 852 static int hpp__color_delta(struct perf_hpp_fmt *fmt,
 853                         struct perf_hpp *hpp, struct hist_entry *he)
 854 {
 855         return __hpp__color_compare(fmt, hpp, he, COMPUTE_DELTA);
 856 }
 857
 858 static int hpp__color_ratio(struct perf_hpp_fmt *fmt,
 859                         struct perf_hpp *hpp, struct hist_entry *he)
 860 {
 861         return __hpp__color_compare(fmt, hpp, he, COMPUTE_RATIO);
 862 }
 863
 864 static int hpp__color_wdiff(struct perf_hpp_fmt *fmt,
 865                         struct perf_hpp *hpp, struct hist_entry *he)
 866 {
 867         return __hpp__color_compare(fmt, hpp, he, COMPUTE_WEIGHTED_DIFF);
 868 }
 869
 870 static void
 871 hpp__entry_unpair(struct hist_entry *he, int idx, char *buf, size_t size)
 872 {
 873         switch (idx) {
 874         case PERF_HPP_DIFF__PERIOD_BASELINE:
 875                 scnprintf(buf, size, "%" PRIu64, he->stat.period);
 876                 break;
 877
 878         default:
 879                 break;
 880         }
 881 }
 882
 883 static void
 884 hpp__entry_pair(struct hist_entry *he, struct hist_entry *pair,
 885                 int idx, char *buf, size_t size)
 886 {
 887         double diff;
 888         double ratio;
 889         s64 wdiff;
 890
 891         switch (idx) {
 892         case PERF_HPP_DIFF__DELTA:
 893                 if (pair->diff.computed)
 894                         diff = pair->diff.period_ratio_delta;
 895                 else
 896                         diff = compute_delta(he, pair);
 897
 898                 if (fabs(diff) >= 0.01)
 899                         scnprintf(buf, size, "%+4.2F%%", diff);
 900                 break;
 901
 902         case PERF_HPP_DIFF__RATIO:
 903                 /* No point for ratio number if we are dummy.. */
 904                 if (he->dummy)
 905                         break;
 906
 907                 if (pair->diff.computed)
 908                         ratio = pair->diff.period_ratio;
 909                 else
 910                         ratio = compute_ratio(he, pair);
 911
 912                 if (ratio > 0.0)
 913                         scnprintf(buf, size, "%14.6F", ratio);
 914                 break;
 915
 916         case PERF_HPP_DIFF__WEIGHTED_DIFF:
 917                 /* No point for wdiff number if we are dummy.. */
 918                 if (he->dummy)
 919                         break;
 920
 921                 if (pair->diff.computed)
 922                         wdiff = pair->diff.wdiff;
 923                 else
 924                         wdiff = compute_wdiff(he, pair);
 925
 926                 if (wdiff != 0)
 927                         scnprintf(buf, size, "%14ld", wdiff);
 928                 break;
 929
 930         case PERF_HPP_DIFF__FORMULA:
 931                 formula_fprintf(he, pair, buf, size);
 932                 break;
 933
 934         case PERF_HPP_DIFF__PERIOD:
 935                 scnprintf(buf, size, "%" PRIu64, pair->stat.period);
 936                 break;
 937
 938         default:
 939                 BUG_ON(1);
 940         };
 941 }
 942
 943 static void
 944 __hpp__entry_global(struct hist_entry *he, struct diff_hpp_fmt *dfmt,
 945                     char *buf, size_t size)
 946 {
 947         struct hist_entry *pair = get_pair_fmt(he, dfmt);
 948         int idx = dfmt->idx;
 949
 950         /* baseline is special */
 951         if (idx == PERF_HPP_DIFF__BASELINE)
 952                 hpp__entry_baseline(he, buf, size);
 953         else {
 954                 if (pair)
 955                         hpp__entry_pair(he, pair, idx, buf, size);
 956                 else
 957                         hpp__entry_unpair(he, idx, buf, size);
 958         }
 959 }
 960
 961 static int hpp__entry_global(struct perf_hpp_fmt *_fmt, struct perf_hpp *hpp,
 962                              struct hist_entry *he)
 963 {
 964         struct diff_hpp_fmt *dfmt =
 965                 container_of(_fmt, struct diff_hpp_fmt, fmt);
 966         char buf[MAX_COL_WIDTH] = " ";
 967
 968         __hpp__entry_global(he, dfmt, buf, MAX_COL_WIDTH);
 969
 970         if (symbol_conf.field_sep)
 971                 return scnprintf(hpp->buf, hpp->size, "%s", buf);
 972         else
 973                 return scnprintf(hpp->buf, hpp->size, "%*s",
 974                                  dfmt->header_width, buf);
 975 }
 976
 977 static int hpp__header(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 978                        struct perf_evsel *evsel __maybe_unused)
 979 {
 980         struct diff_hpp_fmt *dfmt =
 981                 container_of(fmt, struct diff_hpp_fmt, fmt);
 982
 983         BUG_ON(!dfmt->header);
 984         return scnprintf(hpp->buf, hpp->size, dfmt->header);
 985 }
 986
 987 static int hpp__width(struct perf_hpp_fmt *fmt,
 988                       struct perf_hpp *hpp __maybe_unused,
 989                       struct perf_evsel *evsel __maybe_unused)
 990 {
 991         struct diff_hpp_fmt *dfmt =
 992                 container_of(fmt, struct diff_hpp_fmt, fmt);
 993
 994         BUG_ON(dfmt->header_width <= 0);
 995         return dfmt->header_width;
 996 }
 997
 998 static void init_header(struct data__file *d, struct diff_hpp_fmt *dfmt)
 999 {
1000 #define MAX_HEADER_NAME 100
1001         char buf_indent[MAX_HEADER_NAME];
1002         char buf[MAX_HEADER_NAME];
1003         const char *header = NULL;
1004         int width = 0;
1005
1006         BUG_ON(dfmt->idx >= PERF_HPP_DIFF__MAX_INDEX);
1007         header = columns[dfmt->idx].name;
1008         width  = columns[dfmt->idx].width;
1009
1010         /* Only our defined HPP fmts should appear here. */
1011         BUG_ON(!header);
1012
1013         if (data__files_cnt > 2)
1014                 scnprintf(buf, MAX_HEADER_NAME, "%s/%d", header, d->idx);
1015
1016 #define NAME (data__files_cnt > 2 ? buf : header)
1017         dfmt->header_width = width;
1018         width = (int) strlen(NAME);
1019         if (dfmt->header_width < width)
1020                 dfmt->header_width = width;
1021
1022         scnprintf(buf_indent, MAX_HEADER_NAME, "%*s",
1023                   dfmt->header_width, NAME);
1024
1025         dfmt->header = strdup(buf_indent);
1026 #undef MAX_HEADER_NAME
1027 #undef NAME
1028 }
1029
1030 static void data__hpp_register(struct data__file *d, int idx)
1031 {
1032         struct diff_hpp_fmt *dfmt = &d->fmt[idx];
1033         struct perf_hpp_fmt *fmt = &dfmt->fmt;
1034
1035         dfmt->idx = idx;
1036
1037         fmt->header = hpp__header;
1038         fmt->width  = hpp__width;
1039         fmt->entry  = hpp__entry_global;
1040
1041         /* TODO more colors */
1042         switch (idx) {
1043         case PERF_HPP_DIFF__BASELINE:
1044                 fmt->color = hpp__color_baseline;
1045                 break;
1046         case PERF_HPP_DIFF__DELTA:
1047                 fmt->color = hpp__color_delta;
1048                 break;
1049         case PERF_HPP_DIFF__RATIO:
1050                 fmt->color = hpp__color_ratio;
1051                 break;
1052         case PERF_HPP_DIFF__WEIGHTED_DIFF:
1053                 fmt->color = hpp__color_wdiff;
1054                 break;
1055         default:
1056                 break;
1057         }
1058
1059         init_header(d, dfmt);
1060         perf_hpp__column_register(fmt);
1061 }
1062
1063 static void ui_init(void)
1064 {
1065         struct data__file *d;
1066         int i;
1067
1068         data__for_each_file(i, d) {
1069
1070                 /*
1071                  * Baseline or compute realted columns:
1072                  *
1073                  *   PERF_HPP_DIFF__BASELINE
1074                  *   PERF_HPP_DIFF__DELTA
1075                  *   PERF_HPP_DIFF__RATIO
1076                  *   PERF_HPP_DIFF__WEIGHTED_DIFF
1077                  */
1078                 data__hpp_register(d, i ? compute_2_hpp[compute] :
1079                                           PERF_HPP_DIFF__BASELINE);
1080
1081                 /*
1082                  * And the rest:
1083                  *
1084                  * PERF_HPP_DIFF__FORMULA
1085                  * PERF_HPP_DIFF__PERIOD
1086                  * PERF_HPP_DIFF__PERIOD_BASELINE
1087                  */
1088                 if (show_formula && i)
1089                         data__hpp_register(d, PERF_HPP_DIFF__FORMULA);
1090
1091                 if (show_period)
1092                         data__hpp_register(d, i ? PERF_HPP_DIFF__PERIOD :
1093                                                   PERF_HPP_DIFF__PERIOD_BASELINE);
1094         }
1095 }
1096
1097 static int data_init(int argc, const char **argv)
1098 {
1099         struct data__file *d;
1100         static const char *defaults[] = {
1101                 "perf.data.old",
1102                 "perf.data",
1103         };
1104         bool use_default = true;
1105         int i;
1106
1107         data__files_cnt = 2;
1108
1109         if (argc) {
1110                 if (argc == 1)
1111                         defaults[1] = argv[0];
1112                 else {
1113                         data__files_cnt = argc;
1114                         use_default = false;
1115                 }
1116         } else if (perf_guest) {
1117                 defaults[0] = "perf.data.host";
1118                 defaults[1] = "perf.data.guest";
1119         }
1120
1121         if (sort_compute >= (unsigned int) data__files_cnt) {
1122                 pr_err("Order option out of limit.\n");
1123                 return -EINVAL;
1124         }
1125
1126         data__files = zalloc(sizeof(*data__files) * data__files_cnt);
1127         if (!data__files)
1128                 return -ENOMEM;
1129
1130         data__for_each_file(i, d) {
1131                 struct perf_data_file *file = &d->file;
1132
1133                 file->path  = use_default ? defaults[i] : argv[i];
1134                 file->mode  = PERF_DATA_MODE_READ,
1135                 file->force = force,
1136
1137                 d->idx  = i;
1138         }
1139
1140         return 0;
1141 }
1142
1143 int cmd_diff(int argc, const char **argv, const char *prefix __maybe_unused)
1144 {
1145         perf_config(perf_default_config, NULL);
1146
1147         argc = parse_options(argc, argv, options, diff_usage, 0);
1148
1149         if (symbol__init(NULL) < 0)
1150                 return -1;
1151
1152         if (data_init(argc, argv) < 0)
1153                 return -1;
1154
1155         ui_init();
1156
1157         sort__mode = SORT_MODE__DIFF;
1158
1159         if (setup_sorting() < 0)
1160                 usage_with_options(diff_usage, options);
1161
1162         setup_pager();
1163
1164         sort__setup_elide(NULL);
1165
1166         return __cmd_diff();
1167 }