]> git.ipfire.org Git - thirdparty/kernel/stable.git/blame - tools/perf/builtin-top.c
Merge tag 'f2fs-for-5.1' of git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk...
[thirdparty/kernel/stable.git] / tools / perf / builtin-top.c
CommitLineData
07800601 1/*
bf9e1876
IM
2 * builtin-top.c
3 *
4 * Builtin top command: Display a continuously updated profile of
5 * any workload, CPU or specific PID.
6 *
7 * Copyright (C) 2008, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
ab81f3fd 8 * 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
bf9e1876
IM
9 *
10 * Improvements and fixes by:
11 *
12 * Arjan van de Ven <arjan@linux.intel.com>
13 * Yanmin Zhang <yanmin.zhang@intel.com>
14 * Wu Fengguang <fengguang.wu@intel.com>
15 * Mike Galbraith <efault@gmx.de>
16 * Paul Mackerras <paulus@samba.org>
17 *
18 * Released under the GPL v2. (and only v2, not any later version)
07800601 19 */
bf9e1876 20#include "builtin.h"
07800601 21
1a482f38 22#include "perf.h"
bf9e1876 23
36532461 24#include "util/annotate.h"
a40b95bc 25#include "util/bpf-event.h"
41840d21 26#include "util/config.h"
8fc0321f 27#include "util/color.h"
361c99a6 28#include "util/evlist.h"
69aad6f1 29#include "util/evsel.h"
5ab8c689 30#include "util/event.h"
b0a7d1a0 31#include "util/machine.h"
1101f69a 32#include "util/map.h"
b3165f41
ACM
33#include "util/session.h"
34#include "util/symbol.h"
439d473b 35#include "util/thread.h"
fd78260b 36#include "util/thread_map.h"
8c3e10eb 37#include "util/top.h"
43cbcd8a 38#include <linux/rbtree.h>
4b6ab94e 39#include <subcmd/parse-options.h>
b456bae0 40#include "util/parse-events.h"
a12b51c4 41#include "util/cpumap.h"
69aad6f1 42#include "util/xyarray.h"
ab81f3fd 43#include "util/sort.h"
b0742e90 44#include "util/term.h"
6b118e92 45#include "util/intlist.h"
a18b027e 46#include "util/parse-branch-options.h"
0d3942db 47#include "arch/common.h"
07800601 48
8f28827a 49#include "util/debug.h"
16c66bc1 50#include "util/ordered-events.h"
8f28827a 51
07800601 52#include <assert.h>
31d68e7b 53#include <elf.h>
07800601 54#include <fcntl.h>
0e9b20b8 55
07800601 56#include <stdio.h>
923c42c1
MG
57#include <termios.h>
58#include <unistd.h>
9486aa38 59#include <inttypes.h>
0e9b20b8 60
07800601 61#include <errno.h>
07800601
IM
62#include <time.h>
63#include <sched.h>
9607ad3a 64#include <signal.h>
07800601
IM
65
66#include <sys/syscall.h>
67#include <sys/ioctl.h>
a8fa4960 68#include <poll.h>
07800601
IM
69#include <sys/prctl.h>
70#include <sys/wait.h>
71#include <sys/uio.h>
31d68e7b 72#include <sys/utsname.h>
07800601
IM
73#include <sys/mman.h>
74
531d2410 75#include <linux/stringify.h>
b9c4b0f4 76#include <linux/time64.h>
07800601
IM
77#include <linux/types.h>
78
3d689ed6
ACM
79#include "sane_ctype.h"
80
11859e82 81static volatile int done;
b135e5ee 82static volatile int resize;
11859e82 83
933cbb1c
NK
84#define HEADER_LINE_NR 5
85
1758af10 86static void perf_top__update_print_entries(struct perf_top *top)
3b6ed988 87{
933cbb1c 88 top->print_entries = top->winsize.ws_row - HEADER_LINE_NR;
3b6ed988
ACM
89}
90
244a1086 91static void winch_sig(int sig __maybe_unused)
3b6ed988 92{
b135e5ee
JO
93 resize = 1;
94}
1758af10 95
b135e5ee
JO
96static void perf_top__resize(struct perf_top *top)
97{
1758af10
ACM
98 get_term_dimensions(&top->winsize);
99 perf_top__update_print_entries(top);
3b6ed988
ACM
100}
101
1758af10 102static int perf_top__parse_source(struct perf_top *top, struct hist_entry *he)
923c42c1 103{
a7eec4c6 104 struct perf_evsel *evsel = hists_to_evsel(he->hists);
923c42c1 105 struct symbol *sym;
ce6f4fab 106 struct annotation *notes;
439d473b 107 struct map *map;
36532461 108 int err = -1;
923c42c1 109
ab81f3fd 110 if (!he || !he->ms.sym)
b0a9ab62
ACM
111 return -1;
112
ab81f3fd
ACM
113 sym = he->ms.sym;
114 map = he->ms.map;
b0a9ab62
ACM
115
116 /*
117 * We can't annotate with just /proc/kallsyms
118 */
bbb7f846
AH
119 if (map->dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
120 !dso__is_kcore(map->dso)) {
ce6f4fab
ACM
121 pr_err("Can't annotate %s: No vmlinux file was found in the "
122 "path\n", sym->name);
123 sleep(1);
b0a9ab62 124 return -1;
b269876c
ACM
125 }
126
ce6f4fab 127 notes = symbol__annotation(sym);
ce6f4fab 128 pthread_mutex_lock(&notes->lock);
923c42c1 129
14c8dde1 130 if (!symbol__hists(sym, top->evlist->nr_entries)) {
c97cf422 131 pthread_mutex_unlock(&notes->lock);
36532461
ACM
132 pr_err("Not enough memory for annotating '%s' symbol!\n",
133 sym->name);
ce6f4fab 134 sleep(1);
c97cf422 135 return err;
923c42c1 136 }
36532461 137
380195e2 138 err = symbol__annotate(sym, map, evsel, 0, &top->annotation_opts, NULL);
36532461 139 if (err == 0) {
1758af10 140 top->sym_filter_entry = he;
ee51d851
ACM
141 } else {
142 char msg[BUFSIZ];
143 symbol__strerror_disassemble(sym, map, err, msg, sizeof(msg));
144 pr_err("Couldn't annotate %s: %s\n", sym->name, msg);
36532461 145 }
c97cf422 146
ce6f4fab 147 pthread_mutex_unlock(&notes->lock);
36532461 148 return err;
923c42c1
MG
149}
150
ab81f3fd 151static void __zero_source_counters(struct hist_entry *he)
923c42c1 152{
ab81f3fd 153 struct symbol *sym = he->ms.sym;
36532461 154 symbol__annotate_zero_histograms(sym);
923c42c1
MG
155}
156
31d68e7b
ACM
157static void ui__warn_map_erange(struct map *map, struct symbol *sym, u64 ip)
158{
159 struct utsname uts;
160 int err = uname(&uts);
161
162 ui__warning("Out of bounds address found:\n\n"
163 "Addr: %" PRIx64 "\n"
164 "DSO: %s %c\n"
165 "Map: %" PRIx64 "-%" PRIx64 "\n"
166 "Symbol: %" PRIx64 "-%" PRIx64 " %c %s\n"
167 "Arch: %s\n"
168 "Kernel: %s\n"
169 "Tools: %s\n\n"
170 "Not all samples will be on the annotation output.\n\n"
171 "Please report to linux-kernel@vger.kernel.org\n",
172 ip, map->dso->long_name, dso__symtab_origin(map->dso),
173 map->start, map->end, sym->start, sym->end,
174 sym->binding == STB_GLOBAL ? 'g' :
175 sym->binding == STB_LOCAL ? 'l' : 'w', sym->name,
176 err ? "[unknown]" : uts.machine,
177 err ? "[unknown]" : uts.release, perf_version_string);
178 if (use_browser <= 0)
179 sleep(5);
48000a1a 180
31d68e7b
ACM
181 map->erange_warned = true;
182}
183
1758af10
ACM
184static void perf_top__record_precise_ip(struct perf_top *top,
185 struct hist_entry *he,
bab89f6a 186 struct perf_sample *sample,
e345f3bd 187 struct perf_evsel *evsel, u64 ip)
923c42c1 188{
ce6f4fab 189 struct annotation *notes;
beefb8d0 190 struct symbol *sym = he->ms.sym;
48c65bda 191 int err = 0;
ce6f4fab 192
beefb8d0
NK
193 if (sym == NULL || (use_browser == 0 &&
194 (top->sym_filter_entry == NULL ||
195 top->sym_filter_entry->ms.sym != sym)))
923c42c1
MG
196 return;
197
ce6f4fab
ACM
198 notes = symbol__annotation(sym);
199
200 if (pthread_mutex_trylock(&notes->lock))
923c42c1
MG
201 return;
202
e345f3bd 203 err = hist_entry__inc_addr_samples(he, sample, evsel, ip);
c7ad21af 204
ce6f4fab 205 pthread_mutex_unlock(&notes->lock);
31d68e7b 206
151ee834
NK
207 if (unlikely(err)) {
208 /*
209 * This function is now called with he->hists->lock held.
210 * Release it before going to sleep.
211 */
212 pthread_mutex_unlock(&he->hists->lock);
213
214 if (err == -ERANGE && !he->ms.map->erange_warned)
215 ui__warn_map_erange(he->ms.map, sym, ip);
216 else if (err == -ENOMEM) {
217 pr_err("Not enough memory for annotating '%s' symbol!\n",
218 sym->name);
219 sleep(1);
220 }
221
222 pthread_mutex_lock(&he->hists->lock);
b66d8c0c 223 }
923c42c1
MG
224}
225
1758af10 226static void perf_top__show_details(struct perf_top *top)
923c42c1 227{
1758af10 228 struct hist_entry *he = top->sym_filter_entry;
f681d593 229 struct perf_evsel *evsel = hists_to_evsel(he->hists);
ce6f4fab 230 struct annotation *notes;
923c42c1 231 struct symbol *symbol;
36532461 232 int more;
923c42c1 233
ab81f3fd 234 if (!he)
923c42c1
MG
235 return;
236
ab81f3fd 237 symbol = he->ms.sym;
ce6f4fab
ACM
238 notes = symbol__annotation(symbol);
239
240 pthread_mutex_lock(&notes->lock);
241
f681d593
JO
242 symbol__calc_percent(symbol, evsel);
243
ce6f4fab
ACM
244 if (notes->src == NULL)
245 goto out_unlock;
923c42c1 246
7289f83c 247 printf("Showing %s for %s\n", perf_evsel__name(top->sym_evsel), symbol->name);
982d410b 248 printf(" Events Pcnt (>=%d%%)\n", top->annotation_opts.min_pcnt);
923c42c1 249
982d410b 250 more = symbol__annotate_printf(symbol, he->ms.map, top->sym_evsel, &top->annotation_opts);
5d484f99
ACM
251
252 if (top->evlist->enabled) {
253 if (top->zero)
254 symbol__annotate_zero_histogram(symbol, top->sym_evsel->idx);
255 else
256 symbol__annotate_decay_histogram(symbol, top->sym_evsel->idx);
257 }
36532461 258 if (more != 0)
923c42c1 259 printf("%d lines not displayed, maybe increase display entries [e]\n", more);
ce6f4fab
ACM
260out_unlock:
261 pthread_mutex_unlock(&notes->lock);
923c42c1 262}
07800601 263
1758af10 264static void perf_top__print_sym_table(struct perf_top *top)
07800601 265{
8c3e10eb
ACM
266 char bf[160];
267 int printed = 0;
1758af10 268 const int win_width = top->winsize.ws_col - 1;
452ce03b
JO
269 struct perf_evsel *evsel = top->sym_evsel;
270 struct hists *hists = evsel__hists(evsel);
d94b9430 271
0f5486b5 272 puts(CONSOLE_CLEAR);
07800601 273
1758af10 274 perf_top__header_snprintf(top, bf, sizeof(bf));
8c3e10eb 275 printf("%s\n", bf);
07800601 276
1a105f74 277 printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
07800601 278
a1ff5b05
KL
279 if (!top->record_opts.overwrite &&
280 (hists->stats.nr_lost_warned !=
281 hists->stats.nr_events[PERF_RECORD_LOST])) {
4ea062ed
ACM
282 hists->stats.nr_lost_warned =
283 hists->stats.nr_events[PERF_RECORD_LOST];
7b27509f
ACM
284 color_fprintf(stdout, PERF_COLOR_RED,
285 "WARNING: LOST %d chunks, Check IO/CPU overload",
4ea062ed 286 hists->stats.nr_lost_warned);
ab81f3fd 287 ++printed;
93fc64f1
ACM
288 }
289
1758af10
ACM
290 if (top->sym_filter_entry) {
291 perf_top__show_details(top);
923c42c1
MG
292 return;
293 }
294
5d484f99
ACM
295 if (top->evlist->enabled) {
296 if (top->zero) {
297 hists__delete_entries(hists);
298 } else {
299 hists__decay_entries(hists, top->hide_user_symbols,
300 top->hide_kernel_symbols);
301 }
701937bd
NK
302 }
303
4ea062ed 304 hists__collapse_resort(hists, NULL);
452ce03b 305 perf_evsel__output_resort(evsel, NULL);
701937bd 306
4ea062ed 307 hists__output_recalc_col_len(hists, top->print_entries - printed);
7cc017ed 308 putchar('\n');
4ea062ed 309 hists__fprintf(hists, false, top->print_entries - printed, win_width,
e9de7e2f 310 top->min_percent, stdout, !symbol_conf.use_callchain);
07800601
IM
311}
312
923c42c1
MG
313static void prompt_integer(int *target, const char *msg)
314{
315 char *buf = malloc(0), *p;
316 size_t dummy = 0;
317 int tmp;
318
319 fprintf(stdout, "\n%s: ", msg);
320 if (getline(&buf, &dummy, stdin) < 0)
321 return;
322
323 p = strchr(buf, '\n');
324 if (p)
325 *p = 0;
326
327 p = buf;
328 while(*p) {
329 if (!isdigit(*p))
330 goto out_free;
331 p++;
332 }
333 tmp = strtoul(buf, NULL, 10);
334 *target = tmp;
335out_free:
336 free(buf);
337}
338
339static void prompt_percent(int *target, const char *msg)
340{
341 int tmp = 0;
342
343 prompt_integer(&tmp, msg);
344 if (tmp >= 0 && tmp <= 100)
345 *target = tmp;
346}
347
1758af10 348static void perf_top__prompt_symbol(struct perf_top *top, const char *msg)
923c42c1
MG
349{
350 char *buf = malloc(0), *p;
1758af10 351 struct hist_entry *syme = top->sym_filter_entry, *n, *found = NULL;
4ea062ed 352 struct hists *hists = evsel__hists(top->sym_evsel);
ab81f3fd 353 struct rb_node *next;
923c42c1
MG
354 size_t dummy = 0;
355
356 /* zero counters of active symbol */
357 if (syme) {
923c42c1 358 __zero_source_counters(syme);
1758af10 359 top->sym_filter_entry = NULL;
923c42c1
MG
360 }
361
362 fprintf(stdout, "\n%s: ", msg);
363 if (getline(&buf, &dummy, stdin) < 0)
364 goto out_free;
365
366 p = strchr(buf, '\n');
367 if (p)
368 *p = 0;
369
2eb3d689 370 next = rb_first_cached(&hists->entries);
ab81f3fd
ACM
371 while (next) {
372 n = rb_entry(next, struct hist_entry, rb_node);
373 if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
374 found = n;
923c42c1
MG
375 break;
376 }
ab81f3fd 377 next = rb_next(&n->rb_node);
923c42c1
MG
378 }
379
380 if (!found) {
66aeb6d5 381 fprintf(stderr, "Sorry, %s is not active.\n", buf);
923c42c1 382 sleep(1);
923c42c1 383 } else
1758af10 384 perf_top__parse_source(top, found);
923c42c1
MG
385
386out_free:
387 free(buf);
388}
389
1758af10 390static void perf_top__print_mapped_keys(struct perf_top *top)
923c42c1 391{
091bd2e9
MG
392 char *name = NULL;
393
1758af10
ACM
394 if (top->sym_filter_entry) {
395 struct symbol *sym = top->sym_filter_entry->ms.sym;
091bd2e9
MG
396 name = sym->name;
397 }
398
399 fprintf(stdout, "\nMapped keys:\n");
1758af10
ACM
400 fprintf(stdout, "\t[d] display refresh delay. \t(%d)\n", top->delay_secs);
401 fprintf(stdout, "\t[e] display entries (lines). \t(%d)\n", top->print_entries);
091bd2e9 402
1758af10 403 if (top->evlist->nr_entries > 1)
7289f83c 404 fprintf(stdout, "\t[E] active event counter. \t(%s)\n", perf_evsel__name(top->sym_evsel));
091bd2e9 405
1758af10 406 fprintf(stdout, "\t[f] profile display filter (count). \t(%d)\n", top->count_filter);
091bd2e9 407
982d410b 408 fprintf(stdout, "\t[F] annotate display filter (percent). \t(%d%%)\n", top->annotation_opts.min_pcnt);
6cff0e8d
KS
409 fprintf(stdout, "\t[s] annotate symbol. \t(%s)\n", name?: "NULL");
410 fprintf(stdout, "\t[S] stop annotation.\n");
091bd2e9 411
8ffcda17 412 fprintf(stdout,
8fce3743 413 "\t[K] hide kernel symbols. \t(%s)\n",
1758af10 414 top->hide_kernel_symbols ? "yes" : "no");
8ffcda17
ACM
415 fprintf(stdout,
416 "\t[U] hide user symbols. \t(%s)\n",
1758af10
ACM
417 top->hide_user_symbols ? "yes" : "no");
418 fprintf(stdout, "\t[z] toggle sample zeroing. \t(%d)\n", top->zero ? 1 : 0);
091bd2e9
MG
419 fprintf(stdout, "\t[qQ] quit.\n");
420}
421
1758af10 422static int perf_top__key_mapped(struct perf_top *top, int c)
091bd2e9
MG
423{
424 switch (c) {
425 case 'd':
426 case 'e':
427 case 'f':
428 case 'z':
429 case 'q':
430 case 'Q':
8ffcda17
ACM
431 case 'K':
432 case 'U':
6cff0e8d
KS
433 case 'F':
434 case 's':
435 case 'S':
091bd2e9
MG
436 return 1;
437 case 'E':
1758af10 438 return top->evlist->nr_entries > 1 ? 1 : 0;
83a0944f
IM
439 default:
440 break;
091bd2e9
MG
441 }
442
443 return 0;
923c42c1
MG
444}
445
11859e82 446static bool perf_top__handle_keypress(struct perf_top *top, int c)
923c42c1 447{
11859e82
ACM
448 bool ret = true;
449
1758af10 450 if (!perf_top__key_mapped(top, c)) {
091bd2e9 451 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
3969cc09 452 struct termios save;
091bd2e9 453
1758af10 454 perf_top__print_mapped_keys(top);
091bd2e9
MG
455 fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
456 fflush(stdout);
457
3969cc09 458 set_term_quiet_input(&save);
091bd2e9
MG
459
460 poll(&stdin_poll, 1, -1);
461 c = getc(stdin);
462
463 tcsetattr(0, TCSAFLUSH, &save);
1758af10 464 if (!perf_top__key_mapped(top, c))
11859e82 465 return ret;
091bd2e9
MG
466 }
467
923c42c1
MG
468 switch (c) {
469 case 'd':
1758af10
ACM
470 prompt_integer(&top->delay_secs, "Enter display delay");
471 if (top->delay_secs < 1)
472 top->delay_secs = 1;
923c42c1
MG
473 break;
474 case 'e':
1758af10
ACM
475 prompt_integer(&top->print_entries, "Enter display entries (lines)");
476 if (top->print_entries == 0) {
b135e5ee 477 perf_top__resize(top);
244a1086 478 signal(SIGWINCH, winch_sig);
509605db 479 } else {
3b6ed988 480 signal(SIGWINCH, SIG_DFL);
509605db 481 }
923c42c1
MG
482 break;
483 case 'E':
1758af10 484 if (top->evlist->nr_entries > 1) {
ce2d17ca
AN
485 /* Select 0 as the default event: */
486 int counter = 0;
487
923c42c1 488 fprintf(stderr, "\nAvailable events:");
69aad6f1 489
e5cadb93 490 evlist__for_each_entry(top->evlist, top->sym_evsel)
7289f83c 491 fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
923c42c1 492
ec52d976 493 prompt_integer(&counter, "Enter details event counter");
923c42c1 494
1758af10 495 if (counter >= top->evlist->nr_entries) {
0c21f736 496 top->sym_evsel = perf_evlist__first(top->evlist);
7289f83c 497 fprintf(stderr, "Sorry, no such event, using %s.\n", perf_evsel__name(top->sym_evsel));
923c42c1 498 sleep(1);
69aad6f1 499 break;
923c42c1 500 }
e5cadb93 501 evlist__for_each_entry(top->evlist, top->sym_evsel)
1758af10 502 if (top->sym_evsel->idx == counter)
69aad6f1 503 break;
ec52d976 504 } else
0c21f736 505 top->sym_evsel = perf_evlist__first(top->evlist);
923c42c1
MG
506 break;
507 case 'f':
1758af10 508 prompt_integer(&top->count_filter, "Enter display event count filter");
923c42c1
MG
509 break;
510 case 'F':
982d410b 511 prompt_percent(&top->annotation_opts.min_pcnt,
1758af10 512 "Enter details display event filter (percent)");
923c42c1 513 break;
8ffcda17 514 case 'K':
1758af10 515 top->hide_kernel_symbols = !top->hide_kernel_symbols;
8ffcda17 516 break;
923c42c1
MG
517 case 'q':
518 case 'Q':
519 printf("exiting.\n");
1758af10
ACM
520 if (top->dump_symtab)
521 perf_session__fprintf_dsos(top->session, stderr);
11859e82
ACM
522 ret = false;
523 break;
923c42c1 524 case 's':
1758af10 525 perf_top__prompt_symbol(top, "Enter details symbol");
923c42c1
MG
526 break;
527 case 'S':
1758af10 528 if (!top->sym_filter_entry)
923c42c1
MG
529 break;
530 else {
1758af10 531 struct hist_entry *syme = top->sym_filter_entry;
923c42c1 532
1758af10 533 top->sym_filter_entry = NULL;
923c42c1 534 __zero_source_counters(syme);
923c42c1
MG
535 }
536 break;
8ffcda17 537 case 'U':
1758af10 538 top->hide_user_symbols = !top->hide_user_symbols;
8ffcda17 539 break;
923c42c1 540 case 'z':
1758af10 541 top->zero = !top->zero;
923c42c1 542 break;
83a0944f
IM
543 default:
544 break;
923c42c1 545 }
11859e82
ACM
546
547 return ret;
923c42c1
MG
548}
549
ab81f3fd
ACM
550static void perf_top__sort_new_samples(void *arg)
551{
552 struct perf_top *t = arg;
452ce03b 553 struct perf_evsel *evsel = t->sym_evsel;
4ea062ed
ACM
554 struct hists *hists;
555
ab81f3fd
ACM
556 if (t->evlist->selected != NULL)
557 t->sym_evsel = t->evlist->selected;
558
452ce03b 559 hists = evsel__hists(evsel);
4ea062ed 560
5d484f99
ACM
561 if (t->evlist->enabled) {
562 if (t->zero) {
563 hists__delete_entries(hists);
564 } else {
565 hists__decay_entries(hists, t->hide_user_symbols,
566 t->hide_kernel_symbols);
567 }
701937bd
NK
568 }
569
4ea062ed 570 hists__collapse_resort(hists, NULL);
452ce03b 571 perf_evsel__output_resort(evsel, NULL);
254de74c 572
d8590430 573 if (t->lost || t->drop)
254de74c 574 pr_warning("Too slow to read ring buffer (change period (-c/-F) or limit CPUs (-C)\n");
ab81f3fd
ACM
575}
576
c94cef4b
JO
577static void stop_top(void)
578{
579 session_done = 1;
580 done = 1;
581}
582
1758af10 583static void *display_thread_tui(void *arg)
c0443df1 584{
0d37aa34 585 struct perf_evsel *pos;
1758af10 586 struct perf_top *top = arg;
ab81f3fd 587 const char *help = "For a higher level overview, try: perf top --sort comm,dso";
9783adf7
NK
588 struct hist_browser_timer hbt = {
589 .timer = perf_top__sort_new_samples,
590 .arg = top,
591 .refresh = top->delay_secs,
592 };
ab81f3fd 593
868a8329
KJ
594 /* In order to read symbols from other namespaces perf to needs to call
595 * setns(2). This isn't permitted if the struct_fs has multiple users.
596 * unshare(2) the fs so that we may continue to setns into namespaces
597 * that we're observing.
598 */
599 unshare(CLONE_FS);
600
1758af10 601 perf_top__sort_new_samples(top);
0d37aa34
ACM
602
603 /*
604 * Initialize the uid_filter_str, in the future the TUI will allow
adba1634 605 * Zooming in/out UIDs. For now just use whatever the user passed
0d37aa34
ACM
606 * via --uid.
607 */
e5cadb93 608 evlist__for_each_entry(top->evlist, pos) {
4ea062ed
ACM
609 struct hists *hists = evsel__hists(pos);
610 hists->uid_filter_str = top->record_opts.target.uid_str;
611 }
0d37aa34 612
13d1e536
NK
613 perf_evlist__tui_browse_hists(top->evlist, help, &hbt,
614 top->min_percent,
a1ff5b05 615 &top->session->header.env,
cd0cccba
ACM
616 !top->record_opts.overwrite,
617 &top->annotation_opts);
ab81f3fd 618
c94cef4b 619 stop_top();
c0443df1
ACM
620 return NULL;
621}
622
4a1a9971
JO
623static void display_sig(int sig __maybe_unused)
624{
c94cef4b 625 stop_top();
4a1a9971
JO
626}
627
628static void display_setup_sig(void)
629{
09f4d78a
ACM
630 signal(SIGSEGV, sighandler_dump_stack);
631 signal(SIGFPE, sighandler_dump_stack);
4a1a9971
JO
632 signal(SIGINT, display_sig);
633 signal(SIGQUIT, display_sig);
634 signal(SIGTERM, display_sig);
635}
636
1758af10 637static void *display_thread(void *arg)
07800601 638{
0f5486b5 639 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
9398c484 640 struct termios save;
1758af10 641 struct perf_top *top = arg;
923c42c1
MG
642 int delay_msecs, c;
643
868a8329
KJ
644 /* In order to read symbols from other namespaces perf to needs to call
645 * setns(2). This isn't permitted if the struct_fs has multiple users.
646 * unshare(2) the fs so that we may continue to setns into namespaces
647 * that we're observing.
648 */
649 unshare(CLONE_FS);
650
4a1a9971 651 display_setup_sig();
3af6e338 652 pthread__unblock_sigwinch();
923c42c1 653repeat:
b9c4b0f4 654 delay_msecs = top->delay_secs * MSEC_PER_SEC;
9398c484 655 set_term_quiet_input(&save);
923c42c1
MG
656 /* trash return*/
657 getc(stdin);
07800601 658
11859e82 659 while (!done) {
1758af10 660 perf_top__print_sym_table(top);
3af6e338
ACM
661 /*
662 * Either timeout expired or we got an EINTR due to SIGWINCH,
663 * refresh screen in both cases.
664 */
665 switch (poll(&stdin_poll, 1, delay_msecs)) {
666 case 0:
667 continue;
668 case -1:
669 if (errno == EINTR)
670 continue;
7b0214b7 671 __fallthrough;
3af6e338 672 default:
11859e82
ACM
673 c = getc(stdin);
674 tcsetattr(0, TCSAFLUSH, &save);
675
676 if (perf_top__handle_keypress(top, c))
677 goto repeat;
c94cef4b 678 stop_top();
3af6e338
ACM
679 }
680 }
07800601 681
4a1a9971 682 tcsetattr(0, TCSAFLUSH, &save);
07800601
IM
683 return NULL;
684}
685
7c50391f
NK
686static int hist_iter__top_callback(struct hist_entry_iter *iter,
687 struct addr_location *al, bool single,
688 void *arg)
689{
690 struct perf_top *top = arg;
691 struct hist_entry *he = iter->he;
692 struct perf_evsel *evsel = iter->evsel;
693
2e0453af 694 if (perf_hpp_list.sym && single)
e345f3bd 695 perf_top__record_precise_ip(top, he, iter->sample, evsel, al->addr);
7c50391f 696
a18b027e
AK
697 hist__account_cycles(iter->sample->branch_stack, al, iter->sample,
698 !(top->record_opts.branch_stack & PERF_SAMPLE_BRANCH_ANY));
7c50391f
NK
699 return 0;
700}
701
1758af10
ACM
702static void perf_event__process_sample(struct perf_tool *tool,
703 const union perf_event *event,
7b27509f 704 struct perf_evsel *evsel,
8115d60c 705 struct perf_sample *sample,
743eb868 706 struct machine *machine)
07800601 707{
1758af10 708 struct perf_top *top = container_of(tool, struct perf_top, tool);
1ed091c4 709 struct addr_location al;
19d4ac3c 710 int err;
5b2bb75a 711
23346f21 712 if (!machine && perf_guest) {
6b118e92
DA
713 static struct intlist *seen;
714
715 if (!seen)
ffe0fb76 716 seen = intlist__new(NULL);
6b118e92 717
ef89325f 718 if (!intlist__has_entry(seen, sample->pid)) {
6b118e92 719 pr_err("Can't find guest [%d]'s kernel information\n",
ef89325f
AH
720 sample->pid);
721 intlist__add(seen, sample->pid);
6b118e92 722 }
a1645ce1
ZY
723 return;
724 }
725
0c095715 726 if (!machine) {
11859e82 727 pr_err("%u unprocessable samples recorded.\r",
75be989a 728 top->session->evlist->stats.nr_unprocessable_samples++);
0c095715
JR
729 return;
730 }
731
8115d60c 732 if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
1758af10 733 top->exact_samples++;
1676b8a0 734
bb3eb566 735 if (machine__resolve(machine, &al, sample) < 0)
1ed091c4 736 return;
07800601 737
e77a0742 738 if (!machine->kptr_restrict_warned &&
5f6f5580
ACM
739 symbol_conf.kptr_restrict &&
740 al.cpumode == PERF_RECORD_MISC_KERNEL) {
b89a5124
ACM
741 if (!perf_evlist__exclude_kernel(top->session->evlist)) {
742 ui__warning(
5f6f5580
ACM
743"Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
744"Check /proc/sys/kernel/kptr_restrict.\n\n"
745"Kernel%s samples will not be resolved.\n",
e94b861a 746 al.map && map__has_symbols(al.map) ?
5f6f5580 747 " modules" : "");
b89a5124
ACM
748 if (use_browser <= 0)
749 sleep(5);
750 }
e77a0742 751 machine->kptr_restrict_warned = true;
5f6f5580
ACM
752 }
753
68766bfa 754 if (al.sym == NULL && al.map != NULL) {
e4a338d0 755 const char *msg = "Kernel samples will not be resolved.\n";
72b8fa17
ACM
756 /*
757 * As we do lazy loading of symtabs we only will know if the
758 * specified vmlinux file is invalid when we actually have a
759 * hit in kernel space and then try to load it. So if we get
760 * here and there are _no_ symbols in the DSO backing the
761 * kernel map, bail out.
762 *
763 * We may never get here, for instance, if we use -K/
764 * --hide-kernel-symbols, even if the user specifies an
765 * invalid --vmlinux ;-)
766 */
e77a0742 767 if (!machine->kptr_restrict_warned && !top->vmlinux_warned &&
e94b861a 768 __map__is_kernel(al.map) && map__has_symbols(al.map)) {
e4a338d0 769 if (symbol_conf.vmlinux_name) {
18425f13
ACM
770 char serr[256];
771 dso__strerror_load(al.map->dso, serr, sizeof(serr));
772 ui__warning("The %s file can't be used: %s\n%s",
773 symbol_conf.vmlinux_name, serr, msg);
e4a338d0
ACM
774 } else {
775 ui__warning("A vmlinux file was not found.\n%s",
776 msg);
777 }
778
779 if (use_browser <= 0)
780 sleep(5);
1758af10 781 top->vmlinux_warned = true;
72b8fa17 782 }
6cff0e8d
KS
783 }
784
b55cc4ed 785 if (al.sym == NULL || !al.sym->idle) {
4ea062ed 786 struct hists *hists = evsel__hists(evsel);
7c50391f 787 struct hist_entry_iter iter = {
063bd936
NK
788 .evsel = evsel,
789 .sample = sample,
790 .add_entry_cb = hist_iter__top_callback,
7c50391f 791 };
70db7533 792
7c50391f
NK
793 if (symbol_conf.cumulate_callchain)
794 iter.ops = &hist_iter_cumulative;
795 else
796 iter.ops = &hist_iter_normal;
19d4ac3c 797
4ea062ed 798 pthread_mutex_lock(&hists->lock);
ab81f3fd 799
063bd936 800 err = hist_entry_iter__add(&iter, &al, top->max_stack, top);
7c50391f
NK
801 if (err < 0)
802 pr_err("Problem incrementing symbol period, skipping event\n");
19d4ac3c 803
4ea062ed 804 pthread_mutex_unlock(&hists->lock);
5b2bb75a 805 }
ab81f3fd 806
b91fc39f 807 addr_location__put(&al);
07800601
IM
808}
809
d24e3c98
JO
810static void
811perf_top__process_lost(struct perf_top *top, union perf_event *event,
812 struct perf_evsel *evsel)
813{
814 struct hists *hists = evsel__hists(evsel);
815
816 top->lost += event->lost.lost;
817 top->lost_total += event->lost.lost;
818 hists->stats.total_lost += event->lost.lost;
819}
820
821static void
822perf_top__process_lost_samples(struct perf_top *top,
823 union perf_event *event,
824 struct perf_evsel *evsel)
825{
826 struct hists *hists = evsel__hists(evsel);
827
828 top->lost += event->lost_samples.lost;
829 top->lost_total += event->lost_samples.lost;
830 hists->stats.total_lost_samples += event->lost_samples.lost;
831}
832
d63b9f6f
JO
833static u64 last_timestamp;
834
1758af10 835static void perf_top__mmap_read_idx(struct perf_top *top, int idx)
07800601 836{
ebebbf08
KL
837 struct record_opts *opts = &top->record_opts;
838 struct perf_evlist *evlist = top->evlist;
ebebbf08 839 struct perf_mmap *md;
8115d60c 840 union perf_event *event;
07800601 841
ebebbf08 842 md = opts->overwrite ? &evlist->overwrite_mmap[idx] : &evlist->mmap[idx];
b9bae2c8 843 if (perf_mmap__read_init(md) < 0)
ebebbf08
KL
844 return;
845
0019dc87 846 while ((event = perf_mmap__read_event(md)) != NULL) {
16c66bc1 847 int ret;
7b27509f 848
d63b9f6f 849 ret = perf_evlist__parse_sample_timestamp(evlist, event, &last_timestamp);
16c66bc1 850 if (ret && ret != -1)
743eb868 851 break;
743eb868 852
d63b9f6f 853 ret = ordered_events__queue(top->qe.in, event, last_timestamp, 0);
16c66bc1
JO
854 if (ret)
855 break;
94ad6e7e
JO
856
857 perf_mmap__consume(md);
858
859 if (top->qe.rotate) {
860 pthread_mutex_lock(&top->qe.mutex);
861 top->qe.rotate = false;
862 pthread_cond_signal(&top->qe.cond);
863 pthread_mutex_unlock(&top->qe.mutex);
864 }
07800601 865 }
ebebbf08
KL
866
867 perf_mmap__read_done(md);
07800601
IM
868}
869
1758af10 870static void perf_top__mmap_read(struct perf_top *top)
2f01190a 871{
ebebbf08
KL
872 bool overwrite = top->record_opts.overwrite;
873 struct perf_evlist *evlist = top->evlist;
70db7533
ACM
874 int i;
875
ebebbf08
KL
876 if (overwrite)
877 perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_DATA_PENDING);
878
1758af10
ACM
879 for (i = 0; i < top->evlist->nr_mmaps; i++)
880 perf_top__mmap_read_idx(top, i);
ebebbf08
KL
881
882 if (overwrite) {
883 perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
884 perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_RUNNING);
885 }
2f01190a
FW
886}
887
63878a53
KL
888/*
889 * Check per-event overwrite term.
890 * perf top should support consistent term for all events.
891 * - All events don't have per-event term
892 * E.g. "cpu/cpu-cycles/,cpu/instructions/"
893 * Nothing change, return 0.
894 * - All events have same per-event term
895 * E.g. "cpu/cpu-cycles,no-overwrite/,cpu/instructions,no-overwrite/
896 * Using the per-event setting to replace the opts->overwrite if
897 * they are different, then return 0.
898 * - Events have different per-event term
899 * E.g. "cpu/cpu-cycles,overwrite/,cpu/instructions,no-overwrite/"
900 * Return -1
901 * - Some of the event set per-event term, but some not.
902 * E.g. "cpu/cpu-cycles/,cpu/instructions,no-overwrite/"
903 * Return -1
904 */
905static int perf_top__overwrite_check(struct perf_top *top)
906{
907 struct record_opts *opts = &top->record_opts;
908 struct perf_evlist *evlist = top->evlist;
909 struct perf_evsel_config_term *term;
910 struct list_head *config_terms;
911 struct perf_evsel *evsel;
912 int set, overwrite = -1;
913
914 evlist__for_each_entry(evlist, evsel) {
915 set = -1;
916 config_terms = &evsel->config_terms;
917 list_for_each_entry(term, config_terms, list) {
918 if (term->type == PERF_EVSEL__CONFIG_TERM_OVERWRITE)
919 set = term->val.overwrite ? 1 : 0;
920 }
921
922 /* no term for current and previous event (likely) */
923 if ((overwrite < 0) && (set < 0))
924 continue;
925
926 /* has term for both current and previous event, compare */
927 if ((overwrite >= 0) && (set >= 0) && (overwrite != set))
928 return -1;
929
930 /* no term for current event but has term for previous one */
931 if ((overwrite >= 0) && (set < 0))
932 return -1;
933
934 /* has term for current event */
935 if ((overwrite < 0) && (set >= 0)) {
936 /* if it's first event, set overwrite */
937 if (evsel == perf_evlist__first(evlist))
938 overwrite = set;
939 else
940 return -1;
941 }
942 }
943
944 if ((overwrite >= 0) && (opts->overwrite != overwrite))
945 opts->overwrite = overwrite;
946
947 return 0;
948}
949
204721d7
KL
950static int perf_top_overwrite_fallback(struct perf_top *top,
951 struct perf_evsel *evsel)
952{
953 struct record_opts *opts = &top->record_opts;
954 struct perf_evlist *evlist = top->evlist;
955 struct perf_evsel *counter;
956
957 if (!opts->overwrite)
958 return 0;
959
960 /* only fall back when first event fails */
961 if (evsel != perf_evlist__first(evlist))
962 return 0;
963
964 evlist__for_each_entry(evlist, counter)
965 counter->attr.write_backward = false;
966 opts->overwrite = false;
853745f5 967 pr_debug2("fall back to non-overwrite mode\n");
204721d7
KL
968 return 1;
969}
970
11859e82 971static int perf_top__start_counters(struct perf_top *top)
72cb7013 972{
d6195a6a 973 char msg[BUFSIZ];
6a4bb04c 974 struct perf_evsel *counter;
1758af10 975 struct perf_evlist *evlist = top->evlist;
b4006796 976 struct record_opts *opts = &top->record_opts;
727ab04e 977
63878a53
KL
978 if (perf_top__overwrite_check(top)) {
979 ui__error("perf top only support consistent per-event "
980 "overwrite setting for all events\n");
981 goto out_err;
982 }
983
e68ae9cf 984 perf_evlist__config(evlist, opts, &callchain_param);
7e4ff9e3 985
e5cadb93 986 evlist__for_each_entry(evlist, counter) {
72cb7013 987try_again:
1758af10 988 if (perf_evsel__open(counter, top->evlist->cpus,
6a4bb04c 989 top->evlist->threads) < 0) {
204721d7
KL
990
991 /*
992 * Specially handle overwrite fall back.
993 * Because perf top is the only tool which has
994 * overwrite mode by default, support
995 * both overwrite and non-overwrite mode, and
996 * require consistent mode for all events.
997 *
998 * May move it to generic code with more tools
999 * have similar attribute.
1000 */
1001 if (perf_missing_features.write_backward &&
1002 perf_top_overwrite_fallback(top, counter))
1003 goto try_again;
1004
56e52e85 1005 if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
bb963e16 1006 if (verbose > 0)
c0a54341 1007 ui__warning("%s\n", msg);
d6d901c2
ZY
1008 goto try_again;
1009 }
c286c419 1010
56e52e85
ACM
1011 perf_evsel__open_strerror(counter, &opts->target,
1012 errno, msg, sizeof(msg));
1013 ui__error("%s\n", msg);
c286c419 1014 goto out_err;
d6d901c2 1015 }
716c69fe 1016 }
70db7533 1017
f74b9d3a 1018 if (perf_evlist__mmap(evlist, opts->mmap_pages) < 0) {
3780f488 1019 ui__error("Failed to mmap with %d (%s)\n",
c8b5f2c9 1020 errno, str_error_r(errno, msg, sizeof(msg)));
c286c419
ACM
1021 goto out_err;
1022 }
1023
11859e82 1024 return 0;
c286c419
ACM
1025
1026out_err:
11859e82 1027 return -1;
716c69fe
IM
1028}
1029
e3815264 1030static int callchain_param__setup_sample_type(struct callchain_param *callchain)
19d4ac3c 1031{
f2e14cd2 1032 if (callchain->mode != CHAIN_NONE) {
e3815264 1033 if (callchain_register_param(callchain) < 0) {
3780f488 1034 ui__error("Can't register callchain params.\n");
19d4ac3c
ACM
1035 return -EINVAL;
1036 }
1037 }
1038
1039 return 0;
1040}
1041
16c66bc1
JO
1042static struct ordered_events *rotate_queues(struct perf_top *top)
1043{
1044 struct ordered_events *in = top->qe.in;
1045
1046 if (top->qe.in == &top->qe.data[1])
1047 top->qe.in = &top->qe.data[0];
1048 else
1049 top->qe.in = &top->qe.data[1];
1050
1051 return in;
1052}
1053
1054static void *process_thread(void *arg)
1055{
1056 struct perf_top *top = arg;
1057
1058 while (!done) {
1059 struct ordered_events *out, *in = top->qe.in;
1060
1061 if (!in->nr_events) {
1062 usleep(100);
1063 continue;
1064 }
1065
16c66bc1 1066 out = rotate_queues(top);
94ad6e7e
JO
1067
1068 pthread_mutex_lock(&top->qe.mutex);
1069 top->qe.rotate = true;
1070 pthread_cond_wait(&top->qe.cond, &top->qe.mutex);
1071 pthread_mutex_unlock(&top->qe.mutex);
16c66bc1
JO
1072
1073 if (ordered_events__flush(out, OE_FLUSH__TOP))
1074 pr_err("failed to process events\n");
1075 }
1076
1077 return NULL;
1078}
1079
d63b9f6f
JO
1080/*
1081 * Allow only 'top->delay_secs' seconds behind samples.
1082 */
1083static int should_drop(struct ordered_event *qevent, struct perf_top *top)
1084{
1085 union perf_event *event = qevent->event;
1086 u64 delay_timestamp;
1087
1088 if (event->header.type != PERF_RECORD_SAMPLE)
1089 return false;
1090
1091 delay_timestamp = qevent->timestamp + top->delay_secs * NSEC_PER_SEC;
1092 return delay_timestamp < last_timestamp;
1093}
1094
16c66bc1
JO
1095static int deliver_event(struct ordered_events *qe,
1096 struct ordered_event *qevent)
1097{
1098 struct perf_top *top = qe->data;
1099 struct perf_evlist *evlist = top->evlist;
1100 struct perf_session *session = top->session;
1101 union perf_event *event = qevent->event;
1102 struct perf_sample sample;
1103 struct perf_evsel *evsel;
1104 struct machine *machine;
1105 int ret = -1;
1106
97f7e0b3
JO
1107 if (should_drop(qevent, top)) {
1108 top->drop++;
1109 top->drop_total++;
d63b9f6f 1110 return 0;
97f7e0b3 1111 }
d63b9f6f 1112
16c66bc1
JO
1113 ret = perf_evlist__parse_sample(evlist, event, &sample);
1114 if (ret) {
1115 pr_err("Can't parse sample, err = %d\n", ret);
1116 goto next_event;
1117 }
1118
1119 evsel = perf_evlist__id2evsel(session->evlist, sample.id);
1120 assert(evsel != NULL);
1121
1122 if (event->header.type == PERF_RECORD_SAMPLE)
1123 ++top->samples;
1124
1125 switch (sample.cpumode) {
1126 case PERF_RECORD_MISC_USER:
1127 ++top->us_samples;
1128 if (top->hide_user_symbols)
1129 goto next_event;
1130 machine = &session->machines.host;
1131 break;
1132 case PERF_RECORD_MISC_KERNEL:
1133 ++top->kernel_samples;
1134 if (top->hide_kernel_symbols)
1135 goto next_event;
1136 machine = &session->machines.host;
1137 break;
1138 case PERF_RECORD_MISC_GUEST_KERNEL:
1139 ++top->guest_kernel_samples;
1140 machine = perf_session__find_machine(session,
1141 sample.pid);
1142 break;
1143 case PERF_RECORD_MISC_GUEST_USER:
1144 ++top->guest_us_samples;
1145 /*
1146 * TODO: we don't process guest user from host side
1147 * except simple counting.
1148 */
1149 goto next_event;
1150 default:
1151 if (event->header.type == PERF_RECORD_SAMPLE)
1152 goto next_event;
1153 machine = &session->machines.host;
1154 break;
1155 }
1156
1157 if (event->header.type == PERF_RECORD_SAMPLE) {
1158 perf_event__process_sample(&top->tool, event, evsel,
1159 &sample, machine);
1160 } else if (event->header.type == PERF_RECORD_LOST) {
1161 perf_top__process_lost(top, event, evsel);
1162 } else if (event->header.type == PERF_RECORD_LOST_SAMPLES) {
1163 perf_top__process_lost_samples(top, event, evsel);
1164 } else if (event->header.type < PERF_RECORD_MAX) {
1165 hists__inc_nr_events(evsel__hists(evsel), event->header.type);
1166 machine__process_event(machine, event, &sample);
1167 } else
1168 ++session->evlist->stats.nr_unknown_events;
1169
1170 ret = 0;
1171next_event:
1172 return ret;
1173}
1174
1175static void init_process_thread(struct perf_top *top)
1176{
1177 ordered_events__init(&top->qe.data[0], deliver_event, top);
1178 ordered_events__init(&top->qe.data[1], deliver_event, top);
1179 ordered_events__set_copy_on_queue(&top->qe.data[0], true);
1180 ordered_events__set_copy_on_queue(&top->qe.data[1], true);
1181 top->qe.in = &top->qe.data[0];
94ad6e7e
JO
1182 pthread_mutex_init(&top->qe.mutex, NULL);
1183 pthread_cond_init(&top->qe.cond, NULL);
16c66bc1
JO
1184}
1185
1758af10 1186static int __cmd_top(struct perf_top *top)
716c69fe 1187{
b4006796 1188 struct record_opts *opts = &top->record_opts;
16c66bc1 1189 pthread_t thread, thread_process;
19d4ac3c 1190 int ret;
f5fc1412 1191
6a4d98d7 1192 top->session = perf_session__new(NULL, false, NULL);
1758af10 1193 if (top->session == NULL)
52e02834 1194 return -1;
07800601 1195
f178fd2d
ACM
1196 if (!top->annotation_opts.objdump_path) {
1197 ret = perf_env__lookup_objdump(&top->session->header.env,
1198 &top->annotation_opts.objdump_path);
0d3942db
SB
1199 if (ret)
1200 goto out_delete;
1201 }
1202
e3815264 1203 ret = callchain_param__setup_sample_type(&callchain_param);
19d4ac3c
ACM
1204 if (ret)
1205 goto out_delete;
1206
9d8b172f 1207 if (perf_session__register_idle_thread(top->session) < 0)
c53d138d
NK
1208 goto out_delete;
1209
0c6b4994
KL
1210 if (top->nr_threads_synthesize > 1)
1211 perf_set_multithreaded();
340b47f5 1212
16c66bc1
JO
1213 init_process_thread(top);
1214
a40b95bc
ACM
1215 ret = perf_event__synthesize_bpf_events(&top->tool, perf_event__process,
1216 &top->session->machines.host,
1217 &top->record_opts);
1218 if (ret < 0)
1219 pr_warning("Couldn't synthesize bpf events.\n");
1220
a33fbd56 1221 machine__synthesize_threads(&top->session->machines.host, &opts->target,
340b47f5 1222 top->evlist->threads, false,
0c6b4994 1223 top->nr_threads_synthesize);
340b47f5 1224
0c6b4994
KL
1225 if (top->nr_threads_synthesize > 1)
1226 perf_set_singlethreaded();
2e7ea3ab 1227
35a634f7 1228 if (perf_hpp_list.socket) {
2e7ea3ab
KL
1229 ret = perf_env__read_cpu_topology_map(&perf_env);
1230 if (ret < 0)
1231 goto out_err_cpu_topo;
1232 }
1233
11859e82
ACM
1234 ret = perf_top__start_counters(top);
1235 if (ret)
1236 goto out_delete;
1237
1758af10 1238 top->session->evlist = top->evlist;
7b56cce2 1239 perf_session__set_id_hdr_size(top->session);
07800601 1240
2376c67a
ACM
1241 /*
1242 * When perf is starting the traced process, all the events (apart from
1243 * group members) have enable_on_exec=1 set, so don't spoil it by
1244 * prematurely enabling them.
1245 *
1246 * XXX 'top' still doesn't start workloads like record, trace, but should,
1247 * so leave the check here.
1248 */
602ad878 1249 if (!target__none(&opts->target))
2376c67a
ACM
1250 perf_evlist__enable(top->evlist);
1251
11859e82 1252 ret = -1;
16c66bc1
JO
1253 if (pthread_create(&thread_process, NULL, process_thread, top)) {
1254 ui__error("Could not create process thread.\n");
1255 goto out_delete;
1256 }
1257
c0443df1 1258 if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
1758af10 1259 display_thread), top)) {
3780f488 1260 ui__error("Could not create display thread.\n");
16c66bc1 1261 goto out_join_thread;
07800601
IM
1262 }
1263
1758af10 1264 if (top->realtime_prio) {
07800601
IM
1265 struct sched_param param;
1266
1758af10 1267 param.sched_priority = top->realtime_prio;
07800601 1268 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
3780f488 1269 ui__error("Could not set realtime priority.\n");
ae256fa2 1270 goto out_join;
07800601
IM
1271 }
1272 }
1273
ff27a06a
DM
1274 /* Wait for a minimal set of events before starting the snapshot */
1275 perf_evlist__poll(top->evlist, 100);
1276
1277 perf_top__mmap_read(top);
1278
11859e82 1279 while (!done) {
1758af10 1280 u64 hits = top->samples;
07800601 1281
1758af10 1282 perf_top__mmap_read(top);
07800601 1283
ebebbf08 1284 if (opts->overwrite || (hits == top->samples))
f66a889d 1285 ret = perf_evlist__poll(top->evlist, 100);
b135e5ee
JO
1286
1287 if (resize) {
1288 perf_top__resize(top);
1289 resize = 0;
1290 }
07800601
IM
1291 }
1292
11859e82 1293 ret = 0;
ae256fa2
JO
1294out_join:
1295 pthread_join(thread, NULL);
16c66bc1 1296out_join_thread:
94ad6e7e 1297 pthread_cond_signal(&top->qe.cond);
16c66bc1 1298 pthread_join(thread_process, NULL);
19d4ac3c 1299out_delete:
1758af10
ACM
1300 perf_session__delete(top->session);
1301 top->session = NULL;
19d4ac3c 1302
11859e82 1303 return ret;
2e7ea3ab
KL
1304
1305out_err_cpu_topo: {
1306 char errbuf[BUFSIZ];
c8b5f2c9 1307 const char *err = str_error_r(-ret, errbuf, sizeof(errbuf));
2e7ea3ab
KL
1308
1309 ui__error("Could not read the CPU topology map: %s\n", err);
1310 goto out_delete;
1311}
19d4ac3c
ACM
1312}
1313
1314static int
ae779a63 1315callchain_opt(const struct option *opt, const char *arg, int unset)
19d4ac3c 1316{
19d4ac3c 1317 symbol_conf.use_callchain = true;
ae779a63
JO
1318 return record_callchain_opt(opt, arg, unset);
1319}
19d4ac3c 1320
ae779a63
JO
1321static int
1322parse_callchain_opt(const struct option *opt, const char *arg, int unset)
1323{
2ddd5c04 1324 struct callchain_param *callchain = opt->value;
a2c10d39 1325
2ddd5c04
ACM
1326 callchain->enabled = !unset;
1327 callchain->record_mode = CALLCHAIN_FP;
a2c10d39
NK
1328
1329 /*
1330 * --no-call-graph
1331 */
1332 if (unset) {
1333 symbol_conf.use_callchain = false;
2ddd5c04 1334 callchain->record_mode = CALLCHAIN_NONE;
a2c10d39
NK
1335 return 0;
1336 }
1337
1338 return parse_callchain_top_opt(arg);
07800601 1339}
b456bae0 1340
b8cbb349 1341static int perf_top_config(const char *var, const char *value, void *cb __maybe_unused)
eb853e80 1342{
a3a4a3b3
YX
1343 if (!strcmp(var, "top.call-graph")) {
1344 var = "call-graph.record-mode";
1345 return perf_default_config(var, value, cb);
1346 }
104ac991
NK
1347 if (!strcmp(var, "top.children")) {
1348 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
1349 return 0;
1350 }
eb853e80 1351
b8cbb349 1352 return 0;
eb853e80
JO
1353}
1354
fa5df943
NK
1355static int
1356parse_percent_limit(const struct option *opt, const char *arg,
1357 int unset __maybe_unused)
1358{
1359 struct perf_top *top = opt->value;
1360
1361 top->min_percent = strtof(arg, NULL);
1362 return 0;
1363}
1364
76a26549
NK
1365const char top_callchain_help[] = CALLCHAIN_RECORD_HELP CALLCHAIN_REPORT_HELP
1366 "\n\t\t\t\tDefault: fp,graph,0.5,caller,function";
a2c10d39 1367
b0ad8ea6 1368int cmd_top(int argc, const char **argv)
1758af10 1369{
16ad2ffb 1370 char errbuf[BUFSIZ];
1758af10
ACM
1371 struct perf_top top = {
1372 .count_filter = 5,
1373 .delay_secs = 2,
2376c67a
ACM
1374 .record_opts = {
1375 .mmap_pages = UINT_MAX,
1376 .user_freq = UINT_MAX,
1377 .user_interval = ULLONG_MAX,
1378 .freq = 4000, /* 4 KHz */
5dbb6e81 1379 .target = {
2376c67a
ACM
1380 .uses_mmap = true,
1381 },
218d6111
ACM
1382 /*
1383 * FIXME: This will lose PERF_RECORD_MMAP and other metadata
1384 * when we pause, fix that and reenable. Probably using a
1385 * separate evlist with a dummy event, i.e. a non-overwrite
1386 * ring buffer just for metadata events, while PERF_RECORD_SAMPLE
1387 * stays in overwrite mode. -acme
1388 * */
1389 .overwrite = 0,
16c66bc1 1390 .sample_time = true,
d1cb9fce 1391 },
029c75e5 1392 .max_stack = sysctl__max_stack(),
982d410b 1393 .annotation_opts = annotation__default_options,
0c6b4994 1394 .nr_threads_synthesize = UINT_MAX,
1758af10 1395 };
b4006796 1396 struct record_opts *opts = &top.record_opts;
602ad878 1397 struct target *target = &opts->target;
1758af10 1398 const struct option options[] = {
8c3e10eb 1399 OPT_CALLBACK('e', "event", &top.evlist, "event",
86847b62 1400 "event selector. use 'perf list' to list available events",
f120f9d5 1401 parse_events_option),
2376c67a
ACM
1402 OPT_U64('c', "count", &opts->user_interval, "event period to sample"),
1403 OPT_STRING('p', "pid", &target->pid, "pid",
d6d901c2 1404 "profile events on existing process id"),
2376c67a 1405 OPT_STRING('t', "tid", &target->tid, "tid",
d6d901c2 1406 "profile events on existing thread id"),
2376c67a 1407 OPT_BOOLEAN('a', "all-cpus", &target->system_wide,
b456bae0 1408 "system-wide collection from all CPUs"),
2376c67a 1409 OPT_STRING('C', "cpu", &target->cpu_list, "cpu",
c45c6ea2 1410 "list of cpus to monitor"),
b32d133a
ACM
1411 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1412 "file", "vmlinux pathname"),
fc2be696
WT
1413 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
1414 "don't load vmlinux even if found"),
1b3aae90
ACM
1415 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1416 "file", "kallsyms pathname"),
8c3e10eb 1417 OPT_BOOLEAN('K', "hide_kernel_symbols", &top.hide_kernel_symbols,
8ffcda17 1418 "hide kernel symbols"),
994a1f78
JO
1419 OPT_CALLBACK('m', "mmap-pages", &opts->mmap_pages, "pages",
1420 "number of mmap data pages",
1421 perf_evlist__parse_mmap_pages),
1758af10 1422 OPT_INTEGER('r', "realtime", &top.realtime_prio,
b456bae0 1423 "collect data with this RT SCHED_FIFO priority"),
8c3e10eb 1424 OPT_INTEGER('d', "delay", &top.delay_secs,
b456bae0 1425 "number of seconds to delay between refreshes"),
1758af10 1426 OPT_BOOLEAN('D', "dump-symtab", &top.dump_symtab,
b456bae0 1427 "dump the symbol table used for profiling"),
8c3e10eb 1428 OPT_INTEGER('f', "count-filter", &top.count_filter,
b456bae0 1429 "only display functions with more events than this"),
bf80669e 1430 OPT_BOOLEAN(0, "group", &opts->group,
b456bae0 1431 "put the counters into a counter group"),
2376c67a
ACM
1432 OPT_BOOLEAN('i', "no-inherit", &opts->no_inherit,
1433 "child tasks do not inherit counters"),
1758af10 1434 OPT_STRING(0, "sym-annotate", &top.sym_filter, "symbol name",
6cff0e8d 1435 "symbol to annotate"),
2376c67a 1436 OPT_BOOLEAN('z', "zero", &top.zero, "zero history across updates"),
7831bf23
ACM
1437 OPT_CALLBACK('F', "freq", &top.record_opts, "freq or 'max'",
1438 "profile at this frequency",
1439 record__parse_freq),
8c3e10eb 1440 OPT_INTEGER('E', "entries", &top.print_entries,
6e53cdf1 1441 "display this many functions"),
8c3e10eb 1442 OPT_BOOLEAN('U', "hide_user_symbols", &top.hide_user_symbols,
8ffcda17 1443 "hide user symbols"),
1758af10
ACM
1444 OPT_BOOLEAN(0, "tui", &top.use_tui, "Use the TUI interface"),
1445 OPT_BOOLEAN(0, "stdio", &top.use_stdio, "Use the stdio interface"),
c0555642 1446 OPT_INCR('v', "verbose", &verbose,
3da297a6 1447 "be more verbose (show counter open errors, etc)"),
ab81f3fd 1448 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
a2ce067e
NK
1449 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
1450 " Please refer the man page for the complete list."),
6fe8c26d
NK
1451 OPT_STRING(0, "fields", &field_order, "key[,keys...]",
1452 "output field(s): overhead, period, sample plus all of sort keys"),
ab81f3fd
ACM
1453 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
1454 "Show a column with the number of samples"),
2ddd5c04 1455 OPT_CALLBACK_NOOPT('g', NULL, &callchain_param,
a2c10d39 1456 NULL, "enables call-graph recording and display",
ae779a63 1457 &callchain_opt),
2ddd5c04 1458 OPT_CALLBACK(0, "call-graph", &callchain_param,
76a26549 1459 "record_mode[,record_size],print_type,threshold[,print_limit],order,sort_key[,branch]",
a2c10d39 1460 top_callchain_help, &parse_callchain_opt),
1432ec34
NK
1461 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
1462 "Accumulate callchains of children and show total overhead as well"),
5dbb6e81
WL
1463 OPT_INTEGER(0, "max-stack", &top.max_stack,
1464 "Set the maximum stack depth when parsing the callchain. "
4cb93446 1465 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
b21484f1
GP
1466 OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
1467 "ignore callees of these functions in call graphs",
1468 report_parse_ignore_callees_opt),
ab81f3fd
ACM
1469 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1470 "Show a column with the sum of periods"),
1471 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1472 "only consider symbols in these dsos"),
1473 OPT_STRING(0, "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1474 "only consider symbols in these comms"),
1475 OPT_STRING(0, "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1476 "only consider these symbols"),
1eddd9e4 1477 OPT_BOOLEAN(0, "source", &top.annotation_opts.annotate_src,
64c6f0c7 1478 "Interleave source code with assembly code (default)"),
1eddd9e4 1479 OPT_BOOLEAN(0, "asm-raw", &top.annotation_opts.show_asm_raw,
64c6f0c7 1480 "Display raw encoding of assembly instructions (default)"),
763122ad
AK
1481 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
1482 "Enable kernel symbol demangling"),
f178fd2d 1483 OPT_STRING(0, "objdump", &top.annotation_opts.objdump_path, "path",
0d3942db 1484 "objdump binary to use for disassembly and annotations"),
a47e843e 1485 OPT_STRING('M', "disassembler-style", &top.annotation_opts.disassembler_style, "disassembler style",
64c6f0c7 1486 "Specify disassembler style (e.g. -M intel for intel syntax)"),
2376c67a 1487 OPT_STRING('u', "uid", &target->uid_str, "user", "user to profile"),
fa5df943
NK
1488 OPT_CALLBACK(0, "percent-limit", &top, "percent",
1489 "Don't show entries under that percent", parse_percent_limit),
33db4568
NK
1490 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
1491 "How to display percentage of filtered entries", parse_filter_percentage),
cf59002f
NK
1492 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
1493 "width[,width...]",
1494 "don't try to adjust column width, use these fixed values"),
3fcb10e4 1495 OPT_UINTEGER(0, "proc-map-timeout", &proc_map_timeout,
9d9cad76 1496 "per thread proc mmap processing timeout in ms"),
a18b027e
AK
1497 OPT_CALLBACK_NOOPT('b', "branch-any", &opts->branch_stack,
1498 "branch any", "sample any taken branches",
1499 parse_branch_stack),
1500 OPT_CALLBACK('j', "branch-filter", &opts->branch_stack,
1501 "branch filter mask", "branch stack filter modes",
1502 parse_branch_stack),
053a3989
NK
1503 OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace,
1504 "Show raw trace event output (do not use print fmt or plugins)"),
c92fcfde
NK
1505 OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy,
1506 "Show entries in a hierarchy"),
4e303fbe 1507 OPT_BOOLEAN(0, "overwrite", &top.record_opts.overwrite,
218d6111 1508 "Use a backward ring buffer, default: no"),
868a8329 1509 OPT_BOOLEAN(0, "force", &symbol_conf.force, "don't complain, do it"),
0c6b4994
KL
1510 OPT_UINTEGER(0, "num-thread-synthesize", &top.nr_threads_synthesize,
1511 "number of thread to run event synthesize"),
b456bae0 1512 OPT_END()
1758af10 1513 };
be772842
ACM
1514 const char * const top_usage[] = {
1515 "perf top [<options>]",
1516 NULL
1517 };
a635fc51
ACM
1518 int status = hists__init();
1519
1520 if (status < 0)
1521 return status;
b456bae0 1522
982d410b
ACM
1523 top.annotation_opts.min_pcnt = 5;
1524 top.annotation_opts.context = 4;
1525
334fe7a3 1526 top.evlist = perf_evlist__new();
8c3e10eb 1527 if (top.evlist == NULL)
361c99a6
ACM
1528 return -ENOMEM;
1529
ecc4c561
ACM
1530 status = perf_config(perf_top_config, &top);
1531 if (status)
1532 return status;
eb853e80 1533
b456bae0
IM
1534 argc = parse_options(argc, argv, options, top_usage, 0);
1535 if (argc)
1536 usage_with_options(top_usage, options);
1537
54f8f403
NK
1538 if (!top.evlist->nr_entries &&
1539 perf_evlist__add_default(top.evlist) < 0) {
1540 pr_err("Not enough memory for event selector list\n");
1541 goto out_delete_evlist;
1542 }
1543
c92fcfde
NK
1544 if (symbol_conf.report_hierarchy) {
1545 /* disable incompatible options */
1546 symbol_conf.event_group = false;
1547 symbol_conf.cumulate_callchain = false;
1548
1549 if (field_order) {
1550 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
1551 parse_options_usage(top_usage, options, "fields", 0);
1552 parse_options_usage(NULL, options, "hierarchy", 0);
1553 goto out_delete_evlist;
1554 }
1555 }
1556
590ac60d
JY
1557 if (opts->branch_stack && callchain_param.enabled)
1558 symbol_conf.show_branchflag_count = true;
1559
512ae1bd 1560 sort__mode = SORT_MODE__TOP;
6fe8c26d 1561 /* display thread wants entries to be collapsed in a different tree */
52225036 1562 perf_hpp_list.need_collapse = 1;
ab81f3fd 1563
3ee60c3b
ACM
1564 if (top.use_stdio)
1565 use_browser = 0;
1566 else if (top.use_tui)
1567 use_browser = 1;
1568
1569 setup_browser(false);
1570
40184c46 1571 if (setup_sorting(top.evlist) < 0) {
6fe8c26d
NK
1572 if (sort_order)
1573 parse_options_usage(top_usage, options, "s", 1);
1574 if (field_order)
1575 parse_options_usage(sort_order ? NULL : top_usage,
1576 options, "fields", 0);
d37a92dc
NK
1577 goto out_delete_evlist;
1578 }
ab81f3fd 1579
602ad878 1580 status = target__validate(target);
16ad2ffb 1581 if (status) {
602ad878 1582 target__strerror(target, status, errbuf, BUFSIZ);
ea432a8b 1583 ui__warning("%s\n", errbuf);
16ad2ffb
NK
1584 }
1585
602ad878 1586 status = target__parse_uid(target);
16ad2ffb
NK
1587 if (status) {
1588 int saved_errno = errno;
4bd0f2d2 1589
602ad878 1590 target__strerror(target, status, errbuf, BUFSIZ);
ea432a8b 1591 ui__error("%s\n", errbuf);
16ad2ffb
NK
1592
1593 status = -saved_errno;
0d37aa34 1594 goto out_delete_evlist;
16ad2ffb 1595 }
0d37aa34 1596
602ad878 1597 if (target__none(target))
2376c67a 1598 target->system_wide = true;
10b47d54 1599
f8a5c0b2
ACM
1600 if (perf_evlist__create_maps(top.evlist, target) < 0) {
1601 ui__error("Couldn't create thread/CPU maps: %s\n",
c8b5f2c9 1602 errno == ENOENT ? "No such process" : str_error_r(errno, errbuf, sizeof(errbuf)));
f8a5c0b2 1603 goto out_delete_evlist;
69aad6f1 1604 }
5a8e5a30 1605
8c3e10eb
ACM
1606 if (top.delay_secs < 1)
1607 top.delay_secs = 1;
2f335a02 1608
b4006796 1609 if (record_opts__config(opts)) {
2376c67a 1610 status = -EINVAL;
03ad9747 1611 goto out_delete_evlist;
69aad6f1
ACM
1612 }
1613
0c21f736 1614 top.sym_evsel = perf_evlist__first(top.evlist);
cc841580 1615
e3815264 1616 if (!callchain_param.enabled) {
1432ec34
NK
1617 symbol_conf.cumulate_callchain = false;
1618 perf_hpp__cancel_cumulate();
1619 }
1620
792aeafa
NK
1621 if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
1622 callchain_param.order = ORDER_CALLER;
1623
b01141f4
ACM
1624 status = symbol__annotation_init();
1625 if (status < 0)
1626 goto out_delete_evlist;
69aad6f1 1627
7f0b6fde
ACM
1628 annotation_config__init();
1629
69aad6f1 1630 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
0a7e6d1b 1631 if (symbol__init(NULL) < 0)
69aad6f1
ACM
1632 return -1;
1633
08e71542 1634 sort__setup_elide(stdout);
ab81f3fd 1635
1758af10 1636 get_term_dimensions(&top.winsize);
8c3e10eb 1637 if (top.print_entries == 0) {
1758af10 1638 perf_top__update_print_entries(&top);
244a1086 1639 signal(SIGWINCH, winch_sig);
3b6ed988
ACM
1640 }
1641
1758af10 1642 status = __cmd_top(&top);
806fb630 1643
0d37aa34 1644out_delete_evlist:
8c3e10eb 1645 perf_evlist__delete(top.evlist);
69aad6f1
ACM
1646
1647 return status;
b456bae0 1648}