tracing: Add more namespace area to 'perf list' output
[linux-2.6.git] / tools / perf / util / parse-events.c
1
2 #include "../perf.h"
3 #include "util.h"
4 #include "parse-options.h"
5 #include "parse-events.h"
6 #include "exec_cmd.h"
7 #include "string.h"
8 #include "cache.h"
9
10 extern char *strcasestr(const char *haystack, const char *needle);
11
12 int                                     nr_counters;
13
14 struct perf_counter_attr                attrs[MAX_COUNTERS];
15
16 struct event_symbol {
17         u8      type;
18         u64     config;
19         char    *symbol;
20         char    *alias;
21 };
22
23 char debugfs_path[MAXPATHLEN];
24
25 #define CHW(x) .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_##x
26 #define CSW(x) .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_##x
27
28 static struct event_symbol event_symbols[] = {
29   { CHW(CPU_CYCLES),            "cpu-cycles",           "cycles"        },
30   { CHW(INSTRUCTIONS),          "instructions",         ""              },
31   { CHW(CACHE_REFERENCES),      "cache-references",     ""              },
32   { CHW(CACHE_MISSES),          "cache-misses",         ""              },
33   { CHW(BRANCH_INSTRUCTIONS),   "branch-instructions",  "branches"      },
34   { CHW(BRANCH_MISSES),         "branch-misses",        ""              },
35   { CHW(BUS_CYCLES),            "bus-cycles",           ""              },
36
37   { CSW(CPU_CLOCK),             "cpu-clock",            ""              },
38   { CSW(TASK_CLOCK),            "task-clock",           ""              },
39   { CSW(PAGE_FAULTS),           "page-faults",          "faults"        },
40   { CSW(PAGE_FAULTS_MIN),       "minor-faults",         ""              },
41   { CSW(PAGE_FAULTS_MAJ),       "major-faults",         ""              },
42   { CSW(CONTEXT_SWITCHES),      "context-switches",     "cs"            },
43   { CSW(CPU_MIGRATIONS),        "cpu-migrations",       "migrations"    },
44 };
45
46 #define __PERF_COUNTER_FIELD(config, name) \
47         ((config & PERF_COUNTER_##name##_MASK) >> PERF_COUNTER_##name##_SHIFT)
48
49 #define PERF_COUNTER_RAW(config)        __PERF_COUNTER_FIELD(config, RAW)
50 #define PERF_COUNTER_CONFIG(config)     __PERF_COUNTER_FIELD(config, CONFIG)
51 #define PERF_COUNTER_TYPE(config)       __PERF_COUNTER_FIELD(config, TYPE)
52 #define PERF_COUNTER_ID(config)         __PERF_COUNTER_FIELD(config, EVENT)
53
54 static char *hw_event_names[] = {
55         "cycles",
56         "instructions",
57         "cache-references",
58         "cache-misses",
59         "branches",
60         "branch-misses",
61         "bus-cycles",
62 };
63
64 static char *sw_event_names[] = {
65         "cpu-clock-msecs",
66         "task-clock-msecs",
67         "page-faults",
68         "context-switches",
69         "CPU-migrations",
70         "minor-faults",
71         "major-faults",
72 };
73
74 #define MAX_ALIASES 8
75
76 static char *hw_cache[][MAX_ALIASES] = {
77  { "L1-dcache", "l1-d",         "l1d",          "L1-data",              },
78  { "L1-icache", "l1-i",         "l1i",          "L1-instruction",       },
79  { "LLC",       "L2"                                                    },
80  { "dTLB",      "d-tlb",        "Data-TLB",                             },
81  { "iTLB",      "i-tlb",        "Instruction-TLB",                      },
82  { "branch",    "branches",     "bpu",          "btb",          "bpc",  },
83 };
84
85 static char *hw_cache_op[][MAX_ALIASES] = {
86  { "load",      "loads",        "read",                                 },
87  { "store",     "stores",       "write",                                },
88  { "prefetch",  "prefetches",   "speculative-read", "speculative-load", },
89 };
90
91 static char *hw_cache_result[][MAX_ALIASES] = {
92  { "refs",      "Reference",    "ops",          "access",               },
93  { "misses",    "miss",                                                 },
94 };
95
96 #define C(x)            PERF_COUNT_HW_CACHE_##x
97 #define CACHE_READ      (1 << C(OP_READ))
98 #define CACHE_WRITE     (1 << C(OP_WRITE))
99 #define CACHE_PREFETCH  (1 << C(OP_PREFETCH))
100 #define COP(x)          (1 << x)
101
102 /*
103  * cache operartion stat
104  * L1I : Read and prefetch only
105  * ITLB and BPU : Read-only
106  */
107 static unsigned long hw_cache_stat[C(MAX)] = {
108  [C(L1D)]       = (CACHE_READ | CACHE_WRITE | CACHE_PREFETCH),
109  [C(L1I)]       = (CACHE_READ | CACHE_PREFETCH),
110  [C(LL)]        = (CACHE_READ | CACHE_WRITE | CACHE_PREFETCH),
111  [C(DTLB)]      = (CACHE_READ | CACHE_WRITE | CACHE_PREFETCH),
112  [C(ITLB)]      = (CACHE_READ),
113  [C(BPU)]       = (CACHE_READ),
114 };
115
116 #define for_each_subsystem(sys_dir, sys_dirent, sys_next, file, st)            \
117         while (!readdir_r(sys_dir, &sys_dirent, &sys_next) && sys_next)        \
118         if (snprintf(file, MAXPATHLEN, "%s/%s", debugfs_path,                  \
119                         sys_dirent.d_name) &&                                  \
120            (!stat(file, &st)) && (S_ISDIR(st.st_mode)) &&                      \
121            (strcmp(sys_dirent.d_name, ".")) &&                                 \
122            (strcmp(sys_dirent.d_name, "..")))
123
124 static int tp_event_has_id(struct dirent *sys_dir, struct dirent *evt_dir)
125 {
126         char evt_path[MAXPATHLEN];
127         int fd;
128
129         snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id", debugfs_path,
130                         sys_dir->d_name, evt_dir->d_name);
131         fd = open(evt_path, O_RDONLY);
132         if (fd < 0)
133                 return -EINVAL;
134         close(fd);
135
136         return 0;
137 }
138
139 #define for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next, file, st)    \
140         while (!readdir_r(evt_dir, &evt_dirent, &evt_next) && evt_next)        \
141         if (snprintf(file, MAXPATHLEN, "%s/%s/%s", debugfs_path,               \
142                      sys_dirent.d_name, evt_dirent.d_name) &&                  \
143            (!stat(file, &st)) && (S_ISDIR(st.st_mode)) &&                      \
144            (strcmp(evt_dirent.d_name, ".")) &&                                 \
145            (strcmp(evt_dirent.d_name, "..")) &&                                \
146            (!tp_event_has_id(&sys_dirent, &evt_dirent)))
147
148 #define MAX_EVENT_LENGTH 30
149
150 int valid_debugfs_mount(const char *debugfs)
151 {
152         struct statfs st_fs;
153
154         if (statfs(debugfs, &st_fs) < 0)
155                 return -ENOENT;
156         else if (st_fs.f_type != (long) DEBUGFS_MAGIC)
157                 return -ENOENT;
158         return 0;
159 }
160
161 static char *tracepoint_id_to_name(u64 config)
162 {
163         static char tracepoint_name[2 * MAX_EVENT_LENGTH];
164         DIR *sys_dir, *evt_dir;
165         struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
166         struct stat st;
167         char id_buf[4];
168         int fd;
169         u64 id;
170         char evt_path[MAXPATHLEN];
171
172         if (valid_debugfs_mount(debugfs_path))
173                 return "unkown";
174
175         sys_dir = opendir(debugfs_path);
176         if (!sys_dir)
177                 goto cleanup;
178
179         for_each_subsystem(sys_dir, sys_dirent, sys_next, evt_path, st) {
180                 evt_dir = opendir(evt_path);
181                 if (!evt_dir)
182                         goto cleanup;
183                 for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next,
184                                                                 evt_path, st) {
185                         snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id",
186                                  debugfs_path, sys_dirent.d_name,
187                                  evt_dirent.d_name);
188                         fd = open(evt_path, O_RDONLY);
189                         if (fd < 0)
190                                 continue;
191                         if (read(fd, id_buf, sizeof(id_buf)) < 0) {
192                                 close(fd);
193                                 continue;
194                         }
195                         close(fd);
196                         id = atoll(id_buf);
197                         if (id == config) {
198                                 closedir(evt_dir);
199                                 closedir(sys_dir);
200                                 snprintf(tracepoint_name, 2 * MAX_EVENT_LENGTH,
201                                         "%s:%s", sys_dirent.d_name,
202                                         evt_dirent.d_name);
203                                 return tracepoint_name;
204                         }
205                 }
206                 closedir(evt_dir);
207         }
208
209 cleanup:
210         closedir(sys_dir);
211         return "unkown";
212 }
213
214 static int is_cache_op_valid(u8 cache_type, u8 cache_op)
215 {
216         if (hw_cache_stat[cache_type] & COP(cache_op))
217                 return 1;       /* valid */
218         else
219                 return 0;       /* invalid */
220 }
221
222 static char *event_cache_name(u8 cache_type, u8 cache_op, u8 cache_result)
223 {
224         static char name[50];
225
226         if (cache_result) {
227                 sprintf(name, "%s-%s-%s", hw_cache[cache_type][0],
228                         hw_cache_op[cache_op][0],
229                         hw_cache_result[cache_result][0]);
230         } else {
231                 sprintf(name, "%s-%s", hw_cache[cache_type][0],
232                         hw_cache_op[cache_op][1]);
233         }
234
235         return name;
236 }
237
238 char *event_name(int counter)
239 {
240         u64 config = attrs[counter].config;
241         int type = attrs[counter].type;
242
243         return __event_name(type, config);
244 }
245
246 char *__event_name(int type, u64 config)
247 {
248         static char buf[32];
249
250         if (type == PERF_TYPE_RAW) {
251                 sprintf(buf, "raw 0x%llx", config);
252                 return buf;
253         }
254
255         switch (type) {
256         case PERF_TYPE_HARDWARE:
257                 if (config < PERF_COUNT_HW_MAX)
258                         return hw_event_names[config];
259                 return "unknown-hardware";
260
261         case PERF_TYPE_HW_CACHE: {
262                 u8 cache_type, cache_op, cache_result;
263
264                 cache_type   = (config >>  0) & 0xff;
265                 if (cache_type > PERF_COUNT_HW_CACHE_MAX)
266                         return "unknown-ext-hardware-cache-type";
267
268                 cache_op     = (config >>  8) & 0xff;
269                 if (cache_op > PERF_COUNT_HW_CACHE_OP_MAX)
270                         return "unknown-ext-hardware-cache-op";
271
272                 cache_result = (config >> 16) & 0xff;
273                 if (cache_result > PERF_COUNT_HW_CACHE_RESULT_MAX)
274                         return "unknown-ext-hardware-cache-result";
275
276                 if (!is_cache_op_valid(cache_type, cache_op))
277                         return "invalid-cache";
278
279                 return event_cache_name(cache_type, cache_op, cache_result);
280         }
281
282         case PERF_TYPE_SOFTWARE:
283                 if (config < PERF_COUNT_SW_MAX)
284                         return sw_event_names[config];
285                 return "unknown-software";
286
287         case PERF_TYPE_TRACEPOINT:
288                 return tracepoint_id_to_name(config);
289
290         default:
291                 break;
292         }
293
294         return "unknown";
295 }
296
297 static int parse_aliases(const char **str, char *names[][MAX_ALIASES], int size)
298 {
299         int i, j;
300         int n, longest = -1;
301
302         for (i = 0; i < size; i++) {
303                 for (j = 0; j < MAX_ALIASES && names[i][j]; j++) {
304                         n = strlen(names[i][j]);
305                         if (n > longest && !strncasecmp(*str, names[i][j], n))
306                                 longest = n;
307                 }
308                 if (longest > 0) {
309                         *str += longest;
310                         return i;
311                 }
312         }
313
314         return -1;
315 }
316
317 static int
318 parse_generic_hw_event(const char **str, struct perf_counter_attr *attr)
319 {
320         const char *s = *str;
321         int cache_type = -1, cache_op = -1, cache_result = -1;
322
323         cache_type = parse_aliases(&s, hw_cache, PERF_COUNT_HW_CACHE_MAX);
324         /*
325          * No fallback - if we cannot get a clear cache type
326          * then bail out:
327          */
328         if (cache_type == -1)
329                 return 0;
330
331         while ((cache_op == -1 || cache_result == -1) && *s == '-') {
332                 ++s;
333
334                 if (cache_op == -1) {
335                         cache_op = parse_aliases(&s, hw_cache_op,
336                                                 PERF_COUNT_HW_CACHE_OP_MAX);
337                         if (cache_op >= 0) {
338                                 if (!is_cache_op_valid(cache_type, cache_op))
339                                         return 0;
340                                 continue;
341                         }
342                 }
343
344                 if (cache_result == -1) {
345                         cache_result = parse_aliases(&s, hw_cache_result,
346                                                 PERF_COUNT_HW_CACHE_RESULT_MAX);
347                         if (cache_result >= 0)
348                                 continue;
349                 }
350
351                 /*
352                  * Can't parse this as a cache op or result, so back up
353                  * to the '-'.
354                  */
355                 --s;
356                 break;
357         }
358
359         /*
360          * Fall back to reads:
361          */
362         if (cache_op == -1)
363                 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
364
365         /*
366          * Fall back to accesses:
367          */
368         if (cache_result == -1)
369                 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
370
371         attr->config = cache_type | (cache_op << 8) | (cache_result << 16);
372         attr->type = PERF_TYPE_HW_CACHE;
373
374         *str = s;
375         return 1;
376 }
377
378 static int parse_tracepoint_event(const char **strp,
379                                     struct perf_counter_attr *attr)
380 {
381         const char *evt_name;
382         char sys_name[MAX_EVENT_LENGTH];
383         char id_buf[4];
384         int fd;
385         unsigned int sys_length, evt_length;
386         u64 id;
387         char evt_path[MAXPATHLEN];
388
389         if (valid_debugfs_mount(debugfs_path))
390                 return 0;
391
392         evt_name = strchr(*strp, ':');
393         if (!evt_name)
394                 return 0;
395
396         sys_length = evt_name - *strp;
397         if (sys_length >= MAX_EVENT_LENGTH)
398                 return 0;
399
400         strncpy(sys_name, *strp, sys_length);
401         sys_name[sys_length] = '\0';
402         evt_name = evt_name + 1;
403         evt_length = strlen(evt_name);
404         if (evt_length >= MAX_EVENT_LENGTH)
405                 return 0;
406
407         snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id", debugfs_path,
408                  sys_name, evt_name);
409         fd = open(evt_path, O_RDONLY);
410         if (fd < 0)
411                 return 0;
412
413         if (read(fd, id_buf, sizeof(id_buf)) < 0) {
414                 close(fd);
415                 return 0;
416         }
417         close(fd);
418         id = atoll(id_buf);
419         attr->config = id;
420         attr->type = PERF_TYPE_TRACEPOINT;
421         *strp = evt_name + evt_length;
422         return 1;
423 }
424
425 static int check_events(const char *str, unsigned int i)
426 {
427         int n;
428
429         n = strlen(event_symbols[i].symbol);
430         if (!strncmp(str, event_symbols[i].symbol, n))
431                 return n;
432
433         n = strlen(event_symbols[i].alias);
434         if (n)
435                 if (!strncmp(str, event_symbols[i].alias, n))
436                         return n;
437         return 0;
438 }
439
440 static int
441 parse_symbolic_event(const char **strp, struct perf_counter_attr *attr)
442 {
443         const char *str = *strp;
444         unsigned int i;
445         int n;
446
447         for (i = 0; i < ARRAY_SIZE(event_symbols); i++) {
448                 n = check_events(str, i);
449                 if (n > 0) {
450                         attr->type = event_symbols[i].type;
451                         attr->config = event_symbols[i].config;
452                         *strp = str + n;
453                         return 1;
454                 }
455         }
456         return 0;
457 }
458
459 static int parse_raw_event(const char **strp, struct perf_counter_attr *attr)
460 {
461         const char *str = *strp;
462         u64 config;
463         int n;
464
465         if (*str != 'r')
466                 return 0;
467         n = hex2u64(str + 1, &config);
468         if (n > 0) {
469                 *strp = str + n + 1;
470                 attr->type = PERF_TYPE_RAW;
471                 attr->config = config;
472                 return 1;
473         }
474         return 0;
475 }
476
477 static int
478 parse_numeric_event(const char **strp, struct perf_counter_attr *attr)
479 {
480         const char *str = *strp;
481         char *endp;
482         unsigned long type;
483         u64 config;
484
485         type = strtoul(str, &endp, 0);
486         if (endp > str && type < PERF_TYPE_MAX && *endp == ':') {
487                 str = endp + 1;
488                 config = strtoul(str, &endp, 0);
489                 if (endp > str) {
490                         attr->type = type;
491                         attr->config = config;
492                         *strp = endp;
493                         return 1;
494                 }
495         }
496         return 0;
497 }
498
499 static int
500 parse_event_modifier(const char **strp, struct perf_counter_attr *attr)
501 {
502         const char *str = *strp;
503         int eu = 1, ek = 1, eh = 1;
504
505         if (*str++ != ':')
506                 return 0;
507         while (*str) {
508                 if (*str == 'u')
509                         eu = 0;
510                 else if (*str == 'k')
511                         ek = 0;
512                 else if (*str == 'h')
513                         eh = 0;
514                 else
515                         break;
516                 ++str;
517         }
518         if (str >= *strp + 2) {
519                 *strp = str;
520                 attr->exclude_user   = eu;
521                 attr->exclude_kernel = ek;
522                 attr->exclude_hv     = eh;
523                 return 1;
524         }
525         return 0;
526 }
527
528 /*
529  * Each event can have multiple symbolic names.
530  * Symbolic names are (almost) exactly matched.
531  */
532 static int parse_event_symbols(const char **str, struct perf_counter_attr *attr)
533 {
534         if (!(parse_tracepoint_event(str, attr) ||
535               parse_raw_event(str, attr) ||
536               parse_numeric_event(str, attr) ||
537               parse_symbolic_event(str, attr) ||
538               parse_generic_hw_event(str, attr)))
539                 return 0;
540
541         parse_event_modifier(str, attr);
542
543         return 1;
544 }
545
546 int parse_events(const struct option *opt __used, const char *str, int unset __used)
547 {
548         struct perf_counter_attr attr;
549
550         for (;;) {
551                 if (nr_counters == MAX_COUNTERS)
552                         return -1;
553
554                 memset(&attr, 0, sizeof(attr));
555                 if (!parse_event_symbols(&str, &attr))
556                         return -1;
557
558                 if (!(*str == 0 || *str == ',' || isspace(*str)))
559                         return -1;
560
561                 attrs[nr_counters] = attr;
562                 nr_counters++;
563
564                 if (*str == 0)
565                         break;
566                 if (*str == ',')
567                         ++str;
568                 while (isspace(*str))
569                         ++str;
570         }
571
572         return 0;
573 }
574
575 static const char * const event_type_descriptors[] = {
576         "",
577         "Hardware event",
578         "Software event",
579         "Tracepoint event",
580         "Hardware cache event",
581 };
582
583 /*
584  * Print the events from <debugfs_mount_point>/tracing/events
585  */
586
587 static void print_tracepoint_events(void)
588 {
589         DIR *sys_dir, *evt_dir;
590         struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
591         struct stat st;
592         char evt_path[MAXPATHLEN];
593
594         if (valid_debugfs_mount(debugfs_path))
595                 return;
596
597         sys_dir = opendir(debugfs_path);
598         if (!sys_dir)
599                 goto cleanup;
600
601         for_each_subsystem(sys_dir, sys_dirent, sys_next, evt_path, st) {
602                 evt_dir = opendir(evt_path);
603                 if (!evt_dir)
604                         goto cleanup;
605                 for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next,
606                                                                 evt_path, st) {
607                         snprintf(evt_path, MAXPATHLEN, "%s:%s",
608                                  sys_dirent.d_name, evt_dirent.d_name);
609                         fprintf(stderr, "  %-42s [%s]\n", evt_path,
610                                 event_type_descriptors[PERF_TYPE_TRACEPOINT+1]);
611                 }
612                 closedir(evt_dir);
613         }
614
615 cleanup:
616         closedir(sys_dir);
617 }
618
619 /*
620  * Print the help text for the event symbols:
621  */
622 void print_events(void)
623 {
624         struct event_symbol *syms = event_symbols;
625         unsigned int i, type, op, prev_type = -1;
626         char name[40];
627
628         fprintf(stderr, "\n");
629         fprintf(stderr, "List of pre-defined events (to be used in -e):\n");
630
631         for (i = 0; i < ARRAY_SIZE(event_symbols); i++, syms++) {
632                 type = syms->type + 1;
633                 if (type >= ARRAY_SIZE(event_type_descriptors))
634                         type = 0;
635
636                 if (type != prev_type)
637                         fprintf(stderr, "\n");
638
639                 if (strlen(syms->alias))
640                         sprintf(name, "%s OR %s", syms->symbol, syms->alias);
641                 else
642                         strcpy(name, syms->symbol);
643                 fprintf(stderr, "  %-42s [%s]\n", name,
644                         event_type_descriptors[type]);
645
646                 prev_type = type;
647         }
648
649         fprintf(stderr, "\n");
650         for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
651                 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
652                         /* skip invalid cache type */
653                         if (!is_cache_op_valid(type, op))
654                                 continue;
655
656                         for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
657                                 fprintf(stderr, "  %-42s [%s]\n",
658                                         event_cache_name(type, op, i),
659                                         event_type_descriptors[4]);
660                         }
661                 }
662         }
663
664         fprintf(stderr, "\n");
665         fprintf(stderr, "  %-42s [raw hardware event descriptor]\n",
666                 "rNNN");
667         fprintf(stderr, "\n");
668
669         print_tracepoint_events();
670
671         exit(129);
672 }