perf session: Remove sample_type_check from event_ops
[linux-3.10.git] / tools / perf / builtin-kmem.c
1 #include "builtin.h"
2 #include "perf.h"
3
4 #include "util/util.h"
5 #include "util/cache.h"
6 #include "util/symbol.h"
7 #include "util/thread.h"
8 #include "util/header.h"
9 #include "util/session.h"
10
11 #include "util/parse-options.h"
12 #include "util/trace-event.h"
13
14 #include "util/debug.h"
15
16 #include <linux/rbtree.h>
17
18 struct alloc_stat;
19 typedef int (*sort_fn_t)(struct alloc_stat *, struct alloc_stat *);
20
21 static char const               *input_name = "perf.data";
22
23 static int                      alloc_flag;
24 static int                      caller_flag;
25
26 static int                      alloc_lines = -1;
27 static int                      caller_lines = -1;
28
29 static bool                     raw_ip;
30
31 static char                     default_sort_order[] = "frag,hit,bytes";
32
33 static int                      *cpunode_map;
34 static int                      max_cpu_num;
35
36 struct alloc_stat {
37         u64     call_site;
38         u64     ptr;
39         u64     bytes_req;
40         u64     bytes_alloc;
41         u32     hit;
42         u32     pingpong;
43
44         short   alloc_cpu;
45
46         struct rb_node node;
47 };
48
49 static struct rb_root root_alloc_stat;
50 static struct rb_root root_alloc_sorted;
51 static struct rb_root root_caller_stat;
52 static struct rb_root root_caller_sorted;
53
54 static unsigned long total_requested, total_allocated;
55 static unsigned long nr_allocs, nr_cross_allocs;
56
57 #define PATH_SYS_NODE   "/sys/devices/system/node"
58
59 static void init_cpunode_map(void)
60 {
61         FILE *fp;
62         int i;
63
64         fp = fopen("/sys/devices/system/cpu/kernel_max", "r");
65         if (!fp) {
66                 max_cpu_num = 4096;
67                 return;
68         }
69
70         if (fscanf(fp, "%d", &max_cpu_num) < 1)
71                 die("Failed to read 'kernel_max' from sysfs");
72         max_cpu_num++;
73
74         cpunode_map = calloc(max_cpu_num, sizeof(int));
75         if (!cpunode_map)
76                 die("calloc");
77         for (i = 0; i < max_cpu_num; i++)
78                 cpunode_map[i] = -1;
79         fclose(fp);
80 }
81
82 static void setup_cpunode_map(void)
83 {
84         struct dirent *dent1, *dent2;
85         DIR *dir1, *dir2;
86         unsigned int cpu, mem;
87         char buf[PATH_MAX];
88
89         init_cpunode_map();
90
91         dir1 = opendir(PATH_SYS_NODE);
92         if (!dir1)
93                 return;
94
95         while (true) {
96                 dent1 = readdir(dir1);
97                 if (!dent1)
98                         break;
99
100                 if (sscanf(dent1->d_name, "node%u", &mem) < 1)
101                         continue;
102
103                 snprintf(buf, PATH_MAX, "%s/%s", PATH_SYS_NODE, dent1->d_name);
104                 dir2 = opendir(buf);
105                 if (!dir2)
106                         continue;
107                 while (true) {
108                         dent2 = readdir(dir2);
109                         if (!dent2)
110                                 break;
111                         if (sscanf(dent2->d_name, "cpu%u", &cpu) < 1)
112                                 continue;
113                         cpunode_map[cpu] = mem;
114                 }
115         }
116 }
117
118 static void insert_alloc_stat(unsigned long call_site, unsigned long ptr,
119                               int bytes_req, int bytes_alloc, int cpu)
120 {
121         struct rb_node **node = &root_alloc_stat.rb_node;
122         struct rb_node *parent = NULL;
123         struct alloc_stat *data = NULL;
124
125         while (*node) {
126                 parent = *node;
127                 data = rb_entry(*node, struct alloc_stat, node);
128
129                 if (ptr > data->ptr)
130                         node = &(*node)->rb_right;
131                 else if (ptr < data->ptr)
132                         node = &(*node)->rb_left;
133                 else
134                         break;
135         }
136
137         if (data && data->ptr == ptr) {
138                 data->hit++;
139                 data->bytes_req += bytes_req;
140                 data->bytes_alloc += bytes_req;
141         } else {
142                 data = malloc(sizeof(*data));
143                 if (!data)
144                         die("malloc");
145                 data->ptr = ptr;
146                 data->pingpong = 0;
147                 data->hit = 1;
148                 data->bytes_req = bytes_req;
149                 data->bytes_alloc = bytes_alloc;
150
151                 rb_link_node(&data->node, parent, node);
152                 rb_insert_color(&data->node, &root_alloc_stat);
153         }
154         data->call_site = call_site;
155         data->alloc_cpu = cpu;
156 }
157
158 static void insert_caller_stat(unsigned long call_site,
159                               int bytes_req, int bytes_alloc)
160 {
161         struct rb_node **node = &root_caller_stat.rb_node;
162         struct rb_node *parent = NULL;
163         struct alloc_stat *data = NULL;
164
165         while (*node) {
166                 parent = *node;
167                 data = rb_entry(*node, struct alloc_stat, node);
168
169                 if (call_site > data->call_site)
170                         node = &(*node)->rb_right;
171                 else if (call_site < data->call_site)
172                         node = &(*node)->rb_left;
173                 else
174                         break;
175         }
176
177         if (data && data->call_site == call_site) {
178                 data->hit++;
179                 data->bytes_req += bytes_req;
180                 data->bytes_alloc += bytes_req;
181         } else {
182                 data = malloc(sizeof(*data));
183                 if (!data)
184                         die("malloc");
185                 data->call_site = call_site;
186                 data->pingpong = 0;
187                 data->hit = 1;
188                 data->bytes_req = bytes_req;
189                 data->bytes_alloc = bytes_alloc;
190
191                 rb_link_node(&data->node, parent, node);
192                 rb_insert_color(&data->node, &root_caller_stat);
193         }
194 }
195
196 static void process_alloc_event(void *data,
197                                 struct event *event,
198                                 int cpu,
199                                 u64 timestamp __used,
200                                 struct thread *thread __used,
201                                 int node)
202 {
203         unsigned long call_site;
204         unsigned long ptr;
205         int bytes_req;
206         int bytes_alloc;
207         int node1, node2;
208
209         ptr = raw_field_value(event, "ptr", data);
210         call_site = raw_field_value(event, "call_site", data);
211         bytes_req = raw_field_value(event, "bytes_req", data);
212         bytes_alloc = raw_field_value(event, "bytes_alloc", data);
213
214         insert_alloc_stat(call_site, ptr, bytes_req, bytes_alloc, cpu);
215         insert_caller_stat(call_site, bytes_req, bytes_alloc);
216
217         total_requested += bytes_req;
218         total_allocated += bytes_alloc;
219
220         if (node) {
221                 node1 = cpunode_map[cpu];
222                 node2 = raw_field_value(event, "node", data);
223                 if (node1 != node2)
224                         nr_cross_allocs++;
225         }
226         nr_allocs++;
227 }
228
229 static int ptr_cmp(struct alloc_stat *, struct alloc_stat *);
230 static int callsite_cmp(struct alloc_stat *, struct alloc_stat *);
231
232 static struct alloc_stat *search_alloc_stat(unsigned long ptr,
233                                             unsigned long call_site,
234                                             struct rb_root *root,
235                                             sort_fn_t sort_fn)
236 {
237         struct rb_node *node = root->rb_node;
238         struct alloc_stat key = { .ptr = ptr, .call_site = call_site };
239
240         while (node) {
241                 struct alloc_stat *data;
242                 int cmp;
243
244                 data = rb_entry(node, struct alloc_stat, node);
245
246                 cmp = sort_fn(&key, data);
247                 if (cmp < 0)
248                         node = node->rb_left;
249                 else if (cmp > 0)
250                         node = node->rb_right;
251                 else
252                         return data;
253         }
254         return NULL;
255 }
256
257 static void process_free_event(void *data,
258                                struct event *event,
259                                int cpu,
260                                u64 timestamp __used,
261                                struct thread *thread __used)
262 {
263         unsigned long ptr;
264         struct alloc_stat *s_alloc, *s_caller;
265
266         ptr = raw_field_value(event, "ptr", data);
267
268         s_alloc = search_alloc_stat(ptr, 0, &root_alloc_stat, ptr_cmp);
269         if (!s_alloc)
270                 return;
271
272         if (cpu != s_alloc->alloc_cpu) {
273                 s_alloc->pingpong++;
274
275                 s_caller = search_alloc_stat(0, s_alloc->call_site,
276                                              &root_caller_stat, callsite_cmp);
277                 assert(s_caller);
278                 s_caller->pingpong++;
279         }
280         s_alloc->alloc_cpu = -1;
281 }
282
283 static void
284 process_raw_event(event_t *raw_event __used, void *data,
285                   int cpu, u64 timestamp, struct thread *thread)
286 {
287         struct event *event;
288         int type;
289
290         type = trace_parse_common_type(data);
291         event = trace_find_event(type);
292
293         if (!strcmp(event->name, "kmalloc") ||
294             !strcmp(event->name, "kmem_cache_alloc")) {
295                 process_alloc_event(data, event, cpu, timestamp, thread, 0);
296                 return;
297         }
298
299         if (!strcmp(event->name, "kmalloc_node") ||
300             !strcmp(event->name, "kmem_cache_alloc_node")) {
301                 process_alloc_event(data, event, cpu, timestamp, thread, 1);
302                 return;
303         }
304
305         if (!strcmp(event->name, "kfree") ||
306             !strcmp(event->name, "kmem_cache_free")) {
307                 process_free_event(data, event, cpu, timestamp, thread);
308                 return;
309         }
310 }
311
312 static int process_sample_event(event_t *event, struct perf_session *session)
313 {
314         struct sample_data data;
315         struct thread *thread;
316
317         memset(&data, 0, sizeof(data));
318         data.time = -1;
319         data.cpu = -1;
320         data.period = 1;
321
322         event__parse_sample(event, session->sample_type, &data);
323
324         dump_printf("(IP, %d): %d/%d: %p period: %Ld\n",
325                 event->header.misc,
326                 data.pid, data.tid,
327                 (void *)(long)data.ip,
328                 (long long)data.period);
329
330         thread = perf_session__findnew(session, event->ip.pid);
331         if (thread == NULL) {
332                 pr_debug("problem processing %d event, skipping it.\n",
333                          event->header.type);
334                 return -1;
335         }
336
337         dump_printf(" ... thread: %s:%d\n", thread->comm, thread->pid);
338
339         process_raw_event(event, data.raw_data, data.cpu,
340                           data.time, thread);
341
342         return 0;
343 }
344
345 static struct perf_event_ops event_ops = {
346         .process_sample_event   = process_sample_event,
347         .process_comm_event     = event__process_comm,
348 };
349
350 static double fragmentation(unsigned long n_req, unsigned long n_alloc)
351 {
352         if (n_alloc == 0)
353                 return 0.0;
354         else
355                 return 100.0 - (100.0 * n_req / n_alloc);
356 }
357
358 static void __print_result(struct rb_root *root, struct perf_session *session,
359                            int n_lines, int is_caller)
360 {
361         struct rb_node *next;
362
363         printf("%.102s\n", graph_dotted_line);
364         printf(" %-34s |",  is_caller ? "Callsite": "Alloc Ptr");
365         printf(" Total_alloc/Per | Total_req/Per   | Hit   | Ping-pong | Frag\n");
366         printf("%.102s\n", graph_dotted_line);
367
368         next = rb_first(root);
369
370         while (next && n_lines--) {
371                 struct alloc_stat *data = rb_entry(next, struct alloc_stat,
372                                                    node);
373                 struct symbol *sym = NULL;
374                 char buf[BUFSIZ];
375                 u64 addr;
376
377                 if (is_caller) {
378                         addr = data->call_site;
379                         if (!raw_ip)
380                                 sym = map_groups__find_function(&session->kmaps, session, addr, NULL);
381                 } else
382                         addr = data->ptr;
383
384                 if (sym != NULL)
385                         snprintf(buf, sizeof(buf), "%s+%Lx", sym->name,
386                                  addr - sym->start);
387                 else
388                         snprintf(buf, sizeof(buf), "%#Lx", addr);
389                 printf(" %-34s |", buf);
390
391                 printf(" %9llu/%-5lu | %9llu/%-5lu | %6lu | %8lu | %6.3f%%\n",
392                        (unsigned long long)data->bytes_alloc,
393                        (unsigned long)data->bytes_alloc / data->hit,
394                        (unsigned long long)data->bytes_req,
395                        (unsigned long)data->bytes_req / data->hit,
396                        (unsigned long)data->hit,
397                        (unsigned long)data->pingpong,
398                        fragmentation(data->bytes_req, data->bytes_alloc));
399
400                 next = rb_next(next);
401         }
402
403         if (n_lines == -1)
404                 printf(" ...                                | ...             | ...             | ...    | ...      | ...   \n");
405
406         printf("%.102s\n", graph_dotted_line);
407 }
408
409 static void print_summary(void)
410 {
411         printf("\nSUMMARY\n=======\n");
412         printf("Total bytes requested: %lu\n", total_requested);
413         printf("Total bytes allocated: %lu\n", total_allocated);
414         printf("Total bytes wasted on internal fragmentation: %lu\n",
415                total_allocated - total_requested);
416         printf("Internal fragmentation: %f%%\n",
417                fragmentation(total_requested, total_allocated));
418         printf("Cross CPU allocations: %lu/%lu\n", nr_cross_allocs, nr_allocs);
419 }
420
421 static void print_result(struct perf_session *session)
422 {
423         if (caller_flag)
424                 __print_result(&root_caller_sorted, session, caller_lines, 1);
425         if (alloc_flag)
426                 __print_result(&root_alloc_sorted, session, alloc_lines, 0);
427         print_summary();
428 }
429
430 struct sort_dimension {
431         const char              name[20];
432         sort_fn_t               cmp;
433         struct list_head        list;
434 };
435
436 static LIST_HEAD(caller_sort);
437 static LIST_HEAD(alloc_sort);
438
439 static void sort_insert(struct rb_root *root, struct alloc_stat *data,
440                         struct list_head *sort_list)
441 {
442         struct rb_node **new = &(root->rb_node);
443         struct rb_node *parent = NULL;
444         struct sort_dimension *sort;
445
446         while (*new) {
447                 struct alloc_stat *this;
448                 int cmp = 0;
449
450                 this = rb_entry(*new, struct alloc_stat, node);
451                 parent = *new;
452
453                 list_for_each_entry(sort, sort_list, list) {
454                         cmp = sort->cmp(data, this);
455                         if (cmp)
456                                 break;
457                 }
458
459                 if (cmp > 0)
460                         new = &((*new)->rb_left);
461                 else
462                         new = &((*new)->rb_right);
463         }
464
465         rb_link_node(&data->node, parent, new);
466         rb_insert_color(&data->node, root);
467 }
468
469 static void __sort_result(struct rb_root *root, struct rb_root *root_sorted,
470                           struct list_head *sort_list)
471 {
472         struct rb_node *node;
473         struct alloc_stat *data;
474
475         for (;;) {
476                 node = rb_first(root);
477                 if (!node)
478                         break;
479
480                 rb_erase(node, root);
481                 data = rb_entry(node, struct alloc_stat, node);
482                 sort_insert(root_sorted, data, sort_list);
483         }
484 }
485
486 static void sort_result(void)
487 {
488         __sort_result(&root_alloc_stat, &root_alloc_sorted, &alloc_sort);
489         __sort_result(&root_caller_stat, &root_caller_sorted, &caller_sort);
490 }
491
492 static int __cmd_kmem(void)
493 {
494         int err = -EINVAL;
495         struct perf_session *session = perf_session__new(input_name, O_RDONLY, 0);
496         if (session == NULL)
497                 return -ENOMEM;
498
499         if (!perf_session__has_traces(session, "kmem record"))
500                 goto out_delete;
501
502         setup_pager();
503         err = perf_session__process_events(session, &event_ops);
504         if (err != 0)
505                 goto out_delete;
506         sort_result();
507         print_result(session);
508 out_delete:
509         perf_session__delete(session);
510         return err;
511 }
512
513 static const char * const kmem_usage[] = {
514         "perf kmem [<options>] {record|stat}",
515         NULL
516 };
517
518 static int ptr_cmp(struct alloc_stat *l, struct alloc_stat *r)
519 {
520         if (l->ptr < r->ptr)
521                 return -1;
522         else if (l->ptr > r->ptr)
523                 return 1;
524         return 0;
525 }
526
527 static struct sort_dimension ptr_sort_dimension = {
528         .name   = "ptr",
529         .cmp    = ptr_cmp,
530 };
531
532 static int callsite_cmp(struct alloc_stat *l, struct alloc_stat *r)
533 {
534         if (l->call_site < r->call_site)
535                 return -1;
536         else if (l->call_site > r->call_site)
537                 return 1;
538         return 0;
539 }
540
541 static struct sort_dimension callsite_sort_dimension = {
542         .name   = "callsite",
543         .cmp    = callsite_cmp,
544 };
545
546 static int hit_cmp(struct alloc_stat *l, struct alloc_stat *r)
547 {
548         if (l->hit < r->hit)
549                 return -1;
550         else if (l->hit > r->hit)
551                 return 1;
552         return 0;
553 }
554
555 static struct sort_dimension hit_sort_dimension = {
556         .name   = "hit",
557         .cmp    = hit_cmp,
558 };
559
560 static int bytes_cmp(struct alloc_stat *l, struct alloc_stat *r)
561 {
562         if (l->bytes_alloc < r->bytes_alloc)
563                 return -1;
564         else if (l->bytes_alloc > r->bytes_alloc)
565                 return 1;
566         return 0;
567 }
568
569 static struct sort_dimension bytes_sort_dimension = {
570         .name   = "bytes",
571         .cmp    = bytes_cmp,
572 };
573
574 static int frag_cmp(struct alloc_stat *l, struct alloc_stat *r)
575 {
576         double x, y;
577
578         x = fragmentation(l->bytes_req, l->bytes_alloc);
579         y = fragmentation(r->bytes_req, r->bytes_alloc);
580
581         if (x < y)
582                 return -1;
583         else if (x > y)
584                 return 1;
585         return 0;
586 }
587
588 static struct sort_dimension frag_sort_dimension = {
589         .name   = "frag",
590         .cmp    = frag_cmp,
591 };
592
593 static int pingpong_cmp(struct alloc_stat *l, struct alloc_stat *r)
594 {
595         if (l->pingpong < r->pingpong)
596                 return -1;
597         else if (l->pingpong > r->pingpong)
598                 return 1;
599         return 0;
600 }
601
602 static struct sort_dimension pingpong_sort_dimension = {
603         .name   = "pingpong",
604         .cmp    = pingpong_cmp,
605 };
606
607 static struct sort_dimension *avail_sorts[] = {
608         &ptr_sort_dimension,
609         &callsite_sort_dimension,
610         &hit_sort_dimension,
611         &bytes_sort_dimension,
612         &frag_sort_dimension,
613         &pingpong_sort_dimension,
614 };
615
616 #define NUM_AVAIL_SORTS \
617         (int)(sizeof(avail_sorts) / sizeof(struct sort_dimension *))
618
619 static int sort_dimension__add(const char *tok, struct list_head *list)
620 {
621         struct sort_dimension *sort;
622         int i;
623
624         for (i = 0; i < NUM_AVAIL_SORTS; i++) {
625                 if (!strcmp(avail_sorts[i]->name, tok)) {
626                         sort = malloc(sizeof(*sort));
627                         if (!sort)
628                                 die("malloc");
629                         memcpy(sort, avail_sorts[i], sizeof(*sort));
630                         list_add_tail(&sort->list, list);
631                         return 0;
632                 }
633         }
634
635         return -1;
636 }
637
638 static int setup_sorting(struct list_head *sort_list, const char *arg)
639 {
640         char *tok;
641         char *str = strdup(arg);
642
643         if (!str)
644                 die("strdup");
645
646         while (true) {
647                 tok = strsep(&str, ",");
648                 if (!tok)
649                         break;
650                 if (sort_dimension__add(tok, sort_list) < 0) {
651                         error("Unknown --sort key: '%s'", tok);
652                         return -1;
653                 }
654         }
655
656         free(str);
657         return 0;
658 }
659
660 static int parse_sort_opt(const struct option *opt __used,
661                           const char *arg, int unset __used)
662 {
663         if (!arg)
664                 return -1;
665
666         if (caller_flag > alloc_flag)
667                 return setup_sorting(&caller_sort, arg);
668         else
669                 return setup_sorting(&alloc_sort, arg);
670
671         return 0;
672 }
673
674 static int parse_caller_opt(const struct option *opt __used,
675                           const char *arg __used, int unset __used)
676 {
677         caller_flag = (alloc_flag + 1);
678         return 0;
679 }
680
681 static int parse_alloc_opt(const struct option *opt __used,
682                           const char *arg __used, int unset __used)
683 {
684         alloc_flag = (caller_flag + 1);
685         return 0;
686 }
687
688 static int parse_line_opt(const struct option *opt __used,
689                           const char *arg, int unset __used)
690 {
691         int lines;
692
693         if (!arg)
694                 return -1;
695
696         lines = strtoul(arg, NULL, 10);
697
698         if (caller_flag > alloc_flag)
699                 caller_lines = lines;
700         else
701                 alloc_lines = lines;
702
703         return 0;
704 }
705
706 static const struct option kmem_options[] = {
707         OPT_STRING('i', "input", &input_name, "file",
708                    "input file name"),
709         OPT_CALLBACK_NOOPT(0, "caller", NULL, NULL,
710                            "show per-callsite statistics",
711                            parse_caller_opt),
712         OPT_CALLBACK_NOOPT(0, "alloc", NULL, NULL,
713                            "show per-allocation statistics",
714                            parse_alloc_opt),
715         OPT_CALLBACK('s', "sort", NULL, "key[,key2...]",
716                      "sort by keys: ptr, call_site, bytes, hit, pingpong, frag",
717                      parse_sort_opt),
718         OPT_CALLBACK('l', "line", NULL, "num",
719                      "show n lines",
720                      parse_line_opt),
721         OPT_BOOLEAN(0, "raw-ip", &raw_ip, "show raw ip instead of symbol"),
722         OPT_END()
723 };
724
725 static const char *record_args[] = {
726         "record",
727         "-a",
728         "-R",
729         "-M",
730         "-f",
731         "-c", "1",
732         "-e", "kmem:kmalloc",
733         "-e", "kmem:kmalloc_node",
734         "-e", "kmem:kfree",
735         "-e", "kmem:kmem_cache_alloc",
736         "-e", "kmem:kmem_cache_alloc_node",
737         "-e", "kmem:kmem_cache_free",
738 };
739
740 static int __cmd_record(int argc, const char **argv)
741 {
742         unsigned int rec_argc, i, j;
743         const char **rec_argv;
744
745         rec_argc = ARRAY_SIZE(record_args) + argc - 1;
746         rec_argv = calloc(rec_argc + 1, sizeof(char *));
747
748         for (i = 0; i < ARRAY_SIZE(record_args); i++)
749                 rec_argv[i] = strdup(record_args[i]);
750
751         for (j = 1; j < (unsigned int)argc; j++, i++)
752                 rec_argv[i] = argv[j];
753
754         return cmd_record(i, rec_argv, NULL);
755 }
756
757 int cmd_kmem(int argc, const char **argv, const char *prefix __used)
758 {
759         argc = parse_options(argc, argv, kmem_options, kmem_usage, 0);
760
761         if (!argc)
762                 usage_with_options(kmem_usage, kmem_options);
763
764         symbol__init();
765
766         if (!strncmp(argv[0], "rec", 3)) {
767                 return __cmd_record(argc, argv);
768         } else if (!strcmp(argv[0], "stat")) {
769                 setup_cpunode_map();
770
771                 if (list_empty(&caller_sort))
772                         setup_sorting(&caller_sort, default_sort_order);
773                 if (list_empty(&alloc_sort))
774                         setup_sorting(&alloc_sort, default_sort_order);
775
776                 return __cmd_kmem();
777         }
778
779         return 0;
780 }
781