perf top: Fix annotate for userspace
[linux-2.6.git] / 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  *
9  * Improvements and fixes by:
10  *
11  *   Arjan van de Ven <arjan@linux.intel.com>
12  *   Yanmin Zhang <yanmin.zhang@intel.com>
13  *   Wu Fengguang <fengguang.wu@intel.com>
14  *   Mike Galbraith <efault@gmx.de>
15  *   Paul Mackerras <paulus@samba.org>
16  *
17  * Released under the GPL v2. (and only v2, not any later version)
18  */
19 #include "builtin.h"
20
21 #include "perf.h"
22
23 #include "util/color.h"
24 #include "util/session.h"
25 #include "util/symbol.h"
26 #include "util/thread.h"
27 #include "util/util.h"
28 #include <linux/rbtree.h>
29 #include "util/parse-options.h"
30 #include "util/parse-events.h"
31
32 #include "util/debug.h"
33
34 #include <assert.h>
35 #include <fcntl.h>
36
37 #include <stdio.h>
38 #include <termios.h>
39 #include <unistd.h>
40
41 #include <errno.h>
42 #include <time.h>
43 #include <sched.h>
44 #include <pthread.h>
45
46 #include <sys/syscall.h>
47 #include <sys/ioctl.h>
48 #include <sys/poll.h>
49 #include <sys/prctl.h>
50 #include <sys/wait.h>
51 #include <sys/uio.h>
52 #include <sys/mman.h>
53
54 #include <linux/unistd.h>
55 #include <linux/types.h>
56
57 static int                      fd[MAX_NR_CPUS][MAX_COUNTERS];
58
59 static int                      system_wide                     =      0;
60
61 static int                      default_interval                =      0;
62
63 static int                      count_filter                    =      5;
64 static int                      print_entries;
65
66 static int                      target_pid                      =     -1;
67 static int                      inherit                         =      0;
68 static int                      profile_cpu                     =     -1;
69 static int                      nr_cpus                         =      0;
70 static unsigned int             realtime_prio                   =      0;
71 static int                      group                           =      0;
72 static unsigned int             page_size;
73 static unsigned int             mmap_pages                      =     16;
74 static int                      freq                            =   1000; /* 1 KHz */
75
76 static int                      delay_secs                      =      2;
77 static int                      zero                            =      0;
78 static int                      dump_symtab                     =      0;
79
80 static bool                     hide_kernel_symbols             =  false;
81 static bool                     hide_user_symbols               =  false;
82 static struct winsize           winsize;
83
84 /*
85  * Source
86  */
87
88 struct source_line {
89         u64                     eip;
90         unsigned long           count[MAX_COUNTERS];
91         char                    *line;
92         struct source_line      *next;
93 };
94
95 static char                     *sym_filter                     =   NULL;
96 struct sym_entry                *sym_filter_entry               =   NULL;
97 struct sym_entry                *sym_filter_entry_sched         =   NULL;
98 static int                      sym_pcnt_filter                 =      5;
99 static int                      sym_counter                     =      0;
100 static int                      display_weighted                =     -1;
101
102 /*
103  * Symbols
104  */
105
106 struct sym_entry_source {
107         struct source_line      *source;
108         struct source_line      *lines;
109         struct source_line      **lines_tail;
110         pthread_mutex_t         lock;
111 };
112
113 struct sym_entry {
114         struct rb_node          rb_node;
115         struct list_head        node;
116         unsigned long           snap_count;
117         double                  weight;
118         int                     skip;
119         u16                     name_len;
120         u8                      origin;
121         struct map              *map;
122         struct sym_entry_source *src;
123         unsigned long           count[0];
124 };
125
126 /*
127  * Source functions
128  */
129
130 static inline struct symbol *sym_entry__symbol(struct sym_entry *self)
131 {
132        return ((void *)self) + symbol_conf.priv_size;
133 }
134
135 static void get_term_dimensions(struct winsize *ws)
136 {
137         char *s = getenv("LINES");
138
139         if (s != NULL) {
140                 ws->ws_row = atoi(s);
141                 s = getenv("COLUMNS");
142                 if (s != NULL) {
143                         ws->ws_col = atoi(s);
144                         if (ws->ws_row && ws->ws_col)
145                                 return;
146                 }
147         }
148 #ifdef TIOCGWINSZ
149         if (ioctl(1, TIOCGWINSZ, ws) == 0 &&
150             ws->ws_row && ws->ws_col)
151                 return;
152 #endif
153         ws->ws_row = 25;
154         ws->ws_col = 80;
155 }
156
157 static void update_print_entries(struct winsize *ws)
158 {
159         print_entries = ws->ws_row;
160
161         if (print_entries > 9)
162                 print_entries -= 9;
163 }
164
165 static void sig_winch_handler(int sig __used)
166 {
167         get_term_dimensions(&winsize);
168         update_print_entries(&winsize);
169 }
170
171 static void parse_source(struct sym_entry *syme)
172 {
173         struct symbol *sym;
174         struct sym_entry_source *source;
175         struct map *map;
176         FILE *file;
177         char command[PATH_MAX*2];
178         const char *path;
179         u64 len;
180
181         if (!syme)
182                 return;
183
184         if (syme->src == NULL) {
185                 syme->src = zalloc(sizeof(*source));
186                 if (syme->src == NULL)
187                         return;
188                 pthread_mutex_init(&syme->src->lock, NULL);
189         }
190
191         source = syme->src;
192
193         if (source->lines) {
194                 pthread_mutex_lock(&source->lock);
195                 goto out_assign;
196         }
197
198         sym = sym_entry__symbol(syme);
199         map = syme->map;
200         path = map->dso->long_name;
201
202         len = sym->end - sym->start;
203
204         sprintf(command,
205                 "objdump --start-address=0x%016Lx "
206                          "--stop-address=0x%016Lx -dS %s",
207                 map__rip_2objdump(map, sym->start),
208                 map__rip_2objdump(map, sym->end), path);
209
210         file = popen(command, "r");
211         if (!file)
212                 return;
213
214         pthread_mutex_lock(&source->lock);
215         source->lines_tail = &source->lines;
216         while (!feof(file)) {
217                 struct source_line *src;
218                 size_t dummy = 0;
219                 char *c, *sep;
220
221                 src = malloc(sizeof(struct source_line));
222                 assert(src != NULL);
223                 memset(src, 0, sizeof(struct source_line));
224
225                 if (getline(&src->line, &dummy, file) < 0)
226                         break;
227                 if (!src->line)
228                         break;
229
230                 c = strchr(src->line, '\n');
231                 if (c)
232                         *c = 0;
233
234                 src->next = NULL;
235                 *source->lines_tail = src;
236                 source->lines_tail = &src->next;
237
238                 src->eip = strtoull(src->line, &sep, 16);
239                 if (*sep == ':')
240                         src->eip = map__objdump_2ip(map, src->eip);
241                 else /* this line has no ip info (e.g. source line) */
242                         src->eip = 0;
243         }
244         pclose(file);
245 out_assign:
246         sym_filter_entry = syme;
247         pthread_mutex_unlock(&source->lock);
248 }
249
250 static void __zero_source_counters(struct sym_entry *syme)
251 {
252         int i;
253         struct source_line *line;
254
255         line = syme->src->lines;
256         while (line) {
257                 for (i = 0; i < nr_counters; i++)
258                         line->count[i] = 0;
259                 line = line->next;
260         }
261 }
262
263 static void record_precise_ip(struct sym_entry *syme, int counter, u64 ip)
264 {
265         struct source_line *line;
266
267         if (syme != sym_filter_entry)
268                 return;
269
270         if (pthread_mutex_trylock(&syme->src->lock))
271                 return;
272
273         if (syme->src == NULL || syme->src->source == NULL)
274                 goto out_unlock;
275
276         for (line = syme->src->lines; line; line = line->next) {
277                 /* skip lines without IP info */
278                 if (line->eip == 0)
279                         continue;
280                 if (line->eip == ip) {
281                         line->count[counter]++;
282                         break;
283                 }
284                 if (line->eip > ip)
285                         break;
286         }
287 out_unlock:
288         pthread_mutex_unlock(&syme->src->lock);
289 }
290
291 static void lookup_sym_source(struct sym_entry *syme)
292 {
293         struct symbol *symbol = sym_entry__symbol(syme);
294         struct source_line *line;
295         char pattern[PATH_MAX];
296
297         sprintf(pattern, "<%s>:", symbol->name);
298
299         pthread_mutex_lock(&syme->src->lock);
300         for (line = syme->src->lines; line; line = line->next) {
301                 if (strstr(line->line, pattern)) {
302                         syme->src->source = line;
303                         break;
304                 }
305         }
306         pthread_mutex_unlock(&syme->src->lock);
307 }
308
309 static void show_lines(struct source_line *queue, int count, int total)
310 {
311         int i;
312         struct source_line *line;
313
314         line = queue;
315         for (i = 0; i < count; i++) {
316                 float pcnt = 100.0*(float)line->count[sym_counter]/(float)total;
317
318                 printf("%8li %4.1f%%\t%s\n", line->count[sym_counter], pcnt, line->line);
319                 line = line->next;
320         }
321 }
322
323 #define TRACE_COUNT     3
324
325 static void show_details(struct sym_entry *syme)
326 {
327         struct symbol *symbol;
328         struct source_line *line;
329         struct source_line *line_queue = NULL;
330         int displayed = 0;
331         int line_queue_count = 0, total = 0, more = 0;
332
333         if (!syme)
334                 return;
335
336         if (!syme->src->source)
337                 lookup_sym_source(syme);
338
339         if (!syme->src->source)
340                 return;
341
342         symbol = sym_entry__symbol(syme);
343         printf("Showing %s for %s\n", event_name(sym_counter), symbol->name);
344         printf("  Events  Pcnt (>=%d%%)\n", sym_pcnt_filter);
345
346         pthread_mutex_lock(&syme->src->lock);
347         line = syme->src->source;
348         while (line) {
349                 total += line->count[sym_counter];
350                 line = line->next;
351         }
352
353         line = syme->src->source;
354         while (line) {
355                 float pcnt = 0.0;
356
357                 if (!line_queue_count)
358                         line_queue = line;
359                 line_queue_count++;
360
361                 if (line->count[sym_counter])
362                         pcnt = 100.0 * line->count[sym_counter] / (float)total;
363                 if (pcnt >= (float)sym_pcnt_filter) {
364                         if (displayed <= print_entries)
365                                 show_lines(line_queue, line_queue_count, total);
366                         else more++;
367                         displayed += line_queue_count;
368                         line_queue_count = 0;
369                         line_queue = NULL;
370                 } else if (line_queue_count > TRACE_COUNT) {
371                         line_queue = line_queue->next;
372                         line_queue_count--;
373                 }
374
375                 line->count[sym_counter] = zero ? 0 : line->count[sym_counter] * 7 / 8;
376                 line = line->next;
377         }
378         pthread_mutex_unlock(&syme->src->lock);
379         if (more)
380                 printf("%d lines not displayed, maybe increase display entries [e]\n", more);
381 }
382
383 /*
384  * Symbols will be added here in event__process_sample and will get out
385  * after decayed.
386  */
387 static LIST_HEAD(active_symbols);
388 static pthread_mutex_t active_symbols_lock = PTHREAD_MUTEX_INITIALIZER;
389
390 /*
391  * Ordering weight: count-1 * count-2 * ... / count-n
392  */
393 static double sym_weight(const struct sym_entry *sym)
394 {
395         double weight = sym->snap_count;
396         int counter;
397
398         if (!display_weighted)
399                 return weight;
400
401         for (counter = 1; counter < nr_counters-1; counter++)
402                 weight *= sym->count[counter];
403
404         weight /= (sym->count[counter] + 1);
405
406         return weight;
407 }
408
409 static long                     samples;
410 static long                     userspace_samples;
411 static const char               CONSOLE_CLEAR[] = "\e[H\e[2J";
412
413 static void __list_insert_active_sym(struct sym_entry *syme)
414 {
415         list_add(&syme->node, &active_symbols);
416 }
417
418 static void list_remove_active_sym(struct sym_entry *syme)
419 {
420         pthread_mutex_lock(&active_symbols_lock);
421         list_del_init(&syme->node);
422         pthread_mutex_unlock(&active_symbols_lock);
423 }
424
425 static void rb_insert_active_sym(struct rb_root *tree, struct sym_entry *se)
426 {
427         struct rb_node **p = &tree->rb_node;
428         struct rb_node *parent = NULL;
429         struct sym_entry *iter;
430
431         while (*p != NULL) {
432                 parent = *p;
433                 iter = rb_entry(parent, struct sym_entry, rb_node);
434
435                 if (se->weight > iter->weight)
436                         p = &(*p)->rb_left;
437                 else
438                         p = &(*p)->rb_right;
439         }
440
441         rb_link_node(&se->rb_node, parent, p);
442         rb_insert_color(&se->rb_node, tree);
443 }
444
445 static void print_sym_table(void)
446 {
447         int printed = 0, j;
448         int counter, snap = !display_weighted ? sym_counter : 0;
449         float samples_per_sec = samples/delay_secs;
450         float ksamples_per_sec = (samples-userspace_samples)/delay_secs;
451         float sum_ksamples = 0.0;
452         struct sym_entry *syme, *n;
453         struct rb_root tmp = RB_ROOT;
454         struct rb_node *nd;
455         int sym_width = 0, dso_width = 0, max_dso_width;
456         const int win_width = winsize.ws_col - 1;
457
458         samples = userspace_samples = 0;
459
460         /* Sort the active symbols */
461         pthread_mutex_lock(&active_symbols_lock);
462         syme = list_entry(active_symbols.next, struct sym_entry, node);
463         pthread_mutex_unlock(&active_symbols_lock);
464
465         list_for_each_entry_safe_from(syme, n, &active_symbols, node) {
466                 syme->snap_count = syme->count[snap];
467                 if (syme->snap_count != 0) {
468
469                         if ((hide_user_symbols &&
470                              syme->origin == PERF_RECORD_MISC_USER) ||
471                             (hide_kernel_symbols &&
472                              syme->origin == PERF_RECORD_MISC_KERNEL)) {
473                                 list_remove_active_sym(syme);
474                                 continue;
475                         }
476                         syme->weight = sym_weight(syme);
477                         rb_insert_active_sym(&tmp, syme);
478                         sum_ksamples += syme->snap_count;
479
480                         for (j = 0; j < nr_counters; j++)
481                                 syme->count[j] = zero ? 0 : syme->count[j] * 7 / 8;
482                 } else
483                         list_remove_active_sym(syme);
484         }
485
486         puts(CONSOLE_CLEAR);
487
488         printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
489         printf( "   PerfTop:%8.0f irqs/sec  kernel:%4.1f%% [",
490                 samples_per_sec,
491                 100.0 - (100.0*((samples_per_sec-ksamples_per_sec)/samples_per_sec)));
492
493         if (nr_counters == 1 || !display_weighted) {
494                 printf("%Ld", (u64)attrs[0].sample_period);
495                 if (freq)
496                         printf("Hz ");
497                 else
498                         printf(" ");
499         }
500
501         if (!display_weighted)
502                 printf("%s", event_name(sym_counter));
503         else for (counter = 0; counter < nr_counters; counter++) {
504                 if (counter)
505                         printf("/");
506
507                 printf("%s", event_name(counter));
508         }
509
510         printf( "], ");
511
512         if (target_pid != -1)
513                 printf(" (target_pid: %d", target_pid);
514         else
515                 printf(" (all");
516
517         if (profile_cpu != -1)
518                 printf(", cpu: %d)\n", profile_cpu);
519         else {
520                 if (target_pid != -1)
521                         printf(")\n");
522                 else
523                         printf(", %d CPUs)\n", nr_cpus);
524         }
525
526         printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
527
528         if (sym_filter_entry) {
529                 show_details(sym_filter_entry);
530                 return;
531         }
532
533         /*
534          * Find the longest symbol name that will be displayed
535          */
536         for (nd = rb_first(&tmp); nd; nd = rb_next(nd)) {
537                 syme = rb_entry(nd, struct sym_entry, rb_node);
538                 if (++printed > print_entries ||
539                     (int)syme->snap_count < count_filter)
540                         continue;
541
542                 if (syme->map->dso->long_name_len > dso_width)
543                         dso_width = syme->map->dso->long_name_len;
544
545                 if (syme->name_len > sym_width)
546                         sym_width = syme->name_len;
547         }
548
549         printed = 0;
550
551         max_dso_width = winsize.ws_col - sym_width - 29;
552         if (dso_width > max_dso_width)
553                 dso_width = max_dso_width;
554         putchar('\n');
555         if (nr_counters == 1)
556                 printf("             samples  pcnt");
557         else
558                 printf("   weight    samples  pcnt");
559
560         if (verbose)
561                 printf("         RIP       ");
562         printf(" %-*.*s DSO\n", sym_width, sym_width, "function");
563         printf("   %s    _______ _____",
564                nr_counters == 1 ? "      " : "______");
565         if (verbose)
566                 printf(" ________________");
567         printf(" %-*.*s", sym_width, sym_width, graph_line);
568         printf(" %-*.*s", dso_width, dso_width, graph_line);
569         puts("\n");
570
571         for (nd = rb_first(&tmp); nd; nd = rb_next(nd)) {
572                 struct symbol *sym;
573                 double pcnt;
574
575                 syme = rb_entry(nd, struct sym_entry, rb_node);
576                 sym = sym_entry__symbol(syme);
577
578                 if (++printed > print_entries || (int)syme->snap_count < count_filter)
579                         continue;
580
581                 pcnt = 100.0 - (100.0 * ((sum_ksamples - syme->snap_count) /
582                                          sum_ksamples));
583
584                 if (nr_counters == 1 || !display_weighted)
585                         printf("%20.2f ", syme->weight);
586                 else
587                         printf("%9.1f %10ld ", syme->weight, syme->snap_count);
588
589                 percent_color_fprintf(stdout, "%4.1f%%", pcnt);
590                 if (verbose)
591                         printf(" %016llx", sym->start);
592                 printf(" %-*.*s", sym_width, sym_width, sym->name);
593                 printf(" %-*.*s\n", dso_width, dso_width,
594                        dso_width >= syme->map->dso->long_name_len ?
595                                         syme->map->dso->long_name :
596                                         syme->map->dso->short_name);
597         }
598 }
599
600 static void prompt_integer(int *target, const char *msg)
601 {
602         char *buf = malloc(0), *p;
603         size_t dummy = 0;
604         int tmp;
605
606         fprintf(stdout, "\n%s: ", msg);
607         if (getline(&buf, &dummy, stdin) < 0)
608                 return;
609
610         p = strchr(buf, '\n');
611         if (p)
612                 *p = 0;
613
614         p = buf;
615         while(*p) {
616                 if (!isdigit(*p))
617                         goto out_free;
618                 p++;
619         }
620         tmp = strtoul(buf, NULL, 10);
621         *target = tmp;
622 out_free:
623         free(buf);
624 }
625
626 static void prompt_percent(int *target, const char *msg)
627 {
628         int tmp = 0;
629
630         prompt_integer(&tmp, msg);
631         if (tmp >= 0 && tmp <= 100)
632                 *target = tmp;
633 }
634
635 static void prompt_symbol(struct sym_entry **target, const char *msg)
636 {
637         char *buf = malloc(0), *p;
638         struct sym_entry *syme = *target, *n, *found = NULL;
639         size_t dummy = 0;
640
641         /* zero counters of active symbol */
642         if (syme) {
643                 pthread_mutex_lock(&syme->src->lock);
644                 __zero_source_counters(syme);
645                 *target = NULL;
646                 pthread_mutex_unlock(&syme->src->lock);
647         }
648
649         fprintf(stdout, "\n%s: ", msg);
650         if (getline(&buf, &dummy, stdin) < 0)
651                 goto out_free;
652
653         p = strchr(buf, '\n');
654         if (p)
655                 *p = 0;
656
657         pthread_mutex_lock(&active_symbols_lock);
658         syme = list_entry(active_symbols.next, struct sym_entry, node);
659         pthread_mutex_unlock(&active_symbols_lock);
660
661         list_for_each_entry_safe_from(syme, n, &active_symbols, node) {
662                 struct symbol *sym = sym_entry__symbol(syme);
663
664                 if (!strcmp(buf, sym->name)) {
665                         found = syme;
666                         break;
667                 }
668         }
669
670         if (!found) {
671                 fprintf(stderr, "Sorry, %s is not active.\n", buf);
672                 sleep(1);
673                 return;
674         } else
675                 parse_source(found);
676
677 out_free:
678         free(buf);
679 }
680
681 static void print_mapped_keys(void)
682 {
683         char *name = NULL;
684
685         if (sym_filter_entry) {
686                 struct symbol *sym = sym_entry__symbol(sym_filter_entry);
687                 name = sym->name;
688         }
689
690         fprintf(stdout, "\nMapped keys:\n");
691         fprintf(stdout, "\t[d]     display refresh delay.             \t(%d)\n", delay_secs);
692         fprintf(stdout, "\t[e]     display entries (lines).           \t(%d)\n", print_entries);
693
694         if (nr_counters > 1)
695                 fprintf(stdout, "\t[E]     active event counter.              \t(%s)\n", event_name(sym_counter));
696
697         fprintf(stdout, "\t[f]     profile display filter (count).    \t(%d)\n", count_filter);
698
699         fprintf(stdout, "\t[F]     annotate display filter (percent). \t(%d%%)\n", sym_pcnt_filter);
700         fprintf(stdout, "\t[s]     annotate symbol.                   \t(%s)\n", name?: "NULL");
701         fprintf(stdout, "\t[S]     stop annotation.\n");
702
703         if (nr_counters > 1)
704                 fprintf(stdout, "\t[w]     toggle display weighted/count[E]r. \t(%d)\n", display_weighted ? 1 : 0);
705
706         fprintf(stdout,
707                 "\t[K]     hide kernel_symbols symbols.             \t(%s)\n",
708                 hide_kernel_symbols ? "yes" : "no");
709         fprintf(stdout,
710                 "\t[U]     hide user symbols.               \t(%s)\n",
711                 hide_user_symbols ? "yes" : "no");
712         fprintf(stdout, "\t[z]     toggle sample zeroing.             \t(%d)\n", zero ? 1 : 0);
713         fprintf(stdout, "\t[qQ]    quit.\n");
714 }
715
716 static int key_mapped(int c)
717 {
718         switch (c) {
719                 case 'd':
720                 case 'e':
721                 case 'f':
722                 case 'z':
723                 case 'q':
724                 case 'Q':
725                 case 'K':
726                 case 'U':
727                 case 'F':
728                 case 's':
729                 case 'S':
730                         return 1;
731                 case 'E':
732                 case 'w':
733                         return nr_counters > 1 ? 1 : 0;
734                 default:
735                         break;
736         }
737
738         return 0;
739 }
740
741 static void handle_keypress(int c)
742 {
743         if (!key_mapped(c)) {
744                 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
745                 struct termios tc, save;
746
747                 print_mapped_keys();
748                 fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
749                 fflush(stdout);
750
751                 tcgetattr(0, &save);
752                 tc = save;
753                 tc.c_lflag &= ~(ICANON | ECHO);
754                 tc.c_cc[VMIN] = 0;
755                 tc.c_cc[VTIME] = 0;
756                 tcsetattr(0, TCSANOW, &tc);
757
758                 poll(&stdin_poll, 1, -1);
759                 c = getc(stdin);
760
761                 tcsetattr(0, TCSAFLUSH, &save);
762                 if (!key_mapped(c))
763                         return;
764         }
765
766         switch (c) {
767                 case 'd':
768                         prompt_integer(&delay_secs, "Enter display delay");
769                         if (delay_secs < 1)
770                                 delay_secs = 1;
771                         break;
772                 case 'e':
773                         prompt_integer(&print_entries, "Enter display entries (lines)");
774                         if (print_entries == 0) {
775                                 sig_winch_handler(SIGWINCH);
776                                 signal(SIGWINCH, sig_winch_handler);
777                         } else
778                                 signal(SIGWINCH, SIG_DFL);
779                         break;
780                 case 'E':
781                         if (nr_counters > 1) {
782                                 int i;
783
784                                 fprintf(stderr, "\nAvailable events:");
785                                 for (i = 0; i < nr_counters; i++)
786                                         fprintf(stderr, "\n\t%d %s", i, event_name(i));
787
788                                 prompt_integer(&sym_counter, "Enter details event counter");
789
790                                 if (sym_counter >= nr_counters) {
791                                         fprintf(stderr, "Sorry, no such event, using %s.\n", event_name(0));
792                                         sym_counter = 0;
793                                         sleep(1);
794                                 }
795                         } else sym_counter = 0;
796                         break;
797                 case 'f':
798                         prompt_integer(&count_filter, "Enter display event count filter");
799                         break;
800                 case 'F':
801                         prompt_percent(&sym_pcnt_filter, "Enter details display event filter (percent)");
802                         break;
803                 case 'K':
804                         hide_kernel_symbols = !hide_kernel_symbols;
805                         break;
806                 case 'q':
807                 case 'Q':
808                         printf("exiting.\n");
809                         if (dump_symtab)
810                                 dsos__fprintf(stderr);
811                         exit(0);
812                 case 's':
813                         prompt_symbol(&sym_filter_entry, "Enter details symbol");
814                         break;
815                 case 'S':
816                         if (!sym_filter_entry)
817                                 break;
818                         else {
819                                 struct sym_entry *syme = sym_filter_entry;
820
821                                 pthread_mutex_lock(&syme->src->lock);
822                                 sym_filter_entry = NULL;
823                                 __zero_source_counters(syme);
824                                 pthread_mutex_unlock(&syme->src->lock);
825                         }
826                         break;
827                 case 'U':
828                         hide_user_symbols = !hide_user_symbols;
829                         break;
830                 case 'w':
831                         display_weighted = ~display_weighted;
832                         break;
833                 case 'z':
834                         zero = ~zero;
835                         break;
836                 default:
837                         break;
838         }
839 }
840
841 static void *display_thread(void *arg __used)
842 {
843         struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
844         struct termios tc, save;
845         int delay_msecs, c;
846
847         tcgetattr(0, &save);
848         tc = save;
849         tc.c_lflag &= ~(ICANON | ECHO);
850         tc.c_cc[VMIN] = 0;
851         tc.c_cc[VTIME] = 0;
852
853 repeat:
854         delay_msecs = delay_secs * 1000;
855         tcsetattr(0, TCSANOW, &tc);
856         /* trash return*/
857         getc(stdin);
858
859         do {
860                 print_sym_table();
861         } while (!poll(&stdin_poll, 1, delay_msecs) == 1);
862
863         c = getc(stdin);
864         tcsetattr(0, TCSAFLUSH, &save);
865
866         handle_keypress(c);
867         goto repeat;
868
869         return NULL;
870 }
871
872 /* Tag samples to be skipped. */
873 static const char *skip_symbols[] = {
874         "default_idle",
875         "cpu_idle",
876         "enter_idle",
877         "exit_idle",
878         "mwait_idle",
879         "mwait_idle_with_hints",
880         "poll_idle",
881         "ppc64_runlatch_off",
882         "pseries_dedicated_idle_sleep",
883         NULL
884 };
885
886 static int symbol_filter(struct map *map, struct symbol *sym)
887 {
888         struct sym_entry *syme;
889         const char *name = sym->name;
890         int i;
891
892         /*
893          * ppc64 uses function descriptors and appends a '.' to the
894          * start of every instruction address. Remove it.
895          */
896         if (name[0] == '.')
897                 name++;
898
899         if (!strcmp(name, "_text") ||
900             !strcmp(name, "_etext") ||
901             !strcmp(name, "_sinittext") ||
902             !strncmp("init_module", name, 11) ||
903             !strncmp("cleanup_module", name, 14) ||
904             strstr(name, "_text_start") ||
905             strstr(name, "_text_end"))
906                 return 1;
907
908         syme = symbol__priv(sym);
909         syme->map = map;
910         syme->src = NULL;
911
912         if (!sym_filter_entry && sym_filter && !strcmp(name, sym_filter)) {
913                 /* schedule initial sym_filter_entry setup */
914                 sym_filter_entry_sched = syme;
915                 sym_filter = NULL;
916         }
917
918         for (i = 0; skip_symbols[i]; i++) {
919                 if (!strcmp(skip_symbols[i], name)) {
920                         syme->skip = 1;
921                         break;
922                 }
923         }
924
925         if (!syme->skip)
926                 syme->name_len = strlen(sym->name);
927
928         return 0;
929 }
930
931 static void event__process_sample(const event_t *self,
932                                  struct perf_session *session, int counter)
933 {
934         u64 ip = self->ip.ip;
935         struct sym_entry *syme;
936         struct addr_location al;
937         u8 origin = self->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
938
939         ++samples;
940
941         switch (origin) {
942         case PERF_RECORD_MISC_USER:
943                 ++userspace_samples;
944                 if (hide_user_symbols)
945                         return;
946                 break;
947         case PERF_RECORD_MISC_KERNEL:
948                 if (hide_kernel_symbols)
949                         return;
950                 break;
951         default:
952                 return;
953         }
954
955         if (event__preprocess_sample(self, session, &al, symbol_filter) < 0 ||
956             al.filtered)
957                 return;
958
959         if (al.sym == NULL) {
960                 /*
961                  * As we do lazy loading of symtabs we only will know if the
962                  * specified vmlinux file is invalid when we actually have a
963                  * hit in kernel space and then try to load it. So if we get
964                  * here and there are _no_ symbols in the DSO backing the
965                  * kernel map, bail out.
966                  *
967                  * We may never get here, for instance, if we use -K/
968                  * --hide-kernel-symbols, even if the user specifies an
969                  * invalid --vmlinux ;-)
970                  */
971                 if (al.map == session->vmlinux_maps[MAP__FUNCTION] &&
972                     RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION])) {
973                         pr_err("The %s file can't be used\n",
974                                symbol_conf.vmlinux_name);
975                         exit(1);
976                 }
977
978                 return;
979         }
980
981         /* let's see, whether we need to install initial sym_filter_entry */
982         if (sym_filter_entry_sched) {
983                 sym_filter_entry = sym_filter_entry_sched;
984                 sym_filter_entry_sched = NULL;
985                 parse_source(sym_filter_entry);
986         }
987
988         syme = symbol__priv(al.sym);
989         if (!syme->skip) {
990                 syme->count[counter]++;
991                 syme->origin = origin;
992                 record_precise_ip(syme, counter, ip);
993                 pthread_mutex_lock(&active_symbols_lock);
994                 if (list_empty(&syme->node) || !syme->node.next)
995                         __list_insert_active_sym(syme);
996                 pthread_mutex_unlock(&active_symbols_lock);
997         }
998 }
999
1000 static int event__process(event_t *event, struct perf_session *session)
1001 {
1002         switch (event->header.type) {
1003         case PERF_RECORD_COMM:
1004                 event__process_comm(event, session);
1005                 break;
1006         case PERF_RECORD_MMAP:
1007                 event__process_mmap(event, session);
1008                 break;
1009         case PERF_RECORD_FORK:
1010         case PERF_RECORD_EXIT:
1011                 event__process_task(event, session);
1012                 break;
1013         default:
1014                 break;
1015         }
1016
1017         return 0;
1018 }
1019
1020 struct mmap_data {
1021         int                     counter;
1022         void                    *base;
1023         int                     mask;
1024         unsigned int            prev;
1025 };
1026
1027 static unsigned int mmap_read_head(struct mmap_data *md)
1028 {
1029         struct perf_event_mmap_page *pc = md->base;
1030         int head;
1031
1032         head = pc->data_head;
1033         rmb();
1034
1035         return head;
1036 }
1037
1038 static void perf_session__mmap_read_counter(struct perf_session *self,
1039                                             struct mmap_data *md)
1040 {
1041         unsigned int head = mmap_read_head(md);
1042         unsigned int old = md->prev;
1043         unsigned char *data = md->base + page_size;
1044         int diff;
1045
1046         /*
1047          * If we're further behind than half the buffer, there's a chance
1048          * the writer will bite our tail and mess up the samples under us.
1049          *
1050          * If we somehow ended up ahead of the head, we got messed up.
1051          *
1052          * In either case, truncate and restart at head.
1053          */
1054         diff = head - old;
1055         if (diff > md->mask / 2 || diff < 0) {
1056                 fprintf(stderr, "WARNING: failed to keep up with mmap data.\n");
1057
1058                 /*
1059                  * head points to a known good entry, start there.
1060                  */
1061                 old = head;
1062         }
1063
1064         for (; old != head;) {
1065                 event_t *event = (event_t *)&data[old & md->mask];
1066
1067                 event_t event_copy;
1068
1069                 size_t size = event->header.size;
1070
1071                 /*
1072                  * Event straddles the mmap boundary -- header should always
1073                  * be inside due to u64 alignment of output.
1074                  */
1075                 if ((old & md->mask) + size != ((old + size) & md->mask)) {
1076                         unsigned int offset = old;
1077                         unsigned int len = min(sizeof(*event), size), cpy;
1078                         void *dst = &event_copy;
1079
1080                         do {
1081                                 cpy = min(md->mask + 1 - (offset & md->mask), len);
1082                                 memcpy(dst, &data[offset & md->mask], cpy);
1083                                 offset += cpy;
1084                                 dst += cpy;
1085                                 len -= cpy;
1086                         } while (len);
1087
1088                         event = &event_copy;
1089                 }
1090
1091                 if (event->header.type == PERF_RECORD_SAMPLE)
1092                         event__process_sample(event, self, md->counter);
1093                 else
1094                         event__process(event, self);
1095                 old += size;
1096         }
1097
1098         md->prev = old;
1099 }
1100
1101 static struct pollfd event_array[MAX_NR_CPUS * MAX_COUNTERS];
1102 static struct mmap_data mmap_array[MAX_NR_CPUS][MAX_COUNTERS];
1103
1104 static void perf_session__mmap_read(struct perf_session *self)
1105 {
1106         int i, counter;
1107
1108         for (i = 0; i < nr_cpus; i++) {
1109                 for (counter = 0; counter < nr_counters; counter++)
1110                         perf_session__mmap_read_counter(self, &mmap_array[i][counter]);
1111         }
1112 }
1113
1114 int nr_poll;
1115 int group_fd;
1116
1117 static void start_counter(int i, int counter)
1118 {
1119         struct perf_event_attr *attr;
1120         int cpu;
1121
1122         cpu = profile_cpu;
1123         if (target_pid == -1 && profile_cpu == -1)
1124                 cpu = i;
1125
1126         attr = attrs + counter;
1127
1128         attr->sample_type       = PERF_SAMPLE_IP | PERF_SAMPLE_TID;
1129
1130         if (freq) {
1131                 attr->sample_type       |= PERF_SAMPLE_PERIOD;
1132                 attr->freq              = 1;
1133                 attr->sample_freq       = freq;
1134         }
1135
1136         attr->inherit           = (cpu < 0) && inherit;
1137         attr->mmap              = 1;
1138
1139 try_again:
1140         fd[i][counter] = sys_perf_event_open(attr, target_pid, cpu, group_fd, 0);
1141
1142         if (fd[i][counter] < 0) {
1143                 int err = errno;
1144
1145                 if (err == EPERM || err == EACCES)
1146                         die("No permission - are you root?\n");
1147                 /*
1148                  * If it's cycles then fall back to hrtimer
1149                  * based cpu-clock-tick sw counter, which
1150                  * is always available even if no PMU support:
1151                  */
1152                 if (attr->type == PERF_TYPE_HARDWARE
1153                         && attr->config == PERF_COUNT_HW_CPU_CYCLES) {
1154
1155                         if (verbose)
1156                                 warning(" ... trying to fall back to cpu-clock-ticks\n");
1157
1158                         attr->type = PERF_TYPE_SOFTWARE;
1159                         attr->config = PERF_COUNT_SW_CPU_CLOCK;
1160                         goto try_again;
1161                 }
1162                 printf("\n");
1163                 error("perfcounter syscall returned with %d (%s)\n",
1164                         fd[i][counter], strerror(err));
1165                 die("No CONFIG_PERF_EVENTS=y kernel support configured?\n");
1166                 exit(-1);
1167         }
1168         assert(fd[i][counter] >= 0);
1169         fcntl(fd[i][counter], F_SETFL, O_NONBLOCK);
1170
1171         /*
1172          * First counter acts as the group leader:
1173          */
1174         if (group && group_fd == -1)
1175                 group_fd = fd[i][counter];
1176
1177         event_array[nr_poll].fd = fd[i][counter];
1178         event_array[nr_poll].events = POLLIN;
1179         nr_poll++;
1180
1181         mmap_array[i][counter].counter = counter;
1182         mmap_array[i][counter].prev = 0;
1183         mmap_array[i][counter].mask = mmap_pages*page_size - 1;
1184         mmap_array[i][counter].base = mmap(NULL, (mmap_pages+1)*page_size,
1185                         PROT_READ, MAP_SHARED, fd[i][counter], 0);
1186         if (mmap_array[i][counter].base == MAP_FAILED)
1187                 die("failed to mmap with %d (%s)\n", errno, strerror(errno));
1188 }
1189
1190 static int __cmd_top(void)
1191 {
1192         pthread_t thread;
1193         int i, counter;
1194         int ret;
1195         /*
1196          * FIXME: perf_session__new should allow passing a O_MMAP, so that all this
1197          * mmap reading, etc is encapsulated in it. Use O_WRONLY for now.
1198          */
1199         struct perf_session *session = perf_session__new(NULL, O_WRONLY, false);
1200         if (session == NULL)
1201                 return -ENOMEM;
1202
1203         if (target_pid != -1)
1204                 event__synthesize_thread(target_pid, event__process, session);
1205         else
1206                 event__synthesize_threads(event__process, session);
1207
1208         for (i = 0; i < nr_cpus; i++) {
1209                 group_fd = -1;
1210                 for (counter = 0; counter < nr_counters; counter++)
1211                         start_counter(i, counter);
1212         }
1213
1214         /* Wait for a minimal set of events before starting the snapshot */
1215         poll(event_array, nr_poll, 100);
1216
1217         perf_session__mmap_read(session);
1218
1219         if (pthread_create(&thread, NULL, display_thread, NULL)) {
1220                 printf("Could not create display thread.\n");
1221                 exit(-1);
1222         }
1223
1224         if (realtime_prio) {
1225                 struct sched_param param;
1226
1227                 param.sched_priority = realtime_prio;
1228                 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
1229                         printf("Could not set realtime priority.\n");
1230                         exit(-1);
1231                 }
1232         }
1233
1234         while (1) {
1235                 int hits = samples;
1236
1237                 perf_session__mmap_read(session);
1238
1239                 if (hits == samples)
1240                         ret = poll(event_array, nr_poll, 100);
1241         }
1242
1243         return 0;
1244 }
1245
1246 static const char * const top_usage[] = {
1247         "perf top [<options>]",
1248         NULL
1249 };
1250
1251 static const struct option options[] = {
1252         OPT_CALLBACK('e', "event", NULL, "event",
1253                      "event selector. use 'perf list' to list available events",
1254                      parse_events),
1255         OPT_INTEGER('c', "count", &default_interval,
1256                     "event period to sample"),
1257         OPT_INTEGER('p', "pid", &target_pid,
1258                     "profile events on existing pid"),
1259         OPT_BOOLEAN('a', "all-cpus", &system_wide,
1260                             "system-wide collection from all CPUs"),
1261         OPT_INTEGER('C', "CPU", &profile_cpu,
1262                     "CPU to profile on"),
1263         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1264                    "file", "vmlinux pathname"),
1265         OPT_BOOLEAN('K', "hide_kernel_symbols", &hide_kernel_symbols,
1266                     "hide kernel symbols"),
1267         OPT_INTEGER('m', "mmap-pages", &mmap_pages,
1268                     "number of mmap data pages"),
1269         OPT_INTEGER('r', "realtime", &realtime_prio,
1270                     "collect data with this RT SCHED_FIFO priority"),
1271         OPT_INTEGER('d', "delay", &delay_secs,
1272                     "number of seconds to delay between refreshes"),
1273         OPT_BOOLEAN('D', "dump-symtab", &dump_symtab,
1274                             "dump the symbol table used for profiling"),
1275         OPT_INTEGER('f', "count-filter", &count_filter,
1276                     "only display functions with more events than this"),
1277         OPT_BOOLEAN('g', "group", &group,
1278                             "put the counters into a counter group"),
1279         OPT_BOOLEAN('i', "inherit", &inherit,
1280                     "child tasks inherit counters"),
1281         OPT_STRING('s', "sym-annotate", &sym_filter, "symbol name",
1282                     "symbol to annotate"),
1283         OPT_BOOLEAN('z', "zero", &zero,
1284                     "zero history across updates"),
1285         OPT_INTEGER('F', "freq", &freq,
1286                     "profile at this frequency"),
1287         OPT_INTEGER('E', "entries", &print_entries,
1288                     "display this many functions"),
1289         OPT_BOOLEAN('U', "hide_user_symbols", &hide_user_symbols,
1290                     "hide user symbols"),
1291         OPT_BOOLEAN('v', "verbose", &verbose,
1292                     "be more verbose (show counter open errors, etc)"),
1293         OPT_END()
1294 };
1295
1296 int cmd_top(int argc, const char **argv, const char *prefix __used)
1297 {
1298         int counter;
1299
1300         page_size = sysconf(_SC_PAGE_SIZE);
1301
1302         argc = parse_options(argc, argv, options, top_usage, 0);
1303         if (argc)
1304                 usage_with_options(top_usage, options);
1305
1306         /* CPU and PID are mutually exclusive */
1307         if (target_pid != -1 && profile_cpu != -1) {
1308                 printf("WARNING: PID switch overriding CPU\n");
1309                 sleep(1);
1310                 profile_cpu = -1;
1311         }
1312
1313         if (!nr_counters)
1314                 nr_counters = 1;
1315
1316         symbol_conf.priv_size = (sizeof(struct sym_entry) +
1317                                  (nr_counters + 1) * sizeof(unsigned long));
1318
1319         symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1320         if (symbol__init() < 0)
1321                 return -1;
1322
1323         if (delay_secs < 1)
1324                 delay_secs = 1;
1325
1326         /*
1327          * User specified count overrides default frequency.
1328          */
1329         if (default_interval)
1330                 freq = 0;
1331         else if (freq) {
1332                 default_interval = freq;
1333         } else {
1334                 fprintf(stderr, "frequency and count are zero, aborting\n");
1335                 exit(EXIT_FAILURE);
1336         }
1337
1338         /*
1339          * Fill in the ones not specifically initialized via -c:
1340          */
1341         for (counter = 0; counter < nr_counters; counter++) {
1342                 if (attrs[counter].sample_period)
1343                         continue;
1344
1345                 attrs[counter].sample_period = default_interval;
1346         }
1347
1348         nr_cpus = sysconf(_SC_NPROCESSORS_ONLN);
1349         assert(nr_cpus <= MAX_NR_CPUS);
1350         assert(nr_cpus >= 0);
1351
1352         if (target_pid != -1 || profile_cpu != -1)
1353                 nr_cpus = 1;
1354
1355         get_term_dimensions(&winsize);
1356         if (print_entries == 0) {
1357                 update_print_entries(&winsize);
1358                 signal(SIGWINCH, sig_winch_handler);
1359         }
1360
1361         return __cmd_top();
1362 }