GNU Linux-libre 4.19.211-gnu1
[releases.git] / tools / perf / pmu-events / jevents.c
1 #define  _XOPEN_SOURCE 500      /* needed for nftw() */
2 #define  _GNU_SOURCE            /* needed for asprintf() */
3
4 /* Parse event JSON files */
5
6 /*
7  * Copyright (c) 2014, Intel Corporation
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  *
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.
19  *
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.
32 */
33
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <errno.h>
37 #include <string.h>
38 #include <ctype.h>
39 #include <unistd.h>
40 #include <stdarg.h>
41 #include <libgen.h>
42 #include <limits.h>
43 #include <dirent.h>
44 #include <sys/time.h>                   /* getrlimit */
45 #include <sys/resource.h>               /* getrlimit */
46 #include <ftw.h>
47 #include <sys/stat.h>
48 #include <linux/list.h>
49 #include "jsmn.h"
50 #include "json.h"
51 #include "jevents.h"
52
53 int verbose;
54 char *prog;
55
56 int eprintf(int level, int var, const char *fmt, ...)
57 {
58
59         int ret;
60         va_list args;
61
62         if (var < level)
63                 return 0;
64
65         va_start(args, fmt);
66
67         ret = vfprintf(stderr, fmt, args);
68
69         va_end(args);
70
71         return ret;
72 }
73
74 __attribute__((weak)) char *get_cpu_str(void)
75 {
76         return NULL;
77 }
78
79 static void addfield(char *map, char **dst, const char *sep,
80                      const char *a, jsmntok_t *bt)
81 {
82         unsigned int len = strlen(a) + 1 + strlen(sep);
83         int olen = *dst ? strlen(*dst) : 0;
84         int blen = bt ? json_len(bt) : 0;
85         char *out;
86
87         out = realloc(*dst, len + olen + blen);
88         if (!out) {
89                 /* Don't add field in this case */
90                 return;
91         }
92         *dst = out;
93
94         if (!olen)
95                 *(*dst) = 0;
96         else
97                 strcat(*dst, sep);
98         strcat(*dst, a);
99         if (bt)
100                 strncat(*dst, map + bt->start, blen);
101 }
102
103 static void fixname(char *s)
104 {
105         for (; *s; s++)
106                 *s = tolower(*s);
107 }
108
109 static void fixdesc(char *s)
110 {
111         char *e = s + strlen(s);
112
113         /* Remove trailing dots that look ugly in perf list */
114         --e;
115         while (e >= s && isspace(*e))
116                 --e;
117         if (*e == '.')
118                 *e = 0;
119 }
120
121 /* Add escapes for '\' so they are proper C strings. */
122 static char *fixregex(char *s)
123 {
124         int len = 0;
125         int esc_count = 0;
126         char *fixed = NULL;
127         char *p, *q;
128
129         /* Count the number of '\' in string */
130         for (p = s; *p; p++) {
131                 ++len;
132                 if (*p == '\\')
133                         ++esc_count;
134         }
135
136         if (esc_count == 0)
137                 return s;
138
139         /* allocate space for a new string */
140         fixed = (char *) malloc(len + esc_count + 1);
141         if (!fixed)
142                 return NULL;
143
144         /* copy over the characters */
145         q = fixed;
146         for (p = s; *p; p++) {
147                 if (*p == '\\') {
148                         *q = '\\';
149                         ++q;
150                 }
151                 *q = *p;
152                 ++q;
153         }
154         *q = '\0';
155         return fixed;
156 }
157
158 static struct msrmap {
159         const char *num;
160         const char *pname;
161 } msrmap[] = {
162         { "0x3F6", "ldlat=" },
163         { "0x1A6", "offcore_rsp=" },
164         { "0x1A7", "offcore_rsp=" },
165         { "0x3F7", "frontend=" },
166         { NULL, NULL }
167 };
168
169 static struct field {
170         const char *field;
171         const char *kernel;
172 } fields[] = {
173         { "UMask",      "umask=" },
174         { "CounterMask", "cmask=" },
175         { "Invert",     "inv=" },
176         { "AnyThread",  "any=" },
177         { "EdgeDetect", "edge=" },
178         { "SampleAfterValue", "period=" },
179         { "FCMask",     "fc_mask=" },
180         { "PortMask",   "ch_mask=" },
181         { NULL, NULL }
182 };
183
184 static void cut_comma(char *map, jsmntok_t *newval)
185 {
186         int i;
187
188         /* Cut off everything after comma */
189         for (i = newval->start; i < newval->end; i++) {
190                 if (map[i] == ',')
191                         newval->end = i;
192         }
193 }
194
195 static int match_field(char *map, jsmntok_t *field, int nz,
196                        char **event, jsmntok_t *val)
197 {
198         struct field *f;
199         jsmntok_t newval = *val;
200
201         for (f = fields; f->field; f++)
202                 if (json_streq(map, field, f->field) && nz) {
203                         cut_comma(map, &newval);
204                         addfield(map, event, ",", f->kernel, &newval);
205                         return 1;
206                 }
207         return 0;
208 }
209
210 static struct msrmap *lookup_msr(char *map, jsmntok_t *val)
211 {
212         jsmntok_t newval = *val;
213         static bool warned;
214         int i;
215
216         cut_comma(map, &newval);
217         for (i = 0; msrmap[i].num; i++)
218                 if (json_streq(map, &newval, msrmap[i].num))
219                         return &msrmap[i];
220         if (!warned) {
221                 warned = true;
222                 pr_err("%s: Unknown MSR in event file %.*s\n", prog,
223                         json_len(val), map + val->start);
224         }
225         return NULL;
226 }
227
228 static struct map {
229         const char *json;
230         const char *perf;
231 } unit_to_pmu[] = {
232         { "CBO", "uncore_cbox" },
233         { "QPI LL", "uncore_qpi" },
234         { "SBO", "uncore_sbox" },
235         { "iMPH-U", "uncore_arb" },
236         { "CPU-M-CF", "cpum_cf" },
237         { "CPU-M-SF", "cpum_sf" },
238         {}
239 };
240
241 static const char *field_to_perf(struct map *table, char *map, jsmntok_t *val)
242 {
243         int i;
244
245         for (i = 0; table[i].json; i++) {
246                 if (json_streq(map, val, table[i].json))
247                         return table[i].perf;
248         }
249         return NULL;
250 }
251
252 #define EXPECT(e, t, m) do { if (!(e)) {                        \
253         jsmntok_t *loc = (t);                                   \
254         if (!(t)->start && (t) > tokens)                        \
255                 loc = (t) - 1;                                  \
256         pr_err("%s:%d: " m ", got %s\n", fn,                    \
257                json_line(map, loc),                             \
258                json_name(t));                                   \
259         err = -EIO;                                             \
260         goto out_free;                                          \
261 } } while (0)
262
263 static char *topic;
264
265 static char *get_topic(void)
266 {
267         char *tp;
268         int i;
269
270         /* tp is free'd in process_one_file() */
271         i = asprintf(&tp, "%s", topic);
272         if (i < 0) {
273                 pr_info("%s: asprintf() error %s\n", prog);
274                 return NULL;
275         }
276
277         for (i = 0; i < (int) strlen(tp); i++) {
278                 char c = tp[i];
279
280                 if (c == '-')
281                         tp[i] = ' ';
282                 else if (c == '.') {
283                         tp[i] = '\0';
284                         break;
285                 }
286         }
287
288         return tp;
289 }
290
291 static int add_topic(char *bname)
292 {
293         free(topic);
294         topic = strdup(bname);
295         if (!topic) {
296                 pr_info("%s: strdup() error %s for file %s\n", prog,
297                                 strerror(errno), bname);
298                 return -ENOMEM;
299         }
300         return 0;
301 }
302
303 struct perf_entry_data {
304         FILE *outfp;
305         char *topic;
306 };
307
308 static int close_table;
309
310 static void print_events_table_prefix(FILE *fp, const char *tblname)
311 {
312         fprintf(fp, "struct pmu_event %s[] = {\n", tblname);
313         close_table = 1;
314 }
315
316 static int print_events_table_entry(void *data, char *name, char *event,
317                                     char *desc, char *long_desc,
318                                     char *pmu, char *unit, char *perpkg,
319                                     char *metric_expr,
320                                     char *metric_name, char *metric_group)
321 {
322         struct perf_entry_data *pd = data;
323         FILE *outfp = pd->outfp;
324         char *topic = pd->topic;
325
326         /*
327          * TODO: Remove formatting chars after debugging to reduce
328          *       string lengths.
329          */
330         fprintf(outfp, "{\n");
331
332         if (name)
333                 fprintf(outfp, "\t.name = \"%s\",\n", name);
334         if (event)
335                 fprintf(outfp, "\t.event = \"%s\",\n", event);
336         fprintf(outfp, "\t.desc = \"%s\",\n", desc);
337         fprintf(outfp, "\t.topic = \"%s\",\n", topic);
338         if (long_desc && long_desc[0])
339                 fprintf(outfp, "\t.long_desc = \"%s\",\n", long_desc);
340         if (pmu)
341                 fprintf(outfp, "\t.pmu = \"%s\",\n", pmu);
342         if (unit)
343                 fprintf(outfp, "\t.unit = \"%s\",\n", unit);
344         if (perpkg)
345                 fprintf(outfp, "\t.perpkg = \"%s\",\n", perpkg);
346         if (metric_expr)
347                 fprintf(outfp, "\t.metric_expr = \"%s\",\n", metric_expr);
348         if (metric_name)
349                 fprintf(outfp, "\t.metric_name = \"%s\",\n", metric_name);
350         if (metric_group)
351                 fprintf(outfp, "\t.metric_group = \"%s\",\n", metric_group);
352         fprintf(outfp, "},\n");
353
354         return 0;
355 }
356
357 struct event_struct {
358         struct list_head list;
359         char *name;
360         char *event;
361         char *desc;
362         char *long_desc;
363         char *pmu;
364         char *unit;
365         char *perpkg;
366         char *metric_expr;
367         char *metric_name;
368         char *metric_group;
369 };
370
371 #define ADD_EVENT_FIELD(field) do { if (field) {                \
372         es->field = strdup(field);                              \
373         if (!es->field)                                         \
374                 goto out_free;                                  \
375 } } while (0)
376
377 #define FREE_EVENT_FIELD(field) free(es->field)
378
379 #define TRY_FIXUP_FIELD(field) do { if (es->field && !*field) {\
380         *field = strdup(es->field);                             \
381         if (!*field)                                            \
382                 return -ENOMEM;                                 \
383 } } while (0)
384
385 #define FOR_ALL_EVENT_STRUCT_FIELDS(op) do {                    \
386         op(name);                                               \
387         op(event);                                              \
388         op(desc);                                               \
389         op(long_desc);                                          \
390         op(pmu);                                                \
391         op(unit);                                               \
392         op(perpkg);                                             \
393         op(metric_expr);                                        \
394         op(metric_name);                                        \
395         op(metric_group);                                       \
396 } while (0)
397
398 static LIST_HEAD(arch_std_events);
399
400 static void free_arch_std_events(void)
401 {
402         struct event_struct *es, *next;
403
404         list_for_each_entry_safe(es, next, &arch_std_events, list) {
405                 FOR_ALL_EVENT_STRUCT_FIELDS(FREE_EVENT_FIELD);
406                 list_del(&es->list);
407                 free(es);
408         }
409 }
410
411 static int save_arch_std_events(void *data, char *name, char *event,
412                                 char *desc, char *long_desc, char *pmu,
413                                 char *unit, char *perpkg, char *metric_expr,
414                                 char *metric_name, char *metric_group)
415 {
416         struct event_struct *es;
417         struct stat *sb = data;
418
419         es = malloc(sizeof(*es));
420         if (!es)
421                 return -ENOMEM;
422         memset(es, 0, sizeof(*es));
423         FOR_ALL_EVENT_STRUCT_FIELDS(ADD_EVENT_FIELD);
424         list_add_tail(&es->list, &arch_std_events);
425         return 0;
426 out_free:
427         FOR_ALL_EVENT_STRUCT_FIELDS(FREE_EVENT_FIELD);
428         free(es);
429         return -ENOMEM;
430 }
431
432 static void print_events_table_suffix(FILE *outfp)
433 {
434         fprintf(outfp, "{\n");
435
436         fprintf(outfp, "\t.name = 0,\n");
437         fprintf(outfp, "\t.event = 0,\n");
438         fprintf(outfp, "\t.desc = 0,\n");
439
440         fprintf(outfp, "},\n");
441         fprintf(outfp, "};\n");
442         close_table = 0;
443 }
444
445 static struct fixed {
446         const char *name;
447         const char *event;
448 } fixed[] = {
449         { "inst_retired.any", "event=0xc0,period=2000003" },
450         { "inst_retired.any_p", "event=0xc0,period=2000003" },
451         { "cpu_clk_unhalted.ref", "event=0x0,umask=0x03,period=2000003" },
452         { "cpu_clk_unhalted.thread", "event=0x3c,period=2000003" },
453         { "cpu_clk_unhalted.core", "event=0x3c,period=2000003" },
454         { "cpu_clk_unhalted.thread_any", "event=0x3c,any=1,period=2000003" },
455         { NULL, NULL},
456 };
457
458 /*
459  * Handle different fixed counter encodings between JSON and perf.
460  */
461 static char *real_event(const char *name, char *event)
462 {
463         int i;
464
465         if (!name)
466                 return NULL;
467
468         for (i = 0; fixed[i].name; i++)
469                 if (!strcasecmp(name, fixed[i].name))
470                         return (char *)fixed[i].event;
471         return event;
472 }
473
474 static int
475 try_fixup(const char *fn, char *arch_std, char **event, char **desc,
476           char **name, char **long_desc, char **pmu, char **filter,
477           char **perpkg, char **unit, char **metric_expr, char **metric_name,
478           char **metric_group, unsigned long long eventcode)
479 {
480         /* try to find matching event from arch standard values */
481         struct event_struct *es;
482
483         list_for_each_entry(es, &arch_std_events, list) {
484                 if (!strcmp(arch_std, es->name)) {
485                         if (!eventcode && es->event) {
486                                 /* allow EventCode to be overridden */
487                                 free(*event);
488                                 *event = NULL;
489                         }
490                         FOR_ALL_EVENT_STRUCT_FIELDS(TRY_FIXUP_FIELD);
491                         return 0;
492                 }
493         }
494
495         pr_err("%s: could not find matching %s for %s\n",
496                                         prog, arch_std, fn);
497         return -1;
498 }
499
500 /* Call func with each event in the json file */
501 int json_events(const char *fn,
502           int (*func)(void *data, char *name, char *event, char *desc,
503                       char *long_desc,
504                       char *pmu, char *unit, char *perpkg,
505                       char *metric_expr,
506                       char *metric_name, char *metric_group),
507           void *data)
508 {
509         int err;
510         size_t size;
511         jsmntok_t *tokens, *tok;
512         int i, j, len;
513         char *map;
514         char buf[128];
515
516         if (!fn)
517                 return -ENOENT;
518
519         tokens = parse_json(fn, &map, &size, &len);
520         if (!tokens)
521                 return -EIO;
522         EXPECT(tokens->type == JSMN_ARRAY, tokens, "expected top level array");
523         tok = tokens + 1;
524         for (i = 0; i < tokens->size; i++) {
525                 char *event = NULL, *desc = NULL, *name = NULL;
526                 char *long_desc = NULL;
527                 char *extra_desc = NULL;
528                 char *pmu = NULL;
529                 char *filter = NULL;
530                 char *perpkg = NULL;
531                 char *unit = NULL;
532                 char *metric_expr = NULL;
533                 char *metric_name = NULL;
534                 char *metric_group = NULL;
535                 char *arch_std = NULL;
536                 unsigned long long eventcode = 0;
537                 struct msrmap *msr = NULL;
538                 jsmntok_t *msrval = NULL;
539                 jsmntok_t *precise = NULL;
540                 jsmntok_t *obj = tok++;
541
542                 EXPECT(obj->type == JSMN_OBJECT, obj, "expected object");
543                 for (j = 0; j < obj->size; j += 2) {
544                         jsmntok_t *field, *val;
545                         int nz;
546                         char *s;
547
548                         field = tok + j;
549                         EXPECT(field->type == JSMN_STRING, tok + j,
550                                "Expected field name");
551                         val = tok + j + 1;
552                         EXPECT(val->type == JSMN_STRING, tok + j + 1,
553                                "Expected string value");
554
555                         nz = !json_streq(map, val, "0");
556                         if (match_field(map, field, nz, &event, val)) {
557                                 /* ok */
558                         } else if (json_streq(map, field, "EventCode")) {
559                                 char *code = NULL;
560                                 addfield(map, &code, "", "", val);
561                                 eventcode |= strtoul(code, NULL, 0);
562                                 free(code);
563                         } else if (json_streq(map, field, "ExtSel")) {
564                                 char *code = NULL;
565                                 addfield(map, &code, "", "", val);
566                                 eventcode |= strtoul(code, NULL, 0) << 21;
567                                 free(code);
568                         } else if (json_streq(map, field, "EventName")) {
569                                 addfield(map, &name, "", "", val);
570                         } else if (json_streq(map, field, "BriefDescription")) {
571                                 addfield(map, &desc, "", "", val);
572                                 fixdesc(desc);
573                         } else if (json_streq(map, field,
574                                              "PublicDescription")) {
575                                 addfield(map, &long_desc, "", "", val);
576                                 fixdesc(long_desc);
577                         } else if (json_streq(map, field, "PEBS") && nz) {
578                                 precise = val;
579                         } else if (json_streq(map, field, "MSRIndex") && nz) {
580                                 msr = lookup_msr(map, val);
581                         } else if (json_streq(map, field, "MSRValue")) {
582                                 msrval = val;
583                         } else if (json_streq(map, field, "Errata") &&
584                                    !json_streq(map, val, "null")) {
585                                 addfield(map, &extra_desc, ". ",
586                                         " Spec update: ", val);
587                         } else if (json_streq(map, field, "Data_LA") && nz) {
588                                 addfield(map, &extra_desc, ". ",
589                                         " Supports address when precise",
590                                         NULL);
591                         } else if (json_streq(map, field, "Unit")) {
592                                 const char *ppmu;
593
594                                 ppmu = field_to_perf(unit_to_pmu, map, val);
595                                 if (ppmu) {
596                                         pmu = strdup(ppmu);
597                                 } else {
598                                         if (!pmu)
599                                                 pmu = strdup("uncore_");
600                                         addfield(map, &pmu, "", "", val);
601                                         for (s = pmu; *s; s++)
602                                                 *s = tolower(*s);
603                                 }
604                                 addfield(map, &desc, ". ", "Unit: ", NULL);
605                                 addfield(map, &desc, "", pmu, NULL);
606                                 addfield(map, &desc, "", " ", NULL);
607                         } else if (json_streq(map, field, "Filter")) {
608                                 addfield(map, &filter, "", "", val);
609                         } else if (json_streq(map, field, "ScaleUnit")) {
610                                 addfield(map, &unit, "", "", val);
611                         } else if (json_streq(map, field, "PerPkg")) {
612                                 addfield(map, &perpkg, "", "", val);
613                         } else if (json_streq(map, field, "MetricName")) {
614                                 addfield(map, &metric_name, "", "", val);
615                         } else if (json_streq(map, field, "MetricGroup")) {
616                                 addfield(map, &metric_group, "", "", val);
617                         } else if (json_streq(map, field, "MetricExpr")) {
618                                 addfield(map, &metric_expr, "", "", val);
619                                 for (s = metric_expr; *s; s++)
620                                         *s = tolower(*s);
621                         } else if (json_streq(map, field, "ArchStdEvent")) {
622                                 addfield(map, &arch_std, "", "", val);
623                                 for (s = arch_std; *s; s++)
624                                         *s = tolower(*s);
625                         }
626                         /* ignore unknown fields */
627                 }
628                 if (precise && desc && !strstr(desc, "(Precise Event)")) {
629                         if (json_streq(map, precise, "2"))
630                                 addfield(map, &extra_desc, " ",
631                                                 "(Must be precise)", NULL);
632                         else
633                                 addfield(map, &extra_desc, " ",
634                                                 "(Precise event)", NULL);
635                 }
636                 snprintf(buf, sizeof buf, "event=%#llx", eventcode);
637                 addfield(map, &event, ",", buf, NULL);
638                 if (desc && extra_desc)
639                         addfield(map, &desc, " ", extra_desc, NULL);
640                 if (long_desc && extra_desc)
641                         addfield(map, &long_desc, " ", extra_desc, NULL);
642                 if (filter)
643                         addfield(map, &event, ",", filter, NULL);
644                 if (msr != NULL)
645                         addfield(map, &event, ",", msr->pname, msrval);
646                 if (name)
647                         fixname(name);
648
649                 if (arch_std) {
650                         /*
651                          * An arch standard event is referenced, so try to
652                          * fixup any unassigned values.
653                          */
654                         err = try_fixup(fn, arch_std, &event, &desc, &name,
655                                         &long_desc, &pmu, &filter, &perpkg,
656                                         &unit, &metric_expr, &metric_name,
657                                         &metric_group, eventcode);
658                         if (err)
659                                 goto free_strings;
660                 }
661                 err = func(data, name, real_event(name, event), desc, long_desc,
662                            pmu, unit, perpkg, metric_expr, metric_name, metric_group);
663 free_strings:
664                 free(event);
665                 free(desc);
666                 free(name);
667                 free(long_desc);
668                 free(extra_desc);
669                 free(pmu);
670                 free(filter);
671                 free(perpkg);
672                 free(unit);
673                 free(metric_expr);
674                 free(metric_name);
675                 free(metric_group);
676                 free(arch_std);
677
678                 if (err)
679                         break;
680                 tok += j;
681         }
682         EXPECT(tok - tokens == len, tok, "unexpected objects at end");
683         err = 0;
684 out_free:
685         free_json(map, size, tokens);
686         return err;
687 }
688
689 static char *file_name_to_table_name(char *fname)
690 {
691         unsigned int i;
692         int n;
693         int c;
694         char *tblname;
695
696         /*
697          * Ensure tablename starts with alphabetic character.
698          * Derive rest of table name from basename of the JSON file,
699          * replacing hyphens and stripping out .json suffix.
700          */
701         n = asprintf(&tblname, "pme_%s", fname);
702         if (n < 0) {
703                 pr_info("%s: asprintf() error %s for file %s\n", prog,
704                                 strerror(errno), fname);
705                 return NULL;
706         }
707
708         for (i = 0; i < strlen(tblname); i++) {
709                 c = tblname[i];
710
711                 if (c == '-' || c == '/')
712                         tblname[i] = '_';
713                 else if (c == '.') {
714                         tblname[i] = '\0';
715                         break;
716                 } else if (!isalnum(c) && c != '_') {
717                         pr_err("%s: Invalid character '%c' in file name %s\n",
718                                         prog, c, basename(fname));
719                         free(tblname);
720                         tblname = NULL;
721                         break;
722                 }
723         }
724
725         return tblname;
726 }
727
728 static void print_mapping_table_prefix(FILE *outfp)
729 {
730         fprintf(outfp, "struct pmu_events_map pmu_events_map[] = {\n");
731 }
732
733 static void print_mapping_table_suffix(FILE *outfp)
734 {
735         /*
736          * Print the terminating, NULL entry.
737          */
738         fprintf(outfp, "{\n");
739         fprintf(outfp, "\t.cpuid = 0,\n");
740         fprintf(outfp, "\t.version = 0,\n");
741         fprintf(outfp, "\t.type = 0,\n");
742         fprintf(outfp, "\t.table = 0,\n");
743         fprintf(outfp, "},\n");
744
745         /* and finally, the closing curly bracket for the struct */
746         fprintf(outfp, "};\n");
747 }
748
749 static int process_mapfile(FILE *outfp, char *fpath)
750 {
751         int n = 16384;
752         FILE *mapfp;
753         char *save = NULL;
754         char *line, *p;
755         int line_num;
756         char *tblname;
757         int ret = 0;
758
759         pr_info("%s: Processing mapfile %s\n", prog, fpath);
760
761         line = malloc(n);
762         if (!line)
763                 return -1;
764
765         mapfp = fopen(fpath, "r");
766         if (!mapfp) {
767                 pr_info("%s: Error %s opening %s\n", prog, strerror(errno),
768                                 fpath);
769                 free(line);
770                 return -1;
771         }
772
773         print_mapping_table_prefix(outfp);
774
775         /* Skip first line (header) */
776         p = fgets(line, n, mapfp);
777         if (!p)
778                 goto out;
779
780         line_num = 1;
781         while (1) {
782                 char *cpuid, *version, *type, *fname;
783
784                 line_num++;
785                 p = fgets(line, n, mapfp);
786                 if (!p)
787                         break;
788
789                 if (line[0] == '#' || line[0] == '\n')
790                         continue;
791
792                 if (line[strlen(line)-1] != '\n') {
793                         /* TODO Deal with lines longer than 16K */
794                         pr_info("%s: Mapfile %s: line %d too long, aborting\n",
795                                         prog, fpath, line_num);
796                         ret = -1;
797                         goto out;
798                 }
799                 line[strlen(line)-1] = '\0';
800
801                 cpuid = fixregex(strtok_r(p, ",", &save));
802                 version = strtok_r(NULL, ",", &save);
803                 fname = strtok_r(NULL, ",", &save);
804                 type = strtok_r(NULL, ",", &save);
805
806                 tblname = file_name_to_table_name(fname);
807                 fprintf(outfp, "{\n");
808                 fprintf(outfp, "\t.cpuid = \"%s\",\n", cpuid);
809                 fprintf(outfp, "\t.version = \"%s\",\n", version);
810                 fprintf(outfp, "\t.type = \"%s\",\n", type);
811
812                 /*
813                  * CHECK: We can't use the type (eg "core") field in the
814                  * table name. For us to do that, we need to somehow tweak
815                  * the other caller of file_name_to_table(), process_json()
816                  * to determine the type. process_json() file has no way
817                  * of knowing these are "core" events unless file name has
818                  * core in it. If filename has core in it, we can safely
819                  * ignore the type field here also.
820                  */
821                 fprintf(outfp, "\t.table = %s\n", tblname);
822                 fprintf(outfp, "},\n");
823         }
824
825 out:
826         print_mapping_table_suffix(outfp);
827         fclose(mapfp);
828         free(line);
829         return ret;
830 }
831
832 /*
833  * If we fail to locate/process JSON and map files, create a NULL mapping
834  * table. This would at least allow perf to build even if we can't find/use
835  * the aliases.
836  */
837 static void create_empty_mapping(const char *output_file)
838 {
839         FILE *outfp;
840
841         pr_info("%s: Creating empty pmu_events_map[] table\n", prog);
842
843         /* Truncate file to clear any partial writes to it */
844         outfp = fopen(output_file, "w");
845         if (!outfp) {
846                 perror("fopen()");
847                 _Exit(1);
848         }
849
850         fprintf(outfp, "#include \"../../pmu-events/pmu-events.h\"\n");
851         print_mapping_table_prefix(outfp);
852         print_mapping_table_suffix(outfp);
853         fclose(outfp);
854 }
855
856 static int get_maxfds(void)
857 {
858         struct rlimit rlim;
859
860         if (getrlimit(RLIMIT_NOFILE, &rlim) == 0)
861                 return min(rlim.rlim_max / 2, (rlim_t)512);
862
863         return 512;
864 }
865
866 /*
867  * nftw() doesn't let us pass an argument to the processing function,
868  * so use a global variables.
869  */
870 static FILE *eventsfp;
871 static char *mapfile;
872
873 static int is_leaf_dir(const char *fpath)
874 {
875         DIR *d;
876         struct dirent *dir;
877         int res = 1;
878
879         d = opendir(fpath);
880         if (!d)
881                 return 0;
882
883         while ((dir = readdir(d)) != NULL) {
884                 if (!strcmp(dir->d_name, ".") || !strcmp(dir->d_name, ".."))
885                         continue;
886
887                 if (dir->d_type == DT_DIR) {
888                         res = 0;
889                         break;
890                 } else if (dir->d_type == DT_UNKNOWN) {
891                         char path[PATH_MAX];
892                         struct stat st;
893
894                         sprintf(path, "%s/%s", fpath, dir->d_name);
895                         if (stat(path, &st))
896                                 break;
897
898                         if (S_ISDIR(st.st_mode)) {
899                                 res = 0;
900                                 break;
901                         }
902                 }
903         }
904
905         closedir(d);
906
907         return res;
908 }
909
910 static int is_json_file(const char *name)
911 {
912         const char *suffix;
913
914         if (strlen(name) < 5)
915                 return 0;
916
917         suffix = name + strlen(name) - 5;
918
919         if (strncmp(suffix, ".json", 5) == 0)
920                 return 1;
921         return 0;
922 }
923
924 static int preprocess_arch_std_files(const char *fpath, const struct stat *sb,
925                                 int typeflag, struct FTW *ftwbuf)
926 {
927         int level = ftwbuf->level;
928         int is_file = typeflag == FTW_F;
929
930         if (level == 1 && is_file && is_json_file(fpath))
931                 return json_events(fpath, save_arch_std_events, (void *)sb);
932
933         return 0;
934 }
935
936 static int process_one_file(const char *fpath, const struct stat *sb,
937                             int typeflag, struct FTW *ftwbuf)
938 {
939         char *tblname, *bname;
940         int is_dir  = typeflag == FTW_D;
941         int is_file = typeflag == FTW_F;
942         int level   = ftwbuf->level;
943         int err = 0;
944
945         if (level == 2 && is_dir) {
946                 /*
947                  * For level 2 directory, bname will include parent name,
948                  * like vendor/platform. So search back from platform dir
949                  * to find this.
950                  */
951                 bname = (char *) fpath + ftwbuf->base - 2;
952                 for (;;) {
953                         if (*bname == '/')
954                                 break;
955                         bname--;
956                 }
957                 bname++;
958         } else
959                 bname = (char *) fpath + ftwbuf->base;
960
961         pr_debug("%s %d %7jd %-20s %s\n",
962                  is_file ? "f" : is_dir ? "d" : "x",
963                  level, sb->st_size, bname, fpath);
964
965         /* base dir or too deep */
966         if (level == 0 || level > 3)
967                 return 0;
968
969
970         /* model directory, reset topic */
971         if ((level == 1 && is_dir && is_leaf_dir(fpath)) ||
972             (level == 2 && is_dir)) {
973                 if (close_table)
974                         print_events_table_suffix(eventsfp);
975
976                 /*
977                  * Drop file name suffix. Replace hyphens with underscores.
978                  * Fail if file name contains any alphanum characters besides
979                  * underscores.
980                  */
981                 tblname = file_name_to_table_name(bname);
982                 if (!tblname) {
983                         pr_info("%s: Error determining table name for %s\n", prog,
984                                 bname);
985                         return -1;
986                 }
987
988                 print_events_table_prefix(eventsfp, tblname);
989                 return 0;
990         }
991
992         /*
993          * Save the mapfile name for now. We will process mapfile
994          * after processing all JSON files (so we can write out the
995          * mapping table after all PMU events tables).
996          *
997          */
998         if (level == 1 && is_file) {
999                 if (!strcmp(bname, "mapfile.csv")) {
1000                         mapfile = strdup(fpath);
1001                         return 0;
1002                 }
1003
1004                 pr_info("%s: Ignoring file %s\n", prog, fpath);
1005                 return 0;
1006         }
1007
1008         /*
1009          * If the file name does not have a .json extension,
1010          * ignore it. It could be a readme.txt for instance.
1011          */
1012         if (is_file) {
1013                 if (!is_json_file(bname)) {
1014                         pr_info("%s: Ignoring file without .json suffix %s\n", prog,
1015                                 fpath);
1016                         return 0;
1017                 }
1018         }
1019
1020         if (level > 1 && add_topic(bname))
1021                 return -ENOMEM;
1022
1023         /*
1024          * Assume all other files are JSON files.
1025          *
1026          * If mapfile refers to 'power7_core.json', we create a table
1027          * named 'power7_core'. Any inconsistencies between the mapfile
1028          * and directory tree could result in build failure due to table
1029          * names not being found.
1030          *
1031          * Atleast for now, be strict with processing JSON file names.
1032          * i.e. if JSON file name cannot be mapped to C-style table name,
1033          * fail.
1034          */
1035         if (is_file) {
1036                 struct perf_entry_data data = {
1037                         .topic = get_topic(),
1038                         .outfp = eventsfp,
1039                 };
1040
1041                 err = json_events(fpath, print_events_table_entry, &data);
1042
1043                 free(data.topic);
1044         }
1045
1046         return err;
1047 }
1048
1049 #ifndef PATH_MAX
1050 #define PATH_MAX        4096
1051 #endif
1052
1053 /*
1054  * Starting in directory 'start_dirname', find the "mapfile.csv" and
1055  * the set of JSON files for the architecture 'arch'.
1056  *
1057  * From each JSON file, create a C-style "PMU events table" from the
1058  * JSON file (see struct pmu_event).
1059  *
1060  * From the mapfile, create a mapping between the CPU revisions and
1061  * PMU event tables (see struct pmu_events_map).
1062  *
1063  * Write out the PMU events tables and the mapping table to pmu-event.c.
1064  */
1065 int main(int argc, char *argv[])
1066 {
1067         int rc, ret = 0;
1068         int maxfds;
1069         char ldirname[PATH_MAX];
1070         const char *arch;
1071         const char *output_file;
1072         const char *start_dirname;
1073         struct stat stbuf;
1074
1075         prog = basename(argv[0]);
1076         if (argc < 4) {
1077                 pr_err("Usage: %s <arch> <starting_dir> <output_file>\n", prog);
1078                 return 1;
1079         }
1080
1081         arch = argv[1];
1082         start_dirname = argv[2];
1083         output_file = argv[3];
1084
1085         if (argc > 4)
1086                 verbose = atoi(argv[4]);
1087
1088         eventsfp = fopen(output_file, "w");
1089         if (!eventsfp) {
1090                 pr_err("%s Unable to create required file %s (%s)\n",
1091                                 prog, output_file, strerror(errno));
1092                 return 2;
1093         }
1094
1095         sprintf(ldirname, "%s/%s", start_dirname, arch);
1096
1097         /* If architecture does not have any event lists, bail out */
1098         if (stat(ldirname, &stbuf) < 0) {
1099                 pr_info("%s: Arch %s has no PMU event lists\n", prog, arch);
1100                 goto empty_map;
1101         }
1102
1103         /* Include pmu-events.h first */
1104         fprintf(eventsfp, "#include \"../../pmu-events/pmu-events.h\"\n");
1105
1106         /*
1107          * The mapfile allows multiple CPUids to point to the same JSON file,
1108          * so, not sure if there is a need for symlinks within the pmu-events
1109          * directory.
1110          *
1111          * For now, treat symlinks of JSON files as regular files and create
1112          * separate tables for each symlink (presumably, each symlink refers
1113          * to specific version of the CPU).
1114          */
1115
1116         maxfds = get_maxfds();
1117         mapfile = NULL;
1118         rc = nftw(ldirname, preprocess_arch_std_files, maxfds, 0);
1119         if (rc && verbose) {
1120                 pr_info("%s: Error preprocessing arch standard files %s\n",
1121                         prog, ldirname);
1122                 goto empty_map;
1123         } else if (rc < 0) {
1124                 /* Make build fail */
1125                 fclose(eventsfp);
1126                 free_arch_std_events();
1127                 return 1;
1128         } else if (rc) {
1129                 goto empty_map;
1130         }
1131
1132         rc = nftw(ldirname, process_one_file, maxfds, 0);
1133         if (rc && verbose) {
1134                 pr_info("%s: Error walking file tree %s\n", prog, ldirname);
1135                 goto empty_map;
1136         } else if (rc < 0) {
1137                 /* Make build fail */
1138                 fclose(eventsfp);
1139                 free_arch_std_events();
1140                 ret = 1;
1141                 goto out_free_mapfile;
1142         } else if (rc) {
1143                 goto empty_map;
1144         }
1145
1146         if (close_table)
1147                 print_events_table_suffix(eventsfp);
1148
1149         if (!mapfile) {
1150                 pr_info("%s: No CPU->JSON mapping?\n", prog);
1151                 goto empty_map;
1152         }
1153
1154         if (process_mapfile(eventsfp, mapfile)) {
1155                 pr_info("%s: Error processing mapfile %s\n", prog, mapfile);
1156                 /* Make build fail */
1157                 fclose(eventsfp);
1158                 free_arch_std_events();
1159                 ret = 1;
1160         }
1161
1162
1163         goto out_free_mapfile;
1164
1165 empty_map:
1166         fclose(eventsfp);
1167         create_empty_mapping(output_file);
1168         free_arch_std_events();
1169 out_free_mapfile:
1170         free(mapfile);
1171         return ret;
1172 }