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