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