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