1 #define _XOPEN_SOURCE 500 /* needed for nftw() */
2 #define _GNU_SOURCE /* needed for asprintf() */
4 /* Parse event JSON files */
7 * Copyright (c) 2014, Intel Corporation
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions are met:
13 * 1. Redistributions of source code must retain the above copyright notice,
14 * this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
31 * OF THE POSSIBILITY OF SUCH DAMAGE.
43 #include <sys/time.h> /* getrlimit */
44 #include <sys/resource.h> /* getrlimit */
51 #ifndef __maybe_unused
52 #define __maybe_unused __attribute__((unused))
58 int eprintf(int level, int var, const char *fmt, ...)
69 ret = vfprintf(stderr, fmt, args);
76 __attribute__((weak)) char *get_cpu_str(void)
81 static void addfield(char *map, char **dst, const char *sep,
82 const char *a, jsmntok_t *bt)
84 unsigned int len = strlen(a) + 1 + strlen(sep);
85 int olen = *dst ? strlen(*dst) : 0;
86 int blen = bt ? json_len(bt) : 0;
89 out = realloc(*dst, len + olen + blen);
91 /* Don't add field in this case */
102 strncat(*dst, map + bt->start, blen);
105 static void fixname(char *s)
111 static void fixdesc(char *s)
113 char *e = s + strlen(s);
115 /* Remove trailing dots that look ugly in perf list */
117 while (e >= s && isspace(*e))
123 static struct msrmap {
127 { "0x3F6", "ldlat=" },
128 { "0x1A6", "offcore_rsp=" },
129 { "0x1A7", "offcore_rsp=" },
130 { "0x3F7", "frontend=" },
134 static struct field {
138 { "EventCode", "event=" },
139 { "UMask", "umask=" },
140 { "CounterMask", "cmask=" },
141 { "Invert", "inv=" },
142 { "AnyThread", "any=" },
143 { "EdgeDetect", "edge=" },
144 { "SampleAfterValue", "period=" },
148 static void cut_comma(char *map, jsmntok_t *newval)
152 /* Cut off everything after comma */
153 for (i = newval->start; i < newval->end; i++) {
159 static int match_field(char *map, jsmntok_t *field, int nz,
160 char **event, jsmntok_t *val)
163 jsmntok_t newval = *val;
165 for (f = fields; f->field; f++)
166 if (json_streq(map, field, f->field) && nz) {
167 cut_comma(map, &newval);
168 addfield(map, event, ",", f->kernel, &newval);
174 static struct msrmap *lookup_msr(char *map, jsmntok_t *val)
176 jsmntok_t newval = *val;
180 cut_comma(map, &newval);
181 for (i = 0; msrmap[i].num; i++)
182 if (json_streq(map, &newval, msrmap[i].num))
186 pr_err("%s: Unknown MSR in event file %.*s\n", prog,
187 json_len(val), map + val->start);
192 #define EXPECT(e, t, m) do { if (!(e)) { \
193 jsmntok_t *loc = (t); \
194 if (!(t)->start && (t) > tokens) \
196 pr_err("%s:%d: " m ", got %s\n", fn, \
197 json_line(map, loc), \
202 #define TOPIC_DEPTH 256
203 static char *topic_array[TOPIC_DEPTH];
204 static int topic_level;
206 static char *get_topic(void)
208 char *tp_old, *tp = NULL;
211 for (i = 0; i < topic_level + 1; i++) {
215 n = asprintf(&tp, "%s%s", tp ?: "", topic_array[i]);
217 pr_info("%s: asprintf() error %s\n", prog);
223 for (i = 0; i < (int) strlen(tp); i++) {
237 static int add_topic(int level, char *bname)
243 if (level >= TOPIC_DEPTH)
246 topic = strdup(bname);
248 pr_info("%s: strdup() error %s for file %s\n", prog,
249 strerror(errno), bname);
253 free(topic_array[topic_level]);
254 topic_array[topic_level] = topic;
259 struct perf_entry_data {
264 static int close_table;
266 static void print_events_table_prefix(FILE *fp, const char *tblname)
268 fprintf(fp, "struct pmu_event %s[] = {\n", tblname);
272 static int print_events_table_entry(void *data, char *name, char *event,
273 char *desc, char *long_desc)
275 struct perf_entry_data *pd = data;
276 FILE *outfp = pd->outfp;
277 char *topic = pd->topic;
280 * TODO: Remove formatting chars after debugging to reduce
283 fprintf(outfp, "{\n");
285 fprintf(outfp, "\t.name = \"%s\",\n", name);
286 fprintf(outfp, "\t.event = \"%s\",\n", event);
287 fprintf(outfp, "\t.desc = \"%s\",\n", desc);
288 fprintf(outfp, "\t.topic = \"%s\",\n", topic);
289 if (long_desc && long_desc[0])
290 fprintf(outfp, "\t.long_desc = \"%s\",\n", long_desc);
292 fprintf(outfp, "},\n");
297 static void print_events_table_suffix(FILE *outfp)
299 fprintf(outfp, "{\n");
301 fprintf(outfp, "\t.name = 0,\n");
302 fprintf(outfp, "\t.event = 0,\n");
303 fprintf(outfp, "\t.desc = 0,\n");
305 fprintf(outfp, "},\n");
306 fprintf(outfp, "};\n");
310 static struct fixed {
314 { "inst_retired.any", "event=0xc0,period=2000003" },
315 { "inst_retired.any_p", "event=0xc0,period=2000003" },
316 { "cpu_clk_unhalted.ref", "event=0x0,umask=0x03,period=2000003" },
317 { "cpu_clk_unhalted.thread", "event=0x3c,period=2000003" },
318 { "cpu_clk_unhalted.core", "event=0x3c,period=2000003" },
319 { "cpu_clk_unhalted.thread_any", "event=0x3c,any=1,period=2000003" },
324 * Handle different fixed counter encodings between JSON and perf.
326 static char *real_event(const char *name, char *event)
330 for (i = 0; fixed[i].name; i++)
331 if (!strcasecmp(name, fixed[i].name))
332 return (char *)fixed[i].event;
336 /* Call func with each event in the json file */
337 int json_events(const char *fn,
338 int (*func)(void *data, char *name, char *event, char *desc,
344 jsmntok_t *tokens, *tok;
351 tokens = parse_json(fn, &map, &size, &len);
354 EXPECT(tokens->type == JSMN_ARRAY, tokens, "expected top level array");
356 for (i = 0; i < tokens->size; i++) {
357 char *event = NULL, *desc = NULL, *name = NULL;
358 char *long_desc = NULL;
359 char *extra_desc = NULL;
360 struct msrmap *msr = NULL;
361 jsmntok_t *msrval = NULL;
362 jsmntok_t *precise = NULL;
363 jsmntok_t *obj = tok++;
365 EXPECT(obj->type == JSMN_OBJECT, obj, "expected object");
366 for (j = 0; j < obj->size; j += 2) {
367 jsmntok_t *field, *val;
371 EXPECT(field->type == JSMN_STRING, tok + j,
372 "Expected field name");
374 EXPECT(val->type == JSMN_STRING, tok + j + 1,
375 "Expected string value");
377 nz = !json_streq(map, val, "0");
378 if (match_field(map, field, nz, &event, val)) {
380 } else if (json_streq(map, field, "EventName")) {
381 addfield(map, &name, "", "", val);
382 } else if (json_streq(map, field, "BriefDescription")) {
383 addfield(map, &desc, "", "", val);
385 } else if (json_streq(map, field,
386 "PublicDescription")) {
387 addfield(map, &long_desc, "", "", val);
389 } else if (json_streq(map, field, "PEBS") && nz) {
391 } else if (json_streq(map, field, "MSRIndex") && nz) {
392 msr = lookup_msr(map, val);
393 } else if (json_streq(map, field, "MSRValue")) {
395 } else if (json_streq(map, field, "Errata") &&
396 !json_streq(map, val, "null")) {
397 addfield(map, &extra_desc, ". ",
398 " Spec update: ", val);
399 } else if (json_streq(map, field, "Data_LA") && nz) {
400 addfield(map, &extra_desc, ". ",
401 " Supports address when precise",
404 /* ignore unknown fields */
406 if (precise && desc && !strstr(desc, "(Precise Event)")) {
407 if (json_streq(map, precise, "2"))
408 addfield(map, &extra_desc, " ",
409 "(Must be precise)", NULL);
411 addfield(map, &extra_desc, " ",
412 "(Precise event)", NULL);
414 if (desc && extra_desc)
415 addfield(map, &desc, " ", extra_desc, NULL);
416 if (long_desc && extra_desc)
417 addfield(map, &long_desc, " ", extra_desc, NULL);
419 addfield(map, &event, ",", msr->pname, msrval);
422 err = func(data, name, real_event(name, event), desc, long_desc);
432 EXPECT(tok - tokens == len, tok, "unexpected objects at end");
435 free_json(map, size, tokens);
439 static char *file_name_to_table_name(char *fname)
447 * Ensure tablename starts with alphabetic character.
448 * Derive rest of table name from basename of the JSON file,
449 * replacing hyphens and stripping out .json suffix.
451 n = asprintf(&tblname, "pme_%s", basename(fname));
453 pr_info("%s: asprintf() error %s for file %s\n", prog,
454 strerror(errno), fname);
458 for (i = 0; i < strlen(tblname); i++) {
466 } else if (!isalnum(c) && c != '_') {
467 pr_err("%s: Invalid character '%c' in file name %s\n",
468 prog, c, basename(fname));
478 static void print_mapping_table_prefix(FILE *outfp)
480 fprintf(outfp, "struct pmu_events_map pmu_events_map[] = {\n");
483 static void print_mapping_table_suffix(FILE *outfp)
486 * Print the terminating, NULL entry.
488 fprintf(outfp, "{\n");
489 fprintf(outfp, "\t.cpuid = 0,\n");
490 fprintf(outfp, "\t.version = 0,\n");
491 fprintf(outfp, "\t.type = 0,\n");
492 fprintf(outfp, "\t.table = 0,\n");
493 fprintf(outfp, "},\n");
495 /* and finally, the closing curly bracket for the struct */
496 fprintf(outfp, "};\n");
499 static int process_mapfile(FILE *outfp, char *fpath)
508 pr_info("%s: Processing mapfile %s\n", prog, fpath);
514 mapfp = fopen(fpath, "r");
516 pr_info("%s: Error %s opening %s\n", prog, strerror(errno),
521 print_mapping_table_prefix(outfp);
523 /* Skip first line (header) */
524 p = fgets(line, n, mapfp);
530 char *cpuid, *version, *type, *fname;
533 p = fgets(line, n, mapfp);
537 if (line[0] == '#' || line[0] == '\n')
540 if (line[strlen(line)-1] != '\n') {
541 /* TODO Deal with lines longer than 16K */
542 pr_info("%s: Mapfile %s: line %d too long, aborting\n",
543 prog, fpath, line_num);
546 line[strlen(line)-1] = '\0';
548 cpuid = strtok_r(p, ",", &save);
549 version = strtok_r(NULL, ",", &save);
550 fname = strtok_r(NULL, ",", &save);
551 type = strtok_r(NULL, ",", &save);
553 tblname = file_name_to_table_name(fname);
554 fprintf(outfp, "{\n");
555 fprintf(outfp, "\t.cpuid = \"%s\",\n", cpuid);
556 fprintf(outfp, "\t.version = \"%s\",\n", version);
557 fprintf(outfp, "\t.type = \"%s\",\n", type);
560 * CHECK: We can't use the type (eg "core") field in the
561 * table name. For us to do that, we need to somehow tweak
562 * the other caller of file_name_to_table(), process_json()
563 * to determine the type. process_json() file has no way
564 * of knowing these are "core" events unless file name has
565 * core in it. If filename has core in it, we can safely
566 * ignore the type field here also.
568 fprintf(outfp, "\t.table = %s\n", tblname);
569 fprintf(outfp, "},\n");
573 print_mapping_table_suffix(outfp);
578 * If we fail to locate/process JSON and map files, create a NULL mapping
579 * table. This would at least allow perf to build even if we can't find/use
582 static void create_empty_mapping(const char *output_file)
586 pr_info("%s: Creating empty pmu_events_map[] table\n", prog);
588 /* Truncate file to clear any partial writes to it */
589 outfp = fopen(output_file, "w");
595 fprintf(outfp, "#include \"../../pmu-events/pmu-events.h\"\n");
596 print_mapping_table_prefix(outfp);
597 print_mapping_table_suffix(outfp);
601 static int get_maxfds(void)
605 if (getrlimit(RLIMIT_NOFILE, &rlim) == 0)
606 return min(rlim.rlim_max / 2, (rlim_t)512);
612 * nftw() doesn't let us pass an argument to the processing function,
613 * so use a global variables.
615 static FILE *eventsfp;
616 static char *mapfile;
618 static int process_one_file(const char *fpath, const struct stat *sb,
619 int typeflag, struct FTW *ftwbuf)
621 char *tblname, *bname = (char *) fpath + ftwbuf->base;
622 int is_dir = typeflag == FTW_D;
623 int is_file = typeflag == FTW_F;
624 int level = ftwbuf->level;
627 pr_debug("%s %d %7jd %-20s %s\n",
628 is_file ? "f" : is_dir ? "d" : "x",
629 level, sb->st_size, bname, fpath);
635 /* model directory, reset topic */
636 if (level == 1 && is_dir) {
638 print_events_table_suffix(eventsfp);
641 * Drop file name suffix. Replace hyphens with underscores.
642 * Fail if file name contains any alphanum characters besides
645 tblname = file_name_to_table_name(bname);
647 pr_info("%s: Error determining table name for %s\n", prog,
652 print_events_table_prefix(eventsfp, tblname);
657 * Save the mapfile name for now. We will process mapfile
658 * after processing all JSON files (so we can write out the
659 * mapping table after all PMU events tables).
661 * TODO: Allow for multiple mapfiles? Punt for now.
663 if (level == 1 && is_file) {
664 if (!strncmp(bname, "mapfile.csv", 11)) {
666 pr_info("%s: Many mapfiles? Using %s, ignoring %s\n",
667 prog, mapfile, fpath);
669 mapfile = strdup(fpath);
674 pr_info("%s: Ignoring file %s\n", prog, fpath);
679 * If the file name does not have a .json extension,
680 * ignore it. It could be a readme.txt for instance.
683 char *suffix = bname + strlen(bname) - 5;
685 if (strncmp(suffix, ".json", 5)) {
686 pr_info("%s: Ignoring file without .json suffix %s\n", prog,
692 if (level > 1 && add_topic(level, bname))
696 * Assume all other files are JSON files.
698 * If mapfile refers to 'power7_core.json', we create a table
699 * named 'power7_core'. Any inconsistencies between the mapfile
700 * and directory tree could result in build failure due to table
701 * names not being found.
703 * Atleast for now, be strict with processing JSON file names.
704 * i.e. if JSON file name cannot be mapped to C-style table name,
708 struct perf_entry_data data = {
709 .topic = get_topic(),
713 err = json_events(fpath, print_events_table_entry, &data);
722 #define PATH_MAX 4096
726 * Starting in directory 'start_dirname', find the "mapfile.csv" and
727 * the set of JSON files for the architecture 'arch'.
729 * From each JSON file, create a C-style "PMU events table" from the
730 * JSON file (see struct pmu_event).
732 * From the mapfile, create a mapping between the CPU revisions and
733 * PMU event tables (see struct pmu_events_map).
735 * Write out the PMU events tables and the mapping table to pmu-event.c.
737 * If unable to process the JSON or arch files, create an empty mapping
738 * table so we can continue to build/use perf even if we cannot use the
741 int main(int argc, char *argv[])
745 char ldirname[PATH_MAX];
748 const char *output_file;
749 const char *start_dirname;
751 prog = basename(argv[0]);
753 pr_err("Usage: %s <arch> <starting_dir> <output_file>\n", prog);
758 start_dirname = argv[2];
759 output_file = argv[3];
762 verbose = atoi(argv[4]);
764 eventsfp = fopen(output_file, "w");
766 pr_err("%s Unable to create required file %s (%s)\n",
767 prog, output_file, strerror(errno));
771 /* Include pmu-events.h first */
772 fprintf(eventsfp, "#include \"../../pmu-events/pmu-events.h\"\n");
774 sprintf(ldirname, "%s/%s", start_dirname, arch);
777 * The mapfile allows multiple CPUids to point to the same JSON file,
778 * so, not sure if there is a need for symlinks within the pmu-events
781 * For now, treat symlinks of JSON files as regular files and create
782 * separate tables for each symlink (presumably, each symlink refers
783 * to specific version of the CPU).
786 maxfds = get_maxfds();
788 rc = nftw(ldirname, process_one_file, maxfds, 0);
790 pr_info("%s: Error walking file tree %s\n", prog, ldirname);
797 print_events_table_suffix(eventsfp);
800 pr_info("%s: No CPU->JSON mapping?\n", prog);
804 if (process_mapfile(eventsfp, mapfile)) {
805 pr_info("%s: Error processing mapfile %s\n", prog, mapfile);
813 create_empty_mapping(output_file);