blob: c6b16b1db6d053aa07c067cab6dcaeebc39c3686 [file] [log] [blame]
Jiri Olsacd82a322012-03-15 20:09:17 +01001#include <linux/list.h>
Sukadev Bhattiproluc5de47f2015-06-10 00:25:07 -07002#include <linux/compiler.h>
Jiri Olsacd82a322012-03-15 20:09:17 +01003#include <sys/types.h>
Jiri Olsacd82a322012-03-15 20:09:17 +01004#include <unistd.h>
5#include <stdio.h>
Adrian Hunterdc0a6202014-07-31 09:00:49 +03006#include <stdbool.h>
Adrian Hunter7d4bdab2014-07-31 09:00:50 +03007#include <stdarg.h>
Jiri Olsacd82a322012-03-15 20:09:17 +01008#include <dirent.h>
Borislav Petkovcd0cfad2013-12-09 17:14:24 +01009#include <api/fs/fs.h>
Stephane Eranian410136f2013-11-12 17:58:49 +010010#include <locale.h>
Jiri Olsacd82a322012-03-15 20:09:17 +010011#include "util.h"
12#include "pmu.h"
13#include "parse-events.h"
Yan, Zheng7ae92e72012-09-10 15:53:50 +080014#include "cpumap.h"
Jiri Olsacd82a322012-03-15 20:09:17 +010015
Arnaldo Carvalho de Meloab1bf6532013-01-18 17:05:09 -030016struct perf_pmu_format {
17 char *name;
18 int value;
19 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
20 struct list_head list;
21};
22
Robert Richter50a96672012-08-16 21:10:24 +020023#define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/"
24
Jiri Olsacd82a322012-03-15 20:09:17 +010025int perf_pmu_parse(struct list_head *list, char *name);
26extern FILE *perf_pmu_in;
27
28static LIST_HEAD(pmus);
29
30/*
31 * Parse & process all the sysfs attributes located under
32 * the directory specified in 'dir' parameter.
33 */
Jiri Olsacff7f952012-11-10 01:46:50 +010034int perf_pmu__format_parse(char *dir, struct list_head *head)
Jiri Olsacd82a322012-03-15 20:09:17 +010035{
36 struct dirent *evt_ent;
37 DIR *format_dir;
38 int ret = 0;
39
40 format_dir = opendir(dir);
41 if (!format_dir)
42 return -EINVAL;
43
44 while (!ret && (evt_ent = readdir(format_dir))) {
45 char path[PATH_MAX];
46 char *name = evt_ent->d_name;
47 FILE *file;
48
49 if (!strcmp(name, ".") || !strcmp(name, ".."))
50 continue;
51
52 snprintf(path, PATH_MAX, "%s/%s", dir, name);
53
54 ret = -EINVAL;
55 file = fopen(path, "r");
56 if (!file)
57 break;
58
59 perf_pmu_in = file;
60 ret = perf_pmu_parse(head, name);
61 fclose(file);
62 }
63
64 closedir(format_dir);
65 return ret;
66}
67
68/*
69 * Reading/parsing the default pmu format definition, which should be
70 * located at:
71 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
72 */
Adrian Hunterb6b96fb2013-07-04 16:20:25 +030073static int pmu_format(const char *name, struct list_head *format)
Jiri Olsacd82a322012-03-15 20:09:17 +010074{
75 struct stat st;
76 char path[PATH_MAX];
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -030077 const char *sysfs = sysfs__mountpoint();
Jiri Olsacd82a322012-03-15 20:09:17 +010078
Jiri Olsacd82a322012-03-15 20:09:17 +010079 if (!sysfs)
80 return -1;
81
82 snprintf(path, PATH_MAX,
Robert Richter50a96672012-08-16 21:10:24 +020083 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
Jiri Olsacd82a322012-03-15 20:09:17 +010084
85 if (stat(path, &st) < 0)
Robert Richter9bc8f9f2012-06-14 22:38:37 +020086 return 0; /* no error if format does not exist */
Jiri Olsacd82a322012-03-15 20:09:17 +010087
Jiri Olsacff7f952012-11-10 01:46:50 +010088 if (perf_pmu__format_parse(path, format))
Jiri Olsacd82a322012-03-15 20:09:17 +010089 return -1;
90
91 return 0;
92}
93
Stephane Eranian410136f2013-11-12 17:58:49 +010094static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
95{
96 struct stat st;
97 ssize_t sret;
98 char scale[128];
99 int fd, ret = -1;
100 char path[PATH_MAX];
Stephane Eranian8a398892014-01-17 16:34:05 +0100101 const char *lc;
Stephane Eranian410136f2013-11-12 17:58:49 +0100102
103 snprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
104
105 fd = open(path, O_RDONLY);
106 if (fd == -1)
107 return -1;
108
109 if (fstat(fd, &st) < 0)
110 goto error;
111
112 sret = read(fd, scale, sizeof(scale)-1);
113 if (sret < 0)
114 goto error;
115
Madhavan Srinivasan9ecae062015-05-31 11:36:23 +0530116 if (scale[sret - 1] == '\n')
117 scale[sret - 1] = '\0';
118 else
119 scale[sret] = '\0';
120
Stephane Eranian410136f2013-11-12 17:58:49 +0100121 /*
122 * save current locale
123 */
124 lc = setlocale(LC_NUMERIC, NULL);
125
126 /*
127 * force to C locale to ensure kernel
128 * scale string is converted correctly.
129 * kernel uses default C locale.
130 */
131 setlocale(LC_NUMERIC, "C");
132
133 alias->scale = strtod(scale, NULL);
134
135 /* restore locale */
136 setlocale(LC_NUMERIC, lc);
137
138 ret = 0;
139error:
140 close(fd);
141 return ret;
142}
143
144static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
145{
146 char path[PATH_MAX];
147 ssize_t sret;
148 int fd;
149
150 snprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
151
152 fd = open(path, O_RDONLY);
153 if (fd == -1)
154 return -1;
155
156 sret = read(fd, alias->unit, UNIT_MAX_LEN);
157 if (sret < 0)
158 goto error;
159
160 close(fd);
161
Madhavan Srinivasan9ecae062015-05-31 11:36:23 +0530162 if (alias->unit[sret - 1] == '\n')
163 alias->unit[sret - 1] = '\0';
164 else
165 alias->unit[sret] = '\0';
Stephane Eranian410136f2013-11-12 17:58:49 +0100166
167 return 0;
168error:
169 close(fd);
170 alias->unit[0] = '\0';
171 return -1;
172}
173
Matt Fleming044330c2014-11-21 10:31:12 +0100174static int
175perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
176{
177 char path[PATH_MAX];
178 int fd;
179
180 snprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
181
182 fd = open(path, O_RDONLY);
183 if (fd == -1)
184 return -1;
185
186 close(fd);
187
188 alias->per_pkg = true;
189 return 0;
190}
191
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100192static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
193 char *dir, char *name)
194{
195 char path[PATH_MAX];
196 int fd;
197
198 snprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
199
200 fd = open(path, O_RDONLY);
201 if (fd == -1)
202 return -1;
203
204 alias->snapshot = true;
205 close(fd);
206 return 0;
207}
208
Stephane Eranian410136f2013-11-12 17:58:49 +0100209static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
Zheng Yana6146d52012-06-15 14:31:41 +0800210{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300211 struct perf_pmu_alias *alias;
Zheng Yana6146d52012-06-15 14:31:41 +0800212 char buf[256];
213 int ret;
214
215 ret = fread(buf, 1, sizeof(buf), file);
216 if (ret == 0)
217 return -EINVAL;
218 buf[ret] = 0;
219
220 alias = malloc(sizeof(*alias));
221 if (!alias)
222 return -ENOMEM;
223
224 INIT_LIST_HEAD(&alias->terms);
Stephane Eranian410136f2013-11-12 17:58:49 +0100225 alias->scale = 1.0;
226 alias->unit[0] = '\0';
Matt Fleming044330c2014-11-21 10:31:12 +0100227 alias->per_pkg = false;
Stephane Eranian410136f2013-11-12 17:58:49 +0100228
Zheng Yana6146d52012-06-15 14:31:41 +0800229 ret = parse_events_terms(&alias->terms, buf);
230 if (ret) {
231 free(alias);
232 return ret;
233 }
234
235 alias->name = strdup(name);
Stephane Eranian410136f2013-11-12 17:58:49 +0100236 /*
237 * load unit name and scale if available
238 */
239 perf_pmu__parse_unit(alias, dir, name);
240 perf_pmu__parse_scale(alias, dir, name);
Matt Fleming044330c2014-11-21 10:31:12 +0100241 perf_pmu__parse_per_pkg(alias, dir, name);
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100242 perf_pmu__parse_snapshot(alias, dir, name);
Stephane Eranian410136f2013-11-12 17:58:49 +0100243
Zheng Yana6146d52012-06-15 14:31:41 +0800244 list_add_tail(&alias->list, list);
Stephane Eranian410136f2013-11-12 17:58:49 +0100245
Zheng Yana6146d52012-06-15 14:31:41 +0800246 return 0;
247}
248
Matt Fleming46441bd2014-09-24 15:04:06 +0100249static inline bool pmu_alias_info_file(char *name)
250{
251 size_t len;
252
253 len = strlen(name);
254 if (len > 5 && !strcmp(name + len - 5, ".unit"))
255 return true;
256 if (len > 6 && !strcmp(name + len - 6, ".scale"))
257 return true;
Matt Fleming044330c2014-11-21 10:31:12 +0100258 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
259 return true;
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100260 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
261 return true;
Matt Fleming46441bd2014-09-24 15:04:06 +0100262
263 return false;
264}
265
Zheng Yana6146d52012-06-15 14:31:41 +0800266/*
267 * Process all the sysfs attributes located under the directory
268 * specified in 'dir' parameter.
269 */
270static int pmu_aliases_parse(char *dir, struct list_head *head)
271{
272 struct dirent *evt_ent;
273 DIR *event_dir;
274 int ret = 0;
275
276 event_dir = opendir(dir);
277 if (!event_dir)
278 return -EINVAL;
279
280 while (!ret && (evt_ent = readdir(event_dir))) {
281 char path[PATH_MAX];
282 char *name = evt_ent->d_name;
283 FILE *file;
284
285 if (!strcmp(name, ".") || !strcmp(name, ".."))
286 continue;
287
Stephane Eranian410136f2013-11-12 17:58:49 +0100288 /*
Matt Fleming46441bd2014-09-24 15:04:06 +0100289 * skip info files parsed in perf_pmu__new_alias()
Stephane Eranian410136f2013-11-12 17:58:49 +0100290 */
Matt Fleming46441bd2014-09-24 15:04:06 +0100291 if (pmu_alias_info_file(name))
Stephane Eranian410136f2013-11-12 17:58:49 +0100292 continue;
293
Zheng Yana6146d52012-06-15 14:31:41 +0800294 snprintf(path, PATH_MAX, "%s/%s", dir, name);
295
296 ret = -EINVAL;
297 file = fopen(path, "r");
298 if (!file)
299 break;
Stephane Eranian410136f2013-11-12 17:58:49 +0100300
301 ret = perf_pmu__new_alias(head, dir, name, file);
Zheng Yana6146d52012-06-15 14:31:41 +0800302 fclose(file);
303 }
304
305 closedir(event_dir);
306 return ret;
307}
308
309/*
310 * Reading the pmu event aliases definition, which should be located at:
311 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
312 */
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300313static int pmu_aliases(const char *name, struct list_head *head)
Zheng Yana6146d52012-06-15 14:31:41 +0800314{
315 struct stat st;
316 char path[PATH_MAX];
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300317 const char *sysfs = sysfs__mountpoint();
Zheng Yana6146d52012-06-15 14:31:41 +0800318
Zheng Yana6146d52012-06-15 14:31:41 +0800319 if (!sysfs)
320 return -1;
321
322 snprintf(path, PATH_MAX,
323 "%s/bus/event_source/devices/%s/events", sysfs, name);
324
325 if (stat(path, &st) < 0)
Jiri Olsa3fded962012-10-10 14:53:16 +0200326 return 0; /* no error if 'events' does not exist */
Zheng Yana6146d52012-06-15 14:31:41 +0800327
328 if (pmu_aliases_parse(path, head))
329 return -1;
330
331 return 0;
332}
333
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300334static int pmu_alias_terms(struct perf_pmu_alias *alias,
Zheng Yana6146d52012-06-15 14:31:41 +0800335 struct list_head *terms)
336{
Jiri Olsa7c2f8162014-04-16 20:49:02 +0200337 struct parse_events_term *term, *cloned;
Zheng Yana6146d52012-06-15 14:31:41 +0800338 LIST_HEAD(list);
339 int ret;
340
341 list_for_each_entry(term, &alias->terms, list) {
Jiri Olsa7c2f8162014-04-16 20:49:02 +0200342 ret = parse_events_term__clone(&cloned, term);
Zheng Yana6146d52012-06-15 14:31:41 +0800343 if (ret) {
344 parse_events__free_terms(&list);
345 return ret;
346 }
Jiri Olsa7c2f8162014-04-16 20:49:02 +0200347 list_add_tail(&cloned->list, &list);
Zheng Yana6146d52012-06-15 14:31:41 +0800348 }
349 list_splice(&list, terms);
350 return 0;
351}
352
Jiri Olsacd82a322012-03-15 20:09:17 +0100353/*
354 * Reading/parsing the default pmu type value, which should be
355 * located at:
356 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
357 */
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300358static int pmu_type(const char *name, __u32 *type)
Jiri Olsacd82a322012-03-15 20:09:17 +0100359{
360 struct stat st;
361 char path[PATH_MAX];
Jiri Olsacd82a322012-03-15 20:09:17 +0100362 FILE *file;
363 int ret = 0;
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300364 const char *sysfs = sysfs__mountpoint();
Jiri Olsacd82a322012-03-15 20:09:17 +0100365
Jiri Olsacd82a322012-03-15 20:09:17 +0100366 if (!sysfs)
367 return -1;
368
369 snprintf(path, PATH_MAX,
Robert Richter50a96672012-08-16 21:10:24 +0200370 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
Jiri Olsacd82a322012-03-15 20:09:17 +0100371
372 if (stat(path, &st) < 0)
373 return -1;
374
375 file = fopen(path, "r");
376 if (!file)
377 return -EINVAL;
378
379 if (1 != fscanf(file, "%u", type))
380 ret = -1;
381
382 fclose(file);
383 return ret;
384}
385
Robert Richter50a96672012-08-16 21:10:24 +0200386/* Add all pmus in sysfs to pmu list: */
387static void pmu_read_sysfs(void)
388{
389 char path[PATH_MAX];
Robert Richter50a96672012-08-16 21:10:24 +0200390 DIR *dir;
391 struct dirent *dent;
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300392 const char *sysfs = sysfs__mountpoint();
Robert Richter50a96672012-08-16 21:10:24 +0200393
Robert Richter50a96672012-08-16 21:10:24 +0200394 if (!sysfs)
395 return;
396
397 snprintf(path, PATH_MAX,
398 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
399
400 dir = opendir(path);
401 if (!dir)
402 return;
403
404 while ((dent = readdir(dir))) {
405 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
406 continue;
407 /* add to static LIST_HEAD(pmus): */
408 perf_pmu__find(dent->d_name);
409 }
410
411 closedir(dir);
412}
413
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300414static struct cpu_map *pmu_cpumask(const char *name)
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800415{
416 struct stat st;
417 char path[PATH_MAX];
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800418 FILE *file;
419 struct cpu_map *cpus;
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300420 const char *sysfs = sysfs__mountpoint();
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800421
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800422 if (!sysfs)
423 return NULL;
424
425 snprintf(path, PATH_MAX,
426 "%s/bus/event_source/devices/%s/cpumask", sysfs, name);
427
428 if (stat(path, &st) < 0)
429 return NULL;
430
431 file = fopen(path, "r");
432 if (!file)
433 return NULL;
434
435 cpus = cpu_map__read(file);
436 fclose(file);
437 return cpus;
438}
439
Sukadev Bhattiproluc5de47f2015-06-10 00:25:07 -0700440struct perf_event_attr * __weak
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300441perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
442{
443 return NULL;
444}
445
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300446static struct perf_pmu *pmu_lookup(const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +0100447{
448 struct perf_pmu *pmu;
449 LIST_HEAD(format);
Zheng Yana6146d52012-06-15 14:31:41 +0800450 LIST_HEAD(aliases);
Jiri Olsacd82a322012-03-15 20:09:17 +0100451 __u32 type;
452
Adrian Hunter9b5d1c22015-05-22 14:53:58 +0300453 /* No support for intel_bts or intel_pt so disallow them */
454 if (!strcmp(name, "intel_bts") || !strcmp(name, "intel_pt"))
455 return NULL;
456
Jiri Olsacd82a322012-03-15 20:09:17 +0100457 /*
458 * The pmu data we store & need consists of the pmu
459 * type value and format definitions. Load both right
460 * now.
461 */
462 if (pmu_format(name, &format))
463 return NULL;
464
Jiri Olsa3fded962012-10-10 14:53:16 +0200465 if (pmu_aliases(name, &aliases))
466 return NULL;
467
Jiri Olsacd82a322012-03-15 20:09:17 +0100468 if (pmu_type(name, &type))
469 return NULL;
470
471 pmu = zalloc(sizeof(*pmu));
472 if (!pmu)
473 return NULL;
474
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800475 pmu->cpus = pmu_cpumask(name);
476
Jiri Olsacd82a322012-03-15 20:09:17 +0100477 INIT_LIST_HEAD(&pmu->format);
Zheng Yana6146d52012-06-15 14:31:41 +0800478 INIT_LIST_HEAD(&pmu->aliases);
Jiri Olsacd82a322012-03-15 20:09:17 +0100479 list_splice(&format, &pmu->format);
Zheng Yana6146d52012-06-15 14:31:41 +0800480 list_splice(&aliases, &pmu->aliases);
Jiri Olsacd82a322012-03-15 20:09:17 +0100481 pmu->name = strdup(name);
482 pmu->type = type;
Robert Richter9bc8f9f2012-06-14 22:38:37 +0200483 list_add_tail(&pmu->list, &pmus);
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300484
485 pmu->default_config = perf_pmu__get_default_config(pmu);
486
Jiri Olsacd82a322012-03-15 20:09:17 +0100487 return pmu;
488}
489
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300490static struct perf_pmu *pmu_find(const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +0100491{
492 struct perf_pmu *pmu;
493
494 list_for_each_entry(pmu, &pmus, list)
495 if (!strcmp(pmu->name, name))
496 return pmu;
497
498 return NULL;
499}
500
Robert Richter50a96672012-08-16 21:10:24 +0200501struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
502{
503 /*
504 * pmu iterator: If pmu is NULL, we start at the begin,
505 * otherwise return the next pmu. Returns NULL on end.
506 */
507 if (!pmu) {
508 pmu_read_sysfs();
509 pmu = list_prepare_entry(pmu, &pmus, list);
510 }
511 list_for_each_entry_continue(pmu, &pmus, list)
512 return pmu;
513 return NULL;
514}
515
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300516struct perf_pmu *perf_pmu__find(const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +0100517{
518 struct perf_pmu *pmu;
519
520 /*
521 * Once PMU is loaded it stays in the list,
522 * so we keep us from multiple reading/parsing
523 * the pmu format definitions.
524 */
525 pmu = pmu_find(name);
526 if (pmu)
527 return pmu;
528
529 return pmu_lookup(name);
530}
531
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300532static struct perf_pmu_format *
Jiri Olsacd82a322012-03-15 20:09:17 +0100533pmu_find_format(struct list_head *formats, char *name)
534{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300535 struct perf_pmu_format *format;
Jiri Olsacd82a322012-03-15 20:09:17 +0100536
537 list_for_each_entry(format, formats, list)
538 if (!strcmp(format->name, name))
539 return format;
540
541 return NULL;
542}
543
544/*
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300545 * Sets value based on the format definition (format parameter)
Jiri Olsacd82a322012-03-15 20:09:17 +0100546 * and unformated value (value parameter).
Jiri Olsacd82a322012-03-15 20:09:17 +0100547 */
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300548static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
549 bool zero)
Jiri Olsacd82a322012-03-15 20:09:17 +0100550{
551 unsigned long fbit, vbit;
Jiri Olsacd82a322012-03-15 20:09:17 +0100552
553 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
554
555 if (!test_bit(fbit, format))
556 continue;
557
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300558 if (value & (1llu << vbit++))
559 *v |= (1llu << fbit);
560 else if (zero)
561 *v &= ~(1llu << fbit);
Jiri Olsacd82a322012-03-15 20:09:17 +0100562 }
Jiri Olsacd82a322012-03-15 20:09:17 +0100563}
564
565/*
Cody P Schafer688d4df2015-01-07 17:13:50 -0800566 * Term is a string term, and might be a param-term. Try to look up it's value
567 * in the remaining terms.
568 * - We have a term like "base-or-format-term=param-term",
569 * - We need to find the value supplied for "param-term" (with param-term named
570 * in a config string) later on in the term list.
571 */
572static int pmu_resolve_param_term(struct parse_events_term *term,
573 struct list_head *head_terms,
574 __u64 *value)
575{
576 struct parse_events_term *t;
577
578 list_for_each_entry(t, head_terms, list) {
579 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
580 if (!strcmp(t->config, term->config)) {
581 t->used = true;
582 *value = t->val.num;
583 return 0;
584 }
585 }
586 }
587
588 if (verbose)
589 printf("Required parameter '%s' not specified\n", term->config);
590
591 return -1;
592}
593
Jiri Olsae64b0202015-04-22 21:10:21 +0200594static char *formats_error_string(struct list_head *formats)
595{
596 struct perf_pmu_format *format;
597 char *err, *str;
598 static const char *static_terms = "config,config1,config2,name,period,branch_type\n";
599 unsigned i = 0;
600
601 if (!asprintf(&str, "valid terms:"))
602 return NULL;
603
604 /* sysfs exported terms */
605 list_for_each_entry(format, formats, list) {
606 char c = i++ ? ',' : ' ';
607
608 err = str;
609 if (!asprintf(&str, "%s%c%s", err, c, format->name))
610 goto fail;
611 free(err);
612 }
613
614 /* static terms */
615 err = str;
616 if (!asprintf(&str, "%s,%s", err, static_terms))
617 goto fail;
618
619 free(err);
620 return str;
621fail:
622 free(err);
623 return NULL;
624}
625
Cody P Schafer688d4df2015-01-07 17:13:50 -0800626/*
Jiri Olsacd82a322012-03-15 20:09:17 +0100627 * Setup one of config[12] attr members based on the
Cody P Schafer88aca8d2014-01-08 08:43:51 -0800628 * user input data - term parameter.
Jiri Olsacd82a322012-03-15 20:09:17 +0100629 */
630static int pmu_config_term(struct list_head *formats,
631 struct perf_event_attr *attr,
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300632 struct parse_events_term *term,
Cody P Schafer688d4df2015-01-07 17:13:50 -0800633 struct list_head *head_terms,
Jiri Olsae64b0202015-04-22 21:10:21 +0200634 bool zero, struct parse_events_error *err)
Jiri Olsacd82a322012-03-15 20:09:17 +0100635{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300636 struct perf_pmu_format *format;
Jiri Olsacd82a322012-03-15 20:09:17 +0100637 __u64 *vp;
Cody P Schafer688d4df2015-01-07 17:13:50 -0800638 __u64 val;
Jiri Olsacd82a322012-03-15 20:09:17 +0100639
640 /*
Cody P Schafer688d4df2015-01-07 17:13:50 -0800641 * If this is a parameter we've already used for parameterized-eval,
642 * skip it in normal eval.
643 */
644 if (term->used)
645 return 0;
646
647 /*
Jiri Olsacd82a322012-03-15 20:09:17 +0100648 * Hardcoded terms should be already in, so nothing
649 * to be done for them.
650 */
651 if (parse_events__is_hardcoded_term(term))
652 return 0;
653
Jiri Olsacd82a322012-03-15 20:09:17 +0100654 format = pmu_find_format(formats, term->config);
Cody P Schafer688d4df2015-01-07 17:13:50 -0800655 if (!format) {
656 if (verbose)
657 printf("Invalid event/parameter '%s'\n", term->config);
Jiri Olsae64b0202015-04-22 21:10:21 +0200658 if (err) {
659 err->idx = term->err_term;
660 err->str = strdup("unknown term");
661 err->help = formats_error_string(formats);
662 }
Jiri Olsacd82a322012-03-15 20:09:17 +0100663 return -EINVAL;
Cody P Schafer688d4df2015-01-07 17:13:50 -0800664 }
Jiri Olsacd82a322012-03-15 20:09:17 +0100665
666 switch (format->value) {
667 case PERF_PMU_FORMAT_VALUE_CONFIG:
668 vp = &attr->config;
669 break;
670 case PERF_PMU_FORMAT_VALUE_CONFIG1:
671 vp = &attr->config1;
672 break;
673 case PERF_PMU_FORMAT_VALUE_CONFIG2:
674 vp = &attr->config2;
675 break;
676 default:
677 return -EINVAL;
678 }
679
Jiri Olsa16fa7e82012-04-25 18:24:57 +0200680 /*
Cody P Schafer688d4df2015-01-07 17:13:50 -0800681 * Either directly use a numeric term, or try to translate string terms
682 * using event parameters.
Jiri Olsa16fa7e82012-04-25 18:24:57 +0200683 */
Cody P Schafer688d4df2015-01-07 17:13:50 -0800684 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
685 val = term->val.num;
686 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
687 if (strcmp(term->val.str, "?")) {
Jiri Olsae64b0202015-04-22 21:10:21 +0200688 if (verbose) {
Cody P Schafer688d4df2015-01-07 17:13:50 -0800689 pr_info("Invalid sysfs entry %s=%s\n",
690 term->config, term->val.str);
Jiri Olsae64b0202015-04-22 21:10:21 +0200691 }
692 if (err) {
693 err->idx = term->err_val;
694 err->str = strdup("expected numeric value");
695 }
Cody P Schafer688d4df2015-01-07 17:13:50 -0800696 return -EINVAL;
697 }
698
699 if (pmu_resolve_param_term(term, head_terms, &val))
700 return -EINVAL;
701 } else
702 return -EINVAL;
703
704 pmu_format_value(format->bits, val, vp, zero);
Jiri Olsacd82a322012-03-15 20:09:17 +0100705 return 0;
706}
707
Jiri Olsacff7f952012-11-10 01:46:50 +0100708int perf_pmu__config_terms(struct list_head *formats,
709 struct perf_event_attr *attr,
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300710 struct list_head *head_terms,
Jiri Olsae64b0202015-04-22 21:10:21 +0200711 bool zero, struct parse_events_error *err)
Jiri Olsacd82a322012-03-15 20:09:17 +0100712{
Arnaldo Carvalho de Melo6cee6cd2013-01-18 16:29:49 -0300713 struct parse_events_term *term;
Jiri Olsacd82a322012-03-15 20:09:17 +0100714
Cody P Schafer688d4df2015-01-07 17:13:50 -0800715 list_for_each_entry(term, head_terms, list) {
Jiri Olsae64b0202015-04-22 21:10:21 +0200716 if (pmu_config_term(formats, attr, term, head_terms,
717 zero, err))
Jiri Olsacd82a322012-03-15 20:09:17 +0100718 return -EINVAL;
Cody P Schafer688d4df2015-01-07 17:13:50 -0800719 }
Jiri Olsacd82a322012-03-15 20:09:17 +0100720
721 return 0;
722}
723
724/*
725 * Configures event's 'attr' parameter based on the:
726 * 1) users input - specified in terms parameter
727 * 2) pmu format definitions - specified by pmu parameter
728 */
729int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
Jiri Olsae64b0202015-04-22 21:10:21 +0200730 struct list_head *head_terms,
731 struct parse_events_error *err)
Jiri Olsacd82a322012-03-15 20:09:17 +0100732{
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300733 bool zero = !!pmu->default_config;
734
Jiri Olsacd82a322012-03-15 20:09:17 +0100735 attr->type = pmu->type;
Jiri Olsae64b0202015-04-22 21:10:21 +0200736 return perf_pmu__config_terms(&pmu->format, attr, head_terms,
737 zero, err);
Jiri Olsacd82a322012-03-15 20:09:17 +0100738}
739
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300740static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
741 struct parse_events_term *term)
Zheng Yana6146d52012-06-15 14:31:41 +0800742{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300743 struct perf_pmu_alias *alias;
Zheng Yana6146d52012-06-15 14:31:41 +0800744 char *name;
745
746 if (parse_events__is_hardcoded_term(term))
747 return NULL;
748
749 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
750 if (term->val.num != 1)
751 return NULL;
752 if (pmu_find_format(&pmu->format, term->config))
753 return NULL;
754 name = term->config;
755 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
756 if (strcasecmp(term->config, "event"))
757 return NULL;
758 name = term->val.str;
759 } else {
760 return NULL;
761 }
762
763 list_for_each_entry(alias, &pmu->aliases, list) {
764 if (!strcasecmp(alias->name, name))
765 return alias;
766 }
767 return NULL;
768}
769
Stephane Eranian410136f2013-11-12 17:58:49 +0100770
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100771static int check_info_data(struct perf_pmu_alias *alias,
772 struct perf_pmu_info *info)
Stephane Eranian410136f2013-11-12 17:58:49 +0100773{
774 /*
775 * Only one term in event definition can
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100776 * define unit, scale and snapshot, fail
777 * if there's more than one.
Stephane Eranian410136f2013-11-12 17:58:49 +0100778 */
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100779 if ((info->unit && alias->unit) ||
780 (info->scale && alias->scale) ||
781 (info->snapshot && alias->snapshot))
Stephane Eranian410136f2013-11-12 17:58:49 +0100782 return -EINVAL;
783
784 if (alias->unit)
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100785 info->unit = alias->unit;
Stephane Eranian410136f2013-11-12 17:58:49 +0100786
787 if (alias->scale)
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100788 info->scale = alias->scale;
789
790 if (alias->snapshot)
791 info->snapshot = alias->snapshot;
Stephane Eranian410136f2013-11-12 17:58:49 +0100792
793 return 0;
794}
795
Zheng Yana6146d52012-06-15 14:31:41 +0800796/*
797 * Find alias in the terms list and replace it with the terms
798 * defined for the alias
799 */
Stephane Eranian410136f2013-11-12 17:58:49 +0100800int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
Matt Fleming46441bd2014-09-24 15:04:06 +0100801 struct perf_pmu_info *info)
Zheng Yana6146d52012-06-15 14:31:41 +0800802{
Arnaldo Carvalho de Melo6cee6cd2013-01-18 16:29:49 -0300803 struct parse_events_term *term, *h;
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300804 struct perf_pmu_alias *alias;
Zheng Yana6146d52012-06-15 14:31:41 +0800805 int ret;
806
Matt Fleming044330c2014-11-21 10:31:12 +0100807 info->per_pkg = false;
808
Stephane Eranian8a398892014-01-17 16:34:05 +0100809 /*
810 * Mark unit and scale as not set
811 * (different from default values, see below)
812 */
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100813 info->unit = NULL;
814 info->scale = 0.0;
815 info->snapshot = false;
Stephane Eranian410136f2013-11-12 17:58:49 +0100816
Zheng Yana6146d52012-06-15 14:31:41 +0800817 list_for_each_entry_safe(term, h, head_terms, list) {
818 alias = pmu_find_alias(pmu, term);
819 if (!alias)
820 continue;
821 ret = pmu_alias_terms(alias, &term->list);
822 if (ret)
823 return ret;
Stephane Eranian410136f2013-11-12 17:58:49 +0100824
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100825 ret = check_info_data(alias, info);
Stephane Eranian410136f2013-11-12 17:58:49 +0100826 if (ret)
827 return ret;
828
Matt Fleming044330c2014-11-21 10:31:12 +0100829 if (alias->per_pkg)
830 info->per_pkg = true;
831
Zheng Yana6146d52012-06-15 14:31:41 +0800832 list_del(&term->list);
833 free(term);
834 }
Stephane Eranian8a398892014-01-17 16:34:05 +0100835
836 /*
837 * if no unit or scale foundin aliases, then
838 * set defaults as for evsel
839 * unit cannot left to NULL
840 */
Matt Fleming46441bd2014-09-24 15:04:06 +0100841 if (info->unit == NULL)
842 info->unit = "";
Stephane Eranian8a398892014-01-17 16:34:05 +0100843
Matt Fleming46441bd2014-09-24 15:04:06 +0100844 if (info->scale == 0.0)
845 info->scale = 1.0;
Stephane Eranian8a398892014-01-17 16:34:05 +0100846
Zheng Yana6146d52012-06-15 14:31:41 +0800847 return 0;
848}
849
Jiri Olsacd82a322012-03-15 20:09:17 +0100850int perf_pmu__new_format(struct list_head *list, char *name,
851 int config, unsigned long *bits)
852{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300853 struct perf_pmu_format *format;
Jiri Olsacd82a322012-03-15 20:09:17 +0100854
855 format = zalloc(sizeof(*format));
856 if (!format)
857 return -ENOMEM;
858
859 format->name = strdup(name);
860 format->value = config;
861 memcpy(format->bits, bits, sizeof(format->bits));
862
863 list_add_tail(&format->list, list);
864 return 0;
865}
866
867void perf_pmu__set_format(unsigned long *bits, long from, long to)
868{
869 long b;
870
871 if (!to)
872 to = from;
873
Sukadev Bhattiprolu15268132013-01-17 09:11:30 -0800874 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
Jiri Olsacd82a322012-03-15 20:09:17 +0100875 for (b = from; b <= to; b++)
876 set_bit(b, bits);
877}
Andi Kleendc098b32013-04-20 11:02:29 -0700878
Cody P Schaferaaea3612015-01-07 17:13:51 -0800879static int sub_non_neg(int a, int b)
880{
881 if (b > a)
882 return 0;
883 return a - b;
884}
885
Andi Kleendc098b32013-04-20 11:02:29 -0700886static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
887 struct perf_pmu_alias *alias)
888{
Cody P Schaferaaea3612015-01-07 17:13:51 -0800889 struct parse_events_term *term;
890 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
891
892 list_for_each_entry(term, &alias->terms, list) {
893 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
894 used += snprintf(buf + used, sub_non_neg(len, used),
895 ",%s=%s", term->config,
896 term->val.str);
897 }
898
899 if (sub_non_neg(len, used) > 0) {
900 buf[used] = '/';
901 used++;
902 }
903 if (sub_non_neg(len, used) > 0) {
904 buf[used] = '\0';
905 used++;
906 } else
907 buf[len - 1] = '\0';
908
Andi Kleendc098b32013-04-20 11:02:29 -0700909 return buf;
910}
911
912static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
913 struct perf_pmu_alias *alias)
914{
915 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
916 return buf;
917}
918
919static int cmp_string(const void *a, const void *b)
920{
921 const char * const *as = a;
922 const char * const *bs = b;
923 return strcmp(*as, *bs);
924}
925
926void print_pmu_events(const char *event_glob, bool name_only)
927{
928 struct perf_pmu *pmu;
929 struct perf_pmu_alias *alias;
930 char buf[1024];
931 int printed = 0;
932 int len, j;
933 char **aliases;
934
935 pmu = NULL;
936 len = 0;
Adrian Hunter42634bc2014-10-23 13:45:10 +0300937 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
Andi Kleendc098b32013-04-20 11:02:29 -0700938 list_for_each_entry(alias, &pmu->aliases, list)
939 len++;
Adrian Hunter42634bc2014-10-23 13:45:10 +0300940 if (pmu->selectable)
941 len++;
942 }
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -0300943 aliases = zalloc(sizeof(char *) * len);
Andi Kleendc098b32013-04-20 11:02:29 -0700944 if (!aliases)
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -0300945 goto out_enomem;
Andi Kleendc098b32013-04-20 11:02:29 -0700946 pmu = NULL;
947 j = 0;
Adrian Hunter42634bc2014-10-23 13:45:10 +0300948 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
Andi Kleendc098b32013-04-20 11:02:29 -0700949 list_for_each_entry(alias, &pmu->aliases, list) {
950 char *name = format_alias(buf, sizeof(buf), pmu, alias);
951 bool is_cpu = !strcmp(pmu->name, "cpu");
952
953 if (event_glob != NULL &&
954 !(strglobmatch(name, event_glob) ||
955 (!is_cpu && strglobmatch(alias->name,
956 event_glob))))
957 continue;
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -0300958
Andi Kleendc098b32013-04-20 11:02:29 -0700959 if (is_cpu && !name_only)
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -0300960 name = format_alias_or(buf, sizeof(buf), pmu, alias);
961
962 aliases[j] = strdup(name);
963 if (aliases[j] == NULL)
964 goto out_enomem;
Andi Kleendc098b32013-04-20 11:02:29 -0700965 j++;
966 }
Adrian Hunter42634bc2014-10-23 13:45:10 +0300967 if (pmu->selectable) {
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -0300968 char *s;
969 if (asprintf(&s, "%s//", pmu->name) < 0)
970 goto out_enomem;
971 aliases[j] = s;
Adrian Hunter42634bc2014-10-23 13:45:10 +0300972 j++;
973 }
974 }
Andi Kleendc098b32013-04-20 11:02:29 -0700975 len = j;
976 qsort(aliases, len, sizeof(char *), cmp_string);
977 for (j = 0; j < len; j++) {
978 if (name_only) {
979 printf("%s ", aliases[j]);
980 continue;
981 }
982 printf(" %-50s [Kernel PMU event]\n", aliases[j]);
Andi Kleendc098b32013-04-20 11:02:29 -0700983 printed++;
984 }
985 if (printed)
986 printf("\n");
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -0300987out_free:
988 for (j = 0; j < len; j++)
989 zfree(&aliases[j]);
990 zfree(&aliases);
991 return;
992
993out_enomem:
994 printf("FATAL: not enough memory to print PMU events\n");
995 if (aliases)
996 goto out_free;
Andi Kleendc098b32013-04-20 11:02:29 -0700997}
Andi Kleen4cabc3d2013-08-21 16:47:26 -0700998
999bool pmu_have_event(const char *pname, const char *name)
1000{
1001 struct perf_pmu *pmu;
1002 struct perf_pmu_alias *alias;
1003
1004 pmu = NULL;
1005 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1006 if (strcmp(pname, pmu->name))
1007 continue;
1008 list_for_each_entry(alias, &pmu->aliases, list)
1009 if (!strcmp(alias->name, name))
1010 return true;
1011 }
1012 return false;
1013}
Adrian Hunter7d4bdab2014-07-31 09:00:50 +03001014
1015static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1016{
1017 struct stat st;
1018 char path[PATH_MAX];
1019 const char *sysfs;
1020
1021 sysfs = sysfs__mountpoint();
1022 if (!sysfs)
1023 return NULL;
1024
1025 snprintf(path, PATH_MAX,
1026 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1027
1028 if (stat(path, &st) < 0)
1029 return NULL;
1030
1031 return fopen(path, "r");
1032}
1033
1034int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1035 ...)
1036{
1037 va_list args;
1038 FILE *file;
1039 int ret = EOF;
1040
1041 va_start(args, fmt);
1042 file = perf_pmu__open_file(pmu, name);
1043 if (file) {
1044 ret = vfscanf(file, fmt, args);
1045 fclose(file);
1046 }
1047 va_end(args);
1048 return ret;
1049}