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