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.
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"
22 static char const *input_old
= "perf.data.old",
23 *input_new
= "perf.data";
24 static char diff__default_sort_order
[] = "dso,symbol";
26 static bool show_period
;
27 static bool show_formula
;
28 static bool show_baseline_only
;
29 static bool sort_compute
;
31 static s64 compute_wdiff_w1
;
32 static s64 compute_wdiff_w2
;
37 COMPUTE_WEIGHTED_DIFF
,
41 const char *compute_names
[COMPUTE_MAX
] = {
42 [COMPUTE_DELTA
] = "delta",
43 [COMPUTE_RATIO
] = "ratio",
44 [COMPUTE_WEIGHTED_DIFF
] = "wdiff",
49 static int setup_compute_opt_wdiff(char *opt
)
59 w2_str
= strchr(opt
, ',');
67 compute_wdiff_w1
= strtol(w1_str
, NULL
, 10);
68 compute_wdiff_w2
= strtol(w2_str
, NULL
, 10);
70 if (!compute_wdiff_w1
|| !compute_wdiff_w2
)
73 pr_debug("compute wdiff w1(%" PRId64
") w2(%" PRId64
")\n",
74 compute_wdiff_w1
, compute_wdiff_w2
);
80 pr_err("Failed: wrong weight data, use 'wdiff:w1,w2'\n");
85 static int setup_compute_opt(char *opt
)
87 if (compute
== COMPUTE_WEIGHTED_DIFF
)
88 return setup_compute_opt_wdiff(opt
);
91 pr_err("Failed: extra option specified '%s'", opt
);
98 static int setup_compute(const struct option
*opt
, const char *str
,
99 int unset __maybe_unused
)
101 int *cp
= (int *) opt
->value
;
102 char *cstr
= (char *) str
;
114 cstr
= (char *) ++str
;
119 option
= strchr(str
, ':');
121 unsigned len
= option
++ - str
;
124 * The str data are not writeable, so we need
125 * to use another buffer.
128 /* No option value is longer. */
129 if (len
>= sizeof(buf
))
132 strncpy(buf
, str
, len
);
137 for (i
= 0; i
< COMPUTE_MAX
; i
++)
138 if (!strcmp(cstr
, compute_names
[i
])) {
140 return setup_compute_opt(option
);
143 pr_err("Failed: '%s' is not computation method "
144 "(use 'delta','ratio' or 'wdiff')\n", str
);
148 double perf_diff__period_percent(struct hist_entry
*he
, u64 period
)
150 u64 total
= he
->hists
->stats
.total_period
;
151 return (period
* 100.0) / total
;
154 double perf_diff__compute_delta(struct hist_entry
*he
, struct hist_entry
*pair
)
156 double new_percent
= perf_diff__period_percent(he
, he
->stat
.period
);
157 double old_percent
= perf_diff__period_percent(pair
, pair
->stat
.period
);
159 he
->diff
.period_ratio_delta
= new_percent
- old_percent
;
160 he
->diff
.computed
= true;
161 return he
->diff
.period_ratio_delta
;
164 double perf_diff__compute_ratio(struct hist_entry
*he
, struct hist_entry
*pair
)
166 double new_period
= he
->stat
.period
;
167 double old_period
= pair
->stat
.period
;
169 he
->diff
.computed
= true;
170 he
->diff
.period_ratio
= new_period
/ old_period
;
171 return he
->diff
.period_ratio
;
174 s64
perf_diff__compute_wdiff(struct hist_entry
*he
, struct hist_entry
*pair
)
176 u64 new_period
= he
->stat
.period
;
177 u64 old_period
= pair
->stat
.period
;
179 he
->diff
.computed
= true;
180 he
->diff
.wdiff
= new_period
* compute_wdiff_w2
-
181 old_period
* compute_wdiff_w1
;
183 return he
->diff
.wdiff
;
186 static int formula_delta(struct hist_entry
*he
, struct hist_entry
*pair
,
187 char *buf
, size_t size
)
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
);
196 static int formula_ratio(struct hist_entry
*he
, struct hist_entry
*pair
,
197 char *buf
, size_t size
)
199 double new_period
= he
->stat
.period
;
200 double old_period
= pair
->stat
.period
;
202 return scnprintf(buf
, size
, "%.0F / %.0F", new_period
, old_period
);
205 static int formula_wdiff(struct hist_entry
*he
, struct hist_entry
*pair
,
206 char *buf
, size_t size
)
208 u64 new_period
= he
->stat
.period
;
209 u64 old_period
= pair
->stat
.period
;
211 return scnprintf(buf
, size
,
212 "(%" PRIu64
" * " "%" PRId64
") - (%" PRIu64
" * " "%" PRId64
")",
213 new_period
, compute_wdiff_w2
, old_period
, compute_wdiff_w1
);
216 int perf_diff__formula(struct hist_entry
*he
, struct hist_entry
*pair
,
217 char *buf
, size_t size
)
221 return formula_delta(he
, pair
, buf
, size
);
223 return formula_ratio(he
, pair
, buf
, size
);
224 case COMPUTE_WEIGHTED_DIFF
:
225 return formula_wdiff(he
, pair
, buf
, size
);
233 static int hists__add_entry(struct hists
*self
,
234 struct addr_location
*al
, u64 period
,
237 if (__hists__add_entry(self
, al
, NULL
, period
, weight
) != NULL
)
242 static int diff__process_sample_event(struct perf_tool
*tool __maybe_unused
,
243 union perf_event
*event
,
244 struct perf_sample
*sample
,
245 struct perf_evsel
*evsel
,
246 struct machine
*machine
)
248 struct addr_location al
;
250 if (perf_event__preprocess_sample(event
, machine
, &al
, sample
, NULL
) < 0) {
251 pr_warning("problem processing %d event, skipping it.\n",
259 if (hists__add_entry(&evsel
->hists
, &al
, sample
->period
, sample
->weight
)) {
260 pr_warning("problem incrementing symbol period, skipping event\n");
264 evsel
->hists
.stats
.total_period
+= sample
->period
;
268 static struct perf_tool tool
= {
269 .sample
= diff__process_sample_event
,
270 .mmap
= perf_event__process_mmap
,
271 .comm
= perf_event__process_comm
,
272 .exit
= perf_event__process_exit
,
273 .fork
= perf_event__process_fork
,
274 .lost
= perf_event__process_lost
,
275 .ordered_samples
= true,
276 .ordering_requires_timestamps
= true,
279 static struct perf_evsel
*evsel_match(struct perf_evsel
*evsel
,
280 struct perf_evlist
*evlist
)
282 struct perf_evsel
*e
;
284 list_for_each_entry(e
, &evlist
->entries
, node
)
285 if (perf_evsel__match2(evsel
, e
))
291 static void perf_evlist__collapse_resort(struct perf_evlist
*evlist
)
293 struct perf_evsel
*evsel
;
295 list_for_each_entry(evsel
, &evlist
->entries
, node
) {
296 struct hists
*hists
= &evsel
->hists
;
298 hists__collapse_resort(hists
);
302 static void hists__baseline_only(struct hists
*hists
)
304 struct rb_root
*root
;
305 struct rb_node
*next
;
307 if (sort__need_collapse
)
308 root
= &hists
->entries_collapsed
;
310 root
= hists
->entries_in
;
312 next
= rb_first(root
);
313 while (next
!= NULL
) {
314 struct hist_entry
*he
= rb_entry(next
, struct hist_entry
, rb_node_in
);
316 next
= rb_next(&he
->rb_node_in
);
317 if (!hist_entry__next_pair(he
)) {
318 rb_erase(&he
->rb_node_in
, root
);
319 hist_entry__free(he
);
324 static void hists__precompute(struct hists
*hists
)
326 struct rb_root
*root
;
327 struct rb_node
*next
;
329 if (sort__need_collapse
)
330 root
= &hists
->entries_collapsed
;
332 root
= hists
->entries_in
;
334 next
= rb_first(root
);
335 while (next
!= NULL
) {
336 struct hist_entry
*he
= rb_entry(next
, struct hist_entry
, rb_node_in
);
337 struct hist_entry
*pair
= hist_entry__next_pair(he
);
339 next
= rb_next(&he
->rb_node_in
);
345 perf_diff__compute_delta(he
, pair
);
348 perf_diff__compute_ratio(he
, pair
);
350 case COMPUTE_WEIGHTED_DIFF
:
351 perf_diff__compute_wdiff(he
, pair
);
359 static int64_t cmp_doubles(double l
, double r
)
370 hist_entry__cmp_compute(struct hist_entry
*left
, struct hist_entry
*right
,
376 double l
= left
->diff
.period_ratio_delta
;
377 double r
= right
->diff
.period_ratio_delta
;
379 return cmp_doubles(l
, r
);
383 double l
= left
->diff
.period_ratio
;
384 double r
= right
->diff
.period_ratio
;
386 return cmp_doubles(l
, r
);
388 case COMPUTE_WEIGHTED_DIFF
:
390 s64 l
= left
->diff
.wdiff
;
391 s64 r
= right
->diff
.wdiff
;
402 static void insert_hist_entry_by_compute(struct rb_root
*root
,
403 struct hist_entry
*he
,
406 struct rb_node
**p
= &root
->rb_node
;
407 struct rb_node
*parent
= NULL
;
408 struct hist_entry
*iter
;
412 iter
= rb_entry(parent
, struct hist_entry
, rb_node
);
413 if (hist_entry__cmp_compute(he
, iter
, c
) < 0)
419 rb_link_node(&he
->rb_node
, parent
, p
);
420 rb_insert_color(&he
->rb_node
, root
);
423 static void hists__compute_resort(struct hists
*hists
)
425 struct rb_root
*root
;
426 struct rb_node
*next
;
428 if (sort__need_collapse
)
429 root
= &hists
->entries_collapsed
;
431 root
= hists
->entries_in
;
433 hists
->entries
= RB_ROOT
;
434 next
= rb_first(root
);
436 hists
->nr_entries
= 0;
437 hists
->stats
.total_period
= 0;
438 hists__reset_col_len(hists
);
440 while (next
!= NULL
) {
441 struct hist_entry
*he
;
443 he
= rb_entry(next
, struct hist_entry
, rb_node_in
);
444 next
= rb_next(&he
->rb_node_in
);
446 insert_hist_entry_by_compute(&hists
->entries
, he
, compute
);
447 hists__inc_nr_entries(hists
, he
);
451 static void hists__process(struct hists
*old
, struct hists
*new)
453 hists__match(new, old
);
455 if (show_baseline_only
)
456 hists__baseline_only(new);
458 hists__link(new, old
);
461 hists__precompute(new);
462 hists__compute_resort(new);
464 hists__output_resort(new);
467 hists__fprintf(new, true, 0, 0, 0, stdout
);
470 static int __cmd_diff(void)
473 #define older (session[0])
474 #define newer (session[1])
475 struct perf_session
*session
[2];
476 struct perf_evlist
*evlist_new
, *evlist_old
;
477 struct perf_evsel
*evsel
;
480 older
= perf_session__new(input_old
, O_RDONLY
, force
, false,
482 newer
= perf_session__new(input_new
, O_RDONLY
, force
, false,
484 if (session
[0] == NULL
|| session
[1] == NULL
)
487 for (i
= 0; i
< 2; ++i
) {
488 ret
= perf_session__process_events(session
[i
], &tool
);
493 evlist_old
= older
->evlist
;
494 evlist_new
= newer
->evlist
;
496 perf_evlist__collapse_resort(evlist_old
);
497 perf_evlist__collapse_resort(evlist_new
);
499 list_for_each_entry(evsel
, &evlist_new
->entries
, node
) {
500 struct perf_evsel
*evsel_old
;
502 evsel_old
= evsel_match(evsel
, evlist_old
);
506 fprintf(stdout
, "%s# Event '%s'\n#\n", first
? "" : "\n",
507 perf_evsel__name(evsel
));
511 hists__process(&evsel_old
->hists
, &evsel
->hists
);
515 for (i
= 0; i
< 2; ++i
)
516 perf_session__delete(session
[i
]);
522 static const char * const diff_usage
[] = {
523 "perf diff [<options>] [old_file] [new_file]",
527 static const struct option options
[] = {
528 OPT_INCR('v', "verbose", &verbose
,
529 "be more verbose (show symbol address, etc)"),
530 OPT_BOOLEAN('b', "baseline-only", &show_baseline_only
,
531 "Show only items with match in baseline"),
532 OPT_CALLBACK('c', "compute", &compute
,
533 "delta,ratio,wdiff:w1,w2 (default delta)",
534 "Entries differential computation selection",
536 OPT_BOOLEAN('p', "period", &show_period
,
537 "Show period values."),
538 OPT_BOOLEAN('F', "formula", &show_formula
,
540 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
541 "dump raw trace in ASCII"),
542 OPT_BOOLEAN('f', "force", &force
, "don't complain, do it"),
543 OPT_BOOLEAN('m', "modules", &symbol_conf
.use_modules
,
544 "load module symbols - WARNING: use only with -k and LIVE kernel"),
545 OPT_STRING('d', "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
546 "only consider symbols in these dsos"),
547 OPT_STRING('C', "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
548 "only consider symbols in these comms"),
549 OPT_STRING('S', "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
550 "only consider these symbols"),
551 OPT_STRING('s', "sort", &sort_order
, "key[,key2...]",
552 "sort by key(s): pid, comm, dso, symbol, parent"),
553 OPT_STRING('t', "field-separator", &symbol_conf
.field_sep
, "separator",
554 "separator for columns, no spaces will be added between "
555 "columns '.' is reserved."),
556 OPT_STRING(0, "symfs", &symbol_conf
.symfs
, "directory",
557 "Look for files with symbols relative to this directory"),
561 static void ui_init(void)
564 * Display baseline/delta/ratio
565 * formula/periods columns.
567 perf_hpp__column_enable(PERF_HPP__BASELINE
);
571 perf_hpp__column_enable(PERF_HPP__DELTA
);
574 perf_hpp__column_enable(PERF_HPP__RATIO
);
576 case COMPUTE_WEIGHTED_DIFF
:
577 perf_hpp__column_enable(PERF_HPP__WEIGHTED_DIFF
);
584 perf_hpp__column_enable(PERF_HPP__FORMULA
);
587 perf_hpp__column_enable(PERF_HPP__PERIOD
);
588 perf_hpp__column_enable(PERF_HPP__PERIOD_BASELINE
);
592 int cmd_diff(int argc
, const char **argv
, const char *prefix __maybe_unused
)
594 sort_order
= diff__default_sort_order
;
595 argc
= parse_options(argc
, argv
, options
, diff_usage
, 0);
598 usage_with_options(diff_usage
, options
);
604 } else if (symbol_conf
.default_guest_vmlinux_name
||
605 symbol_conf
.default_guest_kallsyms
) {
606 input_old
= "perf.data.host";
607 input_new
= "perf.data.guest";
610 if (symbol__init() < 0)
615 if (setup_sorting() < 0)
616 usage_with_options(diff_usage
, options
);
620 sort__setup_elide(NULL
);