Merge tag 'perf-core-for-mingo' of git://git.kernel.org/pub/scm/linux/kernel/git...
[~shefty/rdma-dev.git] / 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
20 #include <stdlib.h>
21
22 static char const *input_old = "perf.data.old",
23                   *input_new = "perf.data";
24 static char       diff__default_sort_order[] = "dso,symbol";
25 static bool  force;
26 static bool show_period;
27 static bool show_formula;
28 static bool show_baseline_only;
29 static bool sort_compute;
30
31 static s64 compute_wdiff_w1;
32 static s64 compute_wdiff_w2;
33
34 enum {
35         COMPUTE_DELTA,
36         COMPUTE_RATIO,
37         COMPUTE_WEIGHTED_DIFF,
38         COMPUTE_MAX,
39 };
40
41 const char *compute_names[COMPUTE_MAX] = {
42         [COMPUTE_DELTA] = "delta",
43         [COMPUTE_RATIO] = "ratio",
44         [COMPUTE_WEIGHTED_DIFF] = "wdiff",
45 };
46
47 static int compute;
48
49 static int setup_compute_opt_wdiff(char *opt)
50 {
51         char *w1_str = opt;
52         char *w2_str;
53
54         int ret = -EINVAL;
55
56         if (!opt)
57                 goto out;
58
59         w2_str = strchr(opt, ',');
60         if (!w2_str)
61                 goto out;
62
63         *w2_str++ = 0x0;
64         if (!*w2_str)
65                 goto out;
66
67         compute_wdiff_w1 = strtol(w1_str, NULL, 10);
68         compute_wdiff_w2 = strtol(w2_str, NULL, 10);
69
70         if (!compute_wdiff_w1 || !compute_wdiff_w2)
71                 goto out;
72
73         pr_debug("compute wdiff w1(%" PRId64 ") w2(%" PRId64 ")\n",
74                   compute_wdiff_w1, compute_wdiff_w2);
75
76         ret = 0;
77
78  out:
79         if (ret)
80                 pr_err("Failed: wrong weight data, use 'wdiff:w1,w2'\n");
81
82         return ret;
83 }
84
85 static int setup_compute_opt(char *opt)
86 {
87         if (compute == COMPUTE_WEIGHTED_DIFF)
88                 return setup_compute_opt_wdiff(opt);
89
90         if (opt) {
91                 pr_err("Failed: extra option specified '%s'", opt);
92                 return -EINVAL;
93         }
94
95         return 0;
96 }
97
98 static int setup_compute(const struct option *opt, const char *str,
99                          int unset __maybe_unused)
100 {
101         int *cp = (int *) opt->value;
102         char *cstr = (char *) str;
103         char buf[50];
104         unsigned i;
105         char *option;
106
107         if (!str) {
108                 *cp = COMPUTE_DELTA;
109                 return 0;
110         }
111
112         if (*str == '+') {
113                 sort_compute = true;
114                 cstr = (char *) ++str;
115                 if (!*str)
116                         return 0;
117         }
118
119         option = strchr(str, ':');
120         if (option) {
121                 unsigned len = option++ - str;
122
123                 /*
124                  * The str data are not writeable, so we need
125                  * to use another buffer.
126                  */
127
128                 /* No option value is longer. */
129                 if (len >= sizeof(buf))
130                         return -EINVAL;
131
132                 strncpy(buf, str, len);
133                 buf[len] = 0x0;
134                 cstr = buf;
135         }
136
137         for (i = 0; i < COMPUTE_MAX; i++)
138                 if (!strcmp(cstr, compute_names[i])) {
139                         *cp = i;
140                         return setup_compute_opt(option);
141                 }
142
143         pr_err("Failed: '%s' is not computation method "
144                "(use 'delta','ratio' or 'wdiff')\n", str);
145         return -EINVAL;
146 }
147
148 double perf_diff__period_percent(struct hist_entry *he, u64 period)
149 {
150         u64 total = he->hists->stats.total_period;
151         return (period * 100.0) / total;
152 }
153
154 double perf_diff__compute_delta(struct hist_entry *he, struct hist_entry *pair)
155 {
156         double new_percent = perf_diff__period_percent(he, he->stat.period);
157         double old_percent = perf_diff__period_percent(pair, pair->stat.period);
158
159         he->diff.period_ratio_delta = new_percent - old_percent;
160         he->diff.computed = true;
161         return he->diff.period_ratio_delta;
162 }
163
164 double perf_diff__compute_ratio(struct hist_entry *he, struct hist_entry *pair)
165 {
166         double new_period = he->stat.period;
167         double old_period = pair->stat.period;
168
169         he->diff.computed = true;
170         he->diff.period_ratio = new_period / old_period;
171         return he->diff.period_ratio;
172 }
173
174 s64 perf_diff__compute_wdiff(struct hist_entry *he, struct hist_entry *pair)
175 {
176         u64 new_period = he->stat.period;
177         u64 old_period = pair->stat.period;
178
179         he->diff.computed = true;
180         he->diff.wdiff = new_period * compute_wdiff_w2 -
181                          old_period * compute_wdiff_w1;
182
183         return he->diff.wdiff;
184 }
185
186 static int formula_delta(struct hist_entry *he, struct hist_entry *pair,
187                          char *buf, size_t size)
188 {
189         return scnprintf(buf, size,
190                          "(%" PRIu64 " * 100 / %" PRIu64 ") - "
191                          "(%" PRIu64 " * 100 / %" PRIu64 ")",
192                           he->stat.period, he->hists->stats.total_period,
193                           pair->stat.period, pair->hists->stats.total_period);
194 }
195
196 static int formula_ratio(struct hist_entry *he, struct hist_entry *pair,
197                          char *buf, size_t size)
198 {
199         double new_period = he->stat.period;
200         double old_period = pair->stat.period;
201
202         return scnprintf(buf, size, "%.0F / %.0F", new_period, old_period);
203 }
204
205 static int formula_wdiff(struct hist_entry *he, struct hist_entry *pair,
206                          char *buf, size_t size)
207 {
208         u64 new_period = he->stat.period;
209         u64 old_period = pair->stat.period;
210
211         return scnprintf(buf, size,
212                   "(%" PRIu64 " * " "%" PRId64 ") - (%" PRIu64 " * " "%" PRId64 ")",
213                   new_period, compute_wdiff_w2, old_period, compute_wdiff_w1);
214 }
215
216 int perf_diff__formula(struct hist_entry *he, struct hist_entry *pair,
217                        char *buf, size_t size)
218 {
219         switch (compute) {
220         case COMPUTE_DELTA:
221                 return formula_delta(he, pair, buf, size);
222         case COMPUTE_RATIO:
223                 return formula_ratio(he, pair, buf, size);
224         case COMPUTE_WEIGHTED_DIFF:
225                 return formula_wdiff(he, pair, buf, size);
226         default:
227                 BUG_ON(1);
228         }
229
230         return -1;
231 }
232
233 static int hists__add_entry(struct hists *self,
234                             struct addr_location *al, u64 period)
235 {
236         if (__hists__add_entry(self, al, NULL, period) != NULL)
237                 return 0;
238         return -ENOMEM;
239 }
240
241 static int diff__process_sample_event(struct perf_tool *tool __maybe_unused,
242                                       union perf_event *event,
243                                       struct perf_sample *sample,
244                                       struct perf_evsel *evsel,
245                                       struct machine *machine)
246 {
247         struct addr_location al;
248
249         if (perf_event__preprocess_sample(event, machine, &al, sample, NULL) < 0) {
250                 pr_warning("problem processing %d event, skipping it.\n",
251                            event->header.type);
252                 return -1;
253         }
254
255         if (al.filtered)
256                 return 0;
257
258         if (hists__add_entry(&evsel->hists, &al, sample->period)) {
259                 pr_warning("problem incrementing symbol period, skipping event\n");
260                 return -1;
261         }
262
263         evsel->hists.stats.total_period += sample->period;
264         return 0;
265 }
266
267 static struct perf_tool tool = {
268         .sample = diff__process_sample_event,
269         .mmap   = perf_event__process_mmap,
270         .comm   = perf_event__process_comm,
271         .exit   = perf_event__process_exit,
272         .fork   = perf_event__process_fork,
273         .lost   = perf_event__process_lost,
274         .ordered_samples = true,
275         .ordering_requires_timestamps = true,
276 };
277
278 static void insert_hist_entry_by_name(struct rb_root *root,
279                                       struct hist_entry *he)
280 {
281         struct rb_node **p = &root->rb_node;
282         struct rb_node *parent = NULL;
283         struct hist_entry *iter;
284
285         while (*p != NULL) {
286                 parent = *p;
287                 iter = rb_entry(parent, struct hist_entry, rb_node);
288                 if (hist_entry__cmp(he, iter) < 0)
289                         p = &(*p)->rb_left;
290                 else
291                         p = &(*p)->rb_right;
292         }
293
294         rb_link_node(&he->rb_node, parent, p);
295         rb_insert_color(&he->rb_node, root);
296 }
297
298 static void hists__name_resort(struct hists *self)
299 {
300         struct rb_root tmp = RB_ROOT;
301         struct rb_node *next = rb_first(&self->entries);
302
303         while (next != NULL) {
304                 struct hist_entry *n = rb_entry(next, struct hist_entry, rb_node);
305
306                 next = rb_next(&n->rb_node);
307
308                 rb_erase(&n->rb_node, &self->entries);
309                 insert_hist_entry_by_name(&tmp, n);
310         }
311
312         self->entries = tmp;
313 }
314
315 static struct perf_evsel *evsel_match(struct perf_evsel *evsel,
316                                       struct perf_evlist *evlist)
317 {
318         struct perf_evsel *e;
319
320         list_for_each_entry(e, &evlist->entries, node)
321                 if (perf_evsel__match2(evsel, e))
322                         return e;
323
324         return NULL;
325 }
326
327 static void perf_evlist__resort_hists(struct perf_evlist *evlist, bool name)
328 {
329         struct perf_evsel *evsel;
330
331         list_for_each_entry(evsel, &evlist->entries, node) {
332                 struct hists *hists = &evsel->hists;
333
334                 hists__output_resort(hists);
335
336                 if (name)
337                         hists__name_resort(hists);
338         }
339 }
340
341 static void hists__baseline_only(struct hists *hists)
342 {
343         struct rb_node *next = rb_first(&hists->entries);
344
345         while (next != NULL) {
346                 struct hist_entry *he = rb_entry(next, struct hist_entry, rb_node);
347
348                 next = rb_next(&he->rb_node);
349                 if (!hist_entry__next_pair(he)) {
350                         rb_erase(&he->rb_node, &hists->entries);
351                         hist_entry__free(he);
352                 }
353         }
354 }
355
356 static void hists__precompute(struct hists *hists)
357 {
358         struct rb_node *next = rb_first(&hists->entries);
359
360         while (next != NULL) {
361                 struct hist_entry *he = rb_entry(next, struct hist_entry, rb_node);
362                 struct hist_entry *pair = hist_entry__next_pair(he);
363
364                 next = rb_next(&he->rb_node);
365                 if (!pair)
366                         continue;
367
368                 switch (compute) {
369                 case COMPUTE_DELTA:
370                         perf_diff__compute_delta(he, pair);
371                         break;
372                 case COMPUTE_RATIO:
373                         perf_diff__compute_ratio(he, pair);
374                         break;
375                 case COMPUTE_WEIGHTED_DIFF:
376                         perf_diff__compute_wdiff(he, pair);
377                         break;
378                 default:
379                         BUG_ON(1);
380                 }
381         }
382 }
383
384 static int64_t cmp_doubles(double l, double r)
385 {
386         if (l > r)
387                 return -1;
388         else if (l < r)
389                 return 1;
390         else
391                 return 0;
392 }
393
394 static int64_t
395 hist_entry__cmp_compute(struct hist_entry *left, struct hist_entry *right,
396                         int c)
397 {
398         switch (c) {
399         case COMPUTE_DELTA:
400         {
401                 double l = left->diff.period_ratio_delta;
402                 double r = right->diff.period_ratio_delta;
403
404                 return cmp_doubles(l, r);
405         }
406         case COMPUTE_RATIO:
407         {
408                 double l = left->diff.period_ratio;
409                 double r = right->diff.period_ratio;
410
411                 return cmp_doubles(l, r);
412         }
413         case COMPUTE_WEIGHTED_DIFF:
414         {
415                 s64 l = left->diff.wdiff;
416                 s64 r = right->diff.wdiff;
417
418                 return r - l;
419         }
420         default:
421                 BUG_ON(1);
422         }
423
424         return 0;
425 }
426
427 static void insert_hist_entry_by_compute(struct rb_root *root,
428                                          struct hist_entry *he,
429                                          int c)
430 {
431         struct rb_node **p = &root->rb_node;
432         struct rb_node *parent = NULL;
433         struct hist_entry *iter;
434
435         while (*p != NULL) {
436                 parent = *p;
437                 iter = rb_entry(parent, struct hist_entry, rb_node);
438                 if (hist_entry__cmp_compute(he, iter, c) < 0)
439                         p = &(*p)->rb_left;
440                 else
441                         p = &(*p)->rb_right;
442         }
443
444         rb_link_node(&he->rb_node, parent, p);
445         rb_insert_color(&he->rb_node, root);
446 }
447
448 static void hists__compute_resort(struct hists *hists)
449 {
450         struct rb_root tmp = RB_ROOT;
451         struct rb_node *next = rb_first(&hists->entries);
452
453         while (next != NULL) {
454                 struct hist_entry *he = rb_entry(next, struct hist_entry, rb_node);
455
456                 next = rb_next(&he->rb_node);
457
458                 rb_erase(&he->rb_node, &hists->entries);
459                 insert_hist_entry_by_compute(&tmp, he, compute);
460         }
461
462         hists->entries = tmp;
463 }
464
465 static void hists__process(struct hists *old, struct hists *new)
466 {
467         hists__match(new, old);
468
469         if (show_baseline_only)
470                 hists__baseline_only(new);
471         else
472                 hists__link(new, old);
473
474         if (sort_compute) {
475                 hists__precompute(new);
476                 hists__compute_resort(new);
477         }
478
479         hists__fprintf(new, true, 0, 0, stdout);
480 }
481
482 static int __cmd_diff(void)
483 {
484         int ret, i;
485 #define older (session[0])
486 #define newer (session[1])
487         struct perf_session *session[2];
488         struct perf_evlist *evlist_new, *evlist_old;
489         struct perf_evsel *evsel;
490         bool first = true;
491
492         older = perf_session__new(input_old, O_RDONLY, force, false,
493                                   &tool);
494         newer = perf_session__new(input_new, O_RDONLY, force, false,
495                                   &tool);
496         if (session[0] == NULL || session[1] == NULL)
497                 return -ENOMEM;
498
499         for (i = 0; i < 2; ++i) {
500                 ret = perf_session__process_events(session[i], &tool);
501                 if (ret)
502                         goto out_delete;
503         }
504
505         evlist_old = older->evlist;
506         evlist_new = newer->evlist;
507
508         perf_evlist__resort_hists(evlist_old, true);
509         perf_evlist__resort_hists(evlist_new, false);
510
511         list_for_each_entry(evsel, &evlist_new->entries, node) {
512                 struct perf_evsel *evsel_old;
513
514                 evsel_old = evsel_match(evsel, evlist_old);
515                 if (!evsel_old)
516                         continue;
517
518                 fprintf(stdout, "%s# Event '%s'\n#\n", first ? "" : "\n",
519                         perf_evsel__name(evsel));
520
521                 first = false;
522
523                 hists__process(&evsel_old->hists, &evsel->hists);
524         }
525
526 out_delete:
527         for (i = 0; i < 2; ++i)
528                 perf_session__delete(session[i]);
529         return ret;
530 #undef older
531 #undef newer
532 }
533
534 static const char * const diff_usage[] = {
535         "perf diff [<options>] [old_file] [new_file]",
536         NULL,
537 };
538
539 static const struct option options[] = {
540         OPT_INCR('v', "verbose", &verbose,
541                     "be more verbose (show symbol address, etc)"),
542         OPT_BOOLEAN('b', "baseline-only", &show_baseline_only,
543                     "Show only items with match in baseline"),
544         OPT_CALLBACK('c', "compute", &compute,
545                      "delta,ratio,wdiff:w1,w2 (default delta)",
546                      "Entries differential computation selection",
547                      setup_compute),
548         OPT_BOOLEAN('p', "period", &show_period,
549                     "Show period values."),
550         OPT_BOOLEAN('F', "formula", &show_formula,
551                     "Show formula."),
552         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
553                     "dump raw trace in ASCII"),
554         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
555         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
556                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
557         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
558                    "only consider symbols in these dsos"),
559         OPT_STRING('C', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
560                    "only consider symbols in these comms"),
561         OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
562                    "only consider these symbols"),
563         OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
564                    "sort by key(s): pid, comm, dso, symbol, parent"),
565         OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
566                    "separator for columns, no spaces will be added between "
567                    "columns '.' is reserved."),
568         OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
569                     "Look for files with symbols relative to this directory"),
570         OPT_END()
571 };
572
573 static void ui_init(void)
574 {
575         /*
576          * Display baseline/delta/ratio
577          * formula/periods columns.
578          */
579         perf_hpp__column_enable(PERF_HPP__BASELINE);
580
581         switch (compute) {
582         case COMPUTE_DELTA:
583                 perf_hpp__column_enable(PERF_HPP__DELTA);
584                 break;
585         case COMPUTE_RATIO:
586                 perf_hpp__column_enable(PERF_HPP__RATIO);
587                 break;
588         case COMPUTE_WEIGHTED_DIFF:
589                 perf_hpp__column_enable(PERF_HPP__WEIGHTED_DIFF);
590                 break;
591         default:
592                 BUG_ON(1);
593         };
594
595         if (show_formula)
596                 perf_hpp__column_enable(PERF_HPP__FORMULA);
597
598         if (show_period) {
599                 perf_hpp__column_enable(PERF_HPP__PERIOD);
600                 perf_hpp__column_enable(PERF_HPP__PERIOD_BASELINE);
601         }
602 }
603
604 int cmd_diff(int argc, const char **argv, const char *prefix __maybe_unused)
605 {
606         sort_order = diff__default_sort_order;
607         argc = parse_options(argc, argv, options, diff_usage, 0);
608         if (argc) {
609                 if (argc > 2)
610                         usage_with_options(diff_usage, options);
611                 if (argc == 2) {
612                         input_old = argv[0];
613                         input_new = argv[1];
614                 } else
615                         input_new = argv[0];
616         } else if (symbol_conf.default_guest_vmlinux_name ||
617                    symbol_conf.default_guest_kallsyms) {
618                 input_old = "perf.data.host";
619                 input_new = "perf.data.guest";
620         }
621
622         symbol_conf.exclude_other = false;
623         if (symbol__init() < 0)
624                 return -1;
625
626         ui_init();
627
628         setup_sorting(diff_usage, options);
629         setup_pager();
630
631         sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", NULL);
632         sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", NULL);
633         sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", NULL);
634
635         return __cmd_diff();
636 }