perf tools: Adds the tracepoint name parsing support
[linux-2.6-block.git] / tools / perf / util / parse-events.c
CommitLineData
d2709c7c 1#include <linux/hw_breakpoint.h>
8dd2a131 2#include <linux/err.h>
8ad8db37 3#include "util.h"
6b58e7f1 4#include "../perf.h"
361c99a6 5#include "evlist.h"
69aad6f1 6#include "evsel.h"
8ad8db37
IM
7#include "parse-options.h"
8#include "parse-events.h"
9#include "exec_cmd.h"
42f60c2d 10#include "string.h"
5aab621b 11#include "symbol.h"
5beeded1 12#include "cache.h"
8755a8f2 13#include "header.h"
6e81c74c 14#include "debug.h"
592d5a6b 15#include <api/fs/tracing_path.h>
ac20de6f 16#include "parse-events-bison.h"
90e2b22d 17#define YY_EXTRA_TYPE int
89812fc8 18#include "parse-events-flex.h"
5f537a26 19#include "pmu.h"
b41f1cec 20#include "thread_map.h"
f30a79b0 21#include "cpumap.h"
b39b8393 22#include "asm/bug.h"
89812fc8
JO
23
24#define MAX_NAME_LEN 100
8ad8db37 25
82ba1f2f
JO
26#ifdef PARSER_DEBUG
27extern int parse_events_debug;
28#endif
ac20de6f 29int parse_events_parse(void *data, void *scanner);
bcd3279f 30
dcb4e102
KL
31static struct perf_pmu_event_symbol *perf_pmu_events_list;
32/*
33 * The variable indicates the number of supported pmu event symbols.
34 * 0 means not initialized and ready to init
35 * -1 means failed to init, don't try anymore
36 * >0 is the number of supported pmu event symbols
37 */
38static int perf_pmu_events_list_num;
39
705750f2 40struct event_symbol event_symbols_hw[PERF_COUNT_HW_MAX] = {
1dc12760
JO
41 [PERF_COUNT_HW_CPU_CYCLES] = {
42 .symbol = "cpu-cycles",
43 .alias = "cycles",
44 },
45 [PERF_COUNT_HW_INSTRUCTIONS] = {
46 .symbol = "instructions",
47 .alias = "",
48 },
49 [PERF_COUNT_HW_CACHE_REFERENCES] = {
50 .symbol = "cache-references",
51 .alias = "",
52 },
53 [PERF_COUNT_HW_CACHE_MISSES] = {
54 .symbol = "cache-misses",
55 .alias = "",
56 },
57 [PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = {
58 .symbol = "branch-instructions",
59 .alias = "branches",
60 },
61 [PERF_COUNT_HW_BRANCH_MISSES] = {
62 .symbol = "branch-misses",
63 .alias = "",
64 },
65 [PERF_COUNT_HW_BUS_CYCLES] = {
66 .symbol = "bus-cycles",
67 .alias = "",
68 },
69 [PERF_COUNT_HW_STALLED_CYCLES_FRONTEND] = {
70 .symbol = "stalled-cycles-frontend",
71 .alias = "idle-cycles-frontend",
72 },
73 [PERF_COUNT_HW_STALLED_CYCLES_BACKEND] = {
74 .symbol = "stalled-cycles-backend",
75 .alias = "idle-cycles-backend",
76 },
77 [PERF_COUNT_HW_REF_CPU_CYCLES] = {
78 .symbol = "ref-cycles",
79 .alias = "",
80 },
81};
82
705750f2 83struct event_symbol event_symbols_sw[PERF_COUNT_SW_MAX] = {
1dc12760
JO
84 [PERF_COUNT_SW_CPU_CLOCK] = {
85 .symbol = "cpu-clock",
86 .alias = "",
87 },
88 [PERF_COUNT_SW_TASK_CLOCK] = {
89 .symbol = "task-clock",
90 .alias = "",
91 },
92 [PERF_COUNT_SW_PAGE_FAULTS] = {
93 .symbol = "page-faults",
94 .alias = "faults",
95 },
96 [PERF_COUNT_SW_CONTEXT_SWITCHES] = {
97 .symbol = "context-switches",
98 .alias = "cs",
99 },
100 [PERF_COUNT_SW_CPU_MIGRATIONS] = {
101 .symbol = "cpu-migrations",
102 .alias = "migrations",
103 },
104 [PERF_COUNT_SW_PAGE_FAULTS_MIN] = {
105 .symbol = "minor-faults",
106 .alias = "",
107 },
108 [PERF_COUNT_SW_PAGE_FAULTS_MAJ] = {
109 .symbol = "major-faults",
110 .alias = "",
111 },
112 [PERF_COUNT_SW_ALIGNMENT_FAULTS] = {
113 .symbol = "alignment-faults",
114 .alias = "",
115 },
116 [PERF_COUNT_SW_EMULATION_FAULTS] = {
117 .symbol = "emulation-faults",
118 .alias = "",
119 },
d22d1a2a
AH
120 [PERF_COUNT_SW_DUMMY] = {
121 .symbol = "dummy",
122 .alias = "",
123 },
8ad8db37
IM
124};
125
cdd6c482
IM
126#define __PERF_EVENT_FIELD(config, name) \
127 ((config & PERF_EVENT_##name##_MASK) >> PERF_EVENT_##name##_SHIFT)
5242519b 128
1fc570ad 129#define PERF_EVENT_RAW(config) __PERF_EVENT_FIELD(config, RAW)
cdd6c482 130#define PERF_EVENT_CONFIG(config) __PERF_EVENT_FIELD(config, CONFIG)
1fc570ad 131#define PERF_EVENT_TYPE(config) __PERF_EVENT_FIELD(config, TYPE)
cdd6c482 132#define PERF_EVENT_ID(config) __PERF_EVENT_FIELD(config, EVENT)
5242519b 133
6b58e7f1 134#define for_each_subsystem(sys_dir, sys_dirent, sys_next) \
f6bdafef 135 while (!readdir_r(sys_dir, &sys_dirent, &sys_next) && sys_next) \
6b58e7f1 136 if (sys_dirent.d_type == DT_DIR && \
f6bdafef
JB
137 (strcmp(sys_dirent.d_name, ".")) && \
138 (strcmp(sys_dirent.d_name, "..")))
139
ae07b63f
PZ
140static int tp_event_has_id(struct dirent *sys_dir, struct dirent *evt_dir)
141{
142 char evt_path[MAXPATHLEN];
143 int fd;
144
ebf294bf 145 snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id", tracing_events_path,
ae07b63f
PZ
146 sys_dir->d_name, evt_dir->d_name);
147 fd = open(evt_path, O_RDONLY);
148 if (fd < 0)
149 return -EINVAL;
150 close(fd);
151
152 return 0;
153}
154
6b58e7f1 155#define for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) \
f6bdafef 156 while (!readdir_r(evt_dir, &evt_dirent, &evt_next) && evt_next) \
6b58e7f1 157 if (evt_dirent.d_type == DT_DIR && \
f6bdafef 158 (strcmp(evt_dirent.d_name, ".")) && \
ae07b63f
PZ
159 (strcmp(evt_dirent.d_name, "..")) && \
160 (!tp_event_has_id(&sys_dirent, &evt_dirent)))
f6bdafef 161
270bbbe8 162#define MAX_EVENT_LENGTH 512
f6bdafef 163
f6bdafef 164
1ef2ed10 165struct tracepoint_path *tracepoint_id_to_path(u64 config)
f6bdafef 166{
1ef2ed10 167 struct tracepoint_path *path = NULL;
f6bdafef
JB
168 DIR *sys_dir, *evt_dir;
169 struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
8aa8a7c8 170 char id_buf[24];
725b1368 171 int fd;
f6bdafef
JB
172 u64 id;
173 char evt_path[MAXPATHLEN];
725b1368 174 char dir_path[MAXPATHLEN];
f6bdafef 175
ebf294bf 176 sys_dir = opendir(tracing_events_path);
f6bdafef 177 if (!sys_dir)
725b1368 178 return NULL;
6b58e7f1
UD
179
180 for_each_subsystem(sys_dir, sys_dirent, sys_next) {
725b1368 181
ebf294bf 182 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
725b1368
ED
183 sys_dirent.d_name);
184 evt_dir = opendir(dir_path);
185 if (!evt_dir)
6b58e7f1 186 continue;
725b1368 187
6b58e7f1 188 for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
725b1368
ED
189
190 snprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path,
f6bdafef 191 evt_dirent.d_name);
725b1368 192 fd = open(evt_path, O_RDONLY);
f6bdafef
JB
193 if (fd < 0)
194 continue;
195 if (read(fd, id_buf, sizeof(id_buf)) < 0) {
196 close(fd);
197 continue;
198 }
199 close(fd);
200 id = atoll(id_buf);
201 if (id == config) {
202 closedir(evt_dir);
203 closedir(sys_dir);
59b4caeb 204 path = zalloc(sizeof(*path));
1ef2ed10
FW
205 path->system = malloc(MAX_EVENT_LENGTH);
206 if (!path->system) {
207 free(path);
208 return NULL;
209 }
210 path->name = malloc(MAX_EVENT_LENGTH);
211 if (!path->name) {
74cf249d 212 zfree(&path->system);
1ef2ed10
FW
213 free(path);
214 return NULL;
215 }
216 strncpy(path->system, sys_dirent.d_name,
217 MAX_EVENT_LENGTH);
218 strncpy(path->name, evt_dirent.d_name,
219 MAX_EVENT_LENGTH);
220 return path;
f6bdafef
JB
221 }
222 }
223 closedir(evt_dir);
224 }
225
f6bdafef 226 closedir(sys_dir);
1ef2ed10
FW
227 return NULL;
228}
229
e7c93f09
NK
230struct tracepoint_path *tracepoint_name_to_path(const char *name)
231{
232 struct tracepoint_path *path = zalloc(sizeof(*path));
233 char *str = strchr(name, ':');
234
235 if (path == NULL || str == NULL) {
236 free(path);
237 return NULL;
238 }
239
240 path->system = strndup(name, str - name);
241 path->name = strdup(str+1);
242
243 if (path->system == NULL || path->name == NULL) {
74cf249d
ACM
244 zfree(&path->system);
245 zfree(&path->name);
e7c93f09
NK
246 free(path);
247 path = NULL;
248 }
249
250 return path;
251}
252
1424dc96
DA
253const char *event_type(int type)
254{
255 switch (type) {
256 case PERF_TYPE_HARDWARE:
257 return "hardware";
258
259 case PERF_TYPE_SOFTWARE:
260 return "software";
261
262 case PERF_TYPE_TRACEPOINT:
263 return "tracepoint";
264
265 case PERF_TYPE_HW_CACHE:
266 return "hardware-cache";
267
268 default:
269 break;
270 }
271
272 return "unknown";
273}
274
7ae92e74
YZ
275
276
410136f5
SE
277static struct perf_evsel *
278__add_event(struct list_head *list, int *idx,
279 struct perf_event_attr *attr,
930a2e29
JO
280 char *name, struct cpu_map *cpus,
281 struct list_head *config_terms)
89812fc8
JO
282{
283 struct perf_evsel *evsel;
284
285 event_attr_init(attr);
286
ef503831 287 evsel = perf_evsel__new_idx(attr, (*idx)++);
c5cd8ac0 288 if (!evsel)
410136f5 289 return NULL;
89812fc8 290
fce4d296
AH
291 evsel->cpus = cpu_map__get(cpus);
292 evsel->own_cpus = cpu_map__get(cpus);
f30a79b0 293
9db1763c
ACM
294 if (name)
295 evsel->name = strdup(name);
930a2e29
JO
296
297 if (config_terms)
298 list_splice(config_terms, &evsel->config_terms);
299
b847cbdc 300 list_add_tail(&evsel->node, list);
410136f5 301 return evsel;
89812fc8
JO
302}
303
c5cd8ac0 304static int add_event(struct list_head *list, int *idx,
930a2e29
JO
305 struct perf_event_attr *attr, char *name,
306 struct list_head *config_terms)
7ae92e74 307{
930a2e29 308 return __add_event(list, idx, attr, name, NULL, config_terms) ? 0 : -ENOMEM;
7ae92e74
YZ
309}
310
0b668bc9 311static int parse_aliases(char *str, const char *names[][PERF_EVSEL__MAX_ALIASES], int size)
8326f44d
IM
312{
313 int i, j;
61c45981 314 int n, longest = -1;
8326f44d
IM
315
316 for (i = 0; i < size; i++) {
0b668bc9 317 for (j = 0; j < PERF_EVSEL__MAX_ALIASES && names[i][j]; j++) {
61c45981 318 n = strlen(names[i][j]);
89812fc8 319 if (n > longest && !strncasecmp(str, names[i][j], n))
61c45981
PM
320 longest = n;
321 }
89812fc8 322 if (longest > 0)
61c45981 323 return i;
8326f44d
IM
324 }
325
8953645f 326 return -1;
8326f44d
IM
327}
328
c5cd8ac0 329int parse_events_add_cache(struct list_head *list, int *idx,
89812fc8 330 char *type, char *op_result1, char *op_result2)
8326f44d 331{
89812fc8
JO
332 struct perf_event_attr attr;
333 char name[MAX_NAME_LEN];
61c45981 334 int cache_type = -1, cache_op = -1, cache_result = -1;
89812fc8
JO
335 char *op_result[2] = { op_result1, op_result2 };
336 int i, n;
8326f44d 337
8326f44d
IM
338 /*
339 * No fallback - if we cannot get a clear cache type
340 * then bail out:
341 */
0b668bc9 342 cache_type = parse_aliases(type, perf_evsel__hw_cache,
89812fc8 343 PERF_COUNT_HW_CACHE_MAX);
8326f44d 344 if (cache_type == -1)
89812fc8
JO
345 return -EINVAL;
346
347 n = snprintf(name, MAX_NAME_LEN, "%s", type);
61c45981 348
89812fc8
JO
349 for (i = 0; (i < 2) && (op_result[i]); i++) {
350 char *str = op_result[i];
351
275ef387 352 n += snprintf(name + n, MAX_NAME_LEN - n, "-%s", str);
61c45981
PM
353
354 if (cache_op == -1) {
0b668bc9 355 cache_op = parse_aliases(str, perf_evsel__hw_cache_op,
89812fc8 356 PERF_COUNT_HW_CACHE_OP_MAX);
61c45981 357 if (cache_op >= 0) {
0b668bc9 358 if (!perf_evsel__is_cache_op_valid(cache_type, cache_op))
89812fc8 359 return -EINVAL;
61c45981
PM
360 continue;
361 }
362 }
363
364 if (cache_result == -1) {
0b668bc9
ACM
365 cache_result = parse_aliases(str, perf_evsel__hw_cache_result,
366 PERF_COUNT_HW_CACHE_RESULT_MAX);
61c45981
PM
367 if (cache_result >= 0)
368 continue;
369 }
61c45981 370 }
8326f44d 371
8326f44d
IM
372 /*
373 * Fall back to reads:
374 */
8953645f
IM
375 if (cache_op == -1)
376 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
8326f44d 377
8326f44d
IM
378 /*
379 * Fall back to accesses:
380 */
381 if (cache_result == -1)
382 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
383
89812fc8
JO
384 memset(&attr, 0, sizeof(attr));
385 attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
386 attr.type = PERF_TYPE_HW_CACHE;
930a2e29 387 return add_event(list, idx, &attr, name, NULL);
bcd3279f
FW
388}
389
19658171
JO
390static void tracepoint_error(struct parse_events_error *error, int err,
391 char *sys, char *name)
392{
393 char help[BUFSIZ];
394
395 /*
396 * We get error directly from syscall errno ( > 0),
397 * or from encoded pointer's error ( < 0).
398 */
399 err = abs(err);
400
401 switch (err) {
402 case EACCES:
403 error->str = strdup("can't access trace events");
404 break;
405 case ENOENT:
406 error->str = strdup("unknown tracepoint");
407 break;
408 default:
409 error->str = strdup("failed to add tracepoint");
410 break;
411 }
412
413 tracing_path__strerror_open_tp(err, help, sizeof(help), sys, name);
414 error->help = strdup(help);
415}
416
c5cd8ac0 417static int add_tracepoint(struct list_head *list, int *idx,
e2f9f8ea
JO
418 char *sys_name, char *evt_name,
419 struct parse_events_error *error __maybe_unused)
bcd3279f 420{
82fe1c29 421 struct perf_evsel *evsel;
bcd3279f 422
ef503831 423 evsel = perf_evsel__newtp_idx(sys_name, evt_name, (*idx)++);
19658171
JO
424 if (IS_ERR(evsel)) {
425 tracepoint_error(error, PTR_ERR(evsel), sys_name, evt_name);
8dd2a131 426 return PTR_ERR(evsel);
19658171 427 }
bcd3279f 428
82fe1c29 429 list_add_tail(&evsel->node, list);
82fe1c29 430 return 0;
8326f44d
IM
431}
432
c5cd8ac0 433static int add_tracepoint_multi_event(struct list_head *list, int *idx,
e2f9f8ea
JO
434 char *sys_name, char *evt_name,
435 struct parse_events_error *error)
bcd3279f
FW
436{
437 char evt_path[MAXPATHLEN];
438 struct dirent *evt_ent;
439 DIR *evt_dir;
89812fc8 440 int ret = 0;
bcd3279f 441
ebf294bf 442 snprintf(evt_path, MAXPATHLEN, "%s/%s", tracing_events_path, sys_name);
bcd3279f 443 evt_dir = opendir(evt_path);
bcd3279f 444 if (!evt_dir) {
19658171 445 tracepoint_error(error, errno, sys_name, evt_name);
89812fc8 446 return -1;
bcd3279f
FW
447 }
448
89812fc8 449 while (!ret && (evt_ent = readdir(evt_dir))) {
bcd3279f
FW
450 if (!strcmp(evt_ent->d_name, ".")
451 || !strcmp(evt_ent->d_name, "..")
452 || !strcmp(evt_ent->d_name, "enable")
453 || !strcmp(evt_ent->d_name, "filter"))
454 continue;
455
89812fc8 456 if (!strglobmatch(evt_ent->d_name, evt_name))
fb1d2edf
MH
457 continue;
458
e2f9f8ea 459 ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name, error);
bcd3279f
FW
460 }
461
0bd3f084 462 closedir(evt_dir);
89812fc8 463 return ret;
bcd3279f
FW
464}
465
c5cd8ac0 466static int add_tracepoint_event(struct list_head *list, int *idx,
e2f9f8ea
JO
467 char *sys_name, char *evt_name,
468 struct parse_events_error *error)
f35488f9
JO
469{
470 return strpbrk(evt_name, "*?") ?
e2f9f8ea
JO
471 add_tracepoint_multi_event(list, idx, sys_name, evt_name, error) :
472 add_tracepoint(list, idx, sys_name, evt_name, error);
f35488f9
JO
473}
474
c5cd8ac0 475static int add_tracepoint_multi_sys(struct list_head *list, int *idx,
e2f9f8ea
JO
476 char *sys_name, char *evt_name,
477 struct parse_events_error *error)
f35488f9
JO
478{
479 struct dirent *events_ent;
480 DIR *events_dir;
481 int ret = 0;
482
483 events_dir = opendir(tracing_events_path);
484 if (!events_dir) {
19658171 485 tracepoint_error(error, errno, sys_name, evt_name);
f35488f9
JO
486 return -1;
487 }
488
489 while (!ret && (events_ent = readdir(events_dir))) {
490 if (!strcmp(events_ent->d_name, ".")
491 || !strcmp(events_ent->d_name, "..")
492 || !strcmp(events_ent->d_name, "enable")
493 || !strcmp(events_ent->d_name, "header_event")
494 || !strcmp(events_ent->d_name, "header_page"))
495 continue;
496
497 if (!strglobmatch(events_ent->d_name, sys_name))
498 continue;
499
500 ret = add_tracepoint_event(list, idx, events_ent->d_name,
e2f9f8ea 501 evt_name, error);
f35488f9
JO
502 }
503
504 closedir(events_dir);
505 return ret;
506}
507
c5cd8ac0 508int parse_events_add_tracepoint(struct list_head *list, int *idx,
e2f9f8ea
JO
509 char *sys, char *event,
510 struct parse_events_error *error)
f6bdafef 511{
f35488f9 512 if (strpbrk(sys, "*?"))
e2f9f8ea 513 return add_tracepoint_multi_sys(list, idx, sys, event, error);
f35488f9 514 else
e2f9f8ea 515 return add_tracepoint_event(list, idx, sys, event, error);
f6bdafef
JB
516}
517
89812fc8
JO
518static int
519parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
1b290d67
FW
520{
521 int i;
522
523 for (i = 0; i < 3; i++) {
89812fc8 524 if (!type || !type[i])
1b290d67
FW
525 break;
526
7582732f
JO
527#define CHECK_SET_TYPE(bit) \
528do { \
529 if (attr->bp_type & bit) \
530 return -EINVAL; \
531 else \
532 attr->bp_type |= bit; \
533} while (0)
534
1b290d67
FW
535 switch (type[i]) {
536 case 'r':
7582732f 537 CHECK_SET_TYPE(HW_BREAKPOINT_R);
1b290d67
FW
538 break;
539 case 'w':
7582732f 540 CHECK_SET_TYPE(HW_BREAKPOINT_W);
1b290d67
FW
541 break;
542 case 'x':
7582732f 543 CHECK_SET_TYPE(HW_BREAKPOINT_X);
1b290d67
FW
544 break;
545 default:
89812fc8 546 return -EINVAL;
1b290d67
FW
547 }
548 }
89812fc8 549
7582732f
JO
550#undef CHECK_SET_TYPE
551
1b290d67
FW
552 if (!attr->bp_type) /* Default */
553 attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
554
89812fc8 555 return 0;
1b290d67
FW
556}
557
c5cd8ac0 558int parse_events_add_breakpoint(struct list_head *list, int *idx,
3741eb9f 559 void *ptr, char *type, u64 len)
1b290d67 560{
89812fc8 561 struct perf_event_attr attr;
1b290d67 562
89812fc8 563 memset(&attr, 0, sizeof(attr));
9fafd98f 564 attr.bp_addr = (unsigned long) ptr;
1b290d67 565
89812fc8
JO
566 if (parse_breakpoint_type(type, &attr))
567 return -EINVAL;
1b290d67 568
3741eb9f
JS
569 /* Provide some defaults if len is not specified */
570 if (!len) {
571 if (attr.bp_type == HW_BREAKPOINT_X)
572 len = sizeof(long);
573 else
574 len = HW_BREAKPOINT_LEN_4;
575 }
576
577 attr.bp_len = len;
61c45981 578
89812fc8 579 attr.type = PERF_TYPE_BREAKPOINT;
4a841d65 580 attr.sample_period = 1;
b908debd 581
930a2e29 582 return add_event(list, idx, &attr, NULL, NULL);
74d5b588
JSR
583}
584
3b0e371c
JO
585static int check_type_val(struct parse_events_term *term,
586 struct parse_events_error *err,
587 int type)
588{
589 if (type == term->type_val)
590 return 0;
591
592 if (err) {
593 err->idx = term->err_val;
594 if (type == PARSE_EVENTS__TERM_TYPE_NUM)
595 err->str = strdup("expected numeric value");
596 else
597 err->str = strdup("expected string value");
598 }
599 return -EINVAL;
600}
601
0b8891a8
HK
602typedef int config_term_func_t(struct perf_event_attr *attr,
603 struct parse_events_term *term,
604 struct parse_events_error *err);
605
606static int config_term_common(struct perf_event_attr *attr,
607 struct parse_events_term *term,
608 struct parse_events_error *err)
8f707d84 609{
3b0e371c
JO
610#define CHECK_TYPE_VAL(type) \
611do { \
612 if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
613 return -EINVAL; \
16fa7e82
JO
614} while (0)
615
616 switch (term->type_term) {
8f707d84 617 case PARSE_EVENTS__TERM_TYPE_CONFIG:
16fa7e82 618 CHECK_TYPE_VAL(NUM);
8f707d84
JO
619 attr->config = term->val.num;
620 break;
621 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
16fa7e82 622 CHECK_TYPE_VAL(NUM);
8f707d84
JO
623 attr->config1 = term->val.num;
624 break;
625 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
16fa7e82 626 CHECK_TYPE_VAL(NUM);
8f707d84
JO
627 attr->config2 = term->val.num;
628 break;
629 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
16fa7e82 630 CHECK_TYPE_VAL(NUM);
8f707d84 631 break;
09af2a55
NK
632 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
633 CHECK_TYPE_VAL(NUM);
634 break;
8f707d84
JO
635 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
636 /*
637 * TODO uncomment when the field is available
638 * attr->branch_sample_type = term->val.num;
639 */
640 break;
32067712
KL
641 case PARSE_EVENTS__TERM_TYPE_TIME:
642 CHECK_TYPE_VAL(NUM);
643 if (term->val.num > 1) {
644 err->str = strdup("expected 0 or 1");
645 err->idx = term->err_val;
646 return -EINVAL;
647 }
648 break;
d457c963
KL
649 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
650 CHECK_TYPE_VAL(STR);
651 break;
652 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
653 CHECK_TYPE_VAL(NUM);
654 break;
6b5fc39b
JO
655 case PARSE_EVENTS__TERM_TYPE_NAME:
656 CHECK_TYPE_VAL(STR);
657 break;
8f707d84 658 default:
ffeb883e
HK
659 err->str = strdup("unknown term");
660 err->idx = term->err_term;
661 err->help = parse_events_formats_error_string(NULL);
8f707d84
JO
662 return -EINVAL;
663 }
16fa7e82 664
8f707d84 665 return 0;
16fa7e82 666#undef CHECK_TYPE_VAL
8f707d84
JO
667}
668
0b8891a8
HK
669static int config_term_pmu(struct perf_event_attr *attr,
670 struct parse_events_term *term,
671 struct parse_events_error *err)
672{
673 if (term->type_term == PARSE_EVENTS__TERM_TYPE_USER)
674 /*
675 * Always succeed for sysfs terms, as we dont know
676 * at this point what type they need to have.
677 */
678 return 0;
679 else
680 return config_term_common(attr, term, err);
681}
682
8f707d84 683static int config_attr(struct perf_event_attr *attr,
3b0e371c 684 struct list_head *head,
0b8891a8
HK
685 struct parse_events_error *err,
686 config_term_func_t config_term)
8f707d84 687{
6cee6cd3 688 struct parse_events_term *term;
8f707d84
JO
689
690 list_for_each_entry(term, head, list)
3b0e371c 691 if (config_term(attr, term, err))
8f707d84
JO
692 return -EINVAL;
693
694 return 0;
695}
696
930a2e29
JO
697static int get_config_terms(struct list_head *head_config,
698 struct list_head *head_terms __maybe_unused)
699{
700#define ADD_CONFIG_TERM(__type, __name, __val) \
701do { \
702 struct perf_evsel_config_term *__t; \
703 \
704 __t = zalloc(sizeof(*__t)); \
705 if (!__t) \
706 return -ENOMEM; \
707 \
708 INIT_LIST_HEAD(&__t->list); \
709 __t->type = PERF_EVSEL__CONFIG_TERM_ ## __type; \
710 __t->val.__name = __val; \
711 list_add_tail(&__t->list, head_terms); \
712} while (0)
713
714 struct parse_events_term *term;
715
716 list_for_each_entry(term, head_config, list) {
717 switch (term->type_term) {
ee4c7588
JO
718 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
719 ADD_CONFIG_TERM(PERIOD, period, term->val.num);
32067712 720 break;
09af2a55
NK
721 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
722 ADD_CONFIG_TERM(FREQ, freq, term->val.num);
723 break;
32067712
KL
724 case PARSE_EVENTS__TERM_TYPE_TIME:
725 ADD_CONFIG_TERM(TIME, time, term->val.num);
726 break;
d457c963
KL
727 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
728 ADD_CONFIG_TERM(CALLGRAPH, callgraph, term->val.str);
729 break;
730 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
731 ADD_CONFIG_TERM(STACK_USER, stack_user, term->val.num);
732 break;
930a2e29
JO
733 default:
734 break;
735 }
736 }
737#undef ADD_EVSEL_CONFIG
738 return 0;
739}
740
87d650be
JO
741int parse_events_add_numeric(struct parse_events_evlist *data,
742 struct list_head *list,
b527bab5 743 u32 type, u64 config,
8f707d84 744 struct list_head *head_config)
8ad8db37 745{
89812fc8 746 struct perf_event_attr attr;
930a2e29 747 LIST_HEAD(config_terms);
61c45981 748
89812fc8
JO
749 memset(&attr, 0, sizeof(attr));
750 attr.type = type;
751 attr.config = config;
8f707d84 752
930a2e29 753 if (head_config) {
0b8891a8
HK
754 if (config_attr(&attr, head_config, data->error,
755 config_term_common))
930a2e29
JO
756 return -EINVAL;
757
758 if (get_config_terms(head_config, &config_terms))
759 return -ENOMEM;
760 }
8f707d84 761
930a2e29 762 return add_event(list, &data->idx, &attr, NULL, &config_terms);
61c45981 763}
8ad8db37 764
6cee6cd3 765static int parse_events__is_name_term(struct parse_events_term *term)
6b5fc39b
JO
766{
767 return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
768}
769
9db1763c 770static char *pmu_event_name(struct list_head *head_terms)
6b5fc39b 771{
6cee6cd3 772 struct parse_events_term *term;
6b5fc39b
JO
773
774 list_for_each_entry(term, head_terms, list)
775 if (parse_events__is_name_term(term))
776 return term->val.str;
777
9db1763c 778 return NULL;
6b5fc39b
JO
779}
780
36adec85
JO
781int parse_events_add_pmu(struct parse_events_evlist *data,
782 struct list_head *list, char *name,
783 struct list_head *head_config)
5f537a26
JO
784{
785 struct perf_event_attr attr;
46441bdc 786 struct perf_pmu_info info;
5f537a26 787 struct perf_pmu *pmu;
410136f5 788 struct perf_evsel *evsel;
930a2e29 789 LIST_HEAD(config_terms);
5f537a26
JO
790
791 pmu = perf_pmu__find(name);
792 if (!pmu)
793 return -EINVAL;
794
dc0a6202
AH
795 if (pmu->default_config) {
796 memcpy(&attr, pmu->default_config,
797 sizeof(struct perf_event_attr));
798 } else {
799 memset(&attr, 0, sizeof(attr));
800 }
5f537a26 801
ad962273
AH
802 if (!head_config) {
803 attr.type = pmu->type;
930a2e29 804 evsel = __add_event(list, &data->idx, &attr, NULL, pmu->cpus, NULL);
ad962273
AH
805 return evsel ? 0 : -ENOMEM;
806 }
807
46441bdc 808 if (perf_pmu__check_alias(pmu, head_config, &info))
a6146d50
ZY
809 return -EINVAL;
810
5f537a26
JO
811 /*
812 * Configure hardcoded terms first, no need to check
813 * return value when called with fail == 0 ;)
814 */
0b8891a8 815 if (config_attr(&attr, head_config, data->error, config_term_pmu))
c056ba6a 816 return -EINVAL;
5f537a26 817
930a2e29
JO
818 if (get_config_terms(head_config, &config_terms))
819 return -ENOMEM;
820
e64b020b 821 if (perf_pmu__config(pmu, &attr, head_config, data->error))
5f537a26
JO
822 return -EINVAL;
823
36adec85 824 evsel = __add_event(list, &data->idx, &attr,
930a2e29
JO
825 pmu_event_name(head_config), pmu->cpus,
826 &config_terms);
410136f5 827 if (evsel) {
46441bdc
MF
828 evsel->unit = info.unit;
829 evsel->scale = info.scale;
044330c1 830 evsel->per_pkg = info.per_pkg;
1d9e446b 831 evsel->snapshot = info.snapshot;
410136f5
SE
832 }
833
834 return evsel ? 0 : -ENOMEM;
5f537a26
JO
835}
836
6a4bb04c
JO
837int parse_events__modifier_group(struct list_head *list,
838 char *event_mod)
89efb029 839{
6a4bb04c
JO
840 return parse_events__modifier_event(list, event_mod, true);
841}
842
63dab225 843void parse_events__set_leader(char *name, struct list_head *list)
6a4bb04c
JO
844{
845 struct perf_evsel *leader;
846
854f7363
WN
847 if (list_empty(list)) {
848 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
849 return;
850 }
851
63dab225
ACM
852 __perf_evlist__set_leader(list);
853 leader = list_entry(list->next, struct perf_evsel, node);
6a4bb04c 854 leader->group_name = name ? strdup(name) : NULL;
89efb029
JO
855}
856
c5cd8ac0 857/* list_event is assumed to point to malloc'ed memory */
5d7be90e
JO
858void parse_events_update_lists(struct list_head *list_event,
859 struct list_head *list_all)
860{
861 /*
862 * Called for single event definition. Update the
89efb029 863 * 'all event' list, and reinit the 'single event'
5d7be90e
JO
864 * list, for next event definition.
865 */
866 list_splice_tail(list_event, list_all);
b847cbdc 867 free(list_event);
5d7be90e
JO
868}
869
f5b1135b
JO
870struct event_modifier {
871 int eu;
872 int ek;
873 int eh;
874 int eH;
875 int eG;
a1e12da4 876 int eI;
f5b1135b
JO
877 int precise;
878 int exclude_GH;
3c176311 879 int sample_read;
e9a7c414 880 int pinned;
f5b1135b
JO
881};
882
883static int get_event_modifier(struct event_modifier *mod, char *str,
884 struct perf_evsel *evsel)
61c45981 885{
f5b1135b
JO
886 int eu = evsel ? evsel->attr.exclude_user : 0;
887 int ek = evsel ? evsel->attr.exclude_kernel : 0;
888 int eh = evsel ? evsel->attr.exclude_hv : 0;
889 int eH = evsel ? evsel->attr.exclude_host : 0;
890 int eG = evsel ? evsel->attr.exclude_guest : 0;
a1e12da4 891 int eI = evsel ? evsel->attr.exclude_idle : 0;
f5b1135b 892 int precise = evsel ? evsel->attr.precise_ip : 0;
3c176311 893 int sample_read = 0;
e9a7c414 894 int pinned = evsel ? evsel->attr.pinned : 0;
a21ca2ca 895
f5b1135b
JO
896 int exclude = eu | ek | eh;
897 int exclude_GH = evsel ? evsel->exclude_GH : 0;
898
f5b1135b 899 memset(mod, 0, sizeof(*mod));
ceb53fbf 900
61c45981 901 while (*str) {
ab608344
PZ
902 if (*str == 'u') {
903 if (!exclude)
904 exclude = eu = ek = eh = 1;
61c45981 905 eu = 0;
ab608344
PZ
906 } else if (*str == 'k') {
907 if (!exclude)
908 exclude = eu = ek = eh = 1;
61c45981 909 ek = 0;
ab608344
PZ
910 } else if (*str == 'h') {
911 if (!exclude)
912 exclude = eu = ek = eh = 1;
61c45981 913 eh = 0;
99320cc8
JR
914 } else if (*str == 'G') {
915 if (!exclude_GH)
916 exclude_GH = eG = eH = 1;
917 eG = 0;
918 } else if (*str == 'H') {
919 if (!exclude_GH)
920 exclude_GH = eG = eH = 1;
921 eH = 0;
a1e12da4
JO
922 } else if (*str == 'I') {
923 eI = 1;
ab608344
PZ
924 } else if (*str == 'p') {
925 precise++;
1342798c
DA
926 /* use of precise requires exclude_guest */
927 if (!exclude_GH)
928 eG = 1;
3c176311
JO
929 } else if (*str == 'S') {
930 sample_read = 1;
e9a7c414
ME
931 } else if (*str == 'D') {
932 pinned = 1;
ab608344 933 } else
61c45981 934 break;
ab608344 935
61c45981 936 ++str;
5242519b 937 }
ceb53fbf 938
89812fc8
JO
939 /*
940 * precise ip:
941 *
942 * 0 - SAMPLE_IP can have arbitrary skid
943 * 1 - SAMPLE_IP must have constant skid
944 * 2 - SAMPLE_IP requested to have 0 skid
945 * 3 - SAMPLE_IP must have 0 skid
946 *
947 * See also PERF_RECORD_MISC_EXACT_IP
948 */
949 if (precise > 3)
950 return -EINVAL;
ceb53fbf 951
f5b1135b
JO
952 mod->eu = eu;
953 mod->ek = ek;
954 mod->eh = eh;
955 mod->eH = eH;
956 mod->eG = eG;
a1e12da4 957 mod->eI = eI;
f5b1135b
JO
958 mod->precise = precise;
959 mod->exclude_GH = exclude_GH;
3c176311 960 mod->sample_read = sample_read;
e9a7c414
ME
961 mod->pinned = pinned;
962
f5b1135b
JO
963 return 0;
964}
965
534123f4
JO
966/*
967 * Basic modifier sanity check to validate it contains only one
968 * instance of any modifier (apart from 'p') present.
969 */
970static int check_modifier(char *str)
971{
972 char *p = str;
973
974 /* The sizeof includes 0 byte as well. */
a1e12da4 975 if (strlen(str) > (sizeof("ukhGHpppSDI") - 1))
534123f4
JO
976 return -1;
977
978 while (*p) {
979 if (*p != 'p' && strchr(p + 1, *p))
980 return -1;
981 p++;
982 }
983
984 return 0;
985}
986
f5b1135b
JO
987int parse_events__modifier_event(struct list_head *list, char *str, bool add)
988{
989 struct perf_evsel *evsel;
990 struct event_modifier mod;
991
992 if (str == NULL)
993 return 0;
994
534123f4
JO
995 if (check_modifier(str))
996 return -EINVAL;
997
f5b1135b
JO
998 if (!add && get_event_modifier(&mod, str, NULL))
999 return -EINVAL;
1000
0050f7aa 1001 __evlist__for_each(list, evsel) {
f5b1135b
JO
1002 if (add && get_event_modifier(&mod, str, evsel))
1003 return -EINVAL;
1004
1005 evsel->attr.exclude_user = mod.eu;
1006 evsel->attr.exclude_kernel = mod.ek;
1007 evsel->attr.exclude_hv = mod.eh;
1008 evsel->attr.precise_ip = mod.precise;
1009 evsel->attr.exclude_host = mod.eH;
1010 evsel->attr.exclude_guest = mod.eG;
a1e12da4 1011 evsel->attr.exclude_idle = mod.eI;
f5b1135b 1012 evsel->exclude_GH = mod.exclude_GH;
3c176311 1013 evsel->sample_read = mod.sample_read;
e9a7c414
ME
1014
1015 if (perf_evsel__is_group_leader(evsel))
1016 evsel->attr.pinned = mod.pinned;
89812fc8 1017 }
ceb53fbf 1018
61c45981
PM
1019 return 0;
1020}
8ad8db37 1021
ac2ba9f3
RR
1022int parse_events_name(struct list_head *list, char *name)
1023{
1024 struct perf_evsel *evsel;
1025
0050f7aa 1026 __evlist__for_each(list, evsel) {
ac2ba9f3
RR
1027 if (!evsel->name)
1028 evsel->name = strdup(name);
1029 }
1030
1031 return 0;
1032}
1033
dcb4e102
KL
1034static int
1035comp_pmu(const void *p1, const void *p2)
1036{
1037 struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
1038 struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;
1039
1040 return strcmp(pmu1->symbol, pmu2->symbol);
1041}
1042
1043static void perf_pmu__parse_cleanup(void)
1044{
1045 if (perf_pmu_events_list_num > 0) {
1046 struct perf_pmu_event_symbol *p;
1047 int i;
1048
1049 for (i = 0; i < perf_pmu_events_list_num; i++) {
1050 p = perf_pmu_events_list + i;
1051 free(p->symbol);
1052 }
1053 free(perf_pmu_events_list);
1054 perf_pmu_events_list = NULL;
1055 perf_pmu_events_list_num = 0;
1056 }
1057}
1058
1059#define SET_SYMBOL(str, stype) \
1060do { \
1061 p->symbol = str; \
1062 if (!p->symbol) \
1063 goto err; \
1064 p->type = stype; \
1065} while (0)
1066
1067/*
1068 * Read the pmu events list from sysfs
1069 * Save it into perf_pmu_events_list
1070 */
1071static void perf_pmu__parse_init(void)
1072{
1073
1074 struct perf_pmu *pmu = NULL;
1075 struct perf_pmu_alias *alias;
1076 int len = 0;
1077
1078 pmu = perf_pmu__find("cpu");
1079 if ((pmu == NULL) || list_empty(&pmu->aliases)) {
1080 perf_pmu_events_list_num = -1;
1081 return;
1082 }
1083 list_for_each_entry(alias, &pmu->aliases, list) {
1084 if (strchr(alias->name, '-'))
1085 len++;
1086 len++;
1087 }
1088 perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
1089 if (!perf_pmu_events_list)
1090 return;
1091 perf_pmu_events_list_num = len;
1092
1093 len = 0;
1094 list_for_each_entry(alias, &pmu->aliases, list) {
1095 struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
1096 char *tmp = strchr(alias->name, '-');
1097
1098 if (tmp != NULL) {
1099 SET_SYMBOL(strndup(alias->name, tmp - alias->name),
1100 PMU_EVENT_SYMBOL_PREFIX);
1101 p++;
1102 SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
1103 len += 2;
1104 } else {
1105 SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
1106 len++;
1107 }
1108 }
1109 qsort(perf_pmu_events_list, len,
1110 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1111
1112 return;
1113err:
1114 perf_pmu__parse_cleanup();
1115}
1116
1117enum perf_pmu_event_symbol_type
1118perf_pmu__parse_check(const char *name)
1119{
1120 struct perf_pmu_event_symbol p, *r;
1121
1122 /* scan kernel pmu events from sysfs if needed */
1123 if (perf_pmu_events_list_num == 0)
1124 perf_pmu__parse_init();
1125 /*
1126 * name "cpu" could be prefix of cpu-cycles or cpu// events.
1127 * cpu-cycles has been handled by hardcode.
1128 * So it must be cpu// events, not kernel pmu event.
1129 */
1130 if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
1131 return PMU_EVENT_SYMBOL_ERR;
1132
1133 p.symbol = strdup(name);
1134 r = bsearch(&p, perf_pmu_events_list,
1135 (size_t) perf_pmu_events_list_num,
1136 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1137 free(p.symbol);
1138 return r ? r->type : PMU_EVENT_SYMBOL_ERR;
1139}
1140
90e2b22d 1141static int parse_events__scanner(const char *str, void *data, int start_token)
61c45981 1142{
89812fc8 1143 YY_BUFFER_STATE buffer;
ac20de6f 1144 void *scanner;
46010ab2 1145 int ret;
bcd3279f 1146
90e2b22d 1147 ret = parse_events_lex_init_extra(start_token, &scanner);
ac20de6f
ZY
1148 if (ret)
1149 return ret;
1150
1151 buffer = parse_events__scan_string(str, scanner);
a21ca2ca 1152
82ba1f2f
JO
1153#ifdef PARSER_DEBUG
1154 parse_events_debug = 1;
1155#endif
ac20de6f
ZY
1156 ret = parse_events_parse(data, scanner);
1157
1158 parse_events__flush_buffer(buffer, scanner);
1159 parse_events__delete_buffer(buffer, scanner);
1160 parse_events_lex_destroy(scanner);
1161 return ret;
1162}
bcd3279f 1163
90e2b22d
JO
1164/*
1165 * parse event config string, return a list of event terms.
1166 */
1167int parse_events_terms(struct list_head *terms, const char *str)
1168{
23b6339b 1169 struct parse_events_terms data = {
90e2b22d
JO
1170 .terms = NULL,
1171 };
1172 int ret;
1173
1174 ret = parse_events__scanner(str, &data, PE_START_TERMS);
1175 if (!ret) {
1176 list_splice(data.terms, terms);
74cf249d 1177 zfree(&data.terms);
90e2b22d
JO
1178 return 0;
1179 }
1180
b2c34fde
AH
1181 if (data.terms)
1182 parse_events__free_terms(data.terms);
90e2b22d
JO
1183 return ret;
1184}
1185
b39b8393
JO
1186int parse_events(struct perf_evlist *evlist, const char *str,
1187 struct parse_events_error *err)
ac20de6f 1188{
23b6339b 1189 struct parse_events_evlist data = {
b39b8393
JO
1190 .list = LIST_HEAD_INIT(data.list),
1191 .idx = evlist->nr_entries,
1192 .error = err,
ac20de6f
ZY
1193 };
1194 int ret;
bcd3279f 1195
90e2b22d 1196 ret = parse_events__scanner(str, &data, PE_START_EVENTS);
dcb4e102 1197 perf_pmu__parse_cleanup();
89812fc8 1198 if (!ret) {
15bfd2cc
WN
1199 struct perf_evsel *last;
1200
854f7363
WN
1201 if (list_empty(&data.list)) {
1202 WARN_ONCE(true, "WARNING: event parser found nothing");
1203 return -1;
1204 }
1205
f114d6ef 1206 perf_evlist__splice_list_tail(evlist, &data.list);
97f63e4a 1207 evlist->nr_groups += data.nr_groups;
15bfd2cc
WN
1208 last = perf_evlist__last(evlist);
1209 last->cmdline_group_boundary = true;
1210
89812fc8
JO
1211 return 0;
1212 }
bcd3279f 1213
5d7be90e
JO
1214 /*
1215 * There are 2 users - builtin-record and builtin-test objects.
1216 * Both call perf_evlist__delete in case of error, so we dont
1217 * need to bother.
1218 */
bcd3279f 1219 return ret;
8ad8db37
IM
1220}
1221
b39b8393
JO
1222#define MAX_WIDTH 1000
1223static int get_term_width(void)
1224{
1225 struct winsize ws;
1226
1227 get_term_dimensions(&ws);
1228 return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
1229}
1230
1231static void parse_events_print_error(struct parse_events_error *err,
1232 const char *event)
1233{
1234 const char *str = "invalid or unsupported event: ";
1235 char _buf[MAX_WIDTH];
1236 char *buf = (char *) event;
1237 int idx = 0;
1238
1239 if (err->str) {
1240 /* -2 for extra '' in the final fprintf */
1241 int width = get_term_width() - 2;
1242 int len_event = strlen(event);
1243 int len_str, max_len, cut = 0;
1244
1245 /*
1246 * Maximum error index indent, we will cut
1247 * the event string if it's bigger.
1248 */
141b2d31 1249 int max_err_idx = 13;
b39b8393
JO
1250
1251 /*
1252 * Let's be specific with the message when
1253 * we have the precise error.
1254 */
1255 str = "event syntax error: ";
1256 len_str = strlen(str);
1257 max_len = width - len_str;
1258
1259 buf = _buf;
1260
1261 /* We're cutting from the beggining. */
1262 if (err->idx > max_err_idx)
1263 cut = err->idx - max_err_idx;
1264
1265 strncpy(buf, event + cut, max_len);
1266
1267 /* Mark cut parts with '..' on both sides. */
1268 if (cut)
1269 buf[0] = buf[1] = '.';
1270
1271 if ((len_event - cut) > max_len) {
1272 buf[max_len - 1] = buf[max_len - 2] = '.';
1273 buf[max_len] = 0;
1274 }
1275
1276 idx = len_str + err->idx - cut;
1277 }
1278
1279 fprintf(stderr, "%s'%s'\n", str, buf);
1280 if (idx) {
1281 fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err->str);
1282 if (err->help)
1283 fprintf(stderr, "\n%s\n", err->help);
1284 free(err->str);
1285 free(err->help);
1286 }
1287
1288 fprintf(stderr, "Run 'perf list' for a list of valid events\n");
1289}
1290
1291#undef MAX_WIDTH
1292
f120f9d5 1293int parse_events_option(const struct option *opt, const char *str,
1d037ca1 1294 int unset __maybe_unused)
f120f9d5
JO
1295{
1296 struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
b39b8393
JO
1297 struct parse_events_error err = { .idx = 0, };
1298 int ret = parse_events(evlist, str, &err);
1299
1300 if (ret)
1301 parse_events_print_error(&err, str);
9175ce1f 1302
9175ce1f 1303 return ret;
f120f9d5
JO
1304}
1305
4ba1faa1
WN
1306static int
1307foreach_evsel_in_last_glob(struct perf_evlist *evlist,
1308 int (*func)(struct perf_evsel *evsel,
1309 const void *arg),
1310 const void *arg)
c171b552 1311{
69aad6f1 1312 struct perf_evsel *last = NULL;
4ba1faa1 1313 int err;
c171b552 1314
854f7363
WN
1315 /*
1316 * Don't return when list_empty, give func a chance to report
1317 * error when it found last == NULL.
1318 *
1319 * So no need to WARN here, let *func do this.
1320 */
361c99a6 1321 if (evlist->nr_entries > 0)
0c21f736 1322 last = perf_evlist__last(evlist);
69aad6f1 1323
15bfd2cc 1324 do {
4ba1faa1
WN
1325 err = (*func)(last, arg);
1326 if (err)
15bfd2cc 1327 return -1;
4ba1faa1
WN
1328 if (!last)
1329 return 0;
15bfd2cc
WN
1330
1331 if (last->node.prev == &evlist->entries)
1332 return 0;
1333 last = list_entry(last->node.prev, struct perf_evsel, node);
1334 } while (!last->cmdline_group_boundary);
c171b552
LZ
1335
1336 return 0;
1337}
1338
4ba1faa1
WN
1339static int set_filter(struct perf_evsel *evsel, const void *arg)
1340{
1341 const char *str = arg;
1342
1343 if (evsel == NULL || evsel->attr.type != PERF_TYPE_TRACEPOINT) {
1344 fprintf(stderr,
1345 "--filter option should follow a -e tracepoint option\n");
1346 return -1;
1347 }
1348
1349 if (perf_evsel__append_filter(evsel, "&&", str) < 0) {
1350 fprintf(stderr,
1351 "not enough memory to hold filter string\n");
1352 return -1;
1353 }
1354
1355 return 0;
1356}
1357
1358int parse_filter(const struct option *opt, const char *str,
1359 int unset __maybe_unused)
1360{
1361 struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1362
1363 return foreach_evsel_in_last_glob(evlist, set_filter,
1364 (const void *)str);
1365}
1366
1367static int add_exclude_perf_filter(struct perf_evsel *evsel,
1368 const void *arg __maybe_unused)
1369{
1370 char new_filter[64];
1371
1372 if (evsel == NULL || evsel->attr.type != PERF_TYPE_TRACEPOINT) {
1373 fprintf(stderr,
1374 "--exclude-perf option should follow a -e tracepoint option\n");
1375 return -1;
1376 }
1377
1378 snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());
1379
1380 if (perf_evsel__append_filter(evsel, "&&", new_filter) < 0) {
1381 fprintf(stderr,
1382 "not enough memory to hold filter string\n");
1383 return -1;
1384 }
1385
1386 return 0;
1387}
1388
1389int exclude_perf(const struct option *opt,
1390 const char *arg __maybe_unused,
1391 int unset __maybe_unused)
1392{
1393 struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1394
1395 return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
1396 NULL);
1397}
1398
86847b62 1399static const char * const event_type_descriptors[] = {
86847b62
TG
1400 "Hardware event",
1401 "Software event",
1402 "Tracepoint event",
1403 "Hardware cache event",
41bdcb23
LW
1404 "Raw hardware event descriptor",
1405 "Hardware breakpoint",
86847b62
TG
1406};
1407
ab0e4800
YS
1408static int cmp_string(const void *a, const void *b)
1409{
1410 const char * const *as = a;
1411 const char * const *bs = b;
1412
1413 return strcmp(*as, *bs);
1414}
1415
f6bdafef
JB
1416/*
1417 * Print the events from <debugfs_mount_point>/tracing/events
1418 */
1419
a3277d2d
FW
1420void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
1421 bool name_only)
f6bdafef
JB
1422{
1423 DIR *sys_dir, *evt_dir;
1424 struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
f6bdafef 1425 char evt_path[MAXPATHLEN];
725b1368 1426 char dir_path[MAXPATHLEN];
ab0e4800
YS
1427 char **evt_list = NULL;
1428 unsigned int evt_i = 0, evt_num = 0;
1429 bool evt_num_known = false;
f6bdafef 1430
ab0e4800 1431restart:
ebf294bf 1432 sys_dir = opendir(tracing_events_path);
f6bdafef 1433 if (!sys_dir)
725b1368 1434 return;
6b58e7f1 1435
ab0e4800
YS
1436 if (evt_num_known) {
1437 evt_list = zalloc(sizeof(char *) * evt_num);
1438 if (!evt_list)
1439 goto out_close_sys_dir;
1440 }
1441
6b58e7f1 1442 for_each_subsystem(sys_dir, sys_dirent, sys_next) {
48000a1a 1443 if (subsys_glob != NULL &&
668b8788
ACM
1444 !strglobmatch(sys_dirent.d_name, subsys_glob))
1445 continue;
725b1368 1446
ebf294bf 1447 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
725b1368
ED
1448 sys_dirent.d_name);
1449 evt_dir = opendir(dir_path);
1450 if (!evt_dir)
6b58e7f1 1451 continue;
725b1368 1452
6b58e7f1 1453 for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
48000a1a 1454 if (event_glob != NULL &&
668b8788
ACM
1455 !strglobmatch(evt_dirent.d_name, event_glob))
1456 continue;
1457
ab0e4800
YS
1458 if (!evt_num_known) {
1459 evt_num++;
a3277d2d
FW
1460 continue;
1461 }
1462
f6bdafef
JB
1463 snprintf(evt_path, MAXPATHLEN, "%s:%s",
1464 sys_dirent.d_name, evt_dirent.d_name);
ab0e4800
YS
1465
1466 evt_list[evt_i] = strdup(evt_path);
1467 if (evt_list[evt_i] == NULL)
1468 goto out_close_evt_dir;
1469 evt_i++;
f6bdafef
JB
1470 }
1471 closedir(evt_dir);
1472 }
f6bdafef 1473 closedir(sys_dir);
ab0e4800
YS
1474
1475 if (!evt_num_known) {
1476 evt_num_known = true;
1477 goto restart;
1478 }
1479 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
1480 evt_i = 0;
1481 while (evt_i < evt_num) {
1482 if (name_only) {
1483 printf("%s ", evt_list[evt_i++]);
1484 continue;
1485 }
1486 printf(" %-50s [%s]\n", evt_list[evt_i++],
1487 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
1488 }
1489 if (evt_num)
1490 printf("\n");
1491
1492out_free:
1493 evt_num = evt_i;
1494 for (evt_i = 0; evt_i < evt_num; evt_i++)
1495 zfree(&evt_list[evt_i]);
1496 zfree(&evt_list);
1497 return;
1498
1499out_close_evt_dir:
1500 closedir(evt_dir);
1501out_close_sys_dir:
1502 closedir(sys_dir);
1503
1504 printf("FATAL: not enough memory to print %s\n",
1505 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
1506 if (evt_list)
1507 goto out_free;
f6bdafef
JB
1508}
1509
20c457b8
TR
1510/*
1511 * Check whether event is in <debugfs_mount_point>/tracing/events
1512 */
1513
1514int is_valid_tracepoint(const char *event_string)
1515{
1516 DIR *sys_dir, *evt_dir;
1517 struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
1518 char evt_path[MAXPATHLEN];
1519 char dir_path[MAXPATHLEN];
1520
ebf294bf 1521 sys_dir = opendir(tracing_events_path);
20c457b8
TR
1522 if (!sys_dir)
1523 return 0;
1524
1525 for_each_subsystem(sys_dir, sys_dirent, sys_next) {
1526
ebf294bf 1527 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
20c457b8
TR
1528 sys_dirent.d_name);
1529 evt_dir = opendir(dir_path);
1530 if (!evt_dir)
1531 continue;
1532
1533 for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
1534 snprintf(evt_path, MAXPATHLEN, "%s:%s",
1535 sys_dirent.d_name, evt_dirent.d_name);
1536 if (!strcmp(evt_path, event_string)) {
1537 closedir(evt_dir);
1538 closedir(sys_dir);
1539 return 1;
1540 }
1541 }
1542 closedir(evt_dir);
1543 }
1544 closedir(sys_dir);
1545 return 0;
1546}
1547
b41f1cec
NK
1548static bool is_event_supported(u8 type, unsigned config)
1549{
1550 bool ret = true;
88fee52e 1551 int open_return;
b41f1cec
NK
1552 struct perf_evsel *evsel;
1553 struct perf_event_attr attr = {
1554 .type = type,
1555 .config = config,
1556 .disabled = 1,
b41f1cec
NK
1557 };
1558 struct {
1559 struct thread_map map;
1560 int threads[1];
1561 } tmap = {
1562 .map.nr = 1,
1563 .threads = { 0 },
1564 };
1565
ef503831 1566 evsel = perf_evsel__new(&attr);
b41f1cec 1567 if (evsel) {
88fee52e
VW
1568 open_return = perf_evsel__open(evsel, NULL, &tmap.map);
1569 ret = open_return >= 0;
1570
1571 if (open_return == -EACCES) {
1572 /*
1573 * This happens if the paranoid value
1574 * /proc/sys/kernel/perf_event_paranoid is set to 2
1575 * Re-run with exclude_kernel set; we don't do that
1576 * by default as some ARM machines do not support it.
1577 *
1578 */
1579 evsel->attr.exclude_kernel = 1;
1580 ret = perf_evsel__open(evsel, NULL, &tmap.map) >= 0;
1581 }
b41f1cec
NK
1582 perf_evsel__delete(evsel);
1583 }
1584
1585 return ret;
1586}
1587
a3277d2d 1588int print_hwcache_events(const char *event_glob, bool name_only)
668b8788 1589{
ab0e4800 1590 unsigned int type, op, i, evt_i = 0, evt_num = 0;
0b668bc9 1591 char name[64];
ab0e4800
YS
1592 char **evt_list = NULL;
1593 bool evt_num_known = false;
1594
1595restart:
1596 if (evt_num_known) {
1597 evt_list = zalloc(sizeof(char *) * evt_num);
1598 if (!evt_list)
1599 goto out_enomem;
1600 }
668b8788
ACM
1601
1602 for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
1603 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
1604 /* skip invalid cache type */
0b668bc9 1605 if (!perf_evsel__is_cache_op_valid(type, op))
668b8788
ACM
1606 continue;
1607
1608 for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
0b668bc9
ACM
1609 __perf_evsel__hw_cache_type_op_res_name(type, op, i,
1610 name, sizeof(name));
947b4ad1 1611 if (event_glob != NULL && !strglobmatch(name, event_glob))
668b8788
ACM
1612 continue;
1613
b41f1cec
NK
1614 if (!is_event_supported(PERF_TYPE_HW_CACHE,
1615 type | (op << 8) | (i << 16)))
1616 continue;
1617
ab0e4800
YS
1618 if (!evt_num_known) {
1619 evt_num++;
1620 continue;
1621 }
1622
1623 evt_list[evt_i] = strdup(name);
1624 if (evt_list[evt_i] == NULL)
1625 goto out_enomem;
1626 evt_i++;
668b8788
ACM
1627 }
1628 }
1629 }
1630
ab0e4800
YS
1631 if (!evt_num_known) {
1632 evt_num_known = true;
1633 goto restart;
1634 }
1635 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
1636 evt_i = 0;
1637 while (evt_i < evt_num) {
1638 if (name_only) {
1639 printf("%s ", evt_list[evt_i++]);
1640 continue;
1641 }
1642 printf(" %-50s [%s]\n", evt_list[evt_i++],
1643 event_type_descriptors[PERF_TYPE_HW_CACHE]);
1644 }
1645 if (evt_num)
dc098b35 1646 printf("\n");
ab0e4800
YS
1647
1648out_free:
1649 evt_num = evt_i;
1650 for (evt_i = 0; evt_i < evt_num; evt_i++)
1651 zfree(&evt_list[evt_i]);
1652 zfree(&evt_list);
1653 return evt_num;
1654
1655out_enomem:
1656 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[PERF_TYPE_HW_CACHE]);
1657 if (evt_list)
1658 goto out_free;
1659 return evt_num;
668b8788
ACM
1660}
1661
705750f2 1662void print_symbol_events(const char *event_glob, unsigned type,
a3277d2d
FW
1663 struct event_symbol *syms, unsigned max,
1664 bool name_only)
8ad8db37 1665{
ab0e4800 1666 unsigned int i, evt_i = 0, evt_num = 0;
947b4ad1 1667 char name[MAX_NAME_LEN];
ab0e4800
YS
1668 char **evt_list = NULL;
1669 bool evt_num_known = false;
1670
1671restart:
1672 if (evt_num_known) {
1673 evt_list = zalloc(sizeof(char *) * evt_num);
1674 if (!evt_list)
1675 goto out_enomem;
1676 syms -= max;
1677 }
8ad8db37 1678
1dc12760 1679 for (i = 0; i < max; i++, syms++) {
668b8788 1680
48000a1a 1681 if (event_glob != NULL &&
668b8788
ACM
1682 !(strglobmatch(syms->symbol, event_glob) ||
1683 (syms->alias && strglobmatch(syms->alias, event_glob))))
1684 continue;
8ad8db37 1685
b41f1cec
NK
1686 if (!is_event_supported(type, i))
1687 continue;
1688
ab0e4800
YS
1689 if (!evt_num_known) {
1690 evt_num++;
a3277d2d
FW
1691 continue;
1692 }
1693
ab0e4800 1694 if (!name_only && strlen(syms->alias))
947b4ad1 1695 snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
74d5b588 1696 else
947b4ad1 1697 strncpy(name, syms->symbol, MAX_NAME_LEN);
8ad8db37 1698
ab0e4800
YS
1699 evt_list[evt_i] = strdup(name);
1700 if (evt_list[evt_i] == NULL)
1701 goto out_enomem;
1702 evt_i++;
8ad8db37
IM
1703 }
1704
ab0e4800
YS
1705 if (!evt_num_known) {
1706 evt_num_known = true;
1707 goto restart;
1708 }
1709 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
1710 evt_i = 0;
1711 while (evt_i < evt_num) {
1712 if (name_only) {
1713 printf("%s ", evt_list[evt_i++]);
1714 continue;
1715 }
1716 printf(" %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
1717 }
1718 if (evt_num)
668b8788 1719 printf("\n");
ab0e4800
YS
1720
1721out_free:
1722 evt_num = evt_i;
1723 for (evt_i = 0; evt_i < evt_num; evt_i++)
1724 zfree(&evt_list[evt_i]);
1725 zfree(&evt_list);
1726 return;
1727
1728out_enomem:
1729 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
1730 if (evt_list)
1731 goto out_free;
1dc12760
JO
1732}
1733
1734/*
1735 * Print the help text for the event symbols:
1736 */
a3277d2d 1737void print_events(const char *event_glob, bool name_only)
1dc12760 1738{
1dc12760 1739 print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
a3277d2d 1740 event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
1dc12760
JO
1741
1742 print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
a3277d2d 1743 event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
1dc12760 1744
a3277d2d 1745 print_hwcache_events(event_glob, name_only);
668b8788 1746
dc098b35
AK
1747 print_pmu_events(event_glob, name_only);
1748
668b8788
ACM
1749 if (event_glob != NULL)
1750 return;
73c24cb8 1751
a3277d2d 1752 if (!name_only) {
a3277d2d
FW
1753 printf(" %-50s [%s]\n",
1754 "rNNN",
1755 event_type_descriptors[PERF_TYPE_RAW]);
1756 printf(" %-50s [%s]\n",
1757 "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
1758 event_type_descriptors[PERF_TYPE_RAW]);
af3df2cf 1759 printf(" (see 'man perf-list' on how to encode it)\n");
a3277d2d
FW
1760 printf("\n");
1761
1762 printf(" %-50s [%s]\n",
3741eb9f 1763 "mem:<addr>[/len][:access]",
41bdcb23 1764 event_type_descriptors[PERF_TYPE_BREAKPOINT]);
a3277d2d
FW
1765 printf("\n");
1766 }
1b290d67 1767
a3277d2d 1768 print_tracepoint_events(NULL, NULL, name_only);
8ad8db37 1769}
8f707d84 1770
6cee6cd3 1771int parse_events__is_hardcoded_term(struct parse_events_term *term)
8f707d84 1772{
16fa7e82 1773 return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
8f707d84
JO
1774}
1775
6cee6cd3 1776static int new_term(struct parse_events_term **_term, int type_val,
16fa7e82 1777 int type_term, char *config,
cecf3a2e 1778 char *str, u64 num, int err_term, int err_val)
8f707d84 1779{
6cee6cd3 1780 struct parse_events_term *term;
8f707d84
JO
1781
1782 term = zalloc(sizeof(*term));
1783 if (!term)
1784 return -ENOMEM;
1785
1786 INIT_LIST_HEAD(&term->list);
16fa7e82
JO
1787 term->type_val = type_val;
1788 term->type_term = type_term;
8f707d84 1789 term->config = config;
cecf3a2e
JO
1790 term->err_term = err_term;
1791 term->err_val = err_val;
8f707d84 1792
16fa7e82 1793 switch (type_val) {
8f707d84
JO
1794 case PARSE_EVENTS__TERM_TYPE_NUM:
1795 term->val.num = num;
1796 break;
1797 case PARSE_EVENTS__TERM_TYPE_STR:
1798 term->val.str = str;
1799 break;
1800 default:
4be8be6b 1801 free(term);
8f707d84
JO
1802 return -EINVAL;
1803 }
1804
1805 *_term = term;
1806 return 0;
1807}
1808
6cee6cd3 1809int parse_events_term__num(struct parse_events_term **term,
cecf3a2e 1810 int type_term, char *config, u64 num,
bb78ce7d 1811 void *loc_term_, void *loc_val_)
16fa7e82 1812{
bb78ce7d
AH
1813 YYLTYPE *loc_term = loc_term_;
1814 YYLTYPE *loc_val = loc_val_;
1815
16fa7e82 1816 return new_term(term, PARSE_EVENTS__TERM_TYPE_NUM, type_term,
cecf3a2e
JO
1817 config, NULL, num,
1818 loc_term ? loc_term->first_column : 0,
1819 loc_val ? loc_val->first_column : 0);
16fa7e82
JO
1820}
1821
6cee6cd3 1822int parse_events_term__str(struct parse_events_term **term,
cecf3a2e 1823 int type_term, char *config, char *str,
bb78ce7d 1824 void *loc_term_, void *loc_val_)
16fa7e82 1825{
bb78ce7d
AH
1826 YYLTYPE *loc_term = loc_term_;
1827 YYLTYPE *loc_val = loc_val_;
1828
16fa7e82 1829 return new_term(term, PARSE_EVENTS__TERM_TYPE_STR, type_term,
cecf3a2e
JO
1830 config, str, 0,
1831 loc_term ? loc_term->first_column : 0,
1832 loc_val ? loc_val->first_column : 0);
16fa7e82
JO
1833}
1834
6cee6cd3 1835int parse_events_term__sym_hw(struct parse_events_term **term,
1d33d6dc
JO
1836 char *config, unsigned idx)
1837{
1838 struct event_symbol *sym;
1839
1840 BUG_ON(idx >= PERF_COUNT_HW_MAX);
1841 sym = &event_symbols_hw[idx];
1842
1843 if (config)
1844 return new_term(term, PARSE_EVENTS__TERM_TYPE_STR,
1845 PARSE_EVENTS__TERM_TYPE_USER, config,
cecf3a2e 1846 (char *) sym->symbol, 0, 0, 0);
1d33d6dc
JO
1847 else
1848 return new_term(term, PARSE_EVENTS__TERM_TYPE_STR,
1849 PARSE_EVENTS__TERM_TYPE_USER,
cecf3a2e
JO
1850 (char *) "event", (char *) sym->symbol,
1851 0, 0, 0);
1d33d6dc
JO
1852}
1853
6cee6cd3
ACM
1854int parse_events_term__clone(struct parse_events_term **new,
1855 struct parse_events_term *term)
a6146d50
ZY
1856{
1857 return new_term(new, term->type_val, term->type_term, term->config,
cecf3a2e
JO
1858 term->val.str, term->val.num,
1859 term->err_term, term->err_val);
a6146d50
ZY
1860}
1861
8f707d84
JO
1862void parse_events__free_terms(struct list_head *terms)
1863{
6cee6cd3 1864 struct parse_events_term *term, *h;
8f707d84
JO
1865
1866 list_for_each_entry_safe(term, h, terms, list)
1867 free(term);
8f707d84 1868}
b39b8393
JO
1869
1870void parse_events_evlist_error(struct parse_events_evlist *data,
1871 int idx, const char *str)
1872{
1873 struct parse_events_error *err = data->error;
1874
a6ced2be
AH
1875 if (!err)
1876 return;
b39b8393
JO
1877 err->idx = idx;
1878 err->str = strdup(str);
1879 WARN_ONCE(!err->str, "WARNING: failed to allocate error string");
1880}
ffeb883e
HK
1881
1882/*
1883 * Return string contains valid config terms of an event.
1884 * @additional_terms: For terms such as PMU sysfs terms.
1885 */
1886char *parse_events_formats_error_string(char *additional_terms)
1887{
1888 char *str;
1889 static const char *static_terms = "config,config1,config2,name,"
1890 "period,freq,branch_type,time,"
1891 "call-graph,stack-size\n";
1892
1893 /* valid terms */
1894 if (additional_terms) {
1895 if (!asprintf(&str, "valid terms: %s,%s",
1896 additional_terms, static_terms))
1897 goto fail;
1898 } else {
1899 if (!asprintf(&str, "valid terms: %s", static_terms))
1900 goto fail;
1901 }
1902 return str;
1903
1904fail:
1905 return NULL;
1906}