blob: 89c91a1a67e760fc5b82198179f9ecdc4b337df5 [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
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700209static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
210 char *desc __maybe_unused, char *val)
Zheng Yana6146d52012-06-15 14:31:41 +0800211{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300212 struct perf_pmu_alias *alias;
Zheng Yana6146d52012-06-15 14:31:41 +0800213 int ret;
214
Zheng Yana6146d52012-06-15 14:31:41 +0800215 alias = malloc(sizeof(*alias));
216 if (!alias)
217 return -ENOMEM;
218
219 INIT_LIST_HEAD(&alias->terms);
Stephane Eranian410136f2013-11-12 17:58:49 +0100220 alias->scale = 1.0;
221 alias->unit[0] = '\0';
Matt Fleming044330c2014-11-21 10:31:12 +0100222 alias->per_pkg = false;
Stephane Eranian410136f2013-11-12 17:58:49 +0100223
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700224 ret = parse_events_terms(&alias->terms, val);
Zheng Yana6146d52012-06-15 14:31:41 +0800225 if (ret) {
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700226 pr_err("Cannot parse alias %s: %d\n", val, ret);
Zheng Yana6146d52012-06-15 14:31:41 +0800227 free(alias);
228 return ret;
229 }
230
231 alias->name = strdup(name);
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700232 if (dir) {
233 /*
234 * load unit name and scale if available
235 */
236 perf_pmu__parse_unit(alias, dir, name);
237 perf_pmu__parse_scale(alias, dir, name);
238 perf_pmu__parse_per_pkg(alias, dir, name);
239 perf_pmu__parse_snapshot(alias, dir, name);
240 }
Stephane Eranian410136f2013-11-12 17:58:49 +0100241
Zheng Yana6146d52012-06-15 14:31:41 +0800242 list_add_tail(&alias->list, list);
Stephane Eranian410136f2013-11-12 17:58:49 +0100243
Zheng Yana6146d52012-06-15 14:31:41 +0800244 return 0;
245}
246
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700247static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
248{
249 char buf[256];
250 int ret;
251
252 ret = fread(buf, 1, sizeof(buf), file);
253 if (ret == 0)
254 return -EINVAL;
255
256 buf[ret] = 0;
257
258 return __perf_pmu__new_alias(list, dir, name, NULL, buf);
259}
260
Matt Fleming46441bd2014-09-24 15:04:06 +0100261static inline bool pmu_alias_info_file(char *name)
262{
263 size_t len;
264
265 len = strlen(name);
266 if (len > 5 && !strcmp(name + len - 5, ".unit"))
267 return true;
268 if (len > 6 && !strcmp(name + len - 6, ".scale"))
269 return true;
Matt Fleming044330c2014-11-21 10:31:12 +0100270 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
271 return true;
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100272 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
273 return true;
Matt Fleming46441bd2014-09-24 15:04:06 +0100274
275 return false;
276}
277
Zheng Yana6146d52012-06-15 14:31:41 +0800278/*
279 * Process all the sysfs attributes located under the directory
280 * specified in 'dir' parameter.
281 */
282static int pmu_aliases_parse(char *dir, struct list_head *head)
283{
284 struct dirent *evt_ent;
285 DIR *event_dir;
286 int ret = 0;
287
288 event_dir = opendir(dir);
289 if (!event_dir)
290 return -EINVAL;
291
292 while (!ret && (evt_ent = readdir(event_dir))) {
293 char path[PATH_MAX];
294 char *name = evt_ent->d_name;
295 FILE *file;
296
297 if (!strcmp(name, ".") || !strcmp(name, ".."))
298 continue;
299
Stephane Eranian410136f2013-11-12 17:58:49 +0100300 /*
Matt Fleming46441bd2014-09-24 15:04:06 +0100301 * skip info files parsed in perf_pmu__new_alias()
Stephane Eranian410136f2013-11-12 17:58:49 +0100302 */
Matt Fleming46441bd2014-09-24 15:04:06 +0100303 if (pmu_alias_info_file(name))
Stephane Eranian410136f2013-11-12 17:58:49 +0100304 continue;
305
Zheng Yana6146d52012-06-15 14:31:41 +0800306 snprintf(path, PATH_MAX, "%s/%s", dir, name);
307
308 ret = -EINVAL;
309 file = fopen(path, "r");
310 if (!file)
311 break;
Stephane Eranian410136f2013-11-12 17:58:49 +0100312
313 ret = perf_pmu__new_alias(head, dir, name, file);
Zheng Yana6146d52012-06-15 14:31:41 +0800314 fclose(file);
315 }
316
317 closedir(event_dir);
318 return ret;
319}
320
321/*
322 * Reading the pmu event aliases definition, which should be located at:
323 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
324 */
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300325static int pmu_aliases(const char *name, struct list_head *head)
Zheng Yana6146d52012-06-15 14:31:41 +0800326{
327 struct stat st;
328 char path[PATH_MAX];
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300329 const char *sysfs = sysfs__mountpoint();
Zheng Yana6146d52012-06-15 14:31:41 +0800330
Zheng Yana6146d52012-06-15 14:31:41 +0800331 if (!sysfs)
332 return -1;
333
334 snprintf(path, PATH_MAX,
335 "%s/bus/event_source/devices/%s/events", sysfs, name);
336
337 if (stat(path, &st) < 0)
Jiri Olsa3fded962012-10-10 14:53:16 +0200338 return 0; /* no error if 'events' does not exist */
Zheng Yana6146d52012-06-15 14:31:41 +0800339
340 if (pmu_aliases_parse(path, head))
341 return -1;
342
343 return 0;
344}
345
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300346static int pmu_alias_terms(struct perf_pmu_alias *alias,
Zheng Yana6146d52012-06-15 14:31:41 +0800347 struct list_head *terms)
348{
Jiri Olsa7c2f8162014-04-16 20:49:02 +0200349 struct parse_events_term *term, *cloned;
Zheng Yana6146d52012-06-15 14:31:41 +0800350 LIST_HEAD(list);
351 int ret;
352
353 list_for_each_entry(term, &alias->terms, list) {
Jiri Olsa7c2f8162014-04-16 20:49:02 +0200354 ret = parse_events_term__clone(&cloned, term);
Zheng Yana6146d52012-06-15 14:31:41 +0800355 if (ret) {
356 parse_events__free_terms(&list);
357 return ret;
358 }
Jiri Olsa7c2f8162014-04-16 20:49:02 +0200359 list_add_tail(&cloned->list, &list);
Zheng Yana6146d52012-06-15 14:31:41 +0800360 }
361 list_splice(&list, terms);
362 return 0;
363}
364
Jiri Olsacd82a322012-03-15 20:09:17 +0100365/*
366 * Reading/parsing the default pmu type value, which should be
367 * located at:
368 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
369 */
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300370static int pmu_type(const char *name, __u32 *type)
Jiri Olsacd82a322012-03-15 20:09:17 +0100371{
372 struct stat st;
373 char path[PATH_MAX];
Jiri Olsacd82a322012-03-15 20:09:17 +0100374 FILE *file;
375 int ret = 0;
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300376 const char *sysfs = sysfs__mountpoint();
Jiri Olsacd82a322012-03-15 20:09:17 +0100377
Jiri Olsacd82a322012-03-15 20:09:17 +0100378 if (!sysfs)
379 return -1;
380
381 snprintf(path, PATH_MAX,
Robert Richter50a96672012-08-16 21:10:24 +0200382 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
Jiri Olsacd82a322012-03-15 20:09:17 +0100383
384 if (stat(path, &st) < 0)
385 return -1;
386
387 file = fopen(path, "r");
388 if (!file)
389 return -EINVAL;
390
391 if (1 != fscanf(file, "%u", type))
392 ret = -1;
393
394 fclose(file);
395 return ret;
396}
397
Robert Richter50a96672012-08-16 21:10:24 +0200398/* Add all pmus in sysfs to pmu list: */
399static void pmu_read_sysfs(void)
400{
401 char path[PATH_MAX];
Robert Richter50a96672012-08-16 21:10:24 +0200402 DIR *dir;
403 struct dirent *dent;
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300404 const char *sysfs = sysfs__mountpoint();
Robert Richter50a96672012-08-16 21:10:24 +0200405
Robert Richter50a96672012-08-16 21:10:24 +0200406 if (!sysfs)
407 return;
408
409 snprintf(path, PATH_MAX,
410 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
411
412 dir = opendir(path);
413 if (!dir)
414 return;
415
416 while ((dent = readdir(dir))) {
417 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
418 continue;
419 /* add to static LIST_HEAD(pmus): */
420 perf_pmu__find(dent->d_name);
421 }
422
423 closedir(dir);
424}
425
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300426static struct cpu_map *pmu_cpumask(const char *name)
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800427{
428 struct stat st;
429 char path[PATH_MAX];
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800430 FILE *file;
431 struct cpu_map *cpus;
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300432 const char *sysfs = sysfs__mountpoint();
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800433
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800434 if (!sysfs)
435 return NULL;
436
437 snprintf(path, PATH_MAX,
438 "%s/bus/event_source/devices/%s/cpumask", sysfs, name);
439
440 if (stat(path, &st) < 0)
441 return NULL;
442
443 file = fopen(path, "r");
444 if (!file)
445 return NULL;
446
447 cpus = cpu_map__read(file);
448 fclose(file);
449 return cpus;
450}
451
Sukadev Bhattiproluc5de47f2015-06-10 00:25:07 -0700452struct perf_event_attr * __weak
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300453perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
454{
455 return NULL;
456}
457
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300458static struct perf_pmu *pmu_lookup(const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +0100459{
460 struct perf_pmu *pmu;
461 LIST_HEAD(format);
Zheng Yana6146d52012-06-15 14:31:41 +0800462 LIST_HEAD(aliases);
Jiri Olsacd82a322012-03-15 20:09:17 +0100463 __u32 type;
464
465 /*
466 * The pmu data we store & need consists of the pmu
467 * type value and format definitions. Load both right
468 * now.
469 */
470 if (pmu_format(name, &format))
471 return NULL;
472
Jiri Olsa3fded962012-10-10 14:53:16 +0200473 if (pmu_aliases(name, &aliases))
474 return NULL;
475
Jiri Olsacd82a322012-03-15 20:09:17 +0100476 if (pmu_type(name, &type))
477 return NULL;
478
479 pmu = zalloc(sizeof(*pmu));
480 if (!pmu)
481 return NULL;
482
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800483 pmu->cpus = pmu_cpumask(name);
484
Jiri Olsacd82a322012-03-15 20:09:17 +0100485 INIT_LIST_HEAD(&pmu->format);
Zheng Yana6146d52012-06-15 14:31:41 +0800486 INIT_LIST_HEAD(&pmu->aliases);
Jiri Olsacd82a322012-03-15 20:09:17 +0100487 list_splice(&format, &pmu->format);
Zheng Yana6146d52012-06-15 14:31:41 +0800488 list_splice(&aliases, &pmu->aliases);
Jiri Olsacd82a322012-03-15 20:09:17 +0100489 pmu->name = strdup(name);
490 pmu->type = type;
Robert Richter9bc8f9f2012-06-14 22:38:37 +0200491 list_add_tail(&pmu->list, &pmus);
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300492
493 pmu->default_config = perf_pmu__get_default_config(pmu);
494
Jiri Olsacd82a322012-03-15 20:09:17 +0100495 return pmu;
496}
497
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300498static struct perf_pmu *pmu_find(const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +0100499{
500 struct perf_pmu *pmu;
501
502 list_for_each_entry(pmu, &pmus, list)
503 if (!strcmp(pmu->name, name))
504 return pmu;
505
506 return NULL;
507}
508
Robert Richter50a96672012-08-16 21:10:24 +0200509struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
510{
511 /*
512 * pmu iterator: If pmu is NULL, we start at the begin,
513 * otherwise return the next pmu. Returns NULL on end.
514 */
515 if (!pmu) {
516 pmu_read_sysfs();
517 pmu = list_prepare_entry(pmu, &pmus, list);
518 }
519 list_for_each_entry_continue(pmu, &pmus, list)
520 return pmu;
521 return NULL;
522}
523
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300524struct perf_pmu *perf_pmu__find(const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +0100525{
526 struct perf_pmu *pmu;
527
528 /*
529 * Once PMU is loaded it stays in the list,
530 * so we keep us from multiple reading/parsing
531 * the pmu format definitions.
532 */
533 pmu = pmu_find(name);
534 if (pmu)
535 return pmu;
536
537 return pmu_lookup(name);
538}
539
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300540static struct perf_pmu_format *
Adrian Hunter09ff6072015-07-17 19:33:49 +0300541pmu_find_format(struct list_head *formats, const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +0100542{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300543 struct perf_pmu_format *format;
Jiri Olsacd82a322012-03-15 20:09:17 +0100544
545 list_for_each_entry(format, formats, list)
546 if (!strcmp(format->name, name))
547 return format;
548
549 return NULL;
550}
551
Adrian Hunter09ff6072015-07-17 19:33:49 +0300552__u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
553{
554 struct perf_pmu_format *format = pmu_find_format(formats, name);
555 __u64 bits = 0;
556 int fbit;
557
558 if (!format)
559 return 0;
560
561 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
562 bits |= 1ULL << fbit;
563
564 return bits;
565}
566
Jiri Olsacd82a322012-03-15 20:09:17 +0100567/*
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300568 * Sets value based on the format definition (format parameter)
Jiri Olsacd82a322012-03-15 20:09:17 +0100569 * and unformated value (value parameter).
Jiri Olsacd82a322012-03-15 20:09:17 +0100570 */
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300571static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
572 bool zero)
Jiri Olsacd82a322012-03-15 20:09:17 +0100573{
574 unsigned long fbit, vbit;
Jiri Olsacd82a322012-03-15 20:09:17 +0100575
576 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
577
578 if (!test_bit(fbit, format))
579 continue;
580
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300581 if (value & (1llu << vbit++))
582 *v |= (1llu << fbit);
583 else if (zero)
584 *v &= ~(1llu << fbit);
Jiri Olsacd82a322012-03-15 20:09:17 +0100585 }
Jiri Olsacd82a322012-03-15 20:09:17 +0100586}
587
Adrian Hunter0efe6b62015-07-17 19:33:50 +0300588static __u64 pmu_format_max_value(const unsigned long *format)
589{
590 int w;
591
592 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
593 if (!w)
594 return 0;
595 if (w < 64)
596 return (1ULL << w) - 1;
597 return -1;
598}
599
Jiri Olsacd82a322012-03-15 20:09:17 +0100600/*
Cody P Schafer688d4df2015-01-07 17:13:50 -0800601 * Term is a string term, and might be a param-term. Try to look up it's value
602 * in the remaining terms.
603 * - We have a term like "base-or-format-term=param-term",
604 * - We need to find the value supplied for "param-term" (with param-term named
605 * in a config string) later on in the term list.
606 */
607static int pmu_resolve_param_term(struct parse_events_term *term,
608 struct list_head *head_terms,
609 __u64 *value)
610{
611 struct parse_events_term *t;
612
613 list_for_each_entry(t, head_terms, list) {
614 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
615 if (!strcmp(t->config, term->config)) {
616 t->used = true;
617 *value = t->val.num;
618 return 0;
619 }
620 }
621 }
622
623 if (verbose)
624 printf("Required parameter '%s' not specified\n", term->config);
625
626 return -1;
627}
628
Jiri Olsae64b0202015-04-22 21:10:21 +0200629static char *formats_error_string(struct list_head *formats)
630{
631 struct perf_pmu_format *format;
632 char *err, *str;
Kan Liangd457c962015-08-11 06:30:47 -0400633 static const char *static_terms = "config,config1,config2,name,"
634 "period,freq,branch_type,time,"
635 "call-graph,stack-size\n";
Jiri Olsae64b0202015-04-22 21:10:21 +0200636 unsigned i = 0;
637
638 if (!asprintf(&str, "valid terms:"))
639 return NULL;
640
641 /* sysfs exported terms */
642 list_for_each_entry(format, formats, list) {
643 char c = i++ ? ',' : ' ';
644
645 err = str;
646 if (!asprintf(&str, "%s%c%s", err, c, format->name))
647 goto fail;
648 free(err);
649 }
650
651 /* static terms */
652 err = str;
653 if (!asprintf(&str, "%s,%s", err, static_terms))
654 goto fail;
655
656 free(err);
657 return str;
658fail:
659 free(err);
660 return NULL;
661}
662
Cody P Schafer688d4df2015-01-07 17:13:50 -0800663/*
Jiri Olsacd82a322012-03-15 20:09:17 +0100664 * Setup one of config[12] attr members based on the
Cody P Schafer88aca8d2014-01-08 08:43:51 -0800665 * user input data - term parameter.
Jiri Olsacd82a322012-03-15 20:09:17 +0100666 */
667static int pmu_config_term(struct list_head *formats,
668 struct perf_event_attr *attr,
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300669 struct parse_events_term *term,
Cody P Schafer688d4df2015-01-07 17:13:50 -0800670 struct list_head *head_terms,
Jiri Olsae64b0202015-04-22 21:10:21 +0200671 bool zero, struct parse_events_error *err)
Jiri Olsacd82a322012-03-15 20:09:17 +0100672{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300673 struct perf_pmu_format *format;
Jiri Olsacd82a322012-03-15 20:09:17 +0100674 __u64 *vp;
Adrian Hunter0efe6b62015-07-17 19:33:50 +0300675 __u64 val, max_val;
Jiri Olsacd82a322012-03-15 20:09:17 +0100676
677 /*
Cody P Schafer688d4df2015-01-07 17:13:50 -0800678 * If this is a parameter we've already used for parameterized-eval,
679 * skip it in normal eval.
680 */
681 if (term->used)
682 return 0;
683
684 /*
Jiri Olsacd82a322012-03-15 20:09:17 +0100685 * Hardcoded terms should be already in, so nothing
686 * to be done for them.
687 */
688 if (parse_events__is_hardcoded_term(term))
689 return 0;
690
Jiri Olsacd82a322012-03-15 20:09:17 +0100691 format = pmu_find_format(formats, term->config);
Cody P Schafer688d4df2015-01-07 17:13:50 -0800692 if (!format) {
693 if (verbose)
694 printf("Invalid event/parameter '%s'\n", term->config);
Jiri Olsae64b0202015-04-22 21:10:21 +0200695 if (err) {
696 err->idx = term->err_term;
697 err->str = strdup("unknown term");
698 err->help = formats_error_string(formats);
699 }
Jiri Olsacd82a322012-03-15 20:09:17 +0100700 return -EINVAL;
Cody P Schafer688d4df2015-01-07 17:13:50 -0800701 }
Jiri Olsacd82a322012-03-15 20:09:17 +0100702
703 switch (format->value) {
704 case PERF_PMU_FORMAT_VALUE_CONFIG:
705 vp = &attr->config;
706 break;
707 case PERF_PMU_FORMAT_VALUE_CONFIG1:
708 vp = &attr->config1;
709 break;
710 case PERF_PMU_FORMAT_VALUE_CONFIG2:
711 vp = &attr->config2;
712 break;
713 default:
714 return -EINVAL;
715 }
716
Jiri Olsa16fa7e82012-04-25 18:24:57 +0200717 /*
Cody P Schafer688d4df2015-01-07 17:13:50 -0800718 * Either directly use a numeric term, or try to translate string terms
719 * using event parameters.
Jiri Olsa16fa7e82012-04-25 18:24:57 +0200720 */
Cody P Schafer688d4df2015-01-07 17:13:50 -0800721 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
722 val = term->val.num;
723 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
724 if (strcmp(term->val.str, "?")) {
Jiri Olsae64b0202015-04-22 21:10:21 +0200725 if (verbose) {
Cody P Schafer688d4df2015-01-07 17:13:50 -0800726 pr_info("Invalid sysfs entry %s=%s\n",
727 term->config, term->val.str);
Jiri Olsae64b0202015-04-22 21:10:21 +0200728 }
729 if (err) {
730 err->idx = term->err_val;
731 err->str = strdup("expected numeric value");
732 }
Cody P Schafer688d4df2015-01-07 17:13:50 -0800733 return -EINVAL;
734 }
735
736 if (pmu_resolve_param_term(term, head_terms, &val))
737 return -EINVAL;
738 } else
739 return -EINVAL;
740
Adrian Hunter0efe6b62015-07-17 19:33:50 +0300741 max_val = pmu_format_max_value(format->bits);
742 if (val > max_val) {
743 if (err) {
744 err->idx = term->err_val;
745 if (asprintf(&err->str,
746 "value too big for format, maximum is %llu",
747 (unsigned long long)max_val) < 0)
748 err->str = strdup("value too big for format");
749 return -EINVAL;
750 }
751 /*
752 * Assume we don't care if !err, in which case the value will be
753 * silently truncated.
754 */
755 }
756
Cody P Schafer688d4df2015-01-07 17:13:50 -0800757 pmu_format_value(format->bits, val, vp, zero);
Jiri Olsacd82a322012-03-15 20:09:17 +0100758 return 0;
759}
760
Jiri Olsacff7f952012-11-10 01:46:50 +0100761int perf_pmu__config_terms(struct list_head *formats,
762 struct perf_event_attr *attr,
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300763 struct list_head *head_terms,
Jiri Olsae64b0202015-04-22 21:10:21 +0200764 bool zero, struct parse_events_error *err)
Jiri Olsacd82a322012-03-15 20:09:17 +0100765{
Arnaldo Carvalho de Melo6cee6cd2013-01-18 16:29:49 -0300766 struct parse_events_term *term;
Jiri Olsacd82a322012-03-15 20:09:17 +0100767
Cody P Schafer688d4df2015-01-07 17:13:50 -0800768 list_for_each_entry(term, head_terms, list) {
Jiri Olsae64b0202015-04-22 21:10:21 +0200769 if (pmu_config_term(formats, attr, term, head_terms,
770 zero, err))
Jiri Olsacd82a322012-03-15 20:09:17 +0100771 return -EINVAL;
Cody P Schafer688d4df2015-01-07 17:13:50 -0800772 }
Jiri Olsacd82a322012-03-15 20:09:17 +0100773
774 return 0;
775}
776
777/*
778 * Configures event's 'attr' parameter based on the:
779 * 1) users input - specified in terms parameter
780 * 2) pmu format definitions - specified by pmu parameter
781 */
782int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
Jiri Olsae64b0202015-04-22 21:10:21 +0200783 struct list_head *head_terms,
784 struct parse_events_error *err)
Jiri Olsacd82a322012-03-15 20:09:17 +0100785{
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300786 bool zero = !!pmu->default_config;
787
Jiri Olsacd82a322012-03-15 20:09:17 +0100788 attr->type = pmu->type;
Jiri Olsae64b0202015-04-22 21:10:21 +0200789 return perf_pmu__config_terms(&pmu->format, attr, head_terms,
790 zero, err);
Jiri Olsacd82a322012-03-15 20:09:17 +0100791}
792
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300793static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
794 struct parse_events_term *term)
Zheng Yana6146d52012-06-15 14:31:41 +0800795{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300796 struct perf_pmu_alias *alias;
Zheng Yana6146d52012-06-15 14:31:41 +0800797 char *name;
798
799 if (parse_events__is_hardcoded_term(term))
800 return NULL;
801
802 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
803 if (term->val.num != 1)
804 return NULL;
805 if (pmu_find_format(&pmu->format, term->config))
806 return NULL;
807 name = term->config;
808 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
809 if (strcasecmp(term->config, "event"))
810 return NULL;
811 name = term->val.str;
812 } else {
813 return NULL;
814 }
815
816 list_for_each_entry(alias, &pmu->aliases, list) {
817 if (!strcasecmp(alias->name, name))
818 return alias;
819 }
820 return NULL;
821}
822
Stephane Eranian410136f2013-11-12 17:58:49 +0100823
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100824static int check_info_data(struct perf_pmu_alias *alias,
825 struct perf_pmu_info *info)
Stephane Eranian410136f2013-11-12 17:58:49 +0100826{
827 /*
828 * Only one term in event definition can
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100829 * define unit, scale and snapshot, fail
830 * if there's more than one.
Stephane Eranian410136f2013-11-12 17:58:49 +0100831 */
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100832 if ((info->unit && alias->unit) ||
833 (info->scale && alias->scale) ||
834 (info->snapshot && alias->snapshot))
Stephane Eranian410136f2013-11-12 17:58:49 +0100835 return -EINVAL;
836
837 if (alias->unit)
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100838 info->unit = alias->unit;
Stephane Eranian410136f2013-11-12 17:58:49 +0100839
840 if (alias->scale)
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100841 info->scale = alias->scale;
842
843 if (alias->snapshot)
844 info->snapshot = alias->snapshot;
Stephane Eranian410136f2013-11-12 17:58:49 +0100845
846 return 0;
847}
848
Zheng Yana6146d52012-06-15 14:31:41 +0800849/*
850 * Find alias in the terms list and replace it with the terms
851 * defined for the alias
852 */
Stephane Eranian410136f2013-11-12 17:58:49 +0100853int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
Matt Fleming46441bd2014-09-24 15:04:06 +0100854 struct perf_pmu_info *info)
Zheng Yana6146d52012-06-15 14:31:41 +0800855{
Arnaldo Carvalho de Melo6cee6cd2013-01-18 16:29:49 -0300856 struct parse_events_term *term, *h;
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300857 struct perf_pmu_alias *alias;
Zheng Yana6146d52012-06-15 14:31:41 +0800858 int ret;
859
Matt Fleming044330c2014-11-21 10:31:12 +0100860 info->per_pkg = false;
861
Stephane Eranian8a398892014-01-17 16:34:05 +0100862 /*
863 * Mark unit and scale as not set
864 * (different from default values, see below)
865 */
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100866 info->unit = NULL;
867 info->scale = 0.0;
868 info->snapshot = false;
Stephane Eranian410136f2013-11-12 17:58:49 +0100869
Zheng Yana6146d52012-06-15 14:31:41 +0800870 list_for_each_entry_safe(term, h, head_terms, list) {
871 alias = pmu_find_alias(pmu, term);
872 if (!alias)
873 continue;
874 ret = pmu_alias_terms(alias, &term->list);
875 if (ret)
876 return ret;
Stephane Eranian410136f2013-11-12 17:58:49 +0100877
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100878 ret = check_info_data(alias, info);
Stephane Eranian410136f2013-11-12 17:58:49 +0100879 if (ret)
880 return ret;
881
Matt Fleming044330c2014-11-21 10:31:12 +0100882 if (alias->per_pkg)
883 info->per_pkg = true;
884
Zheng Yana6146d52012-06-15 14:31:41 +0800885 list_del(&term->list);
886 free(term);
887 }
Stephane Eranian8a398892014-01-17 16:34:05 +0100888
889 /*
890 * if no unit or scale foundin aliases, then
891 * set defaults as for evsel
892 * unit cannot left to NULL
893 */
Matt Fleming46441bd2014-09-24 15:04:06 +0100894 if (info->unit == NULL)
895 info->unit = "";
Stephane Eranian8a398892014-01-17 16:34:05 +0100896
Matt Fleming46441bd2014-09-24 15:04:06 +0100897 if (info->scale == 0.0)
898 info->scale = 1.0;
Stephane Eranian8a398892014-01-17 16:34:05 +0100899
Zheng Yana6146d52012-06-15 14:31:41 +0800900 return 0;
901}
902
Jiri Olsacd82a322012-03-15 20:09:17 +0100903int perf_pmu__new_format(struct list_head *list, char *name,
904 int config, unsigned long *bits)
905{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300906 struct perf_pmu_format *format;
Jiri Olsacd82a322012-03-15 20:09:17 +0100907
908 format = zalloc(sizeof(*format));
909 if (!format)
910 return -ENOMEM;
911
912 format->name = strdup(name);
913 format->value = config;
914 memcpy(format->bits, bits, sizeof(format->bits));
915
916 list_add_tail(&format->list, list);
917 return 0;
918}
919
920void perf_pmu__set_format(unsigned long *bits, long from, long to)
921{
922 long b;
923
924 if (!to)
925 to = from;
926
Sukadev Bhattiprolu15268132013-01-17 09:11:30 -0800927 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
Jiri Olsacd82a322012-03-15 20:09:17 +0100928 for (b = from; b <= to; b++)
929 set_bit(b, bits);
930}
Andi Kleendc098b32013-04-20 11:02:29 -0700931
Cody P Schaferaaea3612015-01-07 17:13:51 -0800932static int sub_non_neg(int a, int b)
933{
934 if (b > a)
935 return 0;
936 return a - b;
937}
938
Andi Kleendc098b32013-04-20 11:02:29 -0700939static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
940 struct perf_pmu_alias *alias)
941{
Cody P Schaferaaea3612015-01-07 17:13:51 -0800942 struct parse_events_term *term;
943 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
944
945 list_for_each_entry(term, &alias->terms, list) {
946 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
947 used += snprintf(buf + used, sub_non_neg(len, used),
948 ",%s=%s", term->config,
949 term->val.str);
950 }
951
952 if (sub_non_neg(len, used) > 0) {
953 buf[used] = '/';
954 used++;
955 }
956 if (sub_non_neg(len, used) > 0) {
957 buf[used] = '\0';
958 used++;
959 } else
960 buf[len - 1] = '\0';
961
Andi Kleendc098b32013-04-20 11:02:29 -0700962 return buf;
963}
964
965static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
966 struct perf_pmu_alias *alias)
967{
968 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
969 return buf;
970}
971
972static int cmp_string(const void *a, const void *b)
973{
974 const char * const *as = a;
975 const char * const *bs = b;
976 return strcmp(*as, *bs);
977}
978
979void print_pmu_events(const char *event_glob, bool name_only)
980{
981 struct perf_pmu *pmu;
982 struct perf_pmu_alias *alias;
983 char buf[1024];
984 int printed = 0;
985 int len, j;
986 char **aliases;
987
988 pmu = NULL;
989 len = 0;
Adrian Hunter42634bc2014-10-23 13:45:10 +0300990 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
Andi Kleendc098b32013-04-20 11:02:29 -0700991 list_for_each_entry(alias, &pmu->aliases, list)
992 len++;
Adrian Hunter42634bc2014-10-23 13:45:10 +0300993 if (pmu->selectable)
994 len++;
995 }
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -0300996 aliases = zalloc(sizeof(char *) * len);
Andi Kleendc098b32013-04-20 11:02:29 -0700997 if (!aliases)
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -0300998 goto out_enomem;
Andi Kleendc098b32013-04-20 11:02:29 -0700999 pmu = NULL;
1000 j = 0;
Adrian Hunter42634bc2014-10-23 13:45:10 +03001001 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
Andi Kleendc098b32013-04-20 11:02:29 -07001002 list_for_each_entry(alias, &pmu->aliases, list) {
1003 char *name = format_alias(buf, sizeof(buf), pmu, alias);
1004 bool is_cpu = !strcmp(pmu->name, "cpu");
1005
1006 if (event_glob != NULL &&
1007 !(strglobmatch(name, event_glob) ||
1008 (!is_cpu && strglobmatch(alias->name,
1009 event_glob))))
1010 continue;
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001011
Andi Kleendc098b32013-04-20 11:02:29 -07001012 if (is_cpu && !name_only)
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001013 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1014
1015 aliases[j] = strdup(name);
1016 if (aliases[j] == NULL)
1017 goto out_enomem;
Andi Kleendc098b32013-04-20 11:02:29 -07001018 j++;
1019 }
Adrian Hunter42634bc2014-10-23 13:45:10 +03001020 if (pmu->selectable) {
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001021 char *s;
1022 if (asprintf(&s, "%s//", pmu->name) < 0)
1023 goto out_enomem;
1024 aliases[j] = s;
Adrian Hunter42634bc2014-10-23 13:45:10 +03001025 j++;
1026 }
1027 }
Andi Kleendc098b32013-04-20 11:02:29 -07001028 len = j;
1029 qsort(aliases, len, sizeof(char *), cmp_string);
1030 for (j = 0; j < len; j++) {
1031 if (name_only) {
1032 printf("%s ", aliases[j]);
1033 continue;
1034 }
1035 printf(" %-50s [Kernel PMU event]\n", aliases[j]);
Andi Kleendc098b32013-04-20 11:02:29 -07001036 printed++;
1037 }
1038 if (printed)
1039 printf("\n");
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001040out_free:
1041 for (j = 0; j < len; j++)
1042 zfree(&aliases[j]);
1043 zfree(&aliases);
1044 return;
1045
1046out_enomem:
1047 printf("FATAL: not enough memory to print PMU events\n");
1048 if (aliases)
1049 goto out_free;
Andi Kleendc098b32013-04-20 11:02:29 -07001050}
Andi Kleen4cabc3d2013-08-21 16:47:26 -07001051
1052bool pmu_have_event(const char *pname, const char *name)
1053{
1054 struct perf_pmu *pmu;
1055 struct perf_pmu_alias *alias;
1056
1057 pmu = NULL;
1058 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1059 if (strcmp(pname, pmu->name))
1060 continue;
1061 list_for_each_entry(alias, &pmu->aliases, list)
1062 if (!strcmp(alias->name, name))
1063 return true;
1064 }
1065 return false;
1066}
Adrian Hunter7d4bdab2014-07-31 09:00:50 +03001067
1068static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1069{
1070 struct stat st;
1071 char path[PATH_MAX];
1072 const char *sysfs;
1073
1074 sysfs = sysfs__mountpoint();
1075 if (!sysfs)
1076 return NULL;
1077
1078 snprintf(path, PATH_MAX,
1079 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1080
1081 if (stat(path, &st) < 0)
1082 return NULL;
1083
1084 return fopen(path, "r");
1085}
1086
1087int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1088 ...)
1089{
1090 va_list args;
1091 FILE *file;
1092 int ret = EOF;
1093
1094 va_start(args, fmt);
1095 file = perf_pmu__open_file(pmu, name);
1096 if (file) {
1097 ret = vfscanf(file, fmt, args);
1098 fclose(file);
1099 }
1100 va_end(args);
1101 return ret;
1102}