• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 <dirent.h>
43 #include <sys/time.h>			/* getrlimit */
44 #include <sys/resource.h>		/* getrlimit */
45 #include <ftw.h>
46 #include <sys/stat.h>
47 #include "jsmn.h"
48 #include "json.h"
49 #include "jevents.h"
50 
51 int verbose;
52 char *prog;
53 
eprintf(int level,int var,const char * fmt,...)54 int eprintf(int level, int var, const char *fmt, ...)
55 {
56 
57 	int ret;
58 	va_list args;
59 
60 	if (var < level)
61 		return 0;
62 
63 	va_start(args, fmt);
64 
65 	ret = vfprintf(stderr, fmt, args);
66 
67 	va_end(args);
68 
69 	return ret;
70 }
71 
get_cpu_str(void)72 __attribute__((weak)) char *get_cpu_str(void)
73 {
74 	return NULL;
75 }
76 
addfield(char * map,char ** dst,const char * sep,const char * a,jsmntok_t * bt)77 static void addfield(char *map, char **dst, const char *sep,
78 		     const char *a, jsmntok_t *bt)
79 {
80 	unsigned int len = strlen(a) + 1 + strlen(sep);
81 	int olen = *dst ? strlen(*dst) : 0;
82 	int blen = bt ? json_len(bt) : 0;
83 	char *out;
84 
85 	out = realloc(*dst, len + olen + blen);
86 	if (!out) {
87 		/* Don't add field in this case */
88 		return;
89 	}
90 	*dst = out;
91 
92 	if (!olen)
93 		*(*dst) = 0;
94 	else
95 		strcat(*dst, sep);
96 	strcat(*dst, a);
97 	if (bt)
98 		strncat(*dst, map + bt->start, blen);
99 }
100 
fixname(char * s)101 static void fixname(char *s)
102 {
103 	for (; *s; s++)
104 		*s = tolower(*s);
105 }
106 
fixdesc(char * s)107 static void fixdesc(char *s)
108 {
109 	char *e = s + strlen(s);
110 
111 	/* Remove trailing dots that look ugly in perf list */
112 	--e;
113 	while (e >= s && isspace(*e))
114 		--e;
115 	if (*e == '.')
116 		*e = 0;
117 }
118 
119 static struct msrmap {
120 	const char *num;
121 	const char *pname;
122 } msrmap[] = {
123 	{ "0x3F6", "ldlat=" },
124 	{ "0x1A6", "offcore_rsp=" },
125 	{ "0x1A7", "offcore_rsp=" },
126 	{ "0x3F7", "frontend=" },
127 	{ NULL, NULL }
128 };
129 
130 static struct field {
131 	const char *field;
132 	const char *kernel;
133 } fields[] = {
134 	{ "UMask",	"umask=" },
135 	{ "CounterMask", "cmask=" },
136 	{ "Invert",	"inv=" },
137 	{ "AnyThread",	"any=" },
138 	{ "EdgeDetect",	"edge=" },
139 	{ "SampleAfterValue", "period=" },
140 	{ "FCMask",	"fc_mask=" },
141 	{ "PortMask",	"ch_mask=" },
142 	{ NULL, NULL }
143 };
144 
cut_comma(char * map,jsmntok_t * newval)145 static void cut_comma(char *map, jsmntok_t *newval)
146 {
147 	int i;
148 
149 	/* Cut off everything after comma */
150 	for (i = newval->start; i < newval->end; i++) {
151 		if (map[i] == ',')
152 			newval->end = i;
153 	}
154 }
155 
match_field(char * map,jsmntok_t * field,int nz,char ** event,jsmntok_t * val)156 static int match_field(char *map, jsmntok_t *field, int nz,
157 		       char **event, jsmntok_t *val)
158 {
159 	struct field *f;
160 	jsmntok_t newval = *val;
161 
162 	for (f = fields; f->field; f++)
163 		if (json_streq(map, field, f->field) && nz) {
164 			cut_comma(map, &newval);
165 			addfield(map, event, ",", f->kernel, &newval);
166 			return 1;
167 		}
168 	return 0;
169 }
170 
lookup_msr(char * map,jsmntok_t * val)171 static struct msrmap *lookup_msr(char *map, jsmntok_t *val)
172 {
173 	jsmntok_t newval = *val;
174 	static bool warned;
175 	int i;
176 
177 	cut_comma(map, &newval);
178 	for (i = 0; msrmap[i].num; i++)
179 		if (json_streq(map, &newval, msrmap[i].num))
180 			return &msrmap[i];
181 	if (!warned) {
182 		warned = true;
183 		pr_err("%s: Unknown MSR in event file %.*s\n", prog,
184 			json_len(val), map + val->start);
185 	}
186 	return NULL;
187 }
188 
189 static struct map {
190 	const char *json;
191 	const char *perf;
192 } unit_to_pmu[] = {
193 	{ "CBO", "uncore_cbox" },
194 	{ "QPI LL", "uncore_qpi" },
195 	{ "SBO", "uncore_sbox" },
196 	{ "iMPH-U", "uncore_arb" },
197 	{}
198 };
199 
field_to_perf(struct map * table,char * map,jsmntok_t * val)200 static const char *field_to_perf(struct map *table, char *map, jsmntok_t *val)
201 {
202 	int i;
203 
204 	for (i = 0; table[i].json; i++) {
205 		if (json_streq(map, val, table[i].json))
206 			return table[i].perf;
207 	}
208 	return NULL;
209 }
210 
211 #define EXPECT(e, t, m) do { if (!(e)) {			\
212 	jsmntok_t *loc = (t);					\
213 	if (!(t)->start && (t) > tokens)			\
214 		loc = (t) - 1;					\
215 		pr_err("%s:%d: " m ", got %s\n", fn,		\
216 			json_line(map, loc),			\
217 			json_name(t));				\
218 	goto out_free;						\
219 } } while (0)
220 
221 #define TOPIC_DEPTH 256
222 static char *topic_array[TOPIC_DEPTH];
223 static int   topic_level;
224 
get_topic(void)225 static char *get_topic(void)
226 {
227 	char *tp_old, *tp = NULL;
228 	int i;
229 
230 	for (i = 0; i < topic_level + 1; i++) {
231 		int n;
232 
233 		tp_old = tp;
234 		n = asprintf(&tp, "%s%s", tp ?: "", topic_array[i]);
235 		if (n < 0) {
236 			pr_info("%s: asprintf() error %s\n", prog);
237 			return NULL;
238 		}
239 		free(tp_old);
240 	}
241 
242 	for (i = 0; i < (int) strlen(tp); i++) {
243 		char c = tp[i];
244 
245 		if (c == '-')
246 			tp[i] = ' ';
247 		else if (c == '.') {
248 			tp[i] = '\0';
249 			break;
250 		}
251 	}
252 
253 	return tp;
254 }
255 
add_topic(int level,char * bname)256 static int add_topic(int level, char *bname)
257 {
258 	char *topic;
259 
260 	level -= 2;
261 
262 	if (level >= TOPIC_DEPTH)
263 		return -EINVAL;
264 
265 	topic = strdup(bname);
266 	if (!topic) {
267 		pr_info("%s: strdup() error %s for file %s\n", prog,
268 				strerror(errno), bname);
269 		return -ENOMEM;
270 	}
271 
272 	free(topic_array[topic_level]);
273 	topic_array[topic_level] = topic;
274 	topic_level              = level;
275 	return 0;
276 }
277 
278 struct perf_entry_data {
279 	FILE *outfp;
280 	char *topic;
281 };
282 
283 static int close_table;
284 
print_events_table_prefix(FILE * fp,const char * tblname)285 static void print_events_table_prefix(FILE *fp, const char *tblname)
286 {
287 	fprintf(fp, "struct pmu_event %s[] = {\n", tblname);
288 	close_table = 1;
289 }
290 
print_events_table_entry(void * data,char * name,char * event,char * desc,char * long_desc,char * pmu,char * unit,char * perpkg,char * metric_expr,char * metric_name)291 static int print_events_table_entry(void *data, char *name, char *event,
292 				    char *desc, char *long_desc,
293 				    char *pmu, char *unit, char *perpkg,
294 				    char *metric_expr,
295 				    char *metric_name)
296 {
297 	struct perf_entry_data *pd = data;
298 	FILE *outfp = pd->outfp;
299 	char *topic = pd->topic;
300 
301 	/*
302 	 * TODO: Remove formatting chars after debugging to reduce
303 	 *	 string lengths.
304 	 */
305 	fprintf(outfp, "{\n");
306 
307 	fprintf(outfp, "\t.name = \"%s\",\n", name);
308 	fprintf(outfp, "\t.event = \"%s\",\n", event);
309 	fprintf(outfp, "\t.desc = \"%s\",\n", desc);
310 	fprintf(outfp, "\t.topic = \"%s\",\n", topic);
311 	if (long_desc && long_desc[0])
312 		fprintf(outfp, "\t.long_desc = \"%s\",\n", long_desc);
313 	if (pmu)
314 		fprintf(outfp, "\t.pmu = \"%s\",\n", pmu);
315 	if (unit)
316 		fprintf(outfp, "\t.unit = \"%s\",\n", unit);
317 	if (perpkg)
318 		fprintf(outfp, "\t.perpkg = \"%s\",\n", perpkg);
319 	if (metric_expr)
320 		fprintf(outfp, "\t.metric_expr = \"%s\",\n", metric_expr);
321 	if (metric_name)
322 		fprintf(outfp, "\t.metric_name = \"%s\",\n", metric_name);
323 	fprintf(outfp, "},\n");
324 
325 	return 0;
326 }
327 
print_events_table_suffix(FILE * outfp)328 static void print_events_table_suffix(FILE *outfp)
329 {
330 	fprintf(outfp, "{\n");
331 
332 	fprintf(outfp, "\t.name = 0,\n");
333 	fprintf(outfp, "\t.event = 0,\n");
334 	fprintf(outfp, "\t.desc = 0,\n");
335 
336 	fprintf(outfp, "},\n");
337 	fprintf(outfp, "};\n");
338 	close_table = 0;
339 }
340 
341 static struct fixed {
342 	const char *name;
343 	const char *event;
344 } fixed[] = {
345 	{ "inst_retired.any", "event=0xc0,period=2000003" },
346 	{ "inst_retired.any_p", "event=0xc0,period=2000003" },
347 	{ "cpu_clk_unhalted.ref", "event=0x0,umask=0x03,period=2000003" },
348 	{ "cpu_clk_unhalted.thread", "event=0x3c,period=2000003" },
349 	{ "cpu_clk_unhalted.core", "event=0x3c,period=2000003" },
350 	{ "cpu_clk_unhalted.thread_any", "event=0x3c,any=1,period=2000003" },
351 	{ NULL, NULL},
352 };
353 
354 /*
355  * Handle different fixed counter encodings between JSON and perf.
356  */
real_event(const char * name,char * event)357 static char *real_event(const char *name, char *event)
358 {
359 	int i;
360 
361 	for (i = 0; fixed[i].name; i++)
362 		if (!strcasecmp(name, fixed[i].name))
363 			return (char *)fixed[i].event;
364 	return event;
365 }
366 
367 /* Call func with each event in the json file */
json_events(const char * fn,int (* func)(void * data,char * name,char * event,char * desc,char * long_desc,char * pmu,char * unit,char * perpkg,char * metric_expr,char * metric_name),void * data)368 int json_events(const char *fn,
369 	  int (*func)(void *data, char *name, char *event, char *desc,
370 		      char *long_desc,
371 		      char *pmu, char *unit, char *perpkg,
372 		      char *metric_expr,
373 		      char *metric_name),
374 	  void *data)
375 {
376 	int err = -EIO;
377 	size_t size;
378 	jsmntok_t *tokens, *tok;
379 	int i, j, len;
380 	char *map;
381 	char buf[128];
382 
383 	if (!fn)
384 		return -ENOENT;
385 
386 	tokens = parse_json(fn, &map, &size, &len);
387 	if (!tokens)
388 		return -EIO;
389 	EXPECT(tokens->type == JSMN_ARRAY, tokens, "expected top level array");
390 	tok = tokens + 1;
391 	for (i = 0; i < tokens->size; i++) {
392 		char *event = NULL, *desc = NULL, *name = NULL;
393 		char *long_desc = NULL;
394 		char *extra_desc = NULL;
395 		char *pmu = NULL;
396 		char *filter = NULL;
397 		char *perpkg = NULL;
398 		char *unit = NULL;
399 		char *metric_expr = NULL;
400 		char *metric_name = NULL;
401 		unsigned long long eventcode = 0;
402 		struct msrmap *msr = NULL;
403 		jsmntok_t *msrval = NULL;
404 		jsmntok_t *precise = NULL;
405 		jsmntok_t *obj = tok++;
406 
407 		EXPECT(obj->type == JSMN_OBJECT, obj, "expected object");
408 		for (j = 0; j < obj->size; j += 2) {
409 			jsmntok_t *field, *val;
410 			int nz;
411 			char *s;
412 
413 			field = tok + j;
414 			EXPECT(field->type == JSMN_STRING, tok + j,
415 			       "Expected field name");
416 			val = tok + j + 1;
417 			EXPECT(val->type == JSMN_STRING, tok + j + 1,
418 			       "Expected string value");
419 
420 			nz = !json_streq(map, val, "0");
421 			if (match_field(map, field, nz, &event, val)) {
422 				/* ok */
423 			} else if (json_streq(map, field, "EventCode")) {
424 				char *code = NULL;
425 				addfield(map, &code, "", "", val);
426 				eventcode |= strtoul(code, NULL, 0);
427 				free(code);
428 			} else if (json_streq(map, field, "ExtSel")) {
429 				char *code = NULL;
430 				addfield(map, &code, "", "", val);
431 				eventcode |= strtoul(code, NULL, 0) << 21;
432 				free(code);
433 			} else if (json_streq(map, field, "EventName")) {
434 				addfield(map, &name, "", "", val);
435 			} else if (json_streq(map, field, "BriefDescription")) {
436 				addfield(map, &desc, "", "", val);
437 				fixdesc(desc);
438 			} else if (json_streq(map, field,
439 					     "PublicDescription")) {
440 				addfield(map, &long_desc, "", "", val);
441 				fixdesc(long_desc);
442 			} else if (json_streq(map, field, "PEBS") && nz) {
443 				precise = val;
444 			} else if (json_streq(map, field, "MSRIndex") && nz) {
445 				msr = lookup_msr(map, val);
446 			} else if (json_streq(map, field, "MSRValue")) {
447 				msrval = val;
448 			} else if (json_streq(map, field, "Errata") &&
449 				   !json_streq(map, val, "null")) {
450 				addfield(map, &extra_desc, ". ",
451 					" Spec update: ", val);
452 			} else if (json_streq(map, field, "Data_LA") && nz) {
453 				addfield(map, &extra_desc, ". ",
454 					" Supports address when precise",
455 					NULL);
456 			} else if (json_streq(map, field, "Unit")) {
457 				const char *ppmu;
458 
459 				ppmu = field_to_perf(unit_to_pmu, map, val);
460 				if (ppmu) {
461 					pmu = strdup(ppmu);
462 				} else {
463 					if (!pmu)
464 						pmu = strdup("uncore_");
465 					addfield(map, &pmu, "", "", val);
466 					for (s = pmu; *s; s++)
467 						*s = tolower(*s);
468 				}
469 				addfield(map, &desc, ". ", "Unit: ", NULL);
470 				addfield(map, &desc, "", pmu, NULL);
471 				addfield(map, &desc, "", " ", NULL);
472 			} else if (json_streq(map, field, "Filter")) {
473 				addfield(map, &filter, "", "", val);
474 			} else if (json_streq(map, field, "ScaleUnit")) {
475 				addfield(map, &unit, "", "", val);
476 			} else if (json_streq(map, field, "PerPkg")) {
477 				addfield(map, &perpkg, "", "", val);
478 			} else if (json_streq(map, field, "MetricName")) {
479 				addfield(map, &metric_name, "", "", val);
480 			} else if (json_streq(map, field, "MetricExpr")) {
481 				addfield(map, &metric_expr, "", "", val);
482 				for (s = metric_expr; *s; s++)
483 					*s = tolower(*s);
484 			}
485 			/* ignore unknown fields */
486 		}
487 		if (precise && desc && !strstr(desc, "(Precise Event)")) {
488 			if (json_streq(map, precise, "2"))
489 				addfield(map, &extra_desc, " ",
490 						"(Must be precise)", NULL);
491 			else
492 				addfield(map, &extra_desc, " ",
493 						"(Precise event)", NULL);
494 		}
495 		snprintf(buf, sizeof buf, "event=%#llx", eventcode);
496 		addfield(map, &event, ",", buf, NULL);
497 		if (desc && extra_desc)
498 			addfield(map, &desc, " ", extra_desc, NULL);
499 		if (long_desc && extra_desc)
500 			addfield(map, &long_desc, " ", extra_desc, NULL);
501 		if (filter)
502 			addfield(map, &event, ",", filter, NULL);
503 		if (msr != NULL)
504 			addfield(map, &event, ",", msr->pname, msrval);
505 		fixname(name);
506 
507 		err = func(data, name, real_event(name, event), desc, long_desc,
508 				pmu, unit, perpkg, metric_expr, metric_name);
509 		free(event);
510 		free(desc);
511 		free(name);
512 		free(long_desc);
513 		free(extra_desc);
514 		free(pmu);
515 		free(filter);
516 		free(perpkg);
517 		free(unit);
518 		free(metric_expr);
519 		free(metric_name);
520 		if (err)
521 			break;
522 		tok += j;
523 	}
524 	EXPECT(tok - tokens == len, tok, "unexpected objects at end");
525 	err = 0;
526 out_free:
527 	free_json(map, size, tokens);
528 	return err;
529 }
530 
file_name_to_table_name(char * fname)531 static char *file_name_to_table_name(char *fname)
532 {
533 	unsigned int i;
534 	int n;
535 	int c;
536 	char *tblname;
537 
538 	/*
539 	 * Ensure tablename starts with alphabetic character.
540 	 * Derive rest of table name from basename of the JSON file,
541 	 * replacing hyphens and stripping out .json suffix.
542 	 */
543 	n = asprintf(&tblname, "pme_%s", basename(fname));
544 	if (n < 0) {
545 		pr_info("%s: asprintf() error %s for file %s\n", prog,
546 				strerror(errno), fname);
547 		return NULL;
548 	}
549 
550 	for (i = 0; i < strlen(tblname); i++) {
551 		c = tblname[i];
552 
553 		if (c == '-')
554 			tblname[i] = '_';
555 		else if (c == '.') {
556 			tblname[i] = '\0';
557 			break;
558 		} else if (!isalnum(c) && c != '_') {
559 			pr_err("%s: Invalid character '%c' in file name %s\n",
560 					prog, c, basename(fname));
561 			free(tblname);
562 			tblname = NULL;
563 			break;
564 		}
565 	}
566 
567 	return tblname;
568 }
569 
print_mapping_table_prefix(FILE * outfp)570 static void print_mapping_table_prefix(FILE *outfp)
571 {
572 	fprintf(outfp, "struct pmu_events_map pmu_events_map[] = {\n");
573 }
574 
print_mapping_table_suffix(FILE * outfp)575 static void print_mapping_table_suffix(FILE *outfp)
576 {
577 	/*
578 	 * Print the terminating, NULL entry.
579 	 */
580 	fprintf(outfp, "{\n");
581 	fprintf(outfp, "\t.cpuid = 0,\n");
582 	fprintf(outfp, "\t.version = 0,\n");
583 	fprintf(outfp, "\t.type = 0,\n");
584 	fprintf(outfp, "\t.table = 0,\n");
585 	fprintf(outfp, "},\n");
586 
587 	/* and finally, the closing curly bracket for the struct */
588 	fprintf(outfp, "};\n");
589 }
590 
process_mapfile(FILE * outfp,char * fpath)591 static int process_mapfile(FILE *outfp, char *fpath)
592 {
593 	int n = 16384;
594 	FILE *mapfp;
595 	char *save = NULL;
596 	char *line, *p;
597 	int line_num;
598 	char *tblname;
599 
600 	pr_info("%s: Processing mapfile %s\n", prog, fpath);
601 
602 	line = malloc(n);
603 	if (!line)
604 		return -1;
605 
606 	mapfp = fopen(fpath, "r");
607 	if (!mapfp) {
608 		pr_info("%s: Error %s opening %s\n", prog, strerror(errno),
609 				fpath);
610 		return -1;
611 	}
612 
613 	print_mapping_table_prefix(outfp);
614 
615 	/* Skip first line (header) */
616 	p = fgets(line, n, mapfp);
617 	if (!p)
618 		goto out;
619 
620 	line_num = 1;
621 	while (1) {
622 		char *cpuid, *version, *type, *fname;
623 
624 		line_num++;
625 		p = fgets(line, n, mapfp);
626 		if (!p)
627 			break;
628 
629 		if (line[0] == '#' || line[0] == '\n')
630 			continue;
631 
632 		if (line[strlen(line)-1] != '\n') {
633 			/* TODO Deal with lines longer than 16K */
634 			pr_info("%s: Mapfile %s: line %d too long, aborting\n",
635 					prog, fpath, line_num);
636 			return -1;
637 		}
638 		line[strlen(line)-1] = '\0';
639 
640 		cpuid = strtok_r(p, ",", &save);
641 		version = strtok_r(NULL, ",", &save);
642 		fname = strtok_r(NULL, ",", &save);
643 		type = strtok_r(NULL, ",", &save);
644 
645 		tblname = file_name_to_table_name(fname);
646 		fprintf(outfp, "{\n");
647 		fprintf(outfp, "\t.cpuid = \"%s\",\n", cpuid);
648 		fprintf(outfp, "\t.version = \"%s\",\n", version);
649 		fprintf(outfp, "\t.type = \"%s\",\n", type);
650 
651 		/*
652 		 * CHECK: We can't use the type (eg "core") field in the
653 		 * table name. For us to do that, we need to somehow tweak
654 		 * the other caller of file_name_to_table(), process_json()
655 		 * to determine the type. process_json() file has no way
656 		 * of knowing these are "core" events unless file name has
657 		 * core in it. If filename has core in it, we can safely
658 		 * ignore the type field here also.
659 		 */
660 		fprintf(outfp, "\t.table = %s\n", tblname);
661 		fprintf(outfp, "},\n");
662 	}
663 
664 out:
665 	print_mapping_table_suffix(outfp);
666 	return 0;
667 }
668 
669 /*
670  * If we fail to locate/process JSON and map files, create a NULL mapping
671  * table. This would at least allow perf to build even if we can't find/use
672  * the aliases.
673  */
create_empty_mapping(const char * output_file)674 static void create_empty_mapping(const char *output_file)
675 {
676 	FILE *outfp;
677 
678 	pr_info("%s: Creating empty pmu_events_map[] table\n", prog);
679 
680 	/* Truncate file to clear any partial writes to it */
681 	outfp = fopen(output_file, "w");
682 	if (!outfp) {
683 		perror("fopen()");
684 		_Exit(1);
685 	}
686 
687 	fprintf(outfp, "#include \"../../pmu-events/pmu-events.h\"\n");
688 	print_mapping_table_prefix(outfp);
689 	print_mapping_table_suffix(outfp);
690 	fclose(outfp);
691 }
692 
get_maxfds(void)693 static int get_maxfds(void)
694 {
695 	struct rlimit rlim;
696 
697 	if (getrlimit(RLIMIT_NOFILE, &rlim) == 0)
698 		return min((int)rlim.rlim_max / 2, 512);
699 
700 	return 512;
701 }
702 
703 /*
704  * nftw() doesn't let us pass an argument to the processing function,
705  * so use a global variables.
706  */
707 static FILE *eventsfp;
708 static char *mapfile;
709 
process_one_file(const char * fpath,const struct stat * sb,int typeflag,struct FTW * ftwbuf)710 static int process_one_file(const char *fpath, const struct stat *sb,
711 			    int typeflag, struct FTW *ftwbuf)
712 {
713 	char *tblname, *bname  = (char *) fpath + ftwbuf->base;
714 	int is_dir  = typeflag == FTW_D;
715 	int is_file = typeflag == FTW_F;
716 	int level   = ftwbuf->level;
717 	int err = 0;
718 
719 	pr_debug("%s %d %7jd %-20s %s\n",
720 		 is_file ? "f" : is_dir ? "d" : "x",
721 		 level, sb->st_size, bname, fpath);
722 
723 	/* base dir */
724 	if (level == 0)
725 		return 0;
726 
727 	/* model directory, reset topic */
728 	if (level == 1 && is_dir) {
729 		if (close_table)
730 			print_events_table_suffix(eventsfp);
731 
732 		/*
733 		 * Drop file name suffix. Replace hyphens with underscores.
734 		 * Fail if file name contains any alphanum characters besides
735 		 * underscores.
736 		 */
737 		tblname = file_name_to_table_name(bname);
738 		if (!tblname) {
739 			pr_info("%s: Error determining table name for %s\n", prog,
740 				bname);
741 			return -1;
742 		}
743 
744 		print_events_table_prefix(eventsfp, tblname);
745 		return 0;
746 	}
747 
748 	/*
749 	 * Save the mapfile name for now. We will process mapfile
750 	 * after processing all JSON files (so we can write out the
751 	 * mapping table after all PMU events tables).
752 	 *
753 	 * TODO: Allow for multiple mapfiles? Punt for now.
754 	 */
755 	if (level == 1 && is_file) {
756 		if (!strncmp(bname, "mapfile.csv", 11)) {
757 			if (mapfile) {
758 				pr_info("%s: Many mapfiles? Using %s, ignoring %s\n",
759 						prog, mapfile, fpath);
760 			} else {
761 				mapfile = strdup(fpath);
762 			}
763 			return 0;
764 		}
765 
766 		pr_info("%s: Ignoring file %s\n", prog, fpath);
767 		return 0;
768 	}
769 
770 	/*
771 	 * If the file name does not have a .json extension,
772 	 * ignore it. It could be a readme.txt for instance.
773 	 */
774 	if (is_file) {
775 		char *suffix = bname + strlen(bname) - 5;
776 
777 		if (strncmp(suffix, ".json", 5)) {
778 			pr_info("%s: Ignoring file without .json suffix %s\n", prog,
779 				fpath);
780 			return 0;
781 		}
782 	}
783 
784 	if (level > 1 && add_topic(level, bname))
785 		return -ENOMEM;
786 
787 	/*
788 	 * Assume all other files are JSON files.
789 	 *
790 	 * If mapfile refers to 'power7_core.json', we create a table
791 	 * named 'power7_core'. Any inconsistencies between the mapfile
792 	 * and directory tree could result in build failure due to table
793 	 * names not being found.
794 	 *
795 	 * Atleast for now, be strict with processing JSON file names.
796 	 * i.e. if JSON file name cannot be mapped to C-style table name,
797 	 * fail.
798 	 */
799 	if (is_file) {
800 		struct perf_entry_data data = {
801 			.topic = get_topic(),
802 			.outfp = eventsfp,
803 		};
804 
805 		err = json_events(fpath, print_events_table_entry, &data);
806 
807 		free(data.topic);
808 	}
809 
810 	return err;
811 }
812 
813 #ifndef PATH_MAX
814 #define PATH_MAX	4096
815 #endif
816 
817 /*
818  * Starting in directory 'start_dirname', find the "mapfile.csv" and
819  * the set of JSON files for the architecture 'arch'.
820  *
821  * From each JSON file, create a C-style "PMU events table" from the
822  * JSON file (see struct pmu_event).
823  *
824  * From the mapfile, create a mapping between the CPU revisions and
825  * PMU event tables (see struct pmu_events_map).
826  *
827  * Write out the PMU events tables and the mapping table to pmu-event.c.
828  */
main(int argc,char * argv[])829 int main(int argc, char *argv[])
830 {
831 	int rc;
832 	int maxfds;
833 	char ldirname[PATH_MAX];
834 
835 	const char *arch;
836 	const char *output_file;
837 	const char *start_dirname;
838 	struct stat stbuf;
839 
840 	prog = basename(argv[0]);
841 	if (argc < 4) {
842 		pr_err("Usage: %s <arch> <starting_dir> <output_file>\n", prog);
843 		return 1;
844 	}
845 
846 	arch = argv[1];
847 	start_dirname = argv[2];
848 	output_file = argv[3];
849 
850 	if (argc > 4)
851 		verbose = atoi(argv[4]);
852 
853 	eventsfp = fopen(output_file, "w");
854 	if (!eventsfp) {
855 		pr_err("%s Unable to create required file %s (%s)\n",
856 				prog, output_file, strerror(errno));
857 		return 2;
858 	}
859 
860 	sprintf(ldirname, "%s/%s", start_dirname, arch);
861 
862 	/* If architecture does not have any event lists, bail out */
863 	if (stat(ldirname, &stbuf) < 0) {
864 		pr_info("%s: Arch %s has no PMU event lists\n", prog, arch);
865 		goto empty_map;
866 	}
867 
868 	/* Include pmu-events.h first */
869 	fprintf(eventsfp, "#include \"../../pmu-events/pmu-events.h\"\n");
870 
871 	/*
872 	 * The mapfile allows multiple CPUids to point to the same JSON file,
873 	 * so, not sure if there is a need for symlinks within the pmu-events
874 	 * directory.
875 	 *
876 	 * For now, treat symlinks of JSON files as regular files and create
877 	 * separate tables for each symlink (presumably, each symlink refers
878 	 * to specific version of the CPU).
879 	 */
880 
881 	maxfds = get_maxfds();
882 	mapfile = NULL;
883 	rc = nftw(ldirname, process_one_file, maxfds, 0);
884 	if (rc && verbose) {
885 		pr_info("%s: Error walking file tree %s\n", prog, ldirname);
886 		goto empty_map;
887 	} else if (rc < 0) {
888 		/* Make build fail */
889 		return 1;
890 	} else if (rc) {
891 		goto empty_map;
892 	}
893 
894 	if (close_table)
895 		print_events_table_suffix(eventsfp);
896 
897 	if (!mapfile) {
898 		pr_info("%s: No CPU->JSON mapping?\n", prog);
899 		goto empty_map;
900 	}
901 
902 	if (process_mapfile(eventsfp, mapfile)) {
903 		pr_info("%s: Error processing mapfile %s\n", prog, mapfile);
904 		/* Make build fail */
905 		return 1;
906 	}
907 
908 	return 0;
909 
910 empty_map:
911 	fclose(eventsfp);
912 	create_empty_mapping(output_file);
913 	return 0;
914 }
915