perf report: Also do default setup for synthesized branch stacks
[linux-2.6-block.git] / tools / perf / builtin-report.c
CommitLineData
bf9e1876
IM
1/*
2 * builtin-report.c
3 *
4 * Builtin report command: Analyze the perf.data input file,
5 * look up and read DSOs and symbol information and display
6 * a histogram of results, along various sorting keys.
7 */
16f762a2 8#include "builtin.h"
53cb8bc2 9
bf9e1876 10#include "util/util.h"
00c7e1f1 11#include "util/cache.h"
bf9e1876 12
78f7defe 13#include "util/annotate.h"
8fc0321f 14#include "util/color.h"
5da50258 15#include <linux/list.h>
43cbcd8a 16#include <linux/rbtree.h>
a2928c42 17#include "util/symbol.h"
f55c5552 18#include "util/callchain.h"
25903407 19#include "util/strlist.h"
8d513270 20#include "util/values.h"
8fa66bdc 21
53cb8bc2 22#include "perf.h"
8f28827a 23#include "util/debug.h"
e248de33
ACM
24#include "util/evlist.h"
25#include "util/evsel.h"
7c6a1c65 26#include "util/header.h"
94c744b6 27#include "util/session.h"
45694aa7 28#include "util/tool.h"
53cb8bc2
IM
29
30#include "util/parse-options.h"
31#include "util/parse-events.h"
32
6baa0a5a 33#include "util/thread.h"
dd68ada2 34#include "util/sort.h"
3d1d07ec 35#include "util/hist.h"
f5fc1412 36#include "util/data.h"
68e94f4e 37#include "arch/common.h"
6baa0a5a 38
520a2ebc
AH
39#include "util/auxtrace.h"
40
fc67297b 41#include <dlfcn.h>
5d67be97
AB
42#include <linux/bitmap.h>
43
28b21393 44struct report {
45694aa7 45 struct perf_tool tool;
d20deb64 46 struct perf_session *session;
c31a9457 47 bool force, use_tui, use_gtk, use_stdio;
fa372aae
ACM
48 bool hide_unresolved;
49 bool dont_use_callchains;
50 bool show_full_info;
51 bool show_threads;
52 bool inverted_callchain;
f4f7e28d 53 bool mem_mode;
5cfe2c82
JO
54 bool header;
55 bool header_only;
98df858e 56 bool nonany_branch_mode;
91e95617 57 int max_stack;
fa372aae
ACM
58 struct perf_read_values show_threads_values;
59 const char *pretty_printing_style;
fa372aae 60 const char *cpu_list;
b14ffaca 61 const char *symbol_filter_str;
064f1981 62 float min_percent;
58c311da 63 u64 nr_entries;
94786b67 64 u64 queue_size;
21394d94 65 int socket_filter;
fa372aae 66 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
d20deb64 67};
5d67be97 68
28b21393 69static int report__config(const char *var, const char *value, void *cb)
00c7e1f1 70{
94786b67
JO
71 struct report *rep = cb;
72
00c7e1f1
NK
73 if (!strcmp(var, "report.group")) {
74 symbol_conf.event_group = perf_config_bool(var, value);
75 return 0;
76 }
eec574e6 77 if (!strcmp(var, "report.percent-limit")) {
eec574e6
NK
78 rep->min_percent = strtof(value, NULL);
79 return 0;
80 }
8d8e645c
NK
81 if (!strcmp(var, "report.children")) {
82 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
83 return 0;
84 }
94786b67
JO
85 if (!strcmp(var, "report.queue-size")) {
86 rep->queue_size = perf_config_u64(var, value);
87 return 0;
88 }
00c7e1f1
NK
89
90 return perf_default_config(var, value, cb);
91}
92
9d3c02d7
NK
93static int hist_iter__report_callback(struct hist_entry_iter *iter,
94 struct addr_location *al, bool single,
95 void *arg)
96{
97 int err = 0;
98 struct report *rep = arg;
99 struct hist_entry *he = iter->he;
100 struct perf_evsel *evsel = iter->evsel;
101 struct mem_info *mi;
102 struct branch_info *bi;
103
9d3c02d7
NK
104 if (!ui__has_annotation())
105 return 0;
106
57849998
AK
107 hist__account_cycles(iter->sample->branch_stack, al, iter->sample,
108 rep->nonany_branch_mode);
109
9d3c02d7
NK
110 if (sort__mode == SORT_MODE__BRANCH) {
111 bi = he->branch_info;
112 err = addr_map_symbol__inc_samples(&bi->from, evsel->idx);
113 if (err)
114 goto out;
115
116 err = addr_map_symbol__inc_samples(&bi->to, evsel->idx);
117
118 } else if (rep->mem_mode) {
119 mi = he->mem_info;
120 err = addr_map_symbol__inc_samples(&mi->daddr, evsel->idx);
121 if (err)
122 goto out;
123
124 err = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
125
126 } else if (symbol_conf.cumulate_callchain) {
127 if (single)
128 err = hist_entry__inc_addr_samples(he, evsel->idx,
129 al->addr);
130 } else {
131 err = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
132 }
133
134out:
135 return err;
f4f7e28d
SE
136}
137
45694aa7 138static int process_sample_event(struct perf_tool *tool,
d20deb64 139 union perf_event *event,
8115d60c 140 struct perf_sample *sample,
9e69c210 141 struct perf_evsel *evsel,
743eb868 142 struct machine *machine)
75051724 143{
28b21393 144 struct report *rep = container_of(tool, struct report, tool);
1ed091c4 145 struct addr_location al;
69bcb019 146 struct hist_entry_iter iter = {
063bd936
NK
147 .evsel = evsel,
148 .sample = sample,
149 .hide_unresolved = rep->hide_unresolved,
150 .add_entry_cb = hist_iter__report_callback,
69bcb019 151 };
b91fc39f 152 int ret = 0;
180f95e2 153
e44baa3e 154 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
a4210141
NK
155 pr_debug("problem processing %d event, skipping it.\n",
156 event->header.type);
75051724
IM
157 return -1;
158 }
e7fb08b1 159
2c86c7ca 160 if (rep->hide_unresolved && al.sym == NULL)
b91fc39f 161 goto out_put;
7bec7a91 162
fa372aae 163 if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap))
b91fc39f 164 goto out_put;
5d67be97 165
69bcb019
NK
166 if (sort__mode == SORT_MODE__BRANCH)
167 iter.ops = &hist_iter_branch;
168 else if (rep->mem_mode)
169 iter.ops = &hist_iter_mem;
7a13aa28
NK
170 else if (symbol_conf.cumulate_callchain)
171 iter.ops = &hist_iter_cumulative;
69bcb019
NK
172 else
173 iter.ops = &hist_iter_normal;
174
175 if (al.map != NULL)
176 al.map->dso->hit = 1;
177
063bd936 178 ret = hist_entry_iter__add(&iter, &al, rep->max_stack, rep);
69bcb019
NK
179 if (ret < 0)
180 pr_debug("problem adding hist entry, skipping event\n");
b91fc39f
ACM
181out_put:
182 addr_location__put(&al);
27a0dcb7 183 return ret;
75051724 184}
3502973d 185
45694aa7 186static int process_read_event(struct perf_tool *tool,
d20deb64 187 union perf_event *event,
1d037ca1 188 struct perf_sample *sample __maybe_unused,
743eb868 189 struct perf_evsel *evsel,
1d037ca1 190 struct machine *machine __maybe_unused)
e9ea2fde 191{
28b21393 192 struct report *rep = container_of(tool, struct report, tool);
743eb868 193
fa372aae 194 if (rep->show_threads) {
7289f83c 195 const char *name = evsel ? perf_evsel__name(evsel) : "unknown";
fa372aae 196 perf_read_values_add_value(&rep->show_threads_values,
8d513270
BG
197 event->read.pid, event->read.tid,
198 event->read.id,
199 name,
200 event->read.value);
201 }
202
9486aa38 203 dump_printf(": %d %d %s %" PRIu64 "\n", event->read.pid, event->read.tid,
7289f83c 204 evsel ? perf_evsel__name(evsel) : "FAIL",
62daacb5 205 event->read.value);
e9ea2fde
PZ
206
207 return 0;
208}
209
300aa941 210/* For pipe mode, sample_type is not currently set */
28b21393 211static int report__setup_sample_type(struct report *rep)
d80d338d 212{
c824c433
ACM
213 struct perf_session *session = rep->session;
214 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
215 bool is_pipe = perf_data_file__is_pipe(session->file);
d20deb64 216
d062ac16
AH
217 if (session->itrace_synth_opts->callchain ||
218 (!is_pipe &&
219 perf_header__has_feat(&session->header, HEADER_AUXTRACE) &&
220 !session->itrace_synth_opts->set))
221 sample_type |= PERF_SAMPLE_CALLCHAIN;
222
c7eced63
AH
223 if (session->itrace_synth_opts->last_branch)
224 sample_type |= PERF_SAMPLE_BRANCH_STACK;
225
cc9784bd 226 if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) {
91b4eaea 227 if (sort__has_parent) {
3780f488 228 ui__error("Selected --sort parent, but no "
00894ce9
ACM
229 "callchain data. Did you call "
230 "'perf record' without -g?\n");
d549c769 231 return -EINVAL;
91b4eaea 232 }
d599db3f 233 if (symbol_conf.use_callchain) {
fa94c36c
AK
234 ui__error("Selected -g or --branch-history but no "
235 "callchain data. Did\n"
236 "you call 'perf record' without -g?\n");
016e92fb 237 return -1;
91b4eaea 238 }
fa372aae
ACM
239 } else if (!rep->dont_use_callchains &&
240 callchain_param.mode != CHAIN_NONE &&
b9a63b9b 241 !symbol_conf.use_callchain) {
d599db3f 242 symbol_conf.use_callchain = true;
16537f13 243 if (callchain_register_param(&callchain_param) < 0) {
3780f488 244 ui__error("Can't register callchain params.\n");
d549c769 245 return -EINVAL;
b1a88349 246 }
f5970550
PZ
247 }
248
793aaaab
NK
249 if (symbol_conf.cumulate_callchain) {
250 /* Silently ignore if callchain is missing */
251 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) {
252 symbol_conf.cumulate_callchain = false;
253 perf_hpp__cancel_cumulate();
254 }
255 }
256
55369fc1 257 if (sort__mode == SORT_MODE__BRANCH) {
cc9784bd 258 if (!is_pipe &&
7f3be652 259 !(sample_type & PERF_SAMPLE_BRANCH_STACK)) {
3780f488
NK
260 ui__error("Selected -b but no branch data. "
261 "Did you call perf record without -b?\n");
b50311dc
RAV
262 return -1;
263 }
264 }
265
0cdccac6
NK
266 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
267 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
268 (sample_type & PERF_SAMPLE_STACK_USER))
269 callchain_param.record_mode = CALLCHAIN_DWARF;
aad2b21c
KL
270 else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
271 callchain_param.record_mode = CALLCHAIN_LBR;
0cdccac6
NK
272 else
273 callchain_param.record_mode = CALLCHAIN_FP;
274 }
98df858e
AK
275
276 /* ??? handle more cases than just ANY? */
277 if (!(perf_evlist__combined_branch_type(session->evlist) &
278 PERF_SAMPLE_BRANCH_ANY))
279 rep->nonany_branch_mode = true;
280
016e92fb
FW
281 return 0;
282}
6142f9ec 283
1d037ca1 284static void sig_handler(int sig __maybe_unused)
46656ac7
TZ
285{
286 session_done = 1;
287}
288
28b21393 289static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep,
c82ee828
ACM
290 const char *evname, FILE *fp)
291{
292 size_t ret;
293 char unit;
c824c433
ACM
294 unsigned long nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
295 u64 nr_events = hists->stats.total_period;
296 struct perf_evsel *evsel = hists_to_evsel(hists);
717e263f
NK
297 char buf[512];
298 size_t size = sizeof(buf);
84734b06 299 int socked_id = hists->socket_filter;
717e263f 300
f2148330
NK
301 if (symbol_conf.filter_relative) {
302 nr_samples = hists->stats.nr_non_filtered_samples;
303 nr_events = hists->stats.total_non_filtered_period;
304 }
305
759ff497 306 if (perf_evsel__is_group_event(evsel)) {
717e263f
NK
307 struct perf_evsel *pos;
308
309 perf_evsel__group_desc(evsel, buf, size);
310 evname = buf;
311
312 for_each_group_member(pos, evsel) {
4ea062ed
ACM
313 const struct hists *pos_hists = evsel__hists(pos);
314
f2148330 315 if (symbol_conf.filter_relative) {
4ea062ed
ACM
316 nr_samples += pos_hists->stats.nr_non_filtered_samples;
317 nr_events += pos_hists->stats.total_non_filtered_period;
f2148330 318 } else {
4ea062ed
ACM
319 nr_samples += pos_hists->stats.nr_events[PERF_RECORD_SAMPLE];
320 nr_events += pos_hists->stats.total_period;
f2148330 321 }
717e263f
NK
322 }
323 }
c82ee828 324
cc686280
AR
325 nr_samples = convert_unit(nr_samples, &unit);
326 ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit);
c82ee828 327 if (evname != NULL)
cc686280
AR
328 ret += fprintf(fp, " of event '%s'", evname);
329
9e207ddf
KL
330 if (symbol_conf.show_ref_callgraph &&
331 strstr(evname, "call-graph=no")) {
332 ret += fprintf(fp, ", show reference callgraph");
333 }
334
f4f7e28d
SE
335 if (rep->mem_mode) {
336 ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events);
228f14f2 337 ret += fprintf(fp, "\n# Sort order : %s", sort_order ? : default_mem_sort_order);
f4f7e28d
SE
338 } else
339 ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events);
21394d94 340
84734b06
KL
341 if (socked_id > -1)
342 ret += fprintf(fp, "\n# Processor Socket: %d", socked_id);
21394d94 343
c82ee828
ACM
344 return ret + fprintf(fp, "\n#\n");
345}
346
7f0030b2 347static int perf_evlist__tty_browse_hists(struct perf_evlist *evlist,
28b21393 348 struct report *rep,
7f0030b2 349 const char *help)
d67f088e 350{
e248de33 351 struct perf_evsel *pos;
d67f088e 352
6ba29c2f 353 fprintf(stdout, "#\n# Total Lost Samples: %" PRIu64 "\n#\n", evlist->stats.total_lost_samples);
0050f7aa 354 evlist__for_each(evlist, pos) {
4ea062ed 355 struct hists *hists = evsel__hists(pos);
7289f83c 356 const char *evname = perf_evsel__name(pos);
d67f088e 357
fc24d7c2
NK
358 if (symbol_conf.event_group &&
359 !perf_evsel__is_group_leader(pos))
360 continue;
361
28b21393 362 hists__fprintf_nr_sample_events(hists, rep, evname, stdout);
064f1981 363 hists__fprintf(hists, true, 0, 0, rep->min_percent, stdout);
d67f088e 364 fprintf(stdout, "\n\n");
d67f088e
ACM
365 }
366
e944ec2c 367 if (sort_order == NULL &&
021162cf 368 parent_pattern == default_parent_pattern)
d67f088e
ACM
369 fprintf(stdout, "#\n# (%s)\n#\n", help);
370
021162cf
NK
371 if (rep->show_threads) {
372 bool style = !strcmp(rep->pretty_printing_style, "raw");
373 perf_read_values_display(stdout, &rep->show_threads_values,
374 style);
375 perf_read_values_destroy(&rep->show_threads_values);
d67f088e
ACM
376 }
377
378 return 0;
379}
380
fad2918e
ACM
381static void report__warn_kptr_restrict(const struct report *rep)
382{
383 struct map *kernel_map = rep->session->machines.host.vmlinux_maps[MAP__FUNCTION];
f6fcc143 384 struct kmap *kernel_kmap = kernel_map ? map__kmap(kernel_map) : NULL;
fad2918e
ACM
385
386 if (kernel_map == NULL ||
387 (kernel_map->dso->hit &&
388 (kernel_kmap->ref_reloc_sym == NULL ||
389 kernel_kmap->ref_reloc_sym->addr == 0))) {
390 const char *desc =
391 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
392 "can't be resolved.";
393
394 if (kernel_map) {
395 const struct dso *kdso = kernel_map->dso;
396 if (!RB_EMPTY_ROOT(&kdso->symbols[MAP__FUNCTION])) {
397 desc = "If some relocation was applied (e.g. "
398 "kexec) symbols may be misresolved.";
399 }
400 }
401
402 ui__warning(
403"Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
404"Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
405"Samples in kernel modules can't be resolved as well.\n\n",
406 desc);
407 }
408}
409
8362951b
ACM
410static int report__gtk_browse_hists(struct report *rep, const char *help)
411{
412 int (*hist_browser)(struct perf_evlist *evlist, const char *help,
413 struct hist_browser_timer *timer, float min_pcnt);
414
415 hist_browser = dlsym(perf_gtk_handle, "perf_evlist__gtk_browse_hists");
416
417 if (hist_browser == NULL) {
418 ui__error("GTK browser not found!\n");
419 return -1;
420 }
421
422 return hist_browser(rep->session->evlist, help, NULL, rep->min_percent);
423}
424
425static int report__browse_hists(struct report *rep)
426{
427 int ret;
428 struct perf_session *session = rep->session;
429 struct perf_evlist *evlist = session->evlist;
430 const char *help = "For a higher level overview, try: perf report --sort comm,dso";
431
432 switch (use_browser) {
433 case 1:
434 ret = perf_evlist__tui_browse_hists(evlist, help, NULL,
435 rep->min_percent,
436 &session->header.env);
437 /*
438 * Usually "ret" is the last pressed key, and we only
439 * care if the key notifies us to switch data file.
440 */
441 if (ret != K_SWITCH_INPUT_DATA)
442 ret = 0;
443 break;
444 case 2:
445 ret = report__gtk_browse_hists(rep, help);
446 break;
447 default:
448 ret = perf_evlist__tty_browse_hists(evlist, rep, help);
449 break;
450 }
451
452 return ret;
453}
454
58c311da 455static void report__collapse_hists(struct report *rep)
f6d8b057
ACM
456{
457 struct ui_progress prog;
458 struct perf_evsel *pos;
f6d8b057 459
58c311da 460 ui_progress__init(&prog, rep->nr_entries, "Merging related events...");
f6d8b057 461
0050f7aa 462 evlist__for_each(rep->session->evlist, pos) {
4ea062ed 463 struct hists *hists = evsel__hists(pos);
f6d8b057
ACM
464
465 if (pos->idx == 0)
466 hists->symbol_filter_str = rep->symbol_filter_str;
467
21394d94
KL
468 hists->socket_filter = rep->socket_filter;
469
f6d8b057 470 hists__collapse_resort(hists, &prog);
f6d8b057
ACM
471
472 /* Non-group events are considered as leader */
473 if (symbol_conf.event_group &&
474 !perf_evsel__is_group_leader(pos)) {
4ea062ed 475 struct hists *leader_hists = evsel__hists(pos->leader);
f6d8b057
ACM
476
477 hists__match(leader_hists, hists);
478 hists__link(leader_hists, hists);
479 }
480 }
481
482 ui_progress__finish();
f6d8b057
ACM
483}
484
740b97f9
NK
485static void report__output_resort(struct report *rep)
486{
487 struct ui_progress prog;
488 struct perf_evsel *pos;
489
490 ui_progress__init(&prog, rep->nr_entries, "Sorting events for output...");
491
492 evlist__for_each(rep->session->evlist, pos)
493 hists__output_resort(evsel__hists(pos), &prog);
494
495 ui_progress__finish();
496}
497
28b21393 498static int __cmd_report(struct report *rep)
016e92fb 499{
f6d8b057 500 int ret;
993ac88d 501 struct perf_session *session = rep->session;
e248de33 502 struct perf_evsel *pos;
cc9784bd 503 struct perf_data_file *file = session->file;
8fa66bdc 504
46656ac7
TZ
505 signal(SIGINT, sig_handler);
506
fa372aae
ACM
507 if (rep->cpu_list) {
508 ret = perf_session__cpu_bitmap(session, rep->cpu_list,
509 rep->cpu_bitmap);
5d67be97 510 if (ret)
d4ae0a6f 511 return ret;
5d67be97
AB
512 }
513
fa372aae
ACM
514 if (rep->show_threads)
515 perf_read_values_init(&rep->show_threads_values);
f5970550 516
28b21393 517 ret = report__setup_sample_type(rep);
d549c769 518 if (ret)
d4ae0a6f 519 return ret;
d549c769 520
b7b61cbe 521 ret = perf_session__process_events(session);
016e92fb 522 if (ret)
d4ae0a6f 523 return ret;
97b07b69 524
fad2918e 525 report__warn_kptr_restrict(rep);
ec80fde7 526
590cd344
NK
527 evlist__for_each(session->evlist, pos)
528 rep->nr_entries += evsel__hists(pos)->nr_entries;
529
150e465a
NK
530 if (use_browser == 0) {
531 if (verbose > 3)
532 perf_session__fprintf(session, stdout);
9ac99545 533
150e465a
NK
534 if (verbose > 2)
535 perf_session__fprintf_dsos(session, stdout);
16f762a2 536
150e465a
NK
537 if (dump_trace) {
538 perf_session__fprintf_nr_events(session, stdout);
2a1731fb 539 perf_evlist__fprintf_nr_events(session->evlist, stdout);
150e465a
NK
540 return 0;
541 }
71ad0f5e
JO
542 }
543
58c311da 544 report__collapse_hists(rep);
e248de33 545
33e940a2
ACM
546 if (session_done())
547 return 0;
548
740b97f9
NK
549 /*
550 * recalculate number of entries after collapsing since it
551 * might be changed during the collapse phase.
552 */
553 rep->nr_entries = 0;
554 evlist__for_each(session->evlist, pos)
555 rep->nr_entries += evsel__hists(pos)->nr_entries;
556
58c311da 557 if (rep->nr_entries == 0) {
cc9784bd 558 ui__error("The %s file has no samples!\n", file->path);
d4ae0a6f 559 return 0;
cbbc79a5
EM
560 }
561
740b97f9 562 report__output_resort(rep);
6e1f601a 563
8362951b 564 return report__browse_hists(rep);
8fa66bdc
ACM
565}
566
4eb3e478 567static int
cff6bb46 568report_parse_callchain_opt(const struct option *opt, const char *arg, int unset)
4eb3e478 569{
28b21393 570 struct report *rep = (struct report *)opt->value;
c20ab37e 571
b9a63b9b
ACM
572 /*
573 * --no-call-graph
574 */
575 if (unset) {
fa372aae 576 rep->dont_use_callchains = true;
b9a63b9b
ACM
577 return 0;
578 }
579
cff6bb46 580 return parse_callchain_report_opt(arg);
4eb3e478
FW
581}
582
b21484f1
GP
583int
584report_parse_ignore_callees_opt(const struct option *opt __maybe_unused,
585 const char *arg, int unset __maybe_unused)
586{
587 if (arg) {
588 int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED);
589 if (err) {
590 char buf[BUFSIZ];
591 regerror(err, &ignore_callees_regex, buf, sizeof(buf));
592 pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf);
593 return -1;
594 }
595 have_ignore_callees = 1;
596 }
597
598 return 0;
599}
600
993ac88d 601static int
1d037ca1
IT
602parse_branch_mode(const struct option *opt __maybe_unused,
603 const char *str __maybe_unused, int unset)
993ac88d 604{
55369fc1
NK
605 int *branch_mode = opt->value;
606
607 *branch_mode = !unset;
993ac88d
SE
608 return 0;
609}
610
064f1981
NK
611static int
612parse_percent_limit(const struct option *opt, const char *str,
613 int unset __maybe_unused)
614{
28b21393 615 struct report *rep = opt->value;
064f1981
NK
616
617 rep->min_percent = strtof(str, NULL);
618 return 0;
619}
620
1d037ca1 621int cmd_report(int argc, const char **argv, const char *prefix __maybe_unused)
d20deb64 622{
993ac88d 623 struct perf_session *session;
520a2ebc 624 struct itrace_synth_opts itrace_synth_opts = { .set = 0, };
efad1415 625 struct stat st;
993ac88d 626 bool has_br_stack = false;
55369fc1 627 int branch_mode = -1;
fa94c36c 628 bool branch_call_mode = false;
d20deb64
ACM
629 char callchain_default_opt[] = "fractal,0.5,callee";
630 const char * const report_usage[] = {
fb2baceb 631 "perf report [<options>]",
d20deb64
ACM
632 NULL
633 };
28b21393 634 struct report report = {
45694aa7 635 .tool = {
d20deb64
ACM
636 .sample = process_sample_event,
637 .mmap = perf_event__process_mmap,
5c5e854b 638 .mmap2 = perf_event__process_mmap2,
d20deb64 639 .comm = perf_event__process_comm,
f62d3f0f
ACM
640 .exit = perf_event__process_exit,
641 .fork = perf_event__process_fork,
d20deb64
ACM
642 .lost = perf_event__process_lost,
643 .read = process_read_event,
644 .attr = perf_event__process_attr,
d20deb64
ACM
645 .tracing_data = perf_event__process_tracing_data,
646 .build_id = perf_event__process_build_id,
520a2ebc
AH
647 .id_index = perf_event__process_id_index,
648 .auxtrace_info = perf_event__process_auxtrace_info,
649 .auxtrace = perf_event__process_auxtrace,
0a8cb85c 650 .ordered_events = true,
d20deb64
ACM
651 .ordering_requires_timestamps = true,
652 },
91e95617 653 .max_stack = PERF_MAX_STACK_DEPTH,
d20deb64 654 .pretty_printing_style = "normal",
21394d94 655 .socket_filter = -1,
d20deb64
ACM
656 };
657 const struct option options[] = {
70cb4e96 658 OPT_STRING('i', "input", &input_name, "file",
53cb8bc2 659 "input file name"),
c0555642 660 OPT_INCR('v', "verbose", &verbose,
815e777f 661 "be more verbose (show symbol address, etc)"),
97b07b69
IM
662 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
663 "dump raw trace in ASCII"),
b32d133a
ACM
664 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
665 "file", "vmlinux pathname"),
b226a5a7
DA
666 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
667 "file", "kallsyms pathname"),
fa372aae 668 OPT_BOOLEAN('f', "force", &report.force, "don't complain, do it"),
b32d133a 669 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
42976487 670 "load module symbols - WARNING: use only with -k and LIVE kernel"),
d599db3f 671 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
e3d7e183 672 "Show a column with the number of samples"),
fa372aae 673 OPT_BOOLEAN('T', "threads", &report.show_threads,
8d513270 674 "Show per-thread event counters"),
fa372aae 675 OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
9f866697 676 "pretty printing style key: normal raw"),
fa372aae 677 OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
c31a9457 678 OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
fa372aae
ACM
679 OPT_BOOLEAN(0, "stdio", &report.use_stdio,
680 "Use the stdio interface"),
5cfe2c82
JO
681 OPT_BOOLEAN(0, "header", &report.header, "Show data header."),
682 OPT_BOOLEAN(0, "header-only", &report.header_only,
683 "Show only data header."),
63299f05 684 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
a2ce067e
NK
685 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
686 " Please refer the man page for the complete list."),
a7d945bc
NK
687 OPT_STRING('F', "fields", &field_order, "key[,keys...]",
688 "output field(s): overhead, period, sample plus all of sort keys"),
a1645ce1
ZY
689 OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
690 "Show sample percentage for different cpu modes"),
b25bcf2f
IM
691 OPT_STRING('p', "parent", &parent_pattern, "regex",
692 "regex filter to identify parent, see: '--sort parent'"),
d599db3f 693 OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
b8e6d829 694 "Only display entries with parent-match"),
8b7bad58
AK
695 OPT_CALLBACK_DEFAULT('g', "call-graph", &report, "output_type,min_percent[,print_limit],call_order[,branch]",
696 "Display callchains using output_type (graph, flat, fractal, or none) , min percent threshold, optional print limit, callchain order, key (function or address), add branches. "
cff6bb46 697 "Default: fractal,0.5,callee,function", &report_parse_callchain_opt, callchain_default_opt),
793aaaab
NK
698 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
699 "Accumulate callchains of children and show total overhead as well"),
91e95617
WL
700 OPT_INTEGER(0, "max-stack", &report.max_stack,
701 "Set the maximum stack depth when parsing the callchain, "
702 "anything beyond the specified depth will be ignored. "
703 "Default: " __stringify(PERF_MAX_STACK_DEPTH)),
fa372aae
ACM
704 OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
705 "alias for inverted call graph"),
b21484f1
GP
706 OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
707 "ignore callees of these functions in call graphs",
708 report_parse_ignore_callees_opt),
655000e7 709 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
25903407 710 "only consider symbols in these dsos"),
c8e66720 711 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
cc8b88b1 712 "only consider symbols in these comms"),
e03eaa40
DA
713 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
714 "only consider symbols in these pids"),
715 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
716 "only consider symbols in these tids"),
655000e7 717 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
7bec7a91 718 "only consider these symbols"),
b14ffaca
NK
719 OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
720 "only show symbols that (partially) match with this filter"),
655000e7 721 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
52d422de
ACM
722 "width[,width...]",
723 "don't try to adjust column width, use these fixed values"),
0c8c2077 724 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf.field_sep, "separator",
52d422de
ACM
725 "separator for columns, no spaces will be added between "
726 "columns '.' is reserved."),
fa372aae 727 OPT_BOOLEAN('U', "hide-unresolved", &report.hide_unresolved,
71289be7 728 "Only display entries resolved to a symbol"),
ec5761ea
DA
729 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
730 "Look for files with symbols relative to this directory"),
c8e66720 731 OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
fa372aae
ACM
732 "list of cpus to profile"),
733 OPT_BOOLEAN('I', "show-info", &report.show_full_info,
fbe96f29 734 "Display extended information about perf.data file"),
64c6f0c7
ACM
735 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
736 "Interleave source code with assembly code (default)"),
737 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
738 "Display raw encoding of assembly instructions (default)"),
f69b64f7
AK
739 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
740 "Specify disassembler style (e.g. -M intel for intel syntax)"),
3f2728bd
ACM
741 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
742 "Show a column with the sum of periods"),
01d14f16
NK
743 OPT_BOOLEAN(0, "group", &symbol_conf.event_group,
744 "Show event group information together"),
55369fc1 745 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "",
fa94c36c
AK
746 "use branch records for per branch histogram filling",
747 parse_branch_mode),
748 OPT_BOOLEAN(0, "branch-history", &branch_call_mode,
749 "add last branch records to call history"),
7a4ec938
MB
750 OPT_STRING(0, "objdump", &objdump_path, "path",
751 "objdump binary to use for disassembly and annotations"),
328ccdac
NK
752 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
753 "Disable symbol demangling"),
763122ad
AK
754 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
755 "Enable kernel symbol demangling"),
f4f7e28d 756 OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"),
064f1981
NK
757 OPT_CALLBACK(0, "percent-limit", &report, "percent",
758 "Don't show entries under that percent", parse_percent_limit),
f2148330 759 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
33db4568 760 "how to display percentage of filtered entries", parse_filter_percentage),
520a2ebc
AH
761 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
762 "Instruction Tracing options",
763 itrace_parse_synth_opts),
a9710ba0
AK
764 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
765 "Show full source file name path for source lines"),
9e207ddf
KL
766 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf.show_ref_callgraph,
767 "Show callgraph from reference event"),
21394d94
KL
768 OPT_INTEGER(0, "socket-filter", &report.socket_filter,
769 "only show processor socket that match with this filter"),
53cb8bc2 770 OPT_END()
d20deb64 771 };
f5fc1412
JO
772 struct perf_data_file file = {
773 .mode = PERF_DATA_MODE_READ,
774 };
a635fc51
ACM
775 int ret = hists__init();
776
777 if (ret < 0)
778 return ret;
53cb8bc2 779
28b21393 780 perf_config(report__config, &report);
00c7e1f1 781
655000e7
ACM
782 argc = parse_options(argc, argv, options, report_usage, 0);
783
36c8bb56
LZ
784 if (symbol_conf.vmlinux_name &&
785 access(symbol_conf.vmlinux_name, R_OK)) {
786 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name);
787 return -EINVAL;
788 }
789 if (symbol_conf.kallsyms_name &&
790 access(symbol_conf.kallsyms_name, R_OK)) {
791 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name);
792 return -EINVAL;
793 }
794
fa372aae 795 if (report.use_stdio)
8b9e74eb 796 use_browser = 0;
fa372aae 797 else if (report.use_tui)
8b9e74eb 798 use_browser = 1;
c31a9457
PE
799 else if (report.use_gtk)
800 use_browser = 2;
8b9e74eb 801
fa372aae 802 if (report.inverted_callchain)
d797fdc5
SL
803 callchain_param.order = ORDER_CALLER;
804
70cb4e96 805 if (!input_name || !strlen(input_name)) {
efad1415 806 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
70cb4e96 807 input_name = "-";
efad1415 808 else
70cb4e96 809 input_name = "perf.data";
efad1415 810 }
ad0de097 811
f5fc1412
JO
812 file.path = input_name;
813 file.force = report.force;
814
ad0de097 815repeat:
f5fc1412 816 session = perf_session__new(&file, false, &report.tool);
993ac88d 817 if (session == NULL)
52e02834 818 return -1;
993ac88d 819
94786b67
JO
820 if (report.queue_size) {
821 ordered_events__set_alloc_size(&session->ordered_events,
822 report.queue_size);
823 }
824
520a2ebc
AH
825 session->itrace_synth_opts = &itrace_synth_opts;
826
993ac88d
SE
827 report.session = session;
828
829 has_br_stack = perf_header__has_feat(&session->header,
830 HEADER_BRANCH_STACK);
efad1415 831
fb9fab66
AH
832 if (itrace_synth_opts.last_branch)
833 has_br_stack = true;
834
fa94c36c
AK
835 /*
836 * Branch mode is a tristate:
837 * -1 means default, so decide based on the file having branch data.
838 * 0/1 means the user chose a mode.
839 */
840 if (((branch_mode == -1 && has_br_stack) || branch_mode == 1) &&
fefd2d96 841 !branch_call_mode) {
55369fc1 842 sort__mode = SORT_MODE__BRANCH;
793aaaab
NK
843 symbol_conf.cumulate_callchain = false;
844 }
fa94c36c 845 if (branch_call_mode) {
09a6a1b0 846 callchain_param.key = CCKEY_ADDRESS;
fa94c36c
AK
847 callchain_param.branch_callstack = 1;
848 symbol_conf.use_callchain = true;
849 callchain_register_param(&callchain_param);
850 if (sort_order == NULL)
851 sort_order = "srcline,symbol,dso";
852 }
993ac88d 853
f4f7e28d 854 if (report.mem_mode) {
55369fc1 855 if (sort__mode == SORT_MODE__BRANCH) {
a4210141 856 pr_err("branch and mem mode incompatible\n");
f4f7e28d
SE
857 goto error;
858 }
afab87b9 859 sort__mode = SORT_MODE__MEMORY;
793aaaab 860 symbol_conf.cumulate_callchain = false;
f4f7e28d 861 }
a68c2c58 862
91aba0a6 863 if (setup_sorting() < 0) {
a7d945bc
NK
864 if (sort_order)
865 parse_options_usage(report_usage, options, "s", 1);
866 if (field_order)
867 parse_options_usage(sort_order ? NULL : report_usage,
868 options, "F", 1);
91aba0a6
NK
869 goto error;
870 }
034a9265 871
b138f42e
NK
872 /* Force tty output for header output and per-thread stat. */
873 if (report.header || report.header_only || report.show_threads)
5cfe2c82
JO
874 use_browser = 0;
875
4bceffbc
NK
876 if (strcmp(input_name, "-") != 0)
877 setup_browser(true);
22af969e 878 else
4bceffbc 879 use_browser = 0;
4bceffbc 880
5cfe2c82
JO
881 if (report.header || report.header_only) {
882 perf_session__fprintf_info(session, stdout,
883 report.show_full_info);
07a716ff
TS
884 if (report.header_only) {
885 ret = 0;
886 goto error;
887 }
5cfe2c82
JO
888 } else if (use_browser == 0) {
889 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
890 stdout);
891 }
892
ef7b93a1 893 /*
6692c262 894 * Only in the TUI browser we are doing integrated annotation,
ef7b93a1
ACM
895 * so don't allocate extra space that won't be used in the stdio
896 * implementation.
897 */
b9ce0c99 898 if (ui__has_annotation()) {
78f7defe 899 symbol_conf.priv_size = sizeof(struct annotation);
b8681711
AH
900 machines__set_symbol_filter(&session->machines,
901 symbol__annotate_init);
80d50cae
ACM
902 /*
903 * For searching by name on the "Browse map details".
904 * providing it only in verbose mode not to bloat too
905 * much struct symbol.
906 */
907 if (verbose) {
908 /*
909 * XXX: Need to provide a less kludgy way to ask for
910 * more space per symbol, the u32 is for the index on
911 * the ui browser.
912 * See symbol__browser_index.
913 */
914 symbol_conf.priv_size += sizeof(u32);
915 symbol_conf.sort_by_name = true;
916 }
917 }
655000e7 918
0a7e6d1b 919 if (symbol__init(&session->header.env) < 0)
993ac88d 920 goto error;
53cb8bc2 921
6db6127c
NK
922 if (argc) {
923 /*
924 * Special case: if there's an argument left then assume that
925 * it's a symbol filter:
926 */
927 if (argc > 1)
928 usage_with_options(report_usage, options);
929
930 report.symbol_filter_str = argv[0];
931 }
edc52dea 932
08e71542 933 sort__setup_elide(stdout);
25903407 934
993ac88d 935 ret = __cmd_report(&report);
ad0de097
FT
936 if (ret == K_SWITCH_INPUT_DATA) {
937 perf_session__delete(session);
938 goto repeat;
939 } else
940 ret = 0;
941
993ac88d
SE
942error:
943 perf_session__delete(session);
944 return ret;
53cb8bc2 945}