perf script: Fix event ordering settings to work with older kernels
[linux-2.6-block.git] / tools / perf / util / probe-event.c
CommitLineData
50656eec 1/*
0e60836b 2 * probe-event.c : perf-probe definition to probe_events format converter
50656eec
MH
3 *
4 * Written by Masami Hiramatsu <mhiramat@redhat.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 *
20 */
21
22#define _GNU_SOURCE
23#include <sys/utsname.h>
24#include <sys/types.h>
25#include <sys/stat.h>
26#include <fcntl.h>
27#include <errno.h>
28#include <stdio.h>
29#include <unistd.h>
30#include <stdlib.h>
31#include <string.h>
4de189fe
MH
32#include <stdarg.h>
33#include <limits.h>
50656eec
MH
34
35#undef _GNU_SOURCE
31facc5f 36#include "util.h"
50656eec 37#include "event.h"
e1c01d61 38#include "string.h"
4de189fe 39#include "strlist.h"
50656eec 40#include "debug.h"
72041334 41#include "cache.h"
631c9def 42#include "color.h"
e0faa8d3
MH
43#include "symbol.h"
44#include "thread.h"
7ca5989d 45#include "debugfs.h"
4b4da7f7 46#include "trace-event.h" /* For __unused */
50656eec 47#include "probe-event.h"
4235b045 48#include "probe-finder.h"
50656eec
MH
49
50#define MAX_CMDLEN 256
51#define MAX_PROBE_ARGS 128
52#define PERFPROBE_GROUP "probe"
53
f4d7da49
MH
54bool probe_event_dry_run; /* Dry run flag */
55
146a1439 56#define semantic_error(msg ...) pr_err("Semantic error :" msg)
50656eec 57
4de189fe 58/* If there is no space to write, returns -E2BIG. */
84988450
MH
59static int e_snprintf(char *str, size_t size, const char *format, ...)
60 __attribute__((format(printf, 3, 4)));
61
4de189fe
MH
62static int e_snprintf(char *str, size_t size, const char *format, ...)
63{
64 int ret;
65 va_list ap;
66 va_start(ap, format);
67 ret = vsnprintf(str, size, format, ap);
68 va_end(ap);
69 if (ret >= (int)size)
70 ret = -E2BIG;
71 return ret;
72}
73
4b4da7f7 74static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
d28c6223 75static struct machine machine;
e0faa8d3 76
469b9b88 77/* Initialize symbol maps and path of vmlinux/modules */
146a1439 78static int init_vmlinux(void)
e0faa8d3 79{
146a1439
MH
80 int ret;
81
e0faa8d3
MH
82 symbol_conf.sort_by_name = true;
83 if (symbol_conf.vmlinux_name == NULL)
84 symbol_conf.try_vmlinux_path = true;
85 else
86 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
146a1439
MH
87 ret = symbol__init();
88 if (ret < 0) {
89 pr_debug("Failed to init symbol map.\n");
90 goto out;
91 }
e0faa8d3 92
469b9b88 93 ret = machine__init(&machine, "", HOST_KERNEL_ID);
d28c6223
ACM
94 if (ret < 0)
95 goto out;
96
469b9b88 97 if (machine__create_kernel_maps(&machine) < 0) {
0e43e5d2 98 pr_debug("machine__create_kernel_maps() failed.\n");
469b9b88
MH
99 goto out;
100 }
146a1439
MH
101out:
102 if (ret < 0)
103 pr_warning("Failed to init vmlinux path.\n");
104 return ret;
e0faa8d3
MH
105}
106
469b9b88
MH
107static struct symbol *__find_kernel_function_by_name(const char *name,
108 struct map **mapp)
109{
110 return machine__find_kernel_function_by_name(&machine, name, mapp,
111 NULL);
112}
113
114const char *kernel_get_module_path(const char *module)
115{
116 struct dso *dso;
117
118 if (module) {
119 list_for_each_entry(dso, &machine.kernel_dsos, node) {
120 if (strncmp(dso->short_name + 1, module,
121 dso->short_name_len - 2) == 0)
122 goto found;
123 }
124 pr_debug("Failed to find module %s.\n", module);
125 return NULL;
126 } else {
127 dso = machine.vmlinux_maps[MAP__FUNCTION]->dso;
128 if (dso__load_vmlinux_path(dso,
129 machine.vmlinux_maps[MAP__FUNCTION], NULL) < 0) {
130 pr_debug("Failed to load kernel map.\n");
131 return NULL;
132 }
133 }
134found:
135 return dso->long_name;
136}
137
4b4da7f7 138#ifdef DWARF_SUPPORT
469b9b88 139static int open_vmlinux(const char *module)
e0faa8d3 140{
469b9b88
MH
141 const char *path = kernel_get_module_path(module);
142 if (!path) {
0e43e5d2
MH
143 pr_err("Failed to find path of %s module.\n",
144 module ?: "kernel");
469b9b88 145 return -ENOENT;
e0faa8d3 146 }
469b9b88
MH
147 pr_debug("Try to open %s\n", path);
148 return open(path, O_RDONLY);
e0faa8d3 149}
4b4da7f7 150
0e60836b
SD
151/*
152 * Convert trace point to probe point with debuginfo
153 * Currently only handles kprobes.
154 */
155static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
469b9b88 156 struct perf_probe_point *pp)
4b4da7f7
MH
157{
158 struct symbol *sym;
469b9b88
MH
159 struct map *map;
160 u64 addr;
161 int ret = -ENOENT;
4b4da7f7 162
469b9b88 163 sym = __find_kernel_function_by_name(tp->symbol, &map);
4b4da7f7 164 if (sym) {
469b9b88
MH
165 addr = map->unmap_ip(map, sym->start + tp->offset);
166 pr_debug("try to find %s+%ld@%llx\n", tp->symbol,
167 tp->offset, addr);
168 ret = find_perf_probe_point((unsigned long)addr, pp);
4b4da7f7
MH
169 }
170 if (ret <= 0) {
146a1439
MH
171 pr_debug("Failed to find corresponding probes from "
172 "debuginfo. Use kprobe event information.\n");
02b95dad
MH
173 pp->function = strdup(tp->symbol);
174 if (pp->function == NULL)
175 return -ENOMEM;
4b4da7f7
MH
176 pp->offset = tp->offset;
177 }
178 pp->retprobe = tp->retprobe;
146a1439
MH
179
180 return 0;
4b4da7f7
MH
181}
182
183/* Try to find perf_probe_event with debuginfo */
0e60836b
SD
184static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
185 struct probe_trace_event **tevs,
469b9b88 186 int max_tevs, const char *module)
4b4da7f7
MH
187{
188 bool need_dwarf = perf_probe_event_need_dwarf(pev);
189 int fd, ntevs;
190
469b9b88 191 fd = open_vmlinux(module);
4b4da7f7 192 if (fd < 0) {
146a1439
MH
193 if (need_dwarf) {
194 pr_warning("Failed to open debuginfo file.\n");
195 return fd;
196 }
4b4da7f7
MH
197 pr_debug("Could not open vmlinux. Try to use symbols.\n");
198 return 0;
199 }
200
201 /* Searching trace events corresponding to probe event */
0e60836b 202 ntevs = find_probe_trace_events(fd, pev, tevs, max_tevs);
4b4da7f7
MH
203 close(fd);
204
146a1439 205 if (ntevs > 0) { /* Succeeded to find trace events */
0e60836b 206 pr_debug("find %d probe_trace_events.\n", ntevs);
4b4da7f7 207 return ntevs;
146a1439 208 }
4b4da7f7 209
146a1439
MH
210 if (ntevs == 0) { /* No error but failed to find probe point. */
211 pr_warning("Probe point '%s' not found.\n",
212 synthesize_perf_probe_point(&pev->point));
213 return -ENOENT;
214 }
215 /* Error path : ntevs < 0 */
15eca306
MH
216 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
217 if (ntevs == -EBADF) {
218 pr_warning("Warning: No dwarf info found in the vmlinux - "
219 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
220 if (!need_dwarf) {
0e43e5d2 221 pr_debug("Trying to use symbols.\n");
15eca306
MH
222 return 0;
223 }
4b4da7f7 224 }
15eca306 225 return ntevs;
4b4da7f7
MH
226}
227
7cf0b79e
MH
228/*
229 * Find a src file from a DWARF tag path. Prepend optional source path prefix
230 * and chop off leading directories that do not exist. Result is passed back as
231 * a newly allocated path on success.
232 * Return 0 if file was found and readable, -errno otherwise.
233 */
6a330a3c
MH
234static int get_real_path(const char *raw_path, const char *comp_dir,
235 char **new_path)
7cf0b79e 236{
6a330a3c
MH
237 const char *prefix = symbol_conf.source_prefix;
238
239 if (!prefix) {
240 if (raw_path[0] != '/' && comp_dir)
241 /* If not an absolute path, try to use comp_dir */
242 prefix = comp_dir;
243 else {
244 if (access(raw_path, R_OK) == 0) {
245 *new_path = strdup(raw_path);
246 return 0;
247 } else
248 return -errno;
249 }
7cf0b79e
MH
250 }
251
6a330a3c 252 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
7cf0b79e
MH
253 if (!*new_path)
254 return -ENOMEM;
255
256 for (;;) {
6a330a3c 257 sprintf(*new_path, "%s/%s", prefix, raw_path);
7cf0b79e
MH
258
259 if (access(*new_path, R_OK) == 0)
260 return 0;
261
6a330a3c
MH
262 if (!symbol_conf.source_prefix)
263 /* In case of searching comp_dir, don't retry */
264 return -errno;
265
7cf0b79e
MH
266 switch (errno) {
267 case ENAMETOOLONG:
268 case ENOENT:
269 case EROFS:
270 case EFAULT:
271 raw_path = strchr(++raw_path, '/');
272 if (!raw_path) {
273 free(*new_path);
274 *new_path = NULL;
275 return -ENOENT;
276 }
277 continue;
278
279 default:
280 free(*new_path);
281 *new_path = NULL;
282 return -errno;
283 }
284 }
285}
286
4b4da7f7
MH
287#define LINEBUF_SIZE 256
288#define NR_ADDITIONAL_LINES 2
289
fde52dbd 290static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
4b4da7f7
MH
291{
292 char buf[LINEBUF_SIZE];
befe3414
FBH
293 const char *color = show_num ? "" : PERF_COLOR_BLUE;
294 const char *prefix = NULL;
4b4da7f7 295
befe3414 296 do {
4b4da7f7
MH
297 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
298 goto error;
befe3414
FBH
299 if (skip)
300 continue;
301 if (!prefix) {
302 prefix = show_num ? "%7d " : " ";
303 color_fprintf(stdout, color, prefix, l);
4b4da7f7 304 }
befe3414
FBH
305 color_fprintf(stdout, color, "%s", buf);
306
307 } while (strchr(buf, '\n') == NULL);
146a1439 308
fde52dbd 309 return 1;
4b4da7f7 310error:
fde52dbd 311 if (ferror(fp)) {
32b2b6ec 312 pr_warning("File read error: %s\n", strerror(errno));
fde52dbd
FBH
313 return -1;
314 }
315 return 0;
316}
146a1439 317
fde52dbd
FBH
318static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
319{
320 int rv = __show_one_line(fp, l, skip, show_num);
321 if (rv == 0) {
322 pr_warning("Source file is shorter than expected.\n");
323 rv = -1;
324 }
325 return rv;
4b4da7f7
MH
326}
327
fde52dbd
FBH
328#define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
329#define show_one_line(f,l) _show_one_line(f,l,false,false)
330#define skip_one_line(f,l) _show_one_line(f,l,true,false)
331#define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
332
4b4da7f7
MH
333/*
334 * Show line-range always requires debuginfo to find source file and
335 * line number.
336 */
469b9b88 337int show_line_range(struct line_range *lr, const char *module)
4b4da7f7 338{
d3b63d7a 339 int l = 1;
4b4da7f7
MH
340 struct line_node *ln;
341 FILE *fp;
342 int fd, ret;
7cf0b79e 343 char *tmp;
4b4da7f7
MH
344
345 /* Search a line range */
146a1439
MH
346 ret = init_vmlinux();
347 if (ret < 0)
348 return ret;
349
469b9b88 350 fd = open_vmlinux(module);
146a1439
MH
351 if (fd < 0) {
352 pr_warning("Failed to open debuginfo file.\n");
353 return fd;
354 }
355
4b4da7f7 356 ret = find_line_range(fd, lr);
4b4da7f7 357 close(fd);
146a1439
MH
358 if (ret == 0) {
359 pr_warning("Specified source line is not found.\n");
360 return -ENOENT;
361 } else if (ret < 0) {
362 pr_warning("Debuginfo analysis failed. (%d)\n", ret);
363 return ret;
364 }
4b4da7f7 365
7cf0b79e
MH
366 /* Convert source file path */
367 tmp = lr->path;
6a330a3c 368 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
7cf0b79e
MH
369 free(tmp); /* Free old path */
370 if (ret < 0) {
371 pr_warning("Failed to find source file. (%d)\n", ret);
372 return ret;
373 }
374
4b4da7f7
MH
375 setup_pager();
376
377 if (lr->function)
378 fprintf(stdout, "<%s:%d>\n", lr->function,
379 lr->start - lr->offset);
380 else
62c15fc4 381 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
4b4da7f7
MH
382
383 fp = fopen(lr->path, "r");
146a1439
MH
384 if (fp == NULL) {
385 pr_warning("Failed to open %s: %s\n", lr->path,
386 strerror(errno));
387 return -errno;
388 }
4b4da7f7 389 /* Skip to starting line number */
44b81e92 390 while (l < lr->start) {
fde52dbd 391 ret = skip_one_line(fp, l++);
44b81e92
FBH
392 if (ret < 0)
393 goto end;
394 }
4b4da7f7
MH
395
396 list_for_each_entry(ln, &lr->line_list, list) {
44b81e92 397 for (; ln->line > l; l++) {
fde52dbd 398 ret = show_one_line(fp, l - lr->offset);
44b81e92
FBH
399 if (ret < 0)
400 goto end;
401 }
fde52dbd 402 ret = show_one_line_with_num(fp, l++ - lr->offset);
146a1439
MH
403 if (ret < 0)
404 goto end;
4b4da7f7
MH
405 }
406
407 if (lr->end == INT_MAX)
408 lr->end = l + NR_ADDITIONAL_LINES;
fde52dbd
FBH
409 while (l <= lr->end) {
410 ret = show_one_line_or_eof(fp, l++ - lr->offset);
411 if (ret <= 0)
44b81e92
FBH
412 break;
413 }
146a1439 414end:
4b4da7f7 415 fclose(fp);
146a1439 416 return ret;
4b4da7f7
MH
417}
418
cf6eb489 419static int show_available_vars_at(int fd, struct perf_probe_event *pev,
fb8c5a56 420 int max_vls, bool externs)
cf6eb489
MH
421{
422 char *buf;
423 int ret, i;
424 struct str_node *node;
425 struct variable_list *vls = NULL, *vl;
426
427 buf = synthesize_perf_probe_point(&pev->point);
428 if (!buf)
429 return -EINVAL;
430 pr_debug("Searching variables at %s\n", buf);
431
fb8c5a56 432 ret = find_available_vars_at(fd, pev, &vls, max_vls, externs);
cf6eb489
MH
433 if (ret > 0) {
434 /* Some variables were found */
435 fprintf(stdout, "Available variables at %s\n", buf);
436 for (i = 0; i < ret; i++) {
437 vl = &vls[i];
438 /*
439 * A probe point might be converted to
440 * several trace points.
441 */
442 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
443 vl->point.offset);
444 free(vl->point.symbol);
445 if (vl->vars) {
446 strlist__for_each(node, vl->vars)
447 fprintf(stdout, "\t\t%s\n", node->s);
448 strlist__delete(vl->vars);
449 } else
450 fprintf(stdout, "(No variables)\n");
451 }
452 free(vls);
453 } else
454 pr_err("Failed to find variables at %s (%d)\n", buf, ret);
455
456 free(buf);
457 return ret;
458}
459
460/* Show available variables on given probe point */
461int show_available_vars(struct perf_probe_event *pevs, int npevs,
469b9b88 462 int max_vls, const char *module, bool externs)
cf6eb489
MH
463{
464 int i, fd, ret = 0;
465
466 ret = init_vmlinux();
467 if (ret < 0)
468 return ret;
469
469b9b88 470 fd = open_vmlinux(module);
cf6eb489 471 if (fd < 0) {
0e43e5d2 472 pr_warning("Failed to open debug information file.\n");
cf6eb489
MH
473 return fd;
474 }
475
476 setup_pager();
477
478 for (i = 0; i < npevs && ret >= 0; i++)
fb8c5a56 479 ret = show_available_vars_at(fd, &pevs[i], max_vls, externs);
cf6eb489
MH
480
481 close(fd);
482 return ret;
483}
484
4b4da7f7
MH
485#else /* !DWARF_SUPPORT */
486
0e60836b 487static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
469b9b88 488 struct perf_probe_point *pp)
4b4da7f7 489{
469b9b88
MH
490 struct symbol *sym;
491
492 sym = __find_kernel_function_by_name(tp->symbol, NULL);
493 if (!sym) {
494 pr_err("Failed to find symbol %s in kernel.\n", tp->symbol);
495 return -ENOENT;
496 }
02b95dad
MH
497 pp->function = strdup(tp->symbol);
498 if (pp->function == NULL)
499 return -ENOMEM;
4b4da7f7
MH
500 pp->offset = tp->offset;
501 pp->retprobe = tp->retprobe;
146a1439
MH
502
503 return 0;
4b4da7f7
MH
504}
505
0e60836b
SD
506static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
507 struct probe_trace_event **tevs __unused,
469b9b88 508 int max_tevs __unused, const char *mod __unused)
4b4da7f7 509{
146a1439
MH
510 if (perf_probe_event_need_dwarf(pev)) {
511 pr_warning("Debuginfo-analysis is not supported.\n");
512 return -ENOSYS;
513 }
4b4da7f7
MH
514 return 0;
515}
516
469b9b88 517int show_line_range(struct line_range *lr __unused, const char *module __unused)
4b4da7f7 518{
146a1439
MH
519 pr_warning("Debuginfo-analysis is not supported.\n");
520 return -ENOSYS;
4b4da7f7
MH
521}
522
cf6eb489 523int show_available_vars(struct perf_probe_event *pevs __unused,
469b9b88
MH
524 int npevs __unused, int max_vls __unused,
525 const char *module __unused, bool externs __unused)
cf6eb489
MH
526{
527 pr_warning("Debuginfo-analysis is not supported.\n");
528 return -ENOSYS;
529}
e0faa8d3
MH
530#endif
531
21dd9ae5
FBH
532static int parse_line_num(char **ptr, int *val, const char *what)
533{
534 const char *start = *ptr;
535
536 errno = 0;
537 *val = strtol(*ptr, ptr, 0);
538 if (errno || *ptr == start) {
539 semantic_error("'%s' is not a valid number.\n", what);
540 return -EINVAL;
541 }
542 return 0;
543}
544
9d95b580
FBH
545/*
546 * Stuff 'lr' according to the line range described by 'arg'.
547 * The line range syntax is described by:
548 *
549 * SRC[:SLN[+NUM|-ELN]]
550 * FNC[:SLN[+NUM|-ELN]]
551 */
146a1439 552int parse_line_range_desc(const char *arg, struct line_range *lr)
631c9def 553{
21dd9ae5
FBH
554 char *range, *name = strdup(arg);
555 int err;
556
557 if (!name)
558 return -ENOMEM;
559
560 lr->start = 0;
561 lr->end = INT_MAX;
562
563 range = strchr(name, ':');
564 if (range) {
565 *range++ = '\0';
566
567 err = parse_line_num(&range, &lr->start, "start line");
568 if (err)
569 goto err;
570
571 if (*range == '+' || *range == '-') {
572 const char c = *range++;
573
574 err = parse_line_num(&range, &lr->end, "end line");
575 if (err)
576 goto err;
577
578 if (c == '+') {
579 lr->end += lr->start;
580 /*
581 * Adjust the number of lines here.
582 * If the number of lines == 1, the
583 * the end of line should be equal to
584 * the start of line.
585 */
586 lr->end--;
587 }
588 }
9d95b580 589
d3b63d7a 590 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
21dd9ae5
FBH
591
592 err = -EINVAL;
d3b63d7a 593 if (lr->start > lr->end) {
631c9def 594 semantic_error("Start line must be smaller"
146a1439 595 " than end line.\n");
21dd9ae5 596 goto err;
146a1439 597 }
21dd9ae5
FBH
598 if (*range != '\0') {
599 semantic_error("Tailing with invalid str '%s'.\n", range);
600 goto err;
146a1439 601 }
d3b63d7a 602 }
02b95dad 603
21dd9ae5
FBH
604 if (strchr(name, '.'))
605 lr->file = name;
631c9def 606 else
21dd9ae5 607 lr->function = name;
146a1439
MH
608
609 return 0;
21dd9ae5
FBH
610err:
611 free(name);
612 return err;
631c9def
MH
613}
614
b7702a21
MH
615/* Check the name is good for event/group */
616static bool check_event_name(const char *name)
617{
618 if (!isalpha(*name) && *name != '_')
619 return false;
620 while (*++name != '\0') {
621 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
622 return false;
623 }
624 return true;
625}
626
50656eec 627/* Parse probepoint definition. */
146a1439 628static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
50656eec 629{
4235b045 630 struct perf_probe_point *pp = &pev->point;
50656eec
MH
631 char *ptr, *tmp;
632 char c, nc = 0;
633 /*
634 * <Syntax>
2a9c8c36
MH
635 * perf probe [EVENT=]SRC[:LN|;PTN]
636 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
af663d75
MH
637 *
638 * TODO:Group name support
50656eec
MH
639 */
640
2a9c8c36
MH
641 ptr = strpbrk(arg, ";=@+%");
642 if (ptr && *ptr == '=') { /* Event name */
af663d75
MH
643 *ptr = '\0';
644 tmp = ptr + 1;
146a1439
MH
645 if (strchr(arg, ':')) {
646 semantic_error("Group name is not supported yet.\n");
647 return -ENOTSUP;
648 }
649 if (!check_event_name(arg)) {
b7702a21 650 semantic_error("%s is bad for event name -it must "
146a1439
MH
651 "follow C symbol-naming rule.\n", arg);
652 return -EINVAL;
653 }
02b95dad
MH
654 pev->event = strdup(arg);
655 if (pev->event == NULL)
656 return -ENOMEM;
4235b045 657 pev->group = NULL;
af663d75
MH
658 arg = tmp;
659 }
660
2a9c8c36 661 ptr = strpbrk(arg, ";:+@%");
50656eec
MH
662 if (ptr) {
663 nc = *ptr;
664 *ptr++ = '\0';
665 }
666
02b95dad
MH
667 tmp = strdup(arg);
668 if (tmp == NULL)
669 return -ENOMEM;
670
50656eec 671 /* Check arg is function or file and copy it */
02b95dad
MH
672 if (strchr(tmp, '.')) /* File */
673 pp->file = tmp;
50656eec 674 else /* Function */
02b95dad 675 pp->function = tmp;
50656eec
MH
676
677 /* Parse other options */
678 while (ptr) {
679 arg = ptr;
680 c = nc;
2a9c8c36 681 if (c == ';') { /* Lazy pattern must be the last part */
02b95dad
MH
682 pp->lazy_line = strdup(arg);
683 if (pp->lazy_line == NULL)
684 return -ENOMEM;
2a9c8c36
MH
685 break;
686 }
687 ptr = strpbrk(arg, ";:+@%");
50656eec
MH
688 if (ptr) {
689 nc = *ptr;
690 *ptr++ = '\0';
691 }
692 switch (c) {
693 case ':': /* Line number */
694 pp->line = strtoul(arg, &tmp, 0);
146a1439 695 if (*tmp != '\0') {
2a9c8c36 696 semantic_error("There is non-digit char"
146a1439
MH
697 " in line number.\n");
698 return -EINVAL;
699 }
50656eec
MH
700 break;
701 case '+': /* Byte offset from a symbol */
702 pp->offset = strtoul(arg, &tmp, 0);
146a1439 703 if (*tmp != '\0') {
2a9c8c36 704 semantic_error("There is non-digit character"
146a1439
MH
705 " in offset.\n");
706 return -EINVAL;
707 }
50656eec
MH
708 break;
709 case '@': /* File name */
146a1439
MH
710 if (pp->file) {
711 semantic_error("SRC@SRC is not allowed.\n");
712 return -EINVAL;
713 }
02b95dad
MH
714 pp->file = strdup(arg);
715 if (pp->file == NULL)
716 return -ENOMEM;
50656eec
MH
717 break;
718 case '%': /* Probe places */
719 if (strcmp(arg, "return") == 0) {
720 pp->retprobe = 1;
146a1439
MH
721 } else { /* Others not supported yet */
722 semantic_error("%%%s is not supported.\n", arg);
723 return -ENOTSUP;
724 }
50656eec 725 break;
146a1439
MH
726 default: /* Buggy case */
727 pr_err("This program has a bug at %s:%d.\n",
728 __FILE__, __LINE__);
729 return -ENOTSUP;
50656eec
MH
730 break;
731 }
732 }
733
734 /* Exclusion check */
146a1439 735 if (pp->lazy_line && pp->line) {
0e43e5d2
MH
736 semantic_error("Lazy pattern can't be used with"
737 " line number.\n");
146a1439
MH
738 return -EINVAL;
739 }
2a9c8c36 740
146a1439 741 if (pp->lazy_line && pp->offset) {
0e43e5d2 742 semantic_error("Lazy pattern can't be used with offset.\n");
146a1439
MH
743 return -EINVAL;
744 }
2a9c8c36 745
146a1439 746 if (pp->line && pp->offset) {
0e43e5d2 747 semantic_error("Offset can't be used with line number.\n");
146a1439
MH
748 return -EINVAL;
749 }
50656eec 750
146a1439 751 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
2a9c8c36 752 semantic_error("File always requires line number or "
0e43e5d2 753 "lazy pattern.\n");
146a1439
MH
754 return -EINVAL;
755 }
50656eec 756
146a1439 757 if (pp->offset && !pp->function) {
0e43e5d2 758 semantic_error("Offset requires an entry function.\n");
146a1439
MH
759 return -EINVAL;
760 }
50656eec 761
146a1439 762 if (pp->retprobe && !pp->function) {
0e43e5d2 763 semantic_error("Return probe requires an entry function.\n");
146a1439
MH
764 return -EINVAL;
765 }
50656eec 766
146a1439 767 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
2a9c8c36 768 semantic_error("Offset/Line/Lazy pattern can't be used with "
0e43e5d2 769 "return probe.\n");
146a1439
MH
770 return -EINVAL;
771 }
50656eec 772
4235b045 773 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
2a9c8c36
MH
774 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
775 pp->lazy_line);
146a1439 776 return 0;
50656eec
MH
777}
778
7df2f329 779/* Parse perf-probe event argument */
146a1439 780static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
7df2f329 781{
b2a3c12b 782 char *tmp, *goodname;
7df2f329
MH
783 struct perf_probe_arg_field **fieldp;
784
785 pr_debug("parsing arg: %s into ", str);
786
48481938
MH
787 tmp = strchr(str, '=');
788 if (tmp) {
02b95dad
MH
789 arg->name = strndup(str, tmp - str);
790 if (arg->name == NULL)
791 return -ENOMEM;
11a1ca35 792 pr_debug("name:%s ", arg->name);
48481938
MH
793 str = tmp + 1;
794 }
795
11a1ca35
MH
796 tmp = strchr(str, ':');
797 if (tmp) { /* Type setting */
798 *tmp = '\0';
02b95dad
MH
799 arg->type = strdup(tmp + 1);
800 if (arg->type == NULL)
801 return -ENOMEM;
11a1ca35
MH
802 pr_debug("type:%s ", arg->type);
803 }
804
b2a3c12b 805 tmp = strpbrk(str, "-.[");
7df2f329
MH
806 if (!is_c_varname(str) || !tmp) {
807 /* A variable, register, symbol or special value */
02b95dad
MH
808 arg->var = strdup(str);
809 if (arg->var == NULL)
810 return -ENOMEM;
48481938 811 pr_debug("%s\n", arg->var);
146a1439 812 return 0;
7df2f329
MH
813 }
814
b2a3c12b 815 /* Structure fields or array element */
02b95dad
MH
816 arg->var = strndup(str, tmp - str);
817 if (arg->var == NULL)
818 return -ENOMEM;
b2a3c12b 819 goodname = arg->var;
48481938 820 pr_debug("%s, ", arg->var);
7df2f329
MH
821 fieldp = &arg->field;
822
823 do {
e334016f
MH
824 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
825 if (*fieldp == NULL)
826 return -ENOMEM;
b2a3c12b
MH
827 if (*tmp == '[') { /* Array */
828 str = tmp;
829 (*fieldp)->index = strtol(str + 1, &tmp, 0);
7df2f329 830 (*fieldp)->ref = true;
b2a3c12b
MH
831 if (*tmp != ']' || tmp == str + 1) {
832 semantic_error("Array index must be a"
833 " number.\n");
834 return -EINVAL;
835 }
836 tmp++;
837 if (*tmp == '\0')
838 tmp = NULL;
839 } else { /* Structure */
840 if (*tmp == '.') {
841 str = tmp + 1;
842 (*fieldp)->ref = false;
843 } else if (tmp[1] == '>') {
844 str = tmp + 2;
845 (*fieldp)->ref = true;
846 } else {
847 semantic_error("Argument parse error: %s\n",
848 str);
849 return -EINVAL;
850 }
851 tmp = strpbrk(str, "-.[");
146a1439 852 }
7df2f329 853 if (tmp) {
02b95dad
MH
854 (*fieldp)->name = strndup(str, tmp - str);
855 if ((*fieldp)->name == NULL)
856 return -ENOMEM;
b2a3c12b
MH
857 if (*str != '[')
858 goodname = (*fieldp)->name;
7df2f329
MH
859 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
860 fieldp = &(*fieldp)->next;
861 }
862 } while (tmp);
02b95dad
MH
863 (*fieldp)->name = strdup(str);
864 if ((*fieldp)->name == NULL)
865 return -ENOMEM;
b2a3c12b
MH
866 if (*str != '[')
867 goodname = (*fieldp)->name;
7df2f329 868 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
df0faf4b 869
b2a3c12b 870 /* If no name is specified, set the last field name (not array index)*/
02b95dad 871 if (!arg->name) {
b2a3c12b 872 arg->name = strdup(goodname);
02b95dad
MH
873 if (arg->name == NULL)
874 return -ENOMEM;
875 }
146a1439 876 return 0;
7df2f329
MH
877}
878
4235b045 879/* Parse perf-probe event command */
146a1439 880int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
50656eec 881{
e1c01d61 882 char **argv;
146a1439 883 int argc, i, ret = 0;
fac13fd5 884
4235b045 885 argv = argv_split(cmd, &argc);
146a1439
MH
886 if (!argv) {
887 pr_debug("Failed to split arguments.\n");
888 return -ENOMEM;
889 }
890 if (argc - 1 > MAX_PROBE_ARGS) {
891 semantic_error("Too many probe arguments (%d).\n", argc - 1);
892 ret = -ERANGE;
893 goto out;
894 }
50656eec 895 /* Parse probe point */
146a1439
MH
896 ret = parse_perf_probe_point(argv[0], pev);
897 if (ret < 0)
898 goto out;
50656eec 899
e1c01d61 900 /* Copy arguments and ensure return probe has no C argument */
4235b045 901 pev->nargs = argc - 1;
e334016f
MH
902 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
903 if (pev->args == NULL) {
904 ret = -ENOMEM;
905 goto out;
906 }
146a1439
MH
907 for (i = 0; i < pev->nargs && ret >= 0; i++) {
908 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
909 if (ret >= 0 &&
910 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
4235b045 911 semantic_error("You can't specify local variable for"
146a1439
MH
912 " kretprobe.\n");
913 ret = -EINVAL;
914 }
e1c01d61 915 }
146a1439 916out:
e1c01d61 917 argv_free(argv);
146a1439
MH
918
919 return ret;
50656eec
MH
920}
921
4235b045
MH
922/* Return true if this perf_probe_event requires debuginfo */
923bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
924{
925 int i;
926
927 if (pev->point.file || pev->point.line || pev->point.lazy_line)
928 return true;
929
930 for (i = 0; i < pev->nargs; i++)
48481938 931 if (is_c_varname(pev->args[i].var))
4235b045
MH
932 return true;
933
934 return false;
935}
936
0e60836b
SD
937/* Parse probe_events event into struct probe_point */
938static int parse_probe_trace_command(const char *cmd,
939 struct probe_trace_event *tev)
4de189fe 940{
0e60836b 941 struct probe_trace_point *tp = &tev->point;
4de189fe
MH
942 char pr;
943 char *p;
944 int ret, i, argc;
945 char **argv;
946
0e60836b 947 pr_debug("Parsing probe_events: %s\n", cmd);
4235b045 948 argv = argv_split(cmd, &argc);
146a1439
MH
949 if (!argv) {
950 pr_debug("Failed to split arguments.\n");
951 return -ENOMEM;
952 }
953 if (argc < 2) {
954 semantic_error("Too few probe arguments.\n");
955 ret = -ERANGE;
956 goto out;
957 }
4de189fe
MH
958
959 /* Scan event and group name. */
93aaa45a 960 ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
4235b045
MH
961 &pr, (float *)(void *)&tev->group,
962 (float *)(void *)&tev->event);
146a1439
MH
963 if (ret != 3) {
964 semantic_error("Failed to parse event name: %s\n", argv[0]);
965 ret = -EINVAL;
966 goto out;
967 }
4235b045 968 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
4de189fe 969
4235b045 970 tp->retprobe = (pr == 'r');
4de189fe
MH
971
972 /* Scan function name and offset */
4235b045
MH
973 ret = sscanf(argv[1], "%a[^+]+%lu", (float *)(void *)&tp->symbol,
974 &tp->offset);
4de189fe 975 if (ret == 1)
4235b045 976 tp->offset = 0;
4de189fe 977
4235b045 978 tev->nargs = argc - 2;
0e60836b 979 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
e334016f
MH
980 if (tev->args == NULL) {
981 ret = -ENOMEM;
982 goto out;
983 }
4235b045 984 for (i = 0; i < tev->nargs; i++) {
4de189fe
MH
985 p = strchr(argv[i + 2], '=');
986 if (p) /* We don't need which register is assigned. */
4235b045
MH
987 *p++ = '\0';
988 else
989 p = argv[i + 2];
02b95dad 990 tev->args[i].name = strdup(argv[i + 2]);
4235b045 991 /* TODO: parse regs and offset */
02b95dad
MH
992 tev->args[i].value = strdup(p);
993 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
994 ret = -ENOMEM;
995 goto out;
996 }
4de189fe 997 }
146a1439
MH
998 ret = 0;
999out:
4de189fe 1000 argv_free(argv);
146a1439 1001 return ret;
4de189fe
MH
1002}
1003
7df2f329
MH
1004/* Compose only probe arg */
1005int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1006{
1007 struct perf_probe_arg_field *field = pa->field;
1008 int ret;
1009 char *tmp = buf;
1010
48481938
MH
1011 if (pa->name && pa->var)
1012 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1013 else
1014 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
7df2f329
MH
1015 if (ret <= 0)
1016 goto error;
1017 tmp += ret;
1018 len -= ret;
1019
1020 while (field) {
b2a3c12b
MH
1021 if (field->name[0] == '[')
1022 ret = e_snprintf(tmp, len, "%s", field->name);
1023 else
1024 ret = e_snprintf(tmp, len, "%s%s",
1025 field->ref ? "->" : ".", field->name);
7df2f329
MH
1026 if (ret <= 0)
1027 goto error;
1028 tmp += ret;
1029 len -= ret;
1030 field = field->next;
1031 }
11a1ca35
MH
1032
1033 if (pa->type) {
1034 ret = e_snprintf(tmp, len, ":%s", pa->type);
1035 if (ret <= 0)
1036 goto error;
1037 tmp += ret;
1038 len -= ret;
1039 }
1040
7df2f329
MH
1041 return tmp - buf;
1042error:
0e43e5d2 1043 pr_debug("Failed to synthesize perf probe argument: %s\n",
146a1439
MH
1044 strerror(-ret));
1045 return ret;
7df2f329
MH
1046}
1047
4235b045
MH
1048/* Compose only probe point (not argument) */
1049static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
4de189fe 1050{
fb1587d8
MH
1051 char *buf, *tmp;
1052 char offs[32] = "", line[32] = "", file[32] = "";
1053 int ret, len;
4de189fe 1054
e334016f
MH
1055 buf = zalloc(MAX_CMDLEN);
1056 if (buf == NULL) {
1057 ret = -ENOMEM;
1058 goto error;
1059 }
4de189fe 1060 if (pp->offset) {
fb1587d8 1061 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
4de189fe
MH
1062 if (ret <= 0)
1063 goto error;
1064 }
1065 if (pp->line) {
fb1587d8
MH
1066 ret = e_snprintf(line, 32, ":%d", pp->line);
1067 if (ret <= 0)
1068 goto error;
1069 }
1070 if (pp->file) {
dd259c5d 1071 len = strlen(pp->file) - 31;
fb1587d8
MH
1072 if (len < 0)
1073 len = 0;
1074 tmp = strchr(pp->file + len, '/');
1075 if (!tmp)
dd259c5d 1076 tmp = pp->file + len;
fb1587d8 1077 ret = e_snprintf(file, 32, "@%s", tmp + 1);
4de189fe
MH
1078 if (ret <= 0)
1079 goto error;
1080 }
1081
1082 if (pp->function)
fb1587d8
MH
1083 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1084 offs, pp->retprobe ? "%return" : "", line,
1085 file);
4de189fe 1086 else
fb1587d8 1087 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
4235b045
MH
1088 if (ret <= 0)
1089 goto error;
1090
1091 return buf;
7ef17aaf 1092error:
0e43e5d2 1093 pr_debug("Failed to synthesize perf probe point: %s\n",
146a1439 1094 strerror(-ret));
e334016f
MH
1095 if (buf)
1096 free(buf);
146a1439 1097 return NULL;
7ef17aaf
MH
1098}
1099
4235b045
MH
1100#if 0
1101char *synthesize_perf_probe_command(struct perf_probe_event *pev)
7ef17aaf
MH
1102{
1103 char *buf;
1104 int i, len, ret;
1105
4235b045
MH
1106 buf = synthesize_perf_probe_point(&pev->point);
1107 if (!buf)
1108 return NULL;
4de189fe 1109
4235b045
MH
1110 len = strlen(buf);
1111 for (i = 0; i < pev->nargs; i++) {
4de189fe 1112 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
4235b045
MH
1113 pev->args[i].name);
1114 if (ret <= 0) {
1115 free(buf);
1116 return NULL;
1117 }
4de189fe
MH
1118 len += ret;
1119 }
4de189fe 1120
4235b045
MH
1121 return buf;
1122}
1123#endif
1124
0e60836b 1125static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
4235b045
MH
1126 char **buf, size_t *buflen,
1127 int depth)
1128{
1129 int ret;
1130 if (ref->next) {
0e60836b 1131 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
4235b045
MH
1132 buflen, depth + 1);
1133 if (depth < 0)
1134 goto out;
1135 }
1136
1137 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1138 if (ret < 0)
1139 depth = ret;
1140 else {
1141 *buf += ret;
1142 *buflen -= ret;
1143 }
1144out:
1145 return depth;
4de189fe 1146
4de189fe
MH
1147}
1148
0e60836b 1149static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
4235b045 1150 char *buf, size_t buflen)
50656eec 1151{
0e60836b 1152 struct probe_trace_arg_ref *ref = arg->ref;
4235b045
MH
1153 int ret, depth = 0;
1154 char *tmp = buf;
1155
1156 /* Argument name or separator */
1157 if (arg->name)
1158 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1159 else
1160 ret = e_snprintf(buf, buflen, " ");
1161 if (ret < 0)
1162 return ret;
1163 buf += ret;
1164 buflen -= ret;
1165
b7dcb857
MH
1166 /* Special case: @XXX */
1167 if (arg->value[0] == '@' && arg->ref)
1168 ref = ref->next;
1169
4235b045 1170 /* Dereferencing arguments */
b7dcb857 1171 if (ref) {
0e60836b 1172 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
4235b045
MH
1173 &buflen, 1);
1174 if (depth < 0)
1175 return depth;
1176 }
1177
1178 /* Print argument value */
b7dcb857
MH
1179 if (arg->value[0] == '@' && arg->ref)
1180 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1181 arg->ref->offset);
1182 else
1183 ret = e_snprintf(buf, buflen, "%s", arg->value);
4235b045
MH
1184 if (ret < 0)
1185 return ret;
1186 buf += ret;
1187 buflen -= ret;
1188
1189 /* Closing */
1190 while (depth--) {
1191 ret = e_snprintf(buf, buflen, ")");
1192 if (ret < 0)
1193 return ret;
1194 buf += ret;
1195 buflen -= ret;
1196 }
4984912e
MH
1197 /* Print argument type */
1198 if (arg->type) {
1199 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1200 if (ret <= 0)
1201 return ret;
1202 buf += ret;
1203 }
4235b045
MH
1204
1205 return buf - tmp;
1206}
1207
0e60836b 1208char *synthesize_probe_trace_command(struct probe_trace_event *tev)
4235b045 1209{
0e60836b 1210 struct probe_trace_point *tp = &tev->point;
50656eec
MH
1211 char *buf;
1212 int i, len, ret;
1213
e334016f
MH
1214 buf = zalloc(MAX_CMDLEN);
1215 if (buf == NULL)
1216 return NULL;
1217
4235b045
MH
1218 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s+%lu",
1219 tp->retprobe ? 'r' : 'p',
1220 tev->group, tev->event,
1221 tp->symbol, tp->offset);
1222 if (len <= 0)
50656eec 1223 goto error;
50656eec 1224
4235b045 1225 for (i = 0; i < tev->nargs; i++) {
0e60836b 1226 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
4235b045 1227 MAX_CMDLEN - len);
4de189fe 1228 if (ret <= 0)
50656eec
MH
1229 goto error;
1230 len += ret;
1231 }
50656eec 1232
4235b045 1233 return buf;
50656eec 1234error:
4235b045
MH
1235 free(buf);
1236 return NULL;
1237}
50656eec 1238
0e60836b 1239static int convert_to_perf_probe_event(struct probe_trace_event *tev,
469b9b88 1240 struct perf_probe_event *pev)
4235b045 1241{
02b95dad 1242 char buf[64] = "";
146a1439 1243 int i, ret;
4235b045 1244
4b4da7f7 1245 /* Convert event/group name */
02b95dad
MH
1246 pev->event = strdup(tev->event);
1247 pev->group = strdup(tev->group);
1248 if (pev->event == NULL || pev->group == NULL)
1249 return -ENOMEM;
fb1587d8 1250
4b4da7f7 1251 /* Convert trace_point to probe_point */
0e60836b 1252 ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
146a1439
MH
1253 if (ret < 0)
1254 return ret;
4b4da7f7 1255
4235b045
MH
1256 /* Convert trace_arg to probe_arg */
1257 pev->nargs = tev->nargs;
e334016f
MH
1258 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1259 if (pev->args == NULL)
1260 return -ENOMEM;
02b95dad 1261 for (i = 0; i < tev->nargs && ret >= 0; i++) {
4235b045 1262 if (tev->args[i].name)
02b95dad 1263 pev->args[i].name = strdup(tev->args[i].name);
4235b045 1264 else {
0e60836b 1265 ret = synthesize_probe_trace_arg(&tev->args[i],
146a1439 1266 buf, 64);
02b95dad 1267 pev->args[i].name = strdup(buf);
4235b045 1268 }
02b95dad
MH
1269 if (pev->args[i].name == NULL && ret >= 0)
1270 ret = -ENOMEM;
1271 }
146a1439
MH
1272
1273 if (ret < 0)
1274 clear_perf_probe_event(pev);
1275
1276 return ret;
4235b045
MH
1277}
1278
1279void clear_perf_probe_event(struct perf_probe_event *pev)
1280{
1281 struct perf_probe_point *pp = &pev->point;
7df2f329 1282 struct perf_probe_arg_field *field, *next;
4235b045
MH
1283 int i;
1284
1285 if (pev->event)
1286 free(pev->event);
1287 if (pev->group)
1288 free(pev->group);
1289 if (pp->file)
1290 free(pp->file);
1291 if (pp->function)
1292 free(pp->function);
1293 if (pp->lazy_line)
1294 free(pp->lazy_line);
7df2f329 1295 for (i = 0; i < pev->nargs; i++) {
4235b045
MH
1296 if (pev->args[i].name)
1297 free(pev->args[i].name);
48481938
MH
1298 if (pev->args[i].var)
1299 free(pev->args[i].var);
11a1ca35
MH
1300 if (pev->args[i].type)
1301 free(pev->args[i].type);
7df2f329
MH
1302 field = pev->args[i].field;
1303 while (field) {
1304 next = field->next;
1305 if (field->name)
1306 free(field->name);
1307 free(field);
1308 field = next;
1309 }
1310 }
4235b045
MH
1311 if (pev->args)
1312 free(pev->args);
1313 memset(pev, 0, sizeof(*pev));
1314}
1315
0e60836b 1316static void clear_probe_trace_event(struct probe_trace_event *tev)
4235b045 1317{
0e60836b 1318 struct probe_trace_arg_ref *ref, *next;
4235b045
MH
1319 int i;
1320
1321 if (tev->event)
1322 free(tev->event);
1323 if (tev->group)
1324 free(tev->group);
1325 if (tev->point.symbol)
1326 free(tev->point.symbol);
1327 for (i = 0; i < tev->nargs; i++) {
1328 if (tev->args[i].name)
1329 free(tev->args[i].name);
1330 if (tev->args[i].value)
1331 free(tev->args[i].value);
4984912e
MH
1332 if (tev->args[i].type)
1333 free(tev->args[i].type);
4235b045
MH
1334 ref = tev->args[i].ref;
1335 while (ref) {
1336 next = ref->next;
1337 free(ref);
1338 ref = next;
1339 }
1340 }
1341 if (tev->args)
1342 free(tev->args);
1343 memset(tev, 0, sizeof(*tev));
50656eec
MH
1344}
1345
f4d7da49 1346static int open_kprobe_events(bool readwrite)
4de189fe
MH
1347{
1348 char buf[PATH_MAX];
7ca5989d 1349 const char *__debugfs;
4de189fe
MH
1350 int ret;
1351
7ca5989d
MH
1352 __debugfs = debugfs_find_mountpoint();
1353 if (__debugfs == NULL) {
1354 pr_warning("Debugfs is not mounted.\n");
1355 return -ENOENT;
1356 }
1357
1358 ret = e_snprintf(buf, PATH_MAX, "%stracing/kprobe_events", __debugfs);
146a1439 1359 if (ret >= 0) {
7ca5989d 1360 pr_debug("Opening %s write=%d\n", buf, readwrite);
146a1439
MH
1361 if (readwrite && !probe_event_dry_run)
1362 ret = open(buf, O_RDWR, O_APPEND);
1363 else
1364 ret = open(buf, O_RDONLY, 0);
1365 }
f4d7da49 1366
4de189fe
MH
1367 if (ret < 0) {
1368 if (errno == ENOENT)
146a1439
MH
1369 pr_warning("kprobe_events file does not exist - please"
1370 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
4de189fe 1371 else
146a1439
MH
1372 pr_warning("Failed to open kprobe_events file: %s\n",
1373 strerror(errno));
4de189fe
MH
1374 }
1375 return ret;
1376}
1377
1378/* Get raw string list of current kprobe_events */
0e60836b 1379static struct strlist *get_probe_trace_command_rawlist(int fd)
4de189fe
MH
1380{
1381 int ret, idx;
1382 FILE *fp;
1383 char buf[MAX_CMDLEN];
1384 char *p;
1385 struct strlist *sl;
1386
1387 sl = strlist__new(true, NULL);
1388
1389 fp = fdopen(dup(fd), "r");
1390 while (!feof(fp)) {
1391 p = fgets(buf, MAX_CMDLEN, fp);
1392 if (!p)
1393 break;
1394
1395 idx = strlen(p) - 1;
1396 if (p[idx] == '\n')
1397 p[idx] = '\0';
1398 ret = strlist__add(sl, buf);
146a1439
MH
1399 if (ret < 0) {
1400 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1401 strlist__delete(sl);
1402 return NULL;
1403 }
4de189fe
MH
1404 }
1405 fclose(fp);
1406
1407 return sl;
1408}
1409
278498d4 1410/* Show an event */
146a1439 1411static int show_perf_probe_event(struct perf_probe_event *pev)
278498d4 1412{
7e990a51 1413 int i, ret;
278498d4 1414 char buf[128];
4235b045 1415 char *place;
278498d4 1416
4235b045
MH
1417 /* Synthesize only event probe point */
1418 place = synthesize_perf_probe_point(&pev->point);
146a1439
MH
1419 if (!place)
1420 return -EINVAL;
4235b045
MH
1421
1422 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
7e990a51 1423 if (ret < 0)
146a1439
MH
1424 return ret;
1425
fb1587d8 1426 printf(" %-20s (on %s", buf, place);
278498d4 1427
4235b045 1428 if (pev->nargs > 0) {
278498d4 1429 printf(" with");
7df2f329 1430 for (i = 0; i < pev->nargs; i++) {
146a1439
MH
1431 ret = synthesize_perf_probe_arg(&pev->args[i],
1432 buf, 128);
1433 if (ret < 0)
1434 break;
7df2f329
MH
1435 printf(" %s", buf);
1436 }
278498d4
MH
1437 }
1438 printf(")\n");
4235b045 1439 free(place);
146a1439 1440 return ret;
278498d4
MH
1441}
1442
4de189fe 1443/* List up current perf-probe events */
146a1439 1444int show_perf_probe_events(void)
4de189fe 1445{
146a1439 1446 int fd, ret;
0e60836b 1447 struct probe_trace_event tev;
4235b045 1448 struct perf_probe_event pev;
4de189fe
MH
1449 struct strlist *rawlist;
1450 struct str_node *ent;
1451
72041334 1452 setup_pager();
146a1439
MH
1453 ret = init_vmlinux();
1454 if (ret < 0)
1455 return ret;
4235b045
MH
1456
1457 memset(&tev, 0, sizeof(tev));
1458 memset(&pev, 0, sizeof(pev));
72041334 1459
f4d7da49 1460 fd = open_kprobe_events(false);
146a1439
MH
1461 if (fd < 0)
1462 return fd;
1463
0e60836b 1464 rawlist = get_probe_trace_command_rawlist(fd);
4de189fe 1465 close(fd);
146a1439
MH
1466 if (!rawlist)
1467 return -ENOENT;
4de189fe 1468
adf365f4 1469 strlist__for_each(ent, rawlist) {
0e60836b 1470 ret = parse_probe_trace_command(ent->s, &tev);
146a1439
MH
1471 if (ret >= 0) {
1472 ret = convert_to_perf_probe_event(&tev, &pev);
1473 if (ret >= 0)
1474 ret = show_perf_probe_event(&pev);
1475 }
4235b045 1476 clear_perf_probe_event(&pev);
0e60836b 1477 clear_probe_trace_event(&tev);
146a1439
MH
1478 if (ret < 0)
1479 break;
4de189fe 1480 }
4de189fe 1481 strlist__delete(rawlist);
146a1439
MH
1482
1483 return ret;
4de189fe
MH
1484}
1485
b498ce1f 1486/* Get current perf-probe event names */
0e60836b 1487static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
b498ce1f 1488{
fa28244d 1489 char buf[128];
b498ce1f
MH
1490 struct strlist *sl, *rawlist;
1491 struct str_node *ent;
0e60836b 1492 struct probe_trace_event tev;
146a1439 1493 int ret = 0;
b498ce1f 1494
4235b045 1495 memset(&tev, 0, sizeof(tev));
0e60836b 1496 rawlist = get_probe_trace_command_rawlist(fd);
e1d2017b 1497 sl = strlist__new(true, NULL);
adf365f4 1498 strlist__for_each(ent, rawlist) {
0e60836b 1499 ret = parse_probe_trace_command(ent->s, &tev);
146a1439
MH
1500 if (ret < 0)
1501 break;
fa28244d 1502 if (include_group) {
146a1439
MH
1503 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1504 tev.event);
1505 if (ret >= 0)
1506 ret = strlist__add(sl, buf);
fa28244d 1507 } else
146a1439 1508 ret = strlist__add(sl, tev.event);
0e60836b 1509 clear_probe_trace_event(&tev);
146a1439
MH
1510 if (ret < 0)
1511 break;
b498ce1f 1512 }
b498ce1f
MH
1513 strlist__delete(rawlist);
1514
146a1439
MH
1515 if (ret < 0) {
1516 strlist__delete(sl);
1517 return NULL;
1518 }
b498ce1f
MH
1519 return sl;
1520}
1521
0e60836b 1522static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
50656eec 1523{
6eca8cc3 1524 int ret = 0;
0e60836b 1525 char *buf = synthesize_probe_trace_command(tev);
50656eec 1526
146a1439 1527 if (!buf) {
0e60836b 1528 pr_debug("Failed to synthesize probe trace event.\n");
146a1439
MH
1529 return -EINVAL;
1530 }
1531
fa28244d 1532 pr_debug("Writing event: %s\n", buf);
f4d7da49
MH
1533 if (!probe_event_dry_run) {
1534 ret = write(fd, buf, strlen(buf));
1535 if (ret <= 0)
146a1439
MH
1536 pr_warning("Failed to write event: %s\n",
1537 strerror(errno));
f4d7da49 1538 }
4235b045 1539 free(buf);
146a1439 1540 return ret;
50656eec
MH
1541}
1542
146a1439
MH
1543static int get_new_event_name(char *buf, size_t len, const char *base,
1544 struct strlist *namelist, bool allow_suffix)
b498ce1f
MH
1545{
1546 int i, ret;
17f88fcd
MH
1547
1548 /* Try no suffix */
1549 ret = e_snprintf(buf, len, "%s", base);
146a1439
MH
1550 if (ret < 0) {
1551 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1552 return ret;
1553 }
17f88fcd 1554 if (!strlist__has_entry(namelist, buf))
146a1439 1555 return 0;
17f88fcd 1556
d761b08b
MH
1557 if (!allow_suffix) {
1558 pr_warning("Error: event \"%s\" already exists. "
1559 "(Use -f to force duplicates.)\n", base);
146a1439 1560 return -EEXIST;
d761b08b
MH
1561 }
1562
17f88fcd
MH
1563 /* Try to add suffix */
1564 for (i = 1; i < MAX_EVENT_INDEX; i++) {
b498ce1f 1565 ret = e_snprintf(buf, len, "%s_%d", base, i);
146a1439
MH
1566 if (ret < 0) {
1567 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1568 return ret;
1569 }
b498ce1f
MH
1570 if (!strlist__has_entry(namelist, buf))
1571 break;
1572 }
146a1439
MH
1573 if (i == MAX_EVENT_INDEX) {
1574 pr_warning("Too many events are on the same function.\n");
1575 ret = -ERANGE;
1576 }
1577
1578 return ret;
b498ce1f
MH
1579}
1580
0e60836b
SD
1581static int __add_probe_trace_events(struct perf_probe_event *pev,
1582 struct probe_trace_event *tevs,
146a1439 1583 int ntevs, bool allow_suffix)
50656eec 1584{
146a1439 1585 int i, fd, ret;
0e60836b 1586 struct probe_trace_event *tev = NULL;
4235b045
MH
1587 char buf[64];
1588 const char *event, *group;
b498ce1f 1589 struct strlist *namelist;
50656eec 1590
f4d7da49 1591 fd = open_kprobe_events(true);
146a1439
MH
1592 if (fd < 0)
1593 return fd;
b498ce1f 1594 /* Get current event names */
0e60836b 1595 namelist = get_probe_trace_event_names(fd, false);
146a1439
MH
1596 if (!namelist) {
1597 pr_debug("Failed to get current event list.\n");
1598 return -EIO;
1599 }
4235b045 1600
146a1439 1601 ret = 0;
4235b045 1602 printf("Add new event%s\n", (ntevs > 1) ? "s:" : ":");
02b95dad 1603 for (i = 0; i < ntevs; i++) {
4235b045
MH
1604 tev = &tevs[i];
1605 if (pev->event)
1606 event = pev->event;
1607 else
1608 if (pev->point.function)
1609 event = pev->point.function;
1610 else
1611 event = tev->point.symbol;
1612 if (pev->group)
1613 group = pev->group;
1614 else
1615 group = PERFPROBE_GROUP;
1616
1617 /* Get an unused new event name */
146a1439
MH
1618 ret = get_new_event_name(buf, 64, event,
1619 namelist, allow_suffix);
1620 if (ret < 0)
1621 break;
4235b045
MH
1622 event = buf;
1623
02b95dad
MH
1624 tev->event = strdup(event);
1625 tev->group = strdup(group);
1626 if (tev->event == NULL || tev->group == NULL) {
1627 ret = -ENOMEM;
1628 break;
1629 }
0e60836b 1630 ret = write_probe_trace_event(fd, tev);
146a1439
MH
1631 if (ret < 0)
1632 break;
4235b045
MH
1633 /* Add added event name to namelist */
1634 strlist__add(namelist, event);
1635
1636 /* Trick here - save current event/group */
1637 event = pev->event;
1638 group = pev->group;
1639 pev->event = tev->event;
1640 pev->group = tev->group;
1641 show_perf_probe_event(pev);
1642 /* Trick here - restore current event/group */
1643 pev->event = (char *)event;
1644 pev->group = (char *)group;
1645
1646 /*
1647 * Probes after the first probe which comes from same
1648 * user input are always allowed to add suffix, because
1649 * there might be several addresses corresponding to
1650 * one code line.
1651 */
1652 allow_suffix = true;
50656eec 1653 }
146a1439
MH
1654
1655 if (ret >= 0) {
1656 /* Show how to use the event. */
1657 printf("\nYou can now use it on all perf tools, such as:\n\n");
1658 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
1659 tev->event);
1660 }
a9b495b0 1661
e1d2017b 1662 strlist__delete(namelist);
50656eec 1663 close(fd);
146a1439 1664 return ret;
50656eec 1665}
fa28244d 1666
0e60836b
SD
1667static int convert_to_probe_trace_events(struct perf_probe_event *pev,
1668 struct probe_trace_event **tevs,
469b9b88 1669 int max_tevs, const char *module)
e0faa8d3
MH
1670{
1671 struct symbol *sym;
e334016f 1672 int ret = 0, i;
0e60836b 1673 struct probe_trace_event *tev;
4235b045 1674
4b4da7f7 1675 /* Convert perf_probe_event with debuginfo */
469b9b88 1676 ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, module);
e334016f
MH
1677 if (ret != 0)
1678 return ret;
e0faa8d3 1679
4235b045 1680 /* Allocate trace event buffer */
0e60836b 1681 tev = *tevs = zalloc(sizeof(struct probe_trace_event));
e334016f
MH
1682 if (tev == NULL)
1683 return -ENOMEM;
4235b045
MH
1684
1685 /* Copy parameters */
02b95dad
MH
1686 tev->point.symbol = strdup(pev->point.function);
1687 if (tev->point.symbol == NULL) {
1688 ret = -ENOMEM;
1689 goto error;
1690 }
4235b045 1691 tev->point.offset = pev->point.offset;
04ddd04b 1692 tev->point.retprobe = pev->point.retprobe;
4235b045
MH
1693 tev->nargs = pev->nargs;
1694 if (tev->nargs) {
0e60836b 1695 tev->args = zalloc(sizeof(struct probe_trace_arg)
e334016f
MH
1696 * tev->nargs);
1697 if (tev->args == NULL) {
02b95dad
MH
1698 ret = -ENOMEM;
1699 goto error;
e334016f 1700 }
48481938 1701 for (i = 0; i < tev->nargs; i++) {
02b95dad
MH
1702 if (pev->args[i].name) {
1703 tev->args[i].name = strdup(pev->args[i].name);
1704 if (tev->args[i].name == NULL) {
1705 ret = -ENOMEM;
1706 goto error;
1707 }
1708 }
1709 tev->args[i].value = strdup(pev->args[i].var);
1710 if (tev->args[i].value == NULL) {
1711 ret = -ENOMEM;
1712 goto error;
1713 }
1714 if (pev->args[i].type) {
1715 tev->args[i].type = strdup(pev->args[i].type);
1716 if (tev->args[i].type == NULL) {
1717 ret = -ENOMEM;
1718 goto error;
1719 }
1720 }
48481938 1721 }
4235b045
MH
1722 }
1723
1724 /* Currently just checking function name from symbol map */
469b9b88 1725 sym = __find_kernel_function_by_name(tev->point.symbol, NULL);
146a1439
MH
1726 if (!sym) {
1727 pr_warning("Kernel symbol \'%s\' not found.\n",
1728 tev->point.symbol);
02b95dad
MH
1729 ret = -ENOENT;
1730 goto error;
1731 }
e334016f 1732
02b95dad
MH
1733 return 1;
1734error:
0e60836b 1735 clear_probe_trace_event(tev);
02b95dad
MH
1736 free(tev);
1737 *tevs = NULL;
e334016f 1738 return ret;
4235b045
MH
1739}
1740
1741struct __event_package {
1742 struct perf_probe_event *pev;
0e60836b 1743 struct probe_trace_event *tevs;
4235b045
MH
1744 int ntevs;
1745};
1746
146a1439 1747int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
469b9b88 1748 int max_tevs, const char *module, bool force_add)
4235b045 1749{
146a1439 1750 int i, j, ret;
4235b045
MH
1751 struct __event_package *pkgs;
1752
e334016f
MH
1753 pkgs = zalloc(sizeof(struct __event_package) * npevs);
1754 if (pkgs == NULL)
1755 return -ENOMEM;
4235b045
MH
1756
1757 /* Init vmlinux path */
146a1439 1758 ret = init_vmlinux();
449e5b24
MH
1759 if (ret < 0) {
1760 free(pkgs);
146a1439 1761 return ret;
449e5b24 1762 }
4235b045
MH
1763
1764 /* Loop 1: convert all events */
1765 for (i = 0; i < npevs; i++) {
1766 pkgs[i].pev = &pevs[i];
1767 /* Convert with or without debuginfo */
0e60836b 1768 ret = convert_to_probe_trace_events(pkgs[i].pev,
469b9b88
MH
1769 &pkgs[i].tevs,
1770 max_tevs,
1771 module);
146a1439
MH
1772 if (ret < 0)
1773 goto end;
1774 pkgs[i].ntevs = ret;
e0faa8d3
MH
1775 }
1776
4235b045 1777 /* Loop 2: add all events */
146a1439 1778 for (i = 0; i < npevs && ret >= 0; i++)
0e60836b 1779 ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
146a1439
MH
1780 pkgs[i].ntevs, force_add);
1781end:
449e5b24
MH
1782 /* Loop 3: cleanup and free trace events */
1783 for (i = 0; i < npevs; i++) {
146a1439 1784 for (j = 0; j < pkgs[i].ntevs; j++)
0e60836b 1785 clear_probe_trace_event(&pkgs[i].tevs[j]);
449e5b24
MH
1786 free(pkgs[i].tevs);
1787 }
1788 free(pkgs);
146a1439
MH
1789
1790 return ret;
e0faa8d3
MH
1791}
1792
0e60836b 1793static int __del_trace_probe_event(int fd, struct str_node *ent)
bbbb521b
MH
1794{
1795 char *p;
1796 char buf[128];
4235b045 1797 int ret;
bbbb521b 1798
0e60836b 1799 /* Convert from perf-probe event to trace-probe event */
146a1439
MH
1800 ret = e_snprintf(buf, 128, "-:%s", ent->s);
1801 if (ret < 0)
1802 goto error;
1803
bbbb521b 1804 p = strchr(buf + 2, ':');
146a1439
MH
1805 if (!p) {
1806 pr_debug("Internal error: %s should have ':' but not.\n",
1807 ent->s);
1808 ret = -ENOTSUP;
1809 goto error;
1810 }
bbbb521b
MH
1811 *p = '/';
1812
4235b045
MH
1813 pr_debug("Writing event: %s\n", buf);
1814 ret = write(fd, buf, strlen(buf));
146a1439
MH
1815 if (ret < 0)
1816 goto error;
1817
bbbb521b 1818 printf("Remove event: %s\n", ent->s);
146a1439
MH
1819 return 0;
1820error:
1821 pr_warning("Failed to delete event: %s\n", strerror(-ret));
1822 return ret;
bbbb521b
MH
1823}
1824
0e60836b 1825static int del_trace_probe_event(int fd, const char *group,
146a1439 1826 const char *event, struct strlist *namelist)
fa28244d
MH
1827{
1828 char buf[128];
bbbb521b 1829 struct str_node *ent, *n;
146a1439 1830 int found = 0, ret = 0;
fa28244d 1831
146a1439
MH
1832 ret = e_snprintf(buf, 128, "%s:%s", group, event);
1833 if (ret < 0) {
0e43e5d2 1834 pr_err("Failed to copy event.\n");
146a1439
MH
1835 return ret;
1836 }
fa28244d 1837
bbbb521b
MH
1838 if (strpbrk(buf, "*?")) { /* Glob-exp */
1839 strlist__for_each_safe(ent, n, namelist)
1840 if (strglobmatch(ent->s, buf)) {
1841 found++;
0e60836b 1842 ret = __del_trace_probe_event(fd, ent);
146a1439
MH
1843 if (ret < 0)
1844 break;
bbbb521b
MH
1845 strlist__remove(namelist, ent);
1846 }
1847 } else {
1848 ent = strlist__find(namelist, buf);
1849 if (ent) {
1850 found++;
0e60836b 1851 ret = __del_trace_probe_event(fd, ent);
146a1439
MH
1852 if (ret >= 0)
1853 strlist__remove(namelist, ent);
bbbb521b
MH
1854 }
1855 }
146a1439
MH
1856 if (found == 0 && ret >= 0)
1857 pr_info("Info: Event \"%s\" does not exist.\n", buf);
1858
1859 return ret;
fa28244d
MH
1860}
1861
146a1439 1862int del_perf_probe_events(struct strlist *dellist)
fa28244d 1863{
146a1439 1864 int fd, ret = 0;
fa28244d
MH
1865 const char *group, *event;
1866 char *p, *str;
1867 struct str_node *ent;
1868 struct strlist *namelist;
1869
f4d7da49 1870 fd = open_kprobe_events(true);
146a1439
MH
1871 if (fd < 0)
1872 return fd;
1873
fa28244d 1874 /* Get current event names */
0e60836b 1875 namelist = get_probe_trace_event_names(fd, true);
146a1439
MH
1876 if (namelist == NULL)
1877 return -EINVAL;
fa28244d 1878
adf365f4 1879 strlist__for_each(ent, dellist) {
02b95dad
MH
1880 str = strdup(ent->s);
1881 if (str == NULL) {
1882 ret = -ENOMEM;
1883 break;
1884 }
bbbb521b 1885 pr_debug("Parsing: %s\n", str);
fa28244d
MH
1886 p = strchr(str, ':');
1887 if (p) {
1888 group = str;
1889 *p = '\0';
1890 event = p + 1;
1891 } else {
bbbb521b 1892 group = "*";
fa28244d
MH
1893 event = str;
1894 }
bbbb521b 1895 pr_debug("Group: %s, Event: %s\n", group, event);
0e60836b 1896 ret = del_trace_probe_event(fd, group, event, namelist);
fa28244d 1897 free(str);
146a1439
MH
1898 if (ret < 0)
1899 break;
fa28244d
MH
1900 }
1901 strlist__delete(namelist);
1902 close(fd);
146a1439
MH
1903
1904 return ret;
fa28244d
MH
1905}
1906