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