lib/libpmcstat/pmu-events/jevents.c

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