tools/perf/builtin-top.c

   1 /*
   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>
   8  *               2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
   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)
  19  */
  20 #include "builtin.h"
  21
  22 #include "perf.h"
  23
  24 #include "util/annotate.h"
  25 #include "util/cache.h"
  26 #include "util/color.h"
  27 #include "util/evlist.h"
  28 #include "util/evsel.h"
  29 #include "util/machine.h"
  30 #include "util/session.h"
  31 #include "util/symbol.h"
  32 #include "util/thread.h"
  33 #include "util/thread_map.h"
  34 #include "util/top.h"
  35 #include "util/util.h"
  36 #include <linux/rbtree.h>
  37 #include "util/parse-options.h"
  38 #include "util/parse-events.h"
  39 #include "util/cpumap.h"
  40 #include "util/xyarray.h"
  41 #include "util/sort.h"
  42 #include "util/intlist.h"
  43 #include "arch/common.h"
  44
  45 #include "util/debug.h"
  46
  47 #include <assert.h>
  48 #include <elf.h>
  49 #include <fcntl.h>
  50
  51 #include <stdio.h>
  52 #include <termios.h>
  53 #include <unistd.h>
  54 #include <inttypes.h>
  55
  56 #include <errno.h>
  57 #include <time.h>
  58 #include <sched.h>
  59
  60 #include <sys/syscall.h>
  61 #include <sys/ioctl.h>
  62 #include <sys/poll.h>
  63 #include <sys/prctl.h>
  64 #include <sys/wait.h>
  65 #include <sys/uio.h>
  66 #include <sys/utsname.h>
  67 #include <sys/mman.h>
  68
  69 #include <linux/unistd.h>
  70 #include <linux/types.h>
  71
  72 static volatile int done;
  73
  74 #define HEADER_LINE_NR  5
  75
  76 static void perf_top__update_print_entries(struct perf_top *top)
  77 {
  78         top->print_entries = top->winsize.ws_row - HEADER_LINE_NR;
  79 }
  80
  81 static void perf_top__sig_winch(int sig __maybe_unused,
  82                                 siginfo_t *info __maybe_unused, void *arg)
  83 {
  84         struct perf_top *top = arg;
  85
  86         get_term_dimensions(&top->winsize);
  87         perf_top__update_print_entries(top);
  88 }
  89
  90 static int perf_top__parse_source(struct perf_top *top, struct hist_entry *he)
  91 {
  92         struct symbol *sym;
  93         struct annotation *notes;
  94         struct map *map;
  95         int err = -1;
  96
  97         if (!he || !he->ms.sym)
  98                 return -1;
  99
 100         sym = he->ms.sym;
 101         map = he->ms.map;
 102
 103         /*
 104          * We can't annotate with just /proc/kallsyms
 105          */
 106         if (map->dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
 107             !dso__is_kcore(map->dso)) {
 108                 pr_err("Can't annotate %s: No vmlinux file was found in the "
 109                        "path\n", sym->name);
 110                 sleep(1);
 111                 return -1;
 112         }
 113
 114         notes = symbol__annotation(sym);
 115         if (notes->src != NULL) {
 116                 pthread_mutex_lock(&notes->lock);
 117                 goto out_assign;
 118         }
 119
 120         pthread_mutex_lock(&notes->lock);
 121
 122         if (symbol__alloc_hist(sym) < 0) {
 123                 pthread_mutex_unlock(&notes->lock);
 124                 pr_err("Not enough memory for annotating '%s' symbol!\n",
 125                        sym->name);
 126                 sleep(1);
 127                 return err;
 128         }
 129
 130         err = symbol__annotate(sym, map, 0);
 131         if (err == 0) {
 132 out_assign:
 133                 top->sym_filter_entry = he;
 134         }
 135
 136         pthread_mutex_unlock(&notes->lock);
 137         return err;
 138 }
 139
 140 static void __zero_source_counters(struct hist_entry *he)
 141 {
 142         struct symbol *sym = he->ms.sym;
 143         symbol__annotate_zero_histograms(sym);
 144 }
 145
 146 static void ui__warn_map_erange(struct map *map, struct symbol *sym, u64 ip)
 147 {
 148         struct utsname uts;
 149         int err = uname(&uts);
 150
 151         ui__warning("Out of bounds address found:\n\n"
 152                     "Addr:   %" PRIx64 "\n"
 153                     "DSO:    %s %c\n"
 154                     "Map:    %" PRIx64 "-%" PRIx64 "\n"
 155                     "Symbol: %" PRIx64 "-%" PRIx64 " %c %s\n"
 156                     "Arch:   %s\n"
 157                     "Kernel: %s\n"
 158                     "Tools:  %s\n\n"
 159                     "Not all samples will be on the annotation output.\n\n"
 160                     "Please report to linux-kernel@vger.kernel.org\n",
 161                     ip, map->dso->long_name, dso__symtab_origin(map->dso),
 162                     map->start, map->end, sym->start, sym->end,
 163                     sym->binding == STB_GLOBAL ? 'g' :
 164                     sym->binding == STB_LOCAL  ? 'l' : 'w', sym->name,
 165                     err ? "[unknown]" : uts.machine,
 166                     err ? "[unknown]" : uts.release, perf_version_string);
 167         if (use_browser <= 0)
 168                 sleep(5);
 169
 170         map->erange_warned = true;
 171 }
 172
 173 static void perf_top__record_precise_ip(struct perf_top *top,
 174                                         struct hist_entry *he,
 175                                         int counter, u64 ip)
 176 {
 177         struct annotation *notes;
 178         struct symbol *sym;
 179         int err = 0;
 180
 181         if (he == NULL || he->ms.sym == NULL ||
 182             ((top->sym_filter_entry == NULL ||
 183               top->sym_filter_entry->ms.sym != he->ms.sym) && use_browser != 1))
 184                 return;
 185
 186         sym = he->ms.sym;
 187         notes = symbol__annotation(sym);
 188
 189         if (pthread_mutex_trylock(&notes->lock))
 190                 return;
 191
 192         ip = he->ms.map->map_ip(he->ms.map, ip);
 193
 194         if (ui__has_annotation())
 195                 err = hist_entry__inc_addr_samples(he, counter, ip);
 196
 197         pthread_mutex_unlock(&notes->lock);
 198
 199         /*
 200          * This function is now called with he->hists->lock held.
 201          * Release it before going to sleep.
 202          */
 203         pthread_mutex_unlock(&he->hists->lock);
 204
 205         if (err == -ERANGE && !he->ms.map->erange_warned)
 206                 ui__warn_map_erange(he->ms.map, sym, ip);
 207         else if (err == -ENOMEM) {
 208                 pr_err("Not enough memory for annotating '%s' symbol!\n",
 209                        sym->name);
 210                 sleep(1);
 211         }
 212
 213         pthread_mutex_lock(&he->hists->lock);
 214 }
 215
 216 static void perf_top__show_details(struct perf_top *top)
 217 {
 218         struct hist_entry *he = top->sym_filter_entry;
 219         struct annotation *notes;
 220         struct symbol *symbol;
 221         int more;
 222
 223         if (!he)
 224                 return;
 225
 226         symbol = he->ms.sym;
 227         notes = symbol__annotation(symbol);
 228
 229         pthread_mutex_lock(&notes->lock);
 230
 231         if (notes->src == NULL)
 232                 goto out_unlock;
 233
 234         printf("Showing %s for %s\n", perf_evsel__name(top->sym_evsel), symbol->name);
 235         printf("  Events  Pcnt (>=%d%%)\n", top->sym_pcnt_filter);
 236
 237         more = symbol__annotate_printf(symbol, he->ms.map, top->sym_evsel,
 238                                        0, top->sym_pcnt_filter, top->print_entries, 4);
 239         if (top->zero)
 240                 symbol__annotate_zero_histogram(symbol, top->sym_evsel->idx);
 241         else
 242                 symbol__annotate_decay_histogram(symbol, top->sym_evsel->idx);
 243         if (more != 0)
 244                 printf("%d lines not displayed, maybe increase display entries [e]\n", more);
 245 out_unlock:
 246         pthread_mutex_unlock(&notes->lock);
 247 }
 248
 249 static void perf_top__print_sym_table(struct perf_top *top)
 250 {
 251         char bf[160];
 252         int printed = 0;
 253         const int win_width = top->winsize.ws_col - 1;
 254
 255         puts(CONSOLE_CLEAR);
 256
 257         perf_top__header_snprintf(top, bf, sizeof(bf));
 258         printf("%s\n", bf);
 259
 260         perf_top__reset_sample_counters(top);
 261
 262         printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
 263
 264         if (top->sym_evsel->hists.stats.nr_lost_warned !=
 265             top->sym_evsel->hists.stats.nr_events[PERF_RECORD_LOST]) {
 266                 top->sym_evsel->hists.stats.nr_lost_warned =
 267                         top->sym_evsel->hists.stats.nr_events[PERF_RECORD_LOST];
 268                 color_fprintf(stdout, PERF_COLOR_RED,
 269                               "WARNING: LOST %d chunks, Check IO/CPU overload",
 270                               top->sym_evsel->hists.stats.nr_lost_warned);
 271                 ++printed;
 272         }
 273
 274         if (top->sym_filter_entry) {
 275                 perf_top__show_details(top);
 276                 return;
 277         }
 278
 279         hists__collapse_resort(&top->sym_evsel->hists, NULL);
 280         hists__output_resort(&top->sym_evsel->hists);
 281         hists__decay_entries(&top->sym_evsel->hists,
 282                              top->hide_user_symbols,
 283                              top->hide_kernel_symbols);
 284         hists__output_recalc_col_len(&top->sym_evsel->hists,
 285                                      top->print_entries - printed);
 286         putchar('\n');
 287         hists__fprintf(&top->sym_evsel->hists, false,
 288                        top->print_entries - printed, win_width,
 289                        top->min_percent, stdout);
 290 }
 291
 292 static void prompt_integer(int *target, const char *msg)
 293 {
 294         char *buf = malloc(0), *p;
 295         size_t dummy = 0;
 296         int tmp;
 297
 298         fprintf(stdout, "\n%s: ", msg);
 299         if (getline(&buf, &dummy, stdin) < 0)
 300                 return;
 301
 302         p = strchr(buf, '\n');
 303         if (p)
 304                 *p = 0;
 305
 306         p = buf;
 307         while(*p) {
 308                 if (!isdigit(*p))
 309                         goto out_free;
 310                 p++;
 311         }
 312         tmp = strtoul(buf, NULL, 10);
 313         *target = tmp;
 314 out_free:
 315         free(buf);
 316 }
 317
 318 static void prompt_percent(int *target, const char *msg)
 319 {
 320         int tmp = 0;
 321
 322         prompt_integer(&tmp, msg);
 323         if (tmp >= 0 && tmp <= 100)
 324                 *target = tmp;
 325 }
 326
 327 static void perf_top__prompt_symbol(struct perf_top *top, const char *msg)
 328 {
 329         char *buf = malloc(0), *p;
 330         struct hist_entry *syme = top->sym_filter_entry, *n, *found = NULL;
 331         struct rb_node *next;
 332         size_t dummy = 0;
 333
 334         /* zero counters of active symbol */
 335         if (syme) {
 336                 __zero_source_counters(syme);
 337                 top->sym_filter_entry = NULL;
 338         }
 339
 340         fprintf(stdout, "\n%s: ", msg);
 341         if (getline(&buf, &dummy, stdin) < 0)
 342                 goto out_free;
 343
 344         p = strchr(buf, '\n');
 345         if (p)
 346                 *p = 0;
 347
 348         next = rb_first(&top->sym_evsel->hists.entries);
 349         while (next) {
 350                 n = rb_entry(next, struct hist_entry, rb_node);
 351                 if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
 352                         found = n;
 353                         break;
 354                 }
 355                 next = rb_next(&n->rb_node);
 356         }
 357
 358         if (!found) {
 359                 fprintf(stderr, "Sorry, %s is not active.\n", buf);
 360                 sleep(1);
 361         } else
 362                 perf_top__parse_source(top, found);
 363
 364 out_free:
 365         free(buf);
 366 }
 367
 368 static void perf_top__print_mapped_keys(struct perf_top *top)
 369 {
 370         char *name = NULL;
 371
 372         if (top->sym_filter_entry) {
 373                 struct symbol *sym = top->sym_filter_entry->ms.sym;
 374                 name = sym->name;
 375         }
 376
 377         fprintf(stdout, "\nMapped keys:\n");
 378         fprintf(stdout, "\t[d]     display refresh delay.             \t(%d)\n", top->delay_secs);
 379         fprintf(stdout, "\t[e]     display entries (lines).           \t(%d)\n", top->print_entries);
 380
 381         if (top->evlist->nr_entries > 1)
 382                 fprintf(stdout, "\t[E]     active event counter.              \t(%s)\n", perf_evsel__name(top->sym_evsel));
 383
 384         fprintf(stdout, "\t[f]     profile display filter (count).    \t(%d)\n", top->count_filter);
 385
 386         fprintf(stdout, "\t[F]     annotate display filter (percent). \t(%d%%)\n", top->sym_pcnt_filter);
 387         fprintf(stdout, "\t[s]     annotate symbol.                   \t(%s)\n", name?: "NULL");
 388         fprintf(stdout, "\t[S]     stop annotation.\n");
 389
 390         fprintf(stdout,
 391                 "\t[K]     hide kernel_symbols symbols.     \t(%s)\n",
 392                 top->hide_kernel_symbols ? "yes" : "no");
 393         fprintf(stdout,
 394                 "\t[U]     hide user symbols.               \t(%s)\n",
 395                 top->hide_user_symbols ? "yes" : "no");
 396         fprintf(stdout, "\t[z]     toggle sample zeroing.             \t(%d)\n", top->zero ? 1 : 0);
 397         fprintf(stdout, "\t[qQ]    quit.\n");
 398 }
 399
 400 static int perf_top__key_mapped(struct perf_top *top, int c)
 401 {
 402         switch (c) {
 403                 case 'd':
 404                 case 'e':
 405                 case 'f':
 406                 case 'z':
 407                 case 'q':
 408                 case 'Q':
 409                 case 'K':
 410                 case 'U':
 411                 case 'F':
 412                 case 's':
 413                 case 'S':
 414                         return 1;
 415                 case 'E':
 416                         return top->evlist->nr_entries > 1 ? 1 : 0;
 417                 default:
 418                         break;
 419         }
 420
 421         return 0;
 422 }
 423
 424 static bool perf_top__handle_keypress(struct perf_top *top, int c)
 425 {
 426         bool ret = true;
 427
 428         if (!perf_top__key_mapped(top, c)) {
 429                 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
 430                 struct termios tc, save;
 431
 432                 perf_top__print_mapped_keys(top);
 433                 fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
 434                 fflush(stdout);
 435
 436                 tcgetattr(0, &save);
 437                 tc = save;
 438                 tc.c_lflag &= ~(ICANON | ECHO);
 439                 tc.c_cc[VMIN] = 0;
 440                 tc.c_cc[VTIME] = 0;
 441                 tcsetattr(0, TCSANOW, &tc);
 442
 443                 poll(&stdin_poll, 1, -1);
 444                 c = getc(stdin);
 445
 446                 tcsetattr(0, TCSAFLUSH, &save);
 447                 if (!perf_top__key_mapped(top, c))
 448                         return ret;
 449         }
 450
 451         switch (c) {
 452                 case 'd':
 453                         prompt_integer(&top->delay_secs, "Enter display delay");
 454                         if (top->delay_secs < 1)
 455                                 top->delay_secs = 1;
 456                         break;
 457                 case 'e':
 458                         prompt_integer(&top->print_entries, "Enter display entries (lines)");
 459                         if (top->print_entries == 0) {
 460                                 struct sigaction act = {
 461                                         .sa_sigaction = perf_top__sig_winch,
 462                                         .sa_flags     = SA_SIGINFO,
 463                                 };
 464                                 perf_top__sig_winch(SIGWINCH, NULL, top);
 465                                 sigaction(SIGWINCH, &act, NULL);
 466                         } else {
 467                                 signal(SIGWINCH, SIG_DFL);
 468                         }
 469                         break;
 470                 case 'E':
 471                         if (top->evlist->nr_entries > 1) {
 472                                 /* Select 0 as the default event: */
 473                                 int counter = 0;
 474
 475                                 fprintf(stderr, "\nAvailable events:");
 476
 477                                 evlist__for_each(top->evlist, top->sym_evsel)
 478                                         fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
 479
 480                                 prompt_integer(&counter, "Enter details event counter");
 481
 482                                 if (counter >= top->evlist->nr_entries) {
 483                                         top->sym_evsel = perf_evlist__first(top->evlist);
 484                                         fprintf(stderr, "Sorry, no such event, using %s.\n", perf_evsel__name(top->sym_evsel));
 485                                         sleep(1);
 486                                         break;
 487                                 }
 488                                 evlist__for_each(top->evlist, top->sym_evsel)
 489                                         if (top->sym_evsel->idx == counter)
 490                                                 break;
 491                         } else
 492                                 top->sym_evsel = perf_evlist__first(top->evlist);
 493                         break;
 494                 case 'f':
 495                         prompt_integer(&top->count_filter, "Enter display event count filter");
 496                         break;
 497                 case 'F':
 498                         prompt_percent(&top->sym_pcnt_filter,
 499                                        "Enter details display event filter (percent)");
 500                         break;
 501                 case 'K':
 502                         top->hide_kernel_symbols = !top->hide_kernel_symbols;
 503                         break;
 504                 case 'q':
 505                 case 'Q':
 506                         printf("exiting.\n");
 507                         if (top->dump_symtab)
 508                                 perf_session__fprintf_dsos(top->session, stderr);
 509                         ret = false;
 510                         break;
 511                 case 's':
 512                         perf_top__prompt_symbol(top, "Enter details symbol");
 513                         break;
 514                 case 'S':
 515                         if (!top->sym_filter_entry)
 516                                 break;
 517                         else {
 518                                 struct hist_entry *syme = top->sym_filter_entry;
 519
 520                                 top->sym_filter_entry = NULL;
 521                                 __zero_source_counters(syme);
 522                         }
 523                         break;
 524                 case 'U':
 525                         top->hide_user_symbols = !top->hide_user_symbols;
 526                         break;
 527                 case 'z':
 528                         top->zero = !top->zero;
 529                         break;
 530                 default:
 531                         break;
 532         }
 533
 534         return ret;
 535 }
 536
 537 static void perf_top__sort_new_samples(void *arg)
 538 {
 539         struct perf_top *t = arg;
 540         perf_top__reset_sample_counters(t);
 541
 542         if (t->evlist->selected != NULL)
 543                 t->sym_evsel = t->evlist->selected;
 544
 545         hists__collapse_resort(&t->sym_evsel->hists, NULL);
 546         hists__output_resort(&t->sym_evsel->hists);
 547         hists__decay_entries(&t->sym_evsel->hists,
 548                              t->hide_user_symbols,
 549                              t->hide_kernel_symbols);
 550 }
 551
 552 static void *display_thread_tui(void *arg)
 553 {
 554         struct perf_evsel *pos;
 555         struct perf_top *top = arg;
 556         const char *help = "For a higher level overview, try: perf top --sort comm,dso";
 557         struct hist_browser_timer hbt = {
 558                 .timer          = perf_top__sort_new_samples,
 559                 .arg            = top,
 560                 .refresh        = top->delay_secs,
 561         };
 562
 563         perf_top__sort_new_samples(top);
 564
 565         /*
 566          * Initialize the uid_filter_str, in the future the TUI will allow
 567          * Zooming in/out UIDs. For now juse use whatever the user passed
 568          * via --uid.
 569          */
 570         evlist__for_each(top->evlist, pos)
 571                 pos->hists.uid_filter_str = top->record_opts.target.uid_str;
 572
 573         perf_evlist__tui_browse_hists(top->evlist, help, &hbt, top->min_percent,
 574                                       &top->session->header.env);
 575
 576         done = 1;
 577         return NULL;
 578 }
 579
 580 static void *display_thread(void *arg)
 581 {
 582         struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
 583         struct termios tc, save;
 584         struct perf_top *top = arg;
 585         int delay_msecs, c;
 586
 587         tcgetattr(0, &save);
 588         tc = save;
 589         tc.c_lflag &= ~(ICANON | ECHO);
 590         tc.c_cc[VMIN] = 0;
 591         tc.c_cc[VTIME] = 0;
 592
 593         pthread__unblock_sigwinch();
 594 repeat:
 595         delay_msecs = top->delay_secs * 1000;
 596         tcsetattr(0, TCSANOW, &tc);
 597         /* trash return*/
 598         getc(stdin);
 599
 600         while (!done) {
 601                 perf_top__print_sym_table(top);
 602                 /*
 603                  * Either timeout expired or we got an EINTR due to SIGWINCH,
 604                  * refresh screen in both cases.
 605                  */
 606                 switch (poll(&stdin_poll, 1, delay_msecs)) {
 607                 case 0:
 608                         continue;
 609                 case -1:
 610                         if (errno == EINTR)
 611                                 continue;
 612                         __fallthrough;
 613                 default:
 614                         c = getc(stdin);
 615                         tcsetattr(0, TCSAFLUSH, &save);
 616
 617                         if (perf_top__handle_keypress(top, c))
 618                                 goto repeat;
 619                         done = 1;
 620                 }
 621         }
 622
 623         return NULL;
 624 }
 625
 626 static int symbol_filter(struct map *map __maybe_unused, struct symbol *sym)
 627 {
 628         const char *name = sym->name;
 629
 630         /*
 631          * ppc64 uses function descriptors and appends a '.' to the
 632          * start of every instruction address. Remove it.
 633          */
 634         if (name[0] == '.')
 635                 name++;
 636
 637         if (!strcmp(name, "_text") ||
 638             !strcmp(name, "_etext") ||
 639             !strcmp(name, "_sinittext") ||
 640             !strncmp("init_module", name, 11) ||
 641             !strncmp("cleanup_module", name, 14) ||
 642             strstr(name, "_text_start") ||
 643             strstr(name, "_text_end"))
 644                 return 1;
 645
 646         if (symbol__is_idle(sym))
 647                 sym->ignore = true;
 648
 649         return 0;
 650 }
 651
 652 static int hist_iter__top_callback(struct hist_entry_iter *iter,
 653                                    struct addr_location *al, bool single,
 654                                    void *arg)
 655 {
 656         struct perf_top *top = arg;
 657         struct hist_entry *he = iter->he;
 658         struct perf_evsel *evsel = iter->evsel;
 659
 660         if (sort__has_sym && single) {
 661                 u64 ip = al->addr;
 662
 663                 if (al->map)
 664                         ip = al->map->unmap_ip(al->map, ip);
 665
 666                 perf_top__record_precise_ip(top, he, evsel->idx, ip);
 667         }
 668
 669         return 0;
 670 }
 671
 672 static void perf_event__process_sample(struct perf_tool *tool,
 673                                        const union perf_event *event,
 674                                        struct perf_evsel *evsel,
 675                                        struct perf_sample *sample,
 676                                        struct machine *machine)
 677 {
 678         struct perf_top *top = container_of(tool, struct perf_top, tool);
 679         struct addr_location al;
 680         int err;
 681
 682         if (!machine && perf_guest) {
 683                 static struct intlist *seen;
 684
 685                 if (!seen)
 686                         seen = intlist__new(NULL);
 687
 688                 if (!intlist__has_entry(seen, sample->pid)) {
 689                         pr_err("Can't find guest [%d]'s kernel information\n",
 690                                 sample->pid);
 691                         intlist__add(seen, sample->pid);
 692                 }
 693                 return;
 694         }
 695
 696         if (!machine) {
 697                 pr_err("%u unprocessable samples recorded.\r",
 698                        top->session->stats.nr_unprocessable_samples++);
 699                 return;
 700         }
 701
 702         if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
 703                 top->exact_samples++;
 704
 705         if (perf_event__preprocess_sample(event, machine, &al, sample) < 0)
 706                 return;
 707
 708         if (!top->kptr_restrict_warned &&
 709             symbol_conf.kptr_restrict &&
 710             al.cpumode == PERF_RECORD_MISC_KERNEL) {
 711                 ui__warning(
 712 "Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
 713 "Check /proc/sys/kernel/kptr_restrict.\n\n"
 714 "Kernel%s samples will not be resolved.\n",
 715                           !RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION]) ?
 716                           " modules" : "");
 717                 if (use_browser <= 0)
 718                         sleep(5);
 719                 top->kptr_restrict_warned = true;
 720         }
 721
 722         if (al.sym == NULL) {
 723                 const char *msg = "Kernel samples will not be resolved.\n";
 724                 /*
 725                  * As we do lazy loading of symtabs we only will know if the
 726                  * specified vmlinux file is invalid when we actually have a
 727                  * hit in kernel space and then try to load it. So if we get
 728                  * here and there are _no_ symbols in the DSO backing the
 729                  * kernel map, bail out.
 730                  *
 731                  * We may never get here, for instance, if we use -K/
 732                  * --hide-kernel-symbols, even if the user specifies an
 733                  * invalid --vmlinux ;-)
 734                  */
 735                 if (!top->kptr_restrict_warned && !top->vmlinux_warned &&
 736                     al.map == machine->vmlinux_maps[MAP__FUNCTION] &&
 737                     RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION])) {
 738                         if (symbol_conf.vmlinux_name) {
 739                                 ui__warning("The %s file can't be used.\n%s",
 740                                             symbol_conf.vmlinux_name, msg);
 741                         } else {
 742                                 ui__warning("A vmlinux file was not found.\n%s",
 743                                             msg);
 744                         }
 745
 746                         if (use_browser <= 0)
 747                                 sleep(5);
 748                         top->vmlinux_warned = true;
 749                 }
 750         }
 751
 752         if (al.sym == NULL || !al.sym->ignore) {
 753                 struct hist_entry_iter iter = {
 754                         .add_entry_cb = hist_iter__top_callback,
 755                 };
 756
 757                 if (symbol_conf.cumulate_callchain)
 758                         iter.ops = &hist_iter_cumulative;
 759                 else
 760                         iter.ops = &hist_iter_normal;
 761
 762                 pthread_mutex_lock(&evsel->hists.lock);
 763
 764                 err = hist_entry_iter__add(&iter, &al, evsel, sample,
 765                                            top->max_stack, top);
 766                 if (err < 0)
 767                         pr_err("Problem incrementing symbol period, skipping event\n");
 768
 769                 pthread_mutex_unlock(&evsel->hists.lock);
 770         }
 771
 772         return;
 773 }
 774
 775 static void perf_top__mmap_read_idx(struct perf_top *top, int idx)
 776 {
 777         struct perf_sample sample;
 778         struct perf_evsel *evsel;
 779         struct perf_session *session = top->session;
 780         union perf_event *event;
 781         struct machine *machine;
 782         u8 origin;
 783         int ret;
 784
 785         while ((event = perf_evlist__mmap_read(top->evlist, idx)) != NULL) {
 786                 ret = perf_evlist__parse_sample(top->evlist, event, &sample);
 787                 if (ret) {
 788                         pr_err("Can't parse sample, err = %d\n", ret);
 789                         goto next_event;
 790                 }
 791
 792                 evsel = perf_evlist__id2evsel(session->evlist, sample.id);
 793                 assert(evsel != NULL);
 794
 795                 origin = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
 796
 797                 if (event->header.type == PERF_RECORD_SAMPLE)
 798                         ++top->samples;
 799
 800                 switch (origin) {
 801                 case PERF_RECORD_MISC_USER:
 802                         ++top->us_samples;
 803                         if (top->hide_user_symbols)
 804                                 goto next_event;
 805                         machine = &session->machines.host;
 806                         break;
 807                 case PERF_RECORD_MISC_KERNEL:
 808                         ++top->kernel_samples;
 809                         if (top->hide_kernel_symbols)
 810                                 goto next_event;
 811                         machine = &session->machines.host;
 812                         break;
 813                 case PERF_RECORD_MISC_GUEST_KERNEL:
 814                         ++top->guest_kernel_samples;
 815                         machine = perf_session__find_machine(session,
 816                                                              sample.pid);
 817                         break;
 818                 case PERF_RECORD_MISC_GUEST_USER:
 819                         ++top->guest_us_samples;
 820                         /*
 821                          * TODO: we don't process guest user from host side
 822                          * except simple counting.
 823                          */
 824                         /* Fall thru */
 825                 default:
 826                         goto next_event;
 827                 }
 828
 829
 830                 if (event->header.type == PERF_RECORD_SAMPLE) {
 831                         perf_event__process_sample(&top->tool, event, evsel,
 832                                                    &sample, machine);
 833                 } else if (event->header.type < PERF_RECORD_MAX) {
 834                         hists__inc_nr_events(&evsel->hists, event->header.type);
 835                         machine__process_event(machine, event, &sample);
 836                 } else
 837                         ++session->stats.nr_unknown_events;
 838 next_event:
 839                 perf_evlist__mmap_consume(top->evlist, idx);
 840         }
 841 }
 842
 843 static void perf_top__mmap_read(struct perf_top *top)
 844 {
 845         int i;
 846
 847         for (i = 0; i < top->evlist->nr_mmaps; i++)
 848                 perf_top__mmap_read_idx(top, i);
 849 }
 850
 851 static int perf_top__start_counters(struct perf_top *top)
 852 {
 853         char msg[512];
 854         struct perf_evsel *counter;
 855         struct perf_evlist *evlist = top->evlist;
 856         struct record_opts *opts = &top->record_opts;
 857
 858         perf_evlist__config(evlist, opts);
 859
 860         evlist__for_each(evlist, counter) {
 861 try_again:
 862                 if (perf_evsel__open(counter, top->evlist->cpus,
 863                                      top->evlist->threads) < 0) {
 864                         if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
 865                                 if (verbose)
 866                                         ui__warning("%s\n", msg);
 867                                 goto try_again;
 868                         }
 869
 870                         perf_evsel__open_strerror(counter, &opts->target,
 871                                                   errno, msg, sizeof(msg));
 872                         ui__error("%s\n", msg);
 873                         goto out_err;
 874                 }
 875         }
 876
 877         if (perf_evlist__mmap(evlist, opts->mmap_pages, false) < 0) {
 878                 ui__error("Failed to mmap with %d (%s)\n",
 879                             errno, strerror(errno));
 880                 goto out_err;
 881         }
 882
 883         return 0;
 884
 885 out_err:
 886         return -1;
 887 }
 888
 889 static int perf_top__setup_sample_type(struct perf_top *top __maybe_unused)
 890 {
 891         if (!sort__has_sym) {
 892                 if (symbol_conf.use_callchain) {
 893                         ui__error("Selected -g but \"sym\" not present in --sort/-s.");
 894                         return -EINVAL;
 895                 }
 896         } else if (callchain_param.mode != CHAIN_NONE) {
 897                 if (callchain_register_param(&callchain_param) < 0) {
 898                         ui__error("Can't register callchain params.\n");
 899                         return -EINVAL;
 900                 }
 901         }
 902
 903         return 0;
 904 }
 905
 906 static int __cmd_top(struct perf_top *top)
 907 {
 908         struct record_opts *opts = &top->record_opts;
 909         pthread_t thread;
 910         int ret;
 911
 912         top->session = perf_session__new(NULL, false, NULL);
 913         if (top->session == NULL)
 914                 return -ENOMEM;
 915
 916         machines__set_symbol_filter(&top->session->machines, symbol_filter);
 917
 918         if (!objdump_path) {
 919                 ret = perf_session_env__lookup_objdump(&top->session->header.env);
 920                 if (ret)
 921                         goto out_delete;
 922         }
 923
 924         ret = perf_top__setup_sample_type(top);
 925         if (ret)
 926                 goto out_delete;
 927
 928         machine__synthesize_threads(&top->session->machines.host, &opts->target,
 929                                     top->evlist->threads, false);
 930         ret = perf_top__start_counters(top);
 931         if (ret)
 932                 goto out_delete;
 933
 934         top->session->evlist = top->evlist;
 935         perf_session__set_id_hdr_size(top->session);
 936
 937         /*
 938          * When perf is starting the traced process, all the events (apart from
 939          * group members) have enable_on_exec=1 set, so don't spoil it by
 940          * prematurely enabling them.
 941          *
 942          * XXX 'top' still doesn't start workloads like record, trace, but should,
 943          * so leave the check here.
 944          */
 945         if (!target__none(&opts->target))
 946                 perf_evlist__enable(top->evlist);
 947
 948         /* Wait for a minimal set of events before starting the snapshot */
 949         poll(top->evlist->pollfd, top->evlist->nr_fds, 100);
 950
 951         perf_top__mmap_read(top);
 952
 953         ret = -1;
 954         if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
 955                                                             display_thread), top)) {
 956                 ui__error("Could not create display thread.\n");
 957                 goto out_delete;
 958         }
 959
 960         if (top->realtime_prio) {
 961                 struct sched_param param;
 962
 963                 param.sched_priority = top->realtime_prio;
 964                 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
 965                         ui__error("Could not set realtime priority.\n");
 966                         goto out_delete;
 967                 }
 968         }
 969
 970         while (!done) {
 971                 u64 hits = top->samples;
 972
 973                 perf_top__mmap_read(top);
 974
 975                 if (hits == top->samples)
 976                         ret = poll(top->evlist->pollfd, top->evlist->nr_fds, 100);
 977         }
 978
 979         ret = 0;
 980 out_delete:
 981         perf_session__delete(top->session);
 982         top->session = NULL;
 983
 984         return ret;
 985 }
 986
 987 static int
 988 callchain_opt(const struct option *opt, const char *arg, int unset)
 989 {
 990         symbol_conf.use_callchain = true;
 991         return record_callchain_opt(opt, arg, unset);
 992 }
 993
 994 static int
 995 parse_callchain_opt(const struct option *opt, const char *arg, int unset)
 996 {
 997         symbol_conf.use_callchain = true;
 998         return record_parse_callchain_opt(opt, arg, unset);
 999 }
