4 #include "parse-options.h"
5 #include "parse-events.h"
13 struct perf_event_attr attrs[MAX_COUNTERS];
28 char debugfs_path[MAXPATHLEN];
30 #define CHW(x) .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_##x
31 #define CSW(x) .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_##x
33 static struct event_symbol event_symbols[] = {
34 { CHW(CPU_CYCLES), "cpu-cycles", "cycles" },
35 { CHW(INSTRUCTIONS), "instructions", "" },
36 { CHW(CACHE_REFERENCES), "cache-references", "" },
37 { CHW(CACHE_MISSES), "cache-misses", "" },
38 { CHW(BRANCH_INSTRUCTIONS), "branch-instructions", "branches" },
39 { CHW(BRANCH_MISSES), "branch-misses", "" },
40 { CHW(BUS_CYCLES), "bus-cycles", "" },
42 { CSW(CPU_CLOCK), "cpu-clock", "" },
43 { CSW(TASK_CLOCK), "task-clock", "" },
44 { CSW(PAGE_FAULTS), "page-faults", "faults" },
45 { CSW(PAGE_FAULTS_MIN), "minor-faults", "" },
46 { CSW(PAGE_FAULTS_MAJ), "major-faults", "" },
47 { CSW(CONTEXT_SWITCHES), "context-switches", "cs" },
48 { CSW(CPU_MIGRATIONS), "cpu-migrations", "migrations" },
51 #define __PERF_EVENT_FIELD(config, name) \
52 ((config & PERF_EVENT_##name##_MASK) >> PERF_EVENT_##name##_SHIFT)
54 #define PERF_EVENT_RAW(config) __PERF_EVENT_FIELD(config, RAW)
55 #define PERF_EVENT_CONFIG(config) __PERF_EVENT_FIELD(config, CONFIG)
56 #define PERF_EVENT_TYPE(config) __PERF_EVENT_FIELD(config, TYPE)
57 #define PERF_EVENT_ID(config) __PERF_EVENT_FIELD(config, EVENT)
59 static const char *hw_event_names[] = {
69 static const char *sw_event_names[] = {
81 static const char *hw_cache[][MAX_ALIASES] = {
82 { "L1-dcache", "l1-d", "l1d", "L1-data", },
83 { "L1-icache", "l1-i", "l1i", "L1-instruction", },
85 { "dTLB", "d-tlb", "Data-TLB", },
86 { "iTLB", "i-tlb", "Instruction-TLB", },
87 { "branch", "branches", "bpu", "btb", "bpc", },
90 static const char *hw_cache_op[][MAX_ALIASES] = {
91 { "load", "loads", "read", },
92 { "store", "stores", "write", },
93 { "prefetch", "prefetches", "speculative-read", "speculative-load", },
96 static const char *hw_cache_result[][MAX_ALIASES] = {
97 { "refs", "Reference", "ops", "access", },
98 { "misses", "miss", },
101 #define C(x) PERF_COUNT_HW_CACHE_##x
102 #define CACHE_READ (1 << C(OP_READ))
103 #define CACHE_WRITE (1 << C(OP_WRITE))
104 #define CACHE_PREFETCH (1 << C(OP_PREFETCH))
105 #define COP(x) (1 << x)
108 * cache operartion stat
109 * L1I : Read and prefetch only
110 * ITLB and BPU : Read-only
112 static unsigned long hw_cache_stat[C(MAX)] = {
113 [C(L1D)] = (CACHE_READ | CACHE_WRITE | CACHE_PREFETCH),
114 [C(L1I)] = (CACHE_READ | CACHE_PREFETCH),
115 [C(LL)] = (CACHE_READ | CACHE_WRITE | CACHE_PREFETCH),
116 [C(DTLB)] = (CACHE_READ | CACHE_WRITE | CACHE_PREFETCH),
117 [C(ITLB)] = (CACHE_READ),
118 [C(BPU)] = (CACHE_READ),
121 #define for_each_subsystem(sys_dir, sys_dirent, sys_next) \
122 while (!readdir_r(sys_dir, &sys_dirent, &sys_next) && sys_next) \
123 if (sys_dirent.d_type == DT_DIR && \
124 (strcmp(sys_dirent.d_name, ".")) && \
125 (strcmp(sys_dirent.d_name, "..")))
127 static int tp_event_has_id(struct dirent *sys_dir, struct dirent *evt_dir)
129 char evt_path[MAXPATHLEN];
132 snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id", debugfs_path,
133 sys_dir->d_name, evt_dir->d_name);
134 fd = open(evt_path, O_RDONLY);
142 #define for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) \
143 while (!readdir_r(evt_dir, &evt_dirent, &evt_next) && evt_next) \
144 if (evt_dirent.d_type == DT_DIR && \
145 (strcmp(evt_dirent.d_name, ".")) && \
146 (strcmp(evt_dirent.d_name, "..")) && \
147 (!tp_event_has_id(&sys_dirent, &evt_dirent)))
149 #define MAX_EVENT_LENGTH 512
151 int valid_debugfs_mount(const char *debugfs)
155 if (statfs(debugfs, &st_fs) < 0)
157 else if (st_fs.f_type != (long) DEBUGFS_MAGIC)
162 struct tracepoint_path *tracepoint_id_to_path(u64 config)
164 struct tracepoint_path *path = NULL;
165 DIR *sys_dir, *evt_dir;
166 struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
170 char evt_path[MAXPATHLEN];
171 char dir_path[MAXPATHLEN];
173 if (valid_debugfs_mount(debugfs_path))
176 sys_dir = opendir(debugfs_path);
180 for_each_subsystem(sys_dir, sys_dirent, sys_next) {
182 snprintf(dir_path, MAXPATHLEN, "%s/%s", debugfs_path,
184 evt_dir = opendir(dir_path);
188 for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
190 snprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path,
192 fd = open(evt_path, O_RDONLY);
195 if (read(fd, id_buf, sizeof(id_buf)) < 0) {
204 path = calloc(1, sizeof(path));
205 path->system = malloc(MAX_EVENT_LENGTH);
210 path->name = malloc(MAX_EVENT_LENGTH);
216 strncpy(path->system, sys_dirent.d_name,
218 strncpy(path->name, evt_dirent.d_name,
230 #define TP_PATH_LEN (MAX_EVENT_LENGTH * 2 + 1)
231 static const char *tracepoint_id_to_name(u64 config)
233 static char buf[TP_PATH_LEN];
234 struct tracepoint_path *path;
236 path = tracepoint_id_to_path(config);
238 snprintf(buf, TP_PATH_LEN, "%s:%s", path->system, path->name);
243 snprintf(buf, TP_PATH_LEN, "%s:%s", "unknown", "unknown");
248 static int is_cache_op_valid(u8 cache_type, u8 cache_op)
250 if (hw_cache_stat[cache_type] & COP(cache_op))
251 return 1; /* valid */
253 return 0; /* invalid */
256 static char *event_cache_name(u8 cache_type, u8 cache_op, u8 cache_result)
258 static char name[50];
261 sprintf(name, "%s-%s-%s", hw_cache[cache_type][0],
262 hw_cache_op[cache_op][0],
263 hw_cache_result[cache_result][0]);
265 sprintf(name, "%s-%s", hw_cache[cache_type][0],
266 hw_cache_op[cache_op][1]);
272 const char *event_name(int counter)
274 u64 config = attrs[counter].config;
275 int type = attrs[counter].type;
277 return __event_name(type, config);
280 const char *__event_name(int type, u64 config)
284 if (type == PERF_TYPE_RAW) {
285 sprintf(buf, "raw 0x%llx", config);
290 case PERF_TYPE_HARDWARE:
291 if (config < PERF_COUNT_HW_MAX)
292 return hw_event_names[config];
293 return "unknown-hardware";
295 case PERF_TYPE_HW_CACHE: {
296 u8 cache_type, cache_op, cache_result;
298 cache_type = (config >> 0) & 0xff;
299 if (cache_type > PERF_COUNT_HW_CACHE_MAX)
300 return "unknown-ext-hardware-cache-type";
302 cache_op = (config >> 8) & 0xff;
303 if (cache_op > PERF_COUNT_HW_CACHE_OP_MAX)
304 return "unknown-ext-hardware-cache-op";
306 cache_result = (config >> 16) & 0xff;
307 if (cache_result > PERF_COUNT_HW_CACHE_RESULT_MAX)
308 return "unknown-ext-hardware-cache-result";
310 if (!is_cache_op_valid(cache_type, cache_op))
311 return "invalid-cache";
313 return event_cache_name(cache_type, cache_op, cache_result);
316 case PERF_TYPE_SOFTWARE:
317 if (config < PERF_COUNT_SW_MAX)
318 return sw_event_names[config];
319 return "unknown-software";
321 case PERF_TYPE_TRACEPOINT:
322 return tracepoint_id_to_name(config);
331 static int parse_aliases(const char **str, const char *names[][MAX_ALIASES], int size)
336 for (i = 0; i < size; i++) {
337 for (j = 0; j < MAX_ALIASES && names[i][j]; j++) {
338 n = strlen(names[i][j]);
339 if (n > longest && !strncasecmp(*str, names[i][j], n))
351 static enum event_result
352 parse_generic_hw_event(const char **str, struct perf_event_attr *attr)
354 const char *s = *str;
355 int cache_type = -1, cache_op = -1, cache_result = -1;
357 cache_type = parse_aliases(&s, hw_cache, PERF_COUNT_HW_CACHE_MAX);
359 * No fallback - if we cannot get a clear cache type
362 if (cache_type == -1)
365 while ((cache_op == -1 || cache_result == -1) && *s == '-') {
368 if (cache_op == -1) {
369 cache_op = parse_aliases(&s, hw_cache_op,
370 PERF_COUNT_HW_CACHE_OP_MAX);
372 if (!is_cache_op_valid(cache_type, cache_op))
378 if (cache_result == -1) {
379 cache_result = parse_aliases(&s, hw_cache_result,
380 PERF_COUNT_HW_CACHE_RESULT_MAX);
381 if (cache_result >= 0)
386 * Can't parse this as a cache op or result, so back up
394 * Fall back to reads:
397 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
400 * Fall back to accesses:
402 if (cache_result == -1)
403 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
405 attr->config = cache_type | (cache_op << 8) | (cache_result << 16);
406 attr->type = PERF_TYPE_HW_CACHE;
412 static enum event_result
413 parse_single_tracepoint_event(char *sys_name,
414 const char *evt_name,
415 unsigned int evt_length,
417 struct perf_event_attr *attr,
420 char evt_path[MAXPATHLEN];
426 if (!strncmp(flags, "record", strlen(flags))) {
427 attr->sample_type |= PERF_SAMPLE_RAW;
428 attr->sample_type |= PERF_SAMPLE_TIME;
429 attr->sample_type |= PERF_SAMPLE_CPU;
433 snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id", debugfs_path,
436 fd = open(evt_path, O_RDONLY);
440 if (read(fd, id_buf, sizeof(id_buf)) < 0) {
448 attr->type = PERF_TYPE_TRACEPOINT;
449 *strp = evt_name + evt_length;
454 /* sys + ':' + event + ':' + flags*/
455 #define MAX_EVOPT_LEN (MAX_EVENT_LENGTH * 2 + 2 + 128)
456 static enum event_result
457 parse_subsystem_tracepoint_event(char *sys_name, char *flags)
459 char evt_path[MAXPATHLEN];
460 struct dirent *evt_ent;
463 snprintf(evt_path, MAXPATHLEN, "%s/%s", debugfs_path, sys_name);
464 evt_dir = opendir(evt_path);
467 perror("Can't open event dir");
471 while ((evt_ent = readdir(evt_dir))) {
472 char event_opt[MAX_EVOPT_LEN + 1];
474 unsigned int rem = MAX_EVOPT_LEN;
476 if (!strcmp(evt_ent->d_name, ".")
477 || !strcmp(evt_ent->d_name, "..")
478 || !strcmp(evt_ent->d_name, "enable")
479 || !strcmp(evt_ent->d_name, "filter"))
482 len = snprintf(event_opt, MAX_EVOPT_LEN, "%s:%s", sys_name,
489 if (rem < strlen(flags) + 1)
492 strcat(event_opt, ":");
493 strcat(event_opt, flags);
496 if (parse_events(NULL, event_opt, 0))
500 return EVT_HANDLED_ALL;
504 static enum event_result parse_tracepoint_event(const char **strp,
505 struct perf_event_attr *attr)
507 const char *evt_name;
509 char sys_name[MAX_EVENT_LENGTH];
510 unsigned int sys_length, evt_length;
512 if (valid_debugfs_mount(debugfs_path))
515 evt_name = strchr(*strp, ':');
519 sys_length = evt_name - *strp;
520 if (sys_length >= MAX_EVENT_LENGTH)
523 strncpy(sys_name, *strp, sys_length);
524 sys_name[sys_length] = '\0';
525 evt_name = evt_name + 1;
527 flags = strchr(evt_name, ':');
530 evt_name = strndup(evt_name, flags - evt_name);
534 evt_length = strlen(evt_name);
535 if (evt_length >= MAX_EVENT_LENGTH)
538 if (!strcmp(evt_name, "*")) {
539 *strp = evt_name + evt_length;
540 return parse_subsystem_tracepoint_event(sys_name, flags);
542 return parse_single_tracepoint_event(sys_name, evt_name,
547 static int check_events(const char *str, unsigned int i)
551 n = strlen(event_symbols[i].symbol);
552 if (!strncmp(str, event_symbols[i].symbol, n))
555 n = strlen(event_symbols[i].alias);
557 if (!strncmp(str, event_symbols[i].alias, n))
562 static enum event_result
563 parse_symbolic_event(const char **strp, struct perf_event_attr *attr)
565 const char *str = *strp;
569 for (i = 0; i < ARRAY_SIZE(event_symbols); i++) {
570 n = check_events(str, i);
572 attr->type = event_symbols[i].type;
573 attr->config = event_symbols[i].config;
581 static enum event_result
582 parse_raw_event(const char **strp, struct perf_event_attr *attr)
584 const char *str = *strp;
590 n = hex2u64(str + 1, &config);
593 attr->type = PERF_TYPE_RAW;
594 attr->config = config;
600 static enum event_result
601 parse_numeric_event(const char **strp, struct perf_event_attr *attr)
603 const char *str = *strp;
608 type = strtoul(str, &endp, 0);
609 if (endp > str && type < PERF_TYPE_MAX && *endp == ':') {
611 config = strtoul(str, &endp, 0);
614 attr->config = config;
622 static enum event_result
623 parse_event_modifier(const char **strp, struct perf_event_attr *attr)
625 const char *str = *strp;
626 int eu = 1, ek = 1, eh = 1;
633 else if (*str == 'k')
635 else if (*str == 'h')
641 if (str >= *strp + 2) {
643 attr->exclude_user = eu;
644 attr->exclude_kernel = ek;
645 attr->exclude_hv = eh;
652 * Each event can have multiple symbolic names.
653 * Symbolic names are (almost) exactly matched.
655 static enum event_result
656 parse_event_symbols(const char **str, struct perf_event_attr *attr)
658 enum event_result ret;
660 ret = parse_tracepoint_event(str, attr);
661 if (ret != EVT_FAILED)
664 ret = parse_raw_event(str, attr);
665 if (ret != EVT_FAILED)
668 ret = parse_numeric_event(str, attr);
669 if (ret != EVT_FAILED)
672 ret = parse_symbolic_event(str, attr);
673 if (ret != EVT_FAILED)
676 ret = parse_generic_hw_event(str, attr);
677 if (ret != EVT_FAILED)
683 parse_event_modifier(str, attr);
688 static void store_event_type(const char *orgname)
690 char filename[PATH_MAX], *c;
694 sprintf(filename, "/sys/kernel/debug/tracing/events/%s/id", orgname);
695 c = strchr(filename, ':');
699 file = fopen(filename, "r");
702 if (fscanf(file, "%i", &id) < 1)
703 die("cannot store event ID");
705 perf_header__push_event(id, orgname);
709 int parse_events(const struct option *opt __used, const char *str, int unset __used)
711 struct perf_event_attr attr;
712 enum event_result ret;
714 if (strchr(str, ':'))
715 store_event_type(str);
718 if (nr_counters == MAX_COUNTERS)
721 memset(&attr, 0, sizeof(attr));
722 ret = parse_event_symbols(&str, &attr);
723 if (ret == EVT_FAILED)
726 if (!(*str == 0 || *str == ',' || isspace(*str)))
729 if (ret != EVT_HANDLED_ALL) {
730 attrs[nr_counters] = attr;
738 while (isspace(*str))
745 static const char * const event_type_descriptors[] = {
750 "Hardware cache event",
754 * Print the events from <debugfs_mount_point>/tracing/events
757 static void print_tracepoint_events(void)
759 DIR *sys_dir, *evt_dir;
760 struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
761 char evt_path[MAXPATHLEN];
762 char dir_path[MAXPATHLEN];
764 if (valid_debugfs_mount(debugfs_path))
767 sys_dir = opendir(debugfs_path);
771 for_each_subsystem(sys_dir, sys_dirent, sys_next) {
773 snprintf(dir_path, MAXPATHLEN, "%s/%s", debugfs_path,
775 evt_dir = opendir(dir_path);
779 for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
780 snprintf(evt_path, MAXPATHLEN, "%s:%s",
781 sys_dirent.d_name, evt_dirent.d_name);
782 fprintf(stderr, " %-42s [%s]\n", evt_path,
783 event_type_descriptors[PERF_TYPE_TRACEPOINT+1]);
791 * Print the help text for the event symbols:
793 void print_events(void)
795 struct event_symbol *syms = event_symbols;
796 unsigned int i, type, op, prev_type = -1;
799 fprintf(stderr, "\n");
800 fprintf(stderr, "List of pre-defined events (to be used in -e):\n");
802 for (i = 0; i < ARRAY_SIZE(event_symbols); i++, syms++) {
803 type = syms->type + 1;
804 if (type >= ARRAY_SIZE(event_type_descriptors))
807 if (type != prev_type)
808 fprintf(stderr, "\n");
810 if (strlen(syms->alias))
811 sprintf(name, "%s OR %s", syms->symbol, syms->alias);
813 strcpy(name, syms->symbol);
814 fprintf(stderr, " %-42s [%s]\n", name,
815 event_type_descriptors[type]);
820 fprintf(stderr, "\n");
821 for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
822 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
823 /* skip invalid cache type */
824 if (!is_cache_op_valid(type, op))
827 for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
828 fprintf(stderr, " %-42s [%s]\n",
829 event_cache_name(type, op, i),
830 event_type_descriptors[4]);
835 fprintf(stderr, "\n");
836 fprintf(stderr, " %-42s [raw hardware event descriptor]\n",
838 fprintf(stderr, "\n");
840 print_tracepoint_events();