perf top: Move skip symbols to an array
[deliverable/linux.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/symbol.h"
24 #include "util/color.h"
25 #include "util/util.h"
26 #include "util/rbtree.h"
27 #include "util/parse-options.h"
28 #include "util/parse-events.h"
29
30 #include <assert.h>
31 #include <fcntl.h>
32
33 #include <stdio.h>
34
35 #include <errno.h>
36 #include <time.h>
37 #include <sched.h>
38 #include <pthread.h>
39
40 #include <sys/syscall.h>
41 #include <sys/ioctl.h>
42 #include <sys/poll.h>
43 #include <sys/prctl.h>
44 #include <sys/wait.h>
45 #include <sys/uio.h>
46 #include <sys/mman.h>
47
48 #include <linux/unistd.h>
49 #include <linux/types.h>
50
51 static int fd[MAX_NR_CPUS][MAX_COUNTERS];
52
53 static int system_wide = 0;
54
55 static int default_interval = 100000;
56
57 static u64 count_filter = 5;
58 static int print_entries = 15;
59
60 static int target_pid = -1;
61 static int profile_cpu = -1;
62 static int nr_cpus = 0;
63 static unsigned int realtime_prio = 0;
64 static int group = 0;
65 static unsigned int page_size;
66 static unsigned int mmap_pages = 16;
67 static int freq = 0;
68 static int verbose = 0;
69
70 static char *sym_filter;
71 static unsigned long filter_start;
72 static unsigned long filter_end;
73
74 static int delay_secs = 2;
75 static int zero;
76 static int dump_symtab;
77
78 /*
79 * Symbols
80 */
81
82 static u64 min_ip;
83 static u64 max_ip = -1ll;
84
85 struct sym_entry {
86 struct rb_node rb_node;
87 struct list_head node;
88 unsigned long count[MAX_COUNTERS];
89 unsigned long snap_count;
90 double weight;
91 int skip;
92 };
93
94 struct sym_entry *sym_filter_entry;
95
96 struct dso *kernel_dso;
97
98 /*
99 * Symbols will be added here in record_ip and will get out
100 * after decayed.
101 */
102 static LIST_HEAD(active_symbols);
103 static pthread_mutex_t active_symbols_lock = PTHREAD_MUTEX_INITIALIZER;
104
105 /*
106 * Ordering weight: count-1 * count-2 * ... / count-n
107 */
108 static double sym_weight(const struct sym_entry *sym)
109 {
110 double weight = sym->snap_count;
111 int counter;
112
113 for (counter = 1; counter < nr_counters-1; counter++)
114 weight *= sym->count[counter];
115
116 weight /= (sym->count[counter] + 1);
117
118 return weight;
119 }
120
121 static long samples;
122 static long userspace_samples;
123 static const char CONSOLE_CLEAR[] = "\e[H\e[2J";
124
125 static void __list_insert_active_sym(struct sym_entry *syme)
126 {
127 list_add(&syme->node, &active_symbols);
128 }
129
130 static void list_remove_active_sym(struct sym_entry *syme)
131 {
132 pthread_mutex_lock(&active_symbols_lock);
133 list_del_init(&syme->node);
134 pthread_mutex_unlock(&active_symbols_lock);
135 }
136
137 static void rb_insert_active_sym(struct rb_root *tree, struct sym_entry *se)
138 {
139 struct rb_node **p = &tree->rb_node;
140 struct rb_node *parent = NULL;
141 struct sym_entry *iter;
142
143 while (*p != NULL) {
144 parent = *p;
145 iter = rb_entry(parent, struct sym_entry, rb_node);
146
147 if (se->weight > iter->weight)
148 p = &(*p)->rb_left;
149 else
150 p = &(*p)->rb_right;
151 }
152
153 rb_link_node(&se->rb_node, parent, p);
154 rb_insert_color(&se->rb_node, tree);
155 }
156
157 static void print_sym_table(void)
158 {
159 int printed = 0, j;
160 int counter;
161 float samples_per_sec = samples/delay_secs;
162 float ksamples_per_sec = (samples-userspace_samples)/delay_secs;
163 float sum_ksamples = 0.0;
164 struct sym_entry *syme, *n;
165 struct rb_root tmp = RB_ROOT;
166 struct rb_node *nd;
167
168 samples = userspace_samples = 0;
169
170 /* Sort the active symbols */
171 pthread_mutex_lock(&active_symbols_lock);
172 syme = list_entry(active_symbols.next, struct sym_entry, node);
173 pthread_mutex_unlock(&active_symbols_lock);
174
175 list_for_each_entry_safe_from(syme, n, &active_symbols, node) {
176 syme->snap_count = syme->count[0];
177 if (syme->snap_count != 0) {
178 syme->weight = sym_weight(syme);
179 rb_insert_active_sym(&tmp, syme);
180 sum_ksamples += syme->snap_count;
181
182 for (j = 0; j < nr_counters; j++)
183 syme->count[j] = zero ? 0 : syme->count[j] * 7 / 8;
184 } else
185 list_remove_active_sym(syme);
186 }
187
188 puts(CONSOLE_CLEAR);
189
190 printf(
191 "------------------------------------------------------------------------------\n");
192 printf( " PerfTop:%8.0f irqs/sec kernel:%4.1f%% [",
193 samples_per_sec,
194 100.0 - (100.0*((samples_per_sec-ksamples_per_sec)/samples_per_sec)));
195
196 if (nr_counters == 1) {
197 printf("%Ld", (u64)attrs[0].sample_period);
198 if (freq)
199 printf("Hz ");
200 else
201 printf(" ");
202 }
203
204 for (counter = 0; counter < nr_counters; counter++) {
205 if (counter)
206 printf("/");
207
208 printf("%s", event_name(counter));
209 }
210
211 printf( "], ");
212
213 if (target_pid != -1)
214 printf(" (target_pid: %d", target_pid);
215 else
216 printf(" (all");
217
218 if (profile_cpu != -1)
219 printf(", cpu: %d)\n", profile_cpu);
220 else {
221 if (target_pid != -1)
222 printf(")\n");
223 else
224 printf(", %d CPUs)\n", nr_cpus);
225 }
226
227 printf("------------------------------------------------------------------------------\n\n");
228
229 if (nr_counters == 1)
230 printf(" samples pcnt");
231 else
232 printf(" weight samples pcnt");
233
234 printf(" RIP kernel function\n"
235 " ______ _______ _____ ________________ _______________\n\n"
236 );
237
238 for (nd = rb_first(&tmp); nd; nd = rb_next(nd)) {
239 struct sym_entry *syme = rb_entry(nd, struct sym_entry, rb_node);
240 struct symbol *sym = (struct symbol *)(syme + 1);
241 char *color = PERF_COLOR_NORMAL;
242 double pcnt;
243
244 if (++printed > print_entries || syme->snap_count < count_filter)
245 continue;
246
247 pcnt = 100.0 - (100.0 * ((sum_ksamples - syme->snap_count) /
248 sum_ksamples));
249
250 /*
251 * We color high-overhead entries in red, mid-overhead
252 * entries in green - and keep the low overhead places
253 * normal:
254 */
255 if (pcnt >= 5.0) {
256 color = PERF_COLOR_RED;
257 } else {
258 if (pcnt >= 0.5)
259 color = PERF_COLOR_GREEN;
260 }
261
262 if (nr_counters == 1)
263 printf("%20.2f - ", syme->weight);
264 else
265 printf("%9.1f %10ld - ", syme->weight, syme->snap_count);
266
267 color_fprintf(stdout, color, "%4.1f%%", pcnt);
268 printf(" - %016llx : %s\n", sym->start, sym->name);
269 }
270 }
271
272 static void *display_thread(void *arg)
273 {
274 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
275 int delay_msecs = delay_secs * 1000;
276
277 printf("PerfTop refresh period: %d seconds\n", delay_secs);
278
279 do {
280 print_sym_table();
281 } while (!poll(&stdin_poll, 1, delay_msecs) == 1);
282
283 printf("key pressed - exiting.\n");
284 exit(0);
285
286 return NULL;
287 }
288
289 /* Tag samples to be skipped. */
290 char *skip_symbols[] = {
291 "default_idle",
292 "cpu_idle",
293 "enter_idle",
294 "exit_idle",
295 "mwait_idle",
296 NULL
297 };
298
299 static int symbol_filter(struct dso *self, struct symbol *sym)
300 {
301 static int filter_match;
302 struct sym_entry *syme;
303 const char *name = sym->name;
304 int i;
305
306 if (!strcmp(name, "_text") ||
307 !strcmp(name, "_etext") ||
308 !strcmp(name, "_sinittext") ||
309 !strncmp("init_module", name, 11) ||
310 !strncmp("cleanup_module", name, 14) ||
311 strstr(name, "_text_start") ||
312 strstr(name, "_text_end"))
313 return 1;
314
315 syme = dso__sym_priv(self, sym);
316 for (i = 0; skip_symbols[i]; i++) {
317 if (!strcmp(skip_symbols[i], name)) {
318 syme->skip = 1;
319 break;
320 }
321 }
322
323 if (filter_match == 1) {
324 filter_end = sym->start;
325 filter_match = -1;
326 if (filter_end - filter_start > 10000) {
327 fprintf(stderr,
328 "hm, too large filter symbol <%s> - skipping.\n",
329 sym_filter);
330 fprintf(stderr, "symbol filter start: %016lx\n",
331 filter_start);
332 fprintf(stderr, " end: %016lx\n",
333 filter_end);
334 filter_end = filter_start = 0;
335 sym_filter = NULL;
336 sleep(1);
337 }
338 }
339
340 if (filter_match == 0 && sym_filter && !strcmp(name, sym_filter)) {
341 filter_match = 1;
342 filter_start = sym->start;
343 }
344
345
346 return 0;
347 }
348
349 static int parse_symbols(void)
350 {
351 struct rb_node *node;
352 struct symbol *sym;
353
354 kernel_dso = dso__new("[kernel]", sizeof(struct sym_entry));
355 if (kernel_dso == NULL)
356 return -1;
357
358 if (dso__load_kernel(kernel_dso, NULL, symbol_filter, 1) != 0)
359 goto out_delete_dso;
360
361 node = rb_first(&kernel_dso->syms);
362 sym = rb_entry(node, struct symbol, rb_node);
363 min_ip = sym->start;
364
365 node = rb_last(&kernel_dso->syms);
366 sym = rb_entry(node, struct symbol, rb_node);
367 max_ip = sym->end;
368
369 if (dump_symtab)
370 dso__fprintf(kernel_dso, stderr);
371
372 return 0;
373
374 out_delete_dso:
375 dso__delete(kernel_dso);
376 kernel_dso = NULL;
377 return -1;
378 }
379
380 #define TRACE_COUNT 3
381
382 /*
383 * Binary search in the histogram table and record the hit:
384 */
385 static void record_ip(u64 ip, int counter)
386 {
387 struct symbol *sym = dso__find_symbol(kernel_dso, ip);
388
389 if (sym != NULL) {
390 struct sym_entry *syme = dso__sym_priv(kernel_dso, sym);
391
392 if (!syme->skip) {
393 syme->count[counter]++;
394 pthread_mutex_lock(&active_symbols_lock);
395 if (list_empty(&syme->node) || !syme->node.next)
396 __list_insert_active_sym(syme);
397 pthread_mutex_unlock(&active_symbols_lock);
398 return;
399 }
400 }
401
402 samples--;
403 }
404
405 static void process_event(u64 ip, int counter, int user)
406 {
407 samples++;
408
409 if (user) {
410 userspace_samples++;
411 return;
412 }
413
414 record_ip(ip, counter);
415 }
416
417 struct mmap_data {
418 int counter;
419 void *base;
420 unsigned int mask;
421 unsigned int prev;
422 };
423
424 static unsigned int mmap_read_head(struct mmap_data *md)
425 {
426 struct perf_counter_mmap_page *pc = md->base;
427 int head;
428
429 head = pc->data_head;
430 rmb();
431
432 return head;
433 }
434
435 struct timeval last_read, this_read;
436
437 static void mmap_read_counter(struct mmap_data *md)
438 {
439 unsigned int head = mmap_read_head(md);
440 unsigned int old = md->prev;
441 unsigned char *data = md->base + page_size;
442 int diff;
443
444 gettimeofday(&this_read, NULL);
445
446 /*
447 * If we're further behind than half the buffer, there's a chance
448 * the writer will bite our tail and mess up the samples under us.
449 *
450 * If we somehow ended up ahead of the head, we got messed up.
451 *
452 * In either case, truncate and restart at head.
453 */
454 diff = head - old;
455 if (diff > md->mask / 2 || diff < 0) {
456 struct timeval iv;
457 unsigned long msecs;
458
459 timersub(&this_read, &last_read, &iv);
460 msecs = iv.tv_sec*1000 + iv.tv_usec/1000;
461
462 fprintf(stderr, "WARNING: failed to keep up with mmap data."
463 " Last read %lu msecs ago.\n", msecs);
464
465 /*
466 * head points to a known good entry, start there.
467 */
468 old = head;
469 }
470
471 last_read = this_read;
472
473 for (; old != head;) {
474 struct ip_event {
475 struct perf_event_header header;
476 u64 ip;
477 u32 pid, target_pid;
478 };
479 struct mmap_event {
480 struct perf_event_header header;
481 u32 pid, target_pid;
482 u64 start;
483 u64 len;
484 u64 pgoff;
485 char filename[PATH_MAX];
486 };
487
488 typedef union event_union {
489 struct perf_event_header header;
490 struct ip_event ip;
491 struct mmap_event mmap;
492 } event_t;
493
494 event_t *event = (event_t *)&data[old & md->mask];
495
496 event_t event_copy;
497
498 size_t size = event->header.size;
499
500 /*
501 * Event straddles the mmap boundary -- header should always
502 * be inside due to u64 alignment of output.
503 */
504 if ((old & md->mask) + size != ((old + size) & md->mask)) {
505 unsigned int offset = old;
506 unsigned int len = min(sizeof(*event), size), cpy;
507 void *dst = &event_copy;
508
509 do {
510 cpy = min(md->mask + 1 - (offset & md->mask), len);
511 memcpy(dst, &data[offset & md->mask], cpy);
512 offset += cpy;
513 dst += cpy;
514 len -= cpy;
515 } while (len);
516
517 event = &event_copy;
518 }
519
520 old += size;
521
522 if (event->header.type == PERF_EVENT_SAMPLE) {
523 int user =
524 (event->header.misc & PERF_EVENT_MISC_CPUMODE_MASK) == PERF_EVENT_MISC_USER;
525 process_event(event->ip.ip, md->counter, user);
526 }
527 }
528
529 md->prev = old;
530 }
531
532 static struct pollfd event_array[MAX_NR_CPUS * MAX_COUNTERS];
533 static struct mmap_data mmap_array[MAX_NR_CPUS][MAX_COUNTERS];
534
535 static void mmap_read(void)
536 {
537 int i, counter;
538
539 for (i = 0; i < nr_cpus; i++) {
540 for (counter = 0; counter < nr_counters; counter++)
541 mmap_read_counter(&mmap_array[i][counter]);
542 }
543 }
544
545 int nr_poll;
546 int group_fd;
547
548 static void start_counter(int i, int counter)
549 {
550 struct perf_counter_attr *attr;
551 unsigned int cpu;
552
553 cpu = profile_cpu;
554 if (target_pid == -1 && profile_cpu == -1)
555 cpu = i;
556
557 attr = attrs + counter;
558
559 attr->sample_type = PERF_SAMPLE_IP | PERF_SAMPLE_TID;
560 attr->freq = freq;
561
562 try_again:
563 fd[i][counter] = sys_perf_counter_open(attr, target_pid, cpu, group_fd, 0);
564
565 if (fd[i][counter] < 0) {
566 int err = errno;
567
568 if (err == EPERM)
569 die("No permission - are you root?\n");
570 /*
571 * If it's cycles then fall back to hrtimer
572 * based cpu-clock-tick sw counter, which
573 * is always available even if no PMU support:
574 */
575 if (attr->type == PERF_TYPE_HARDWARE
576 && attr->config == PERF_COUNT_HW_CPU_CYCLES) {
577
578 if (verbose)
579 warning(" ... trying to fall back to cpu-clock-ticks\n");
580
581 attr->type = PERF_TYPE_SOFTWARE;
582 attr->config = PERF_COUNT_SW_CPU_CLOCK;
583 goto try_again;
584 }
585 printf("\n");
586 error("perfcounter syscall returned with %d (%s)\n",
587 fd[i][counter], strerror(err));
588 die("No CONFIG_PERF_COUNTERS=y kernel support configured?\n");
589 exit(-1);
590 }
591 assert(fd[i][counter] >= 0);
592 fcntl(fd[i][counter], F_SETFL, O_NONBLOCK);
593
594 /*
595 * First counter acts as the group leader:
596 */
597 if (group && group_fd == -1)
598 group_fd = fd[i][counter];
599
600 event_array[nr_poll].fd = fd[i][counter];
601 event_array[nr_poll].events = POLLIN;
602 nr_poll++;
603
604 mmap_array[i][counter].counter = counter;
605 mmap_array[i][counter].prev = 0;
606 mmap_array[i][counter].mask = mmap_pages*page_size - 1;
607 mmap_array[i][counter].base = mmap(NULL, (mmap_pages+1)*page_size,
608 PROT_READ, MAP_SHARED, fd[i][counter], 0);
609 if (mmap_array[i][counter].base == MAP_FAILED)
610 die("failed to mmap with %d (%s)\n", errno, strerror(errno));
611 }
612
613 static int __cmd_top(void)
614 {
615 pthread_t thread;
616 int i, counter;
617 int ret;
618
619 for (i = 0; i < nr_cpus; i++) {
620 group_fd = -1;
621 for (counter = 0; counter < nr_counters; counter++)
622 start_counter(i, counter);
623 }
624
625 /* Wait for a minimal set of events before starting the snapshot */
626 poll(event_array, nr_poll, 100);
627
628 mmap_read();
629
630 if (pthread_create(&thread, NULL, display_thread, NULL)) {
631 printf("Could not create display thread.\n");
632 exit(-1);
633 }
634
635 if (realtime_prio) {
636 struct sched_param param;
637
638 param.sched_priority = realtime_prio;
639 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
640 printf("Could not set realtime priority.\n");
641 exit(-1);
642 }
643 }
644
645 while (1) {
646 int hits = samples;
647
648 mmap_read();
649
650 if (hits == samples)
651 ret = poll(event_array, nr_poll, 100);
652 }
653
654 return 0;
655 }
656
657 static const char * const top_usage[] = {
658 "perf top [<options>]",
659 NULL
660 };
661
662 static const struct option options[] = {
663 OPT_CALLBACK('e', "event", NULL, "event",
664 "event selector. use 'perf list' to list available events",
665 parse_events),
666 OPT_INTEGER('c', "count", &default_interval,
667 "event period to sample"),
668 OPT_INTEGER('p', "pid", &target_pid,
669 "profile events on existing pid"),
670 OPT_BOOLEAN('a', "all-cpus", &system_wide,
671 "system-wide collection from all CPUs"),
672 OPT_INTEGER('C', "CPU", &profile_cpu,
673 "CPU to profile on"),
674 OPT_INTEGER('m', "mmap-pages", &mmap_pages,
675 "number of mmap data pages"),
676 OPT_INTEGER('r', "realtime", &realtime_prio,
677 "collect data with this RT SCHED_FIFO priority"),
678 OPT_INTEGER('d', "delay", &delay_secs,
679 "number of seconds to delay between refreshes"),
680 OPT_BOOLEAN('D', "dump-symtab", &dump_symtab,
681 "dump the symbol table used for profiling"),
682 OPT_INTEGER('f', "count-filter", &count_filter,
683 "only display functions with more events than this"),
684 OPT_BOOLEAN('g', "group", &group,
685 "put the counters into a counter group"),
686 OPT_STRING('s', "sym-filter", &sym_filter, "pattern",
687 "only display symbols matchig this pattern"),
688 OPT_BOOLEAN('z', "zero", &zero,
689 "zero history across updates"),
690 OPT_INTEGER('F', "freq", &freq,
691 "profile at this frequency"),
692 OPT_INTEGER('E', "entries", &print_entries,
693 "display this many functions"),
694 OPT_BOOLEAN('v', "verbose", &verbose,
695 "be more verbose (show counter open errors, etc)"),
696 OPT_END()
697 };
698
699 int cmd_top(int argc, const char **argv, const char *prefix)
700 {
701 int counter;
702
703 page_size = sysconf(_SC_PAGE_SIZE);
704
705 argc = parse_options(argc, argv, options, top_usage, 0);
706 if (argc)
707 usage_with_options(top_usage, options);
708
709 if (freq) {
710 default_interval = freq;
711 freq = 1;
712 }
713
714 /* CPU and PID are mutually exclusive */
715 if (target_pid != -1 && profile_cpu != -1) {
716 printf("WARNING: PID switch overriding CPU\n");
717 sleep(1);
718 profile_cpu = -1;
719 }
720
721 if (!nr_counters)
722 nr_counters = 1;
723
724 if (delay_secs < 1)
725 delay_secs = 1;
726
727 parse_symbols();
728
729 /*
730 * Fill in the ones not specifically initialized via -c:
731 */
732 for (counter = 0; counter < nr_counters; counter++) {
733 if (attrs[counter].sample_period)
734 continue;
735
736 attrs[counter].sample_period = default_interval;
737 }
738
739 nr_cpus = sysconf(_SC_NPROCESSORS_ONLN);
740 assert(nr_cpus <= MAX_NR_CPUS);
741 assert(nr_cpus >= 0);
742
743 if (target_pid != -1 || profile_cpu != -1)
744 nr_cpus = 1;
745
746 return __cmd_top();
747 }
This page took 0.063517 seconds and 6 git commands to generate.