1000
1001 static int perf_top_config(const char *var, const char *value, void *cb)
1002 {
1003         struct perf_top *top = cb;
1004
1005         if (!strcmp(var, "top.call-graph"))
1006                 return record_parse_callchain(value, &top->record_opts);
1007         if (!strcmp(var, "top.children")) {
1008                 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
1009                 return 0;
1010         }
1011
1012         return perf_default_config(var, value, cb);
1013 }
1014
1015 static int
1016 parse_percent_limit(const struct option *opt, const char *arg,
1017                     int unset __maybe_unused)
1018 {
1019         struct perf_top *top = opt->value;
1020
1021         top->min_percent = strtof(arg, NULL);
1022         return 0;
1023 }
1024
1025 int cmd_top(int argc, const char **argv, const char *prefix __maybe_unused)
1026 {
1027         int status = -1;
1028         char errbuf[BUFSIZ];
1029         struct perf_top top = {
1030                 .count_filter        = 5,
1031                 .delay_secs          = 2,
1032                 .record_opts = {
1033                         .mmap_pages     = UINT_MAX,
1034                         .user_freq      = UINT_MAX,
1035                         .user_interval  = ULLONG_MAX,
1036                         .freq           = 4000, /* 4 KHz */
1037                         .target         = {
1038                                 .uses_mmap   = true,
1039                         },
1040                 },
1041                 .max_stack           = PERF_MAX_STACK_DEPTH,
1042                 .sym_pcnt_filter     = 5,
1043         };
1044         struct record_opts *opts = &top.record_opts;
1045         struct target *target = &opts->target;
1046         const struct option options[] = {
1047         OPT_CALLBACK('e', "event", &top.evlist, "event",
1048                      "event selector. use 'perf list' to list available events",
1049                      parse_events_option),
1050         OPT_U64('c', "count", &opts->user_interval, "event period to sample"),
1051         OPT_STRING('p', "pid", &target->pid, "pid",
1052                     "profile events on existing process id"),
1053         OPT_STRING('t', "tid", &target->tid, "tid",
1054                     "profile events on existing thread id"),
1055         OPT_BOOLEAN('a', "all-cpus", &target->system_wide,
1056                             "system-wide collection from all CPUs"),
1057         OPT_STRING('C', "cpu", &target->cpu_list, "cpu",
1058                     "list of cpus to monitor"),
1059         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1060                    "file", "vmlinux pathname"),
1061         OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
1062                     "don't load vmlinux even if found"),
1063         OPT_BOOLEAN('K', "hide_kernel_symbols", &top.hide_kernel_symbols,
1064                     "hide kernel symbols"),
1065         OPT_CALLBACK('m', "mmap-pages", &opts->mmap_pages, "pages",
1066                      "number of mmap data pages",
1067                      perf_evlist__parse_mmap_pages),
1068         OPT_INTEGER('r', "realtime", &top.realtime_prio,
1069                     "collect data with this RT SCHED_FIFO priority"),
1070         OPT_INTEGER('d', "delay", &top.delay_secs,
1071                     "number of seconds to delay between refreshes"),
1072         OPT_BOOLEAN('D', "dump-symtab", &top.dump_symtab,
1073                             "dump the symbol table used for profiling"),
1074         OPT_INTEGER('f', "count-filter", &top.count_filter,
1075                     "only display functions with more events than this"),
1076         OPT_BOOLEAN(0, "group", &opts->group,
1077                             "put the counters into a counter group"),
1078         OPT_BOOLEAN('i', "no-inherit", &opts->no_inherit,
1079                     "child tasks do not inherit counters"),
1080         OPT_STRING(0, "sym-annotate", &top.sym_filter, "symbol name",
1081                     "symbol to annotate"),
1082         OPT_BOOLEAN('z', "zero", &top.zero, "zero history across updates"),
1083         OPT_UINTEGER('F', "freq", &opts->user_freq, "profile at this frequency"),
1084         OPT_INTEGER('E', "entries", &top.print_entries,
1085                     "display this many functions"),
1086         OPT_BOOLEAN('U', "hide_user_symbols", &top.hide_user_symbols,
1087                     "hide user symbols"),
1088         OPT_BOOLEAN(0, "tui", &top.use_tui, "Use the TUI interface"),
1089         OPT_BOOLEAN(0, "stdio", &top.use_stdio, "Use the stdio interface"),
1090         OPT_INCR('v', "verbose", &verbose,
1091                     "be more verbose (show counter open errors, etc)"),
1092         OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1093                    "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
1094                    " Please refer the man page for the complete list."),
1095         OPT_STRING(0, "fields", &field_order, "key[,keys...]",
1096                    "output field(s): overhead, period, sample plus all of sort keys"),
1097         OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
1098                     "Show a column with the number of samples"),
1099         OPT_CALLBACK_NOOPT('g', NULL, &top.record_opts,
1100                            NULL, "enables call-graph recording",
1101                            &callchain_opt),
1102         OPT_CALLBACK(0, "call-graph", &top.record_opts,
1103                      "mode[,dump_size]", record_callchain_help,
1104                      &parse_callchain_opt),
1105         OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
1106                     "Accumulate callchains of children and show total overhead as well"),
1107         OPT_INTEGER(0, "max-stack", &top.max_stack,
1108                     "Set the maximum stack depth when parsing the callchain. "
1109                     "Default: " __stringify(PERF_MAX_STACK_DEPTH)),
1110         OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
1111                    "ignore callees of these functions in call graphs",
1112                    report_parse_ignore_callees_opt),
1113         OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1114                     "Show a column with the sum of periods"),
1115         OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1116                    "only consider symbols in these dsos"),
1117         OPT_STRING(0, "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1118                    "only consider symbols in these comms"),
1119         OPT_STRING(0, "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1120                    "only consider these symbols"),
1121         OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
1122                     "Interleave source code with assembly code (default)"),
1123         OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
1124                     "Display raw encoding of assembly instructions (default)"),
1125         OPT_STRING(0, "objdump", &objdump_path, "path",
1126                     "objdump binary to use for disassembly and annotations"),
1127         OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
1128                    "Specify disassembler style (e.g. -M intel for intel syntax)"),
1129         OPT_STRING('u', "uid", &target->uid_str, "user", "user to profile"),
1130         OPT_CALLBACK(0, "percent-limit", &top, "percent",
1131                      "Don't show entries under that percent", parse_percent_limit),
1132         OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
1133                      "How to display percentage of filtered entries", parse_filter_percentage),
1134         OPT_END()
1135         };
1136         const char * const top_usage[] = {
1137                 "perf top [<options>]",
1138                 NULL
1139         };
1140
1141         top.evlist = perf_evlist__new();
1142         if (top.evlist == NULL)
1143                 return -ENOMEM;
1144
1145         perf_config(perf_top_config, &top);
1146
1147         argc = parse_options(argc, argv, options, top_usage, 0);
1148         if (argc)
1149                 usage_with_options(top_usage, options);
1150
1151         sort__mode = SORT_MODE__TOP;
1152         /* display thread wants entries to be collapsed in a different tree */
1153         sort__need_collapse = 1;
1154
1155         if (setup_sorting() < 0) {
1156                 if (sort_order)
1157                         parse_options_usage(top_usage, options, "s", 1);
1158                 if (field_order)
1159                         parse_options_usage(sort_order ? NULL : top_usage,
1160                                             options, "fields", 0);
1161                 goto out_delete_evlist;
1162         }
1163
1164         if (top.use_stdio)
1165                 use_browser = 0;
1166         else if (top.use_tui)
1167                 use_browser = 1;
1168
1169         setup_browser(false);
1170
1171         status = target__validate(target);
1172         if (status) {
1173                 target__strerror(target, status, errbuf, BUFSIZ);
1174                 ui__warning("%s\n", errbuf);
1175         }
1176
1177         status = target__parse_uid(target);
1178         if (status) {
1179                 int saved_errno = errno;
1180
1181                 target__strerror(target, status, errbuf, BUFSIZ);
1182                 ui__error("%s\n", errbuf);
1183
1184                 status = -saved_errno;
1185                 goto out_delete_evlist;
1186         }
1187
1188         if (target__none(target))
1189                 target->system_wide = true;
1190
1191         if (perf_evlist__create_maps(top.evlist, target) < 0)
1192                 usage_with_options(top_usage, options);
1193
1194         if (!top.evlist->nr_entries &&
1195             perf_evlist__add_default(top.evlist) < 0) {
1196                 ui__error("Not enough memory for event selector list\n");
1197                 goto out_delete_evlist;
1198         }
1199
1200         symbol_conf.nr_events = top.evlist->nr_entries;
1201
1202         if (top.delay_secs < 1)
1203                 top.delay_secs = 1;
1204
1205         if (record_opts__config(opts)) {
1206                 status = -EINVAL;
1207                 goto out_delete_evlist;
1208         }
1209
1210         top.sym_evsel = perf_evlist__first(top.evlist);
1211
1212         if (!symbol_conf.use_callchain) {
1213                 symbol_conf.cumulate_callchain = false;
1214                 perf_hpp__cancel_cumulate();
1215         }
1216
1217         symbol_conf.priv_size = sizeof(struct annotation);
1218
1219         symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1220         if (symbol__init() < 0)
1221                 return -1;
1222
1223         sort__setup_elide(stdout);
1224
1225         get_term_dimensions(&top.winsize);
1226         if (top.print_entries == 0) {
1227                 struct sigaction act = {
1228                         .sa_sigaction = perf_top__sig_winch,
1229                         .sa_flags     = SA_SIGINFO,
1230                 };
1231                 perf_top__update_print_entries(&top);
1232                 sigaction(SIGWINCH, &act, NULL);
1233         }
1234
1235         status = __cmd_top(&top);
1236
1237 out_delete_evlist:
1238         perf_evlist__delete(top.evlist);
1239
1240         return status;
1241 }