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