perf probe: Rewrite show_one_line() to make it simpler
[GitHub/mt8127/android_kernel_alcatel_ttab.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
d3b63d7a 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
MH
308
309 return 0;
4b4da7f7
MH
310error:
311 if (feof(fp))
146a1439 312 pr_warning("Source file is shorter than expected.\n");
4b4da7f7 313 else
146a1439
MH
314 pr_warning("File read error: %s\n", strerror(errno));
315
316 return -1;
4b4da7f7
MH
317}
318
319/*
320 * Show line-range always requires debuginfo to find source file and
321 * line number.
322 */
469b9b88 323int show_line_range(struct line_range *lr, const char *module)
4b4da7f7 324{
d3b63d7a 325 int l = 1;
4b4da7f7
MH
326 struct line_node *ln;
327 FILE *fp;
328 int fd, ret;
7cf0b79e 329 char *tmp;
4b4da7f7
MH
330
331 /* Search a line range */
146a1439
MH
332 ret = init_vmlinux();
333 if (ret < 0)
334 return ret;
335
469b9b88 336 fd = open_vmlinux(module);
146a1439
MH
337 if (fd < 0) {
338 pr_warning("Failed to open debuginfo file.\n");
339 return fd;
340 }
341
4b4da7f7 342 ret = find_line_range(fd, lr);
4b4da7f7 343 close(fd);
146a1439
MH
344 if (ret == 0) {
345 pr_warning("Specified source line is not found.\n");
346 return -ENOENT;
347 } else if (ret < 0) {
348 pr_warning("Debuginfo analysis failed. (%d)\n", ret);
349 return ret;
350 }
4b4da7f7 351
7cf0b79e
MH
352 /* Convert source file path */
353 tmp = lr->path;
6a330a3c 354 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
7cf0b79e
MH
355 free(tmp); /* Free old path */
356 if (ret < 0) {
357 pr_warning("Failed to find source file. (%d)\n", ret);
358 return ret;
359 }
360
4b4da7f7
MH
361 setup_pager();
362
363 if (lr->function)
364 fprintf(stdout, "<%s:%d>\n", lr->function,
365 lr->start - lr->offset);
366 else
62c15fc4 367 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
4b4da7f7
MH
368
369 fp = fopen(lr->path, "r");
146a1439
MH
370 if (fp == NULL) {
371 pr_warning("Failed to open %s: %s\n", lr->path,
372 strerror(errno));
373 return -errno;
374 }
4b4da7f7 375 /* Skip to starting line number */
146a1439
MH
376 while (l < lr->start && ret >= 0)
377 ret = show_one_line(fp, l++, true, false);
378 if (ret < 0)
379 goto end;
4b4da7f7
MH
380
381 list_for_each_entry(ln, &lr->line_list, list) {
146a1439
MH
382 while (ln->line > l && ret >= 0)
383 ret = show_one_line(fp, (l++) - lr->offset,
384 false, false);
385 if (ret >= 0)
386 ret = show_one_line(fp, (l++) - lr->offset,
387 false, true);
388 if (ret < 0)
389 goto end;
4b4da7f7
MH
390 }
391
392 if (lr->end == INT_MAX)
393 lr->end = l + NR_ADDITIONAL_LINES;
dda4ab34 394 while (l <= lr->end && !feof(fp) && ret >= 0)
146a1439
MH
395 ret = show_one_line(fp, (l++) - lr->offset, false, false);
396end:
4b4da7f7 397 fclose(fp);
146a1439 398 return ret;
4b4da7f7
MH
399}
400
cf6eb489 401static int show_available_vars_at(int fd, struct perf_probe_event *pev,
fb8c5a56 402 int max_vls, bool externs)
cf6eb489
MH
403{
404 char *buf;
405 int ret, i;
406 struct str_node *node;
407 struct variable_list *vls = NULL, *vl;
408
409 buf = synthesize_perf_probe_point(&pev->point);
410 if (!buf)
411 return -EINVAL;
412 pr_debug("Searching variables at %s\n", buf);
413
fb8c5a56 414 ret = find_available_vars_at(fd, pev, &vls, max_vls, externs);
cf6eb489
MH
415 if (ret > 0) {
416 /* Some variables were found */
417 fprintf(stdout, "Available variables at %s\n", buf);
418 for (i = 0; i < ret; i++) {
419 vl = &vls[i];
420 /*
421 * A probe point might be converted to
422 * several trace points.
423 */
424 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
425 vl->point.offset);
426 free(vl->point.symbol);
427 if (vl->vars) {
428 strlist__for_each(node, vl->vars)
429 fprintf(stdout, "\t\t%s\n", node->s);
430 strlist__delete(vl->vars);
431 } else
432 fprintf(stdout, "(No variables)\n");
433 }
434 free(vls);
435 } else
436 pr_err("Failed to find variables at %s (%d)\n", buf, ret);
437
438 free(buf);
439 return ret;
440}
441
442/* Show available variables on given probe point */
443int show_available_vars(struct perf_probe_event *pevs, int npevs,
469b9b88 444 int max_vls, const char *module, bool externs)
cf6eb489
MH
445{
446 int i, fd, ret = 0;
447
448 ret = init_vmlinux();
449 if (ret < 0)
450 return ret;
451
469b9b88 452 fd = open_vmlinux(module);
cf6eb489 453 if (fd < 0) {
0e43e5d2 454 pr_warning("Failed to open debug information file.\n");
cf6eb489
MH
455 return fd;
456 }
457
458 setup_pager();
459
460 for (i = 0; i < npevs && ret >= 0; i++)
fb8c5a56 461 ret = show_available_vars_at(fd, &pevs[i], max_vls, externs);
cf6eb489
MH
462
463 close(fd);
464 return ret;
465}
466
4b4da7f7
MH
467#else /* !DWARF_SUPPORT */
468
0e60836b 469static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
469b9b88 470 struct perf_probe_point *pp)
4b4da7f7 471{
469b9b88
MH
472 struct symbol *sym;
473
474 sym = __find_kernel_function_by_name(tp->symbol, NULL);
475 if (!sym) {
476 pr_err("Failed to find symbol %s in kernel.\n", tp->symbol);
477 return -ENOENT;
478 }
02b95dad
MH
479 pp->function = strdup(tp->symbol);
480 if (pp->function == NULL)
481 return -ENOMEM;
4b4da7f7
MH
482 pp->offset = tp->offset;
483 pp->retprobe = tp->retprobe;
146a1439
MH
484
485 return 0;
4b4da7f7
MH
486}
487
0e60836b
SD
488static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
489 struct probe_trace_event **tevs __unused,
469b9b88 490 int max_tevs __unused, const char *mod __unused)
4b4da7f7 491{
146a1439
MH
492 if (perf_probe_event_need_dwarf(pev)) {
493 pr_warning("Debuginfo-analysis is not supported.\n");
494 return -ENOSYS;
495 }
4b4da7f7
MH
496 return 0;
497}
498
469b9b88 499int show_line_range(struct line_range *lr __unused, const char *module __unused)
4b4da7f7 500{
146a1439
MH
501 pr_warning("Debuginfo-analysis is not supported.\n");
502 return -ENOSYS;
4b4da7f7
MH
503}
504
cf6eb489 505int show_available_vars(struct perf_probe_event *pevs __unused,
469b9b88
MH
506 int npevs __unused, int max_vls __unused,
507 const char *module __unused, bool externs __unused)
cf6eb489
MH
508{
509 pr_warning("Debuginfo-analysis is not supported.\n");
510 return -ENOSYS;
511}
e0faa8d3
MH
512#endif
513
146a1439 514int parse_line_range_desc(const char *arg, struct line_range *lr)
631c9def
MH
515{
516 const char *ptr;
517 char *tmp;
518 /*
519 * <Syntax>
520 * SRC:SLN[+NUM|-ELN]
521 * FUNC[:SLN[+NUM|-ELN]]
522 */
523 ptr = strchr(arg, ':');
524 if (ptr) {
d3b63d7a 525 lr->start = (int)strtoul(ptr + 1, &tmp, 0);
dda4ab34 526 if (*tmp == '+') {
d3b63d7a 527 lr->end = lr->start + (int)strtoul(tmp + 1, &tmp, 0);
dda4ab34
MH
528 lr->end--; /*
529 * Adjust the number of lines here.
530 * If the number of lines == 1, the
531 * the end of line should be equal to
532 * the start of line.
533 */
534 } else if (*tmp == '-')
d3b63d7a 535 lr->end = (int)strtoul(tmp + 1, &tmp, 0);
631c9def 536 else
d3b63d7a
MH
537 lr->end = INT_MAX;
538 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
539 if (lr->start > lr->end) {
631c9def 540 semantic_error("Start line must be smaller"
146a1439
MH
541 " than end line.\n");
542 return -EINVAL;
543 }
544 if (*tmp != '\0') {
545 semantic_error("Tailing with invalid character '%d'.\n",
631c9def 546 *tmp);
146a1439
MH
547 return -EINVAL;
548 }
02b95dad 549 tmp = strndup(arg, (ptr - arg));
d3b63d7a 550 } else {
02b95dad 551 tmp = strdup(arg);
d3b63d7a
MH
552 lr->end = INT_MAX;
553 }
02b95dad
MH
554
555 if (tmp == NULL)
556 return -ENOMEM;
631c9def
MH
557
558 if (strchr(tmp, '.'))
559 lr->file = tmp;
560 else
561 lr->function = tmp;
146a1439
MH
562
563 return 0;
631c9def
MH
564}
565
b7702a21
MH
566/* Check the name is good for event/group */
567static bool check_event_name(const char *name)
568{
569 if (!isalpha(*name) && *name != '_')
570 return false;
571 while (*++name != '\0') {
572 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
573 return false;
574 }
575 return true;
576}
577
50656eec 578/* Parse probepoint definition. */
146a1439 579static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
50656eec 580{
4235b045 581 struct perf_probe_point *pp = &pev->point;
50656eec
MH
582 char *ptr, *tmp;
583 char c, nc = 0;
584 /*
585 * <Syntax>
2a9c8c36
MH
586 * perf probe [EVENT=]SRC[:LN|;PTN]
587 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
af663d75
MH
588 *
589 * TODO:Group name support
50656eec
MH
590 */
591
2a9c8c36
MH
592 ptr = strpbrk(arg, ";=@+%");
593 if (ptr && *ptr == '=') { /* Event name */
af663d75
MH
594 *ptr = '\0';
595 tmp = ptr + 1;
146a1439
MH
596 if (strchr(arg, ':')) {
597 semantic_error("Group name is not supported yet.\n");
598 return -ENOTSUP;
599 }
600 if (!check_event_name(arg)) {
b7702a21 601 semantic_error("%s is bad for event name -it must "
146a1439
MH
602 "follow C symbol-naming rule.\n", arg);
603 return -EINVAL;
604 }
02b95dad
MH
605 pev->event = strdup(arg);
606 if (pev->event == NULL)
607 return -ENOMEM;
4235b045 608 pev->group = NULL;
af663d75
MH
609 arg = tmp;
610 }
611
2a9c8c36 612 ptr = strpbrk(arg, ";:+@%");
50656eec
MH
613 if (ptr) {
614 nc = *ptr;
615 *ptr++ = '\0';
616 }
617
02b95dad
MH
618 tmp = strdup(arg);
619 if (tmp == NULL)
620 return -ENOMEM;
621
50656eec 622 /* Check arg is function or file and copy it */
02b95dad
MH
623 if (strchr(tmp, '.')) /* File */
624 pp->file = tmp;
50656eec 625 else /* Function */
02b95dad 626 pp->function = tmp;
50656eec
MH
627
628 /* Parse other options */
629 while (ptr) {
630 arg = ptr;
631 c = nc;
2a9c8c36 632 if (c == ';') { /* Lazy pattern must be the last part */
02b95dad
MH
633 pp->lazy_line = strdup(arg);
634 if (pp->lazy_line == NULL)
635 return -ENOMEM;
2a9c8c36
MH
636 break;
637 }
638 ptr = strpbrk(arg, ";:+@%");
50656eec
MH
639 if (ptr) {
640 nc = *ptr;
641 *ptr++ = '\0';
642 }
643 switch (c) {
644 case ':': /* Line number */
645 pp->line = strtoul(arg, &tmp, 0);
146a1439 646 if (*tmp != '\0') {
2a9c8c36 647 semantic_error("There is non-digit char"
146a1439
MH
648 " in line number.\n");
649 return -EINVAL;
650 }
50656eec
MH
651 break;
652 case '+': /* Byte offset from a symbol */
653 pp->offset = strtoul(arg, &tmp, 0);
146a1439 654 if (*tmp != '\0') {
2a9c8c36 655 semantic_error("There is non-digit character"
146a1439
MH
656 " in offset.\n");
657 return -EINVAL;
658 }
50656eec
MH
659 break;
660 case '@': /* File name */
146a1439
MH
661 if (pp->file) {
662 semantic_error("SRC@SRC is not allowed.\n");
663 return -EINVAL;
664 }
02b95dad
MH
665 pp->file = strdup(arg);
666 if (pp->file == NULL)
667 return -ENOMEM;
50656eec
MH
668 break;
669 case '%': /* Probe places */
670 if (strcmp(arg, "return") == 0) {
671 pp->retprobe = 1;
146a1439
MH
672 } else { /* Others not supported yet */
673 semantic_error("%%%s is not supported.\n", arg);
674 return -ENOTSUP;
675 }
50656eec 676 break;
146a1439
MH
677 default: /* Buggy case */
678 pr_err("This program has a bug at %s:%d.\n",
679 __FILE__, __LINE__);
680 return -ENOTSUP;
50656eec
MH
681 break;
682 }
683 }
684
685 /* Exclusion check */
146a1439 686 if (pp->lazy_line && pp->line) {
0e43e5d2
MH
687 semantic_error("Lazy pattern can't be used with"
688 " line number.\n");
146a1439
MH
689 return -EINVAL;
690 }
2a9c8c36 691
146a1439 692 if (pp->lazy_line && pp->offset) {
0e43e5d2 693 semantic_error("Lazy pattern can't be used with offset.\n");
146a1439
MH
694 return -EINVAL;
695 }
2a9c8c36 696
146a1439 697 if (pp->line && pp->offset) {
0e43e5d2 698 semantic_error("Offset can't be used with line number.\n");
146a1439
MH
699 return -EINVAL;
700 }
50656eec 701
146a1439 702 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
2a9c8c36 703 semantic_error("File always requires line number or "
0e43e5d2 704 "lazy pattern.\n");
146a1439
MH
705 return -EINVAL;
706 }
50656eec 707
146a1439 708 if (pp->offset && !pp->function) {
0e43e5d2 709 semantic_error("Offset requires an entry function.\n");
146a1439
MH
710 return -EINVAL;
711 }
50656eec 712
146a1439 713 if (pp->retprobe && !pp->function) {
0e43e5d2 714 semantic_error("Return probe requires an entry function.\n");
146a1439
MH
715 return -EINVAL;
716 }
50656eec 717
146a1439 718 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
2a9c8c36 719 semantic_error("Offset/Line/Lazy pattern can't be used with "
0e43e5d2 720 "return probe.\n");
146a1439
MH
721 return -EINVAL;
722 }
50656eec 723
4235b045 724 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
2a9c8c36
MH
725 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
726 pp->lazy_line);
146a1439 727 return 0;
50656eec
MH
728}
729
7df2f329 730/* Parse perf-probe event argument */
146a1439 731static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
7df2f329 732{
b2a3c12b 733 char *tmp, *goodname;
7df2f329
MH
734 struct perf_probe_arg_field **fieldp;
735
736 pr_debug("parsing arg: %s into ", str);
737
48481938
MH
738 tmp = strchr(str, '=');
739 if (tmp) {
02b95dad
MH
740 arg->name = strndup(str, tmp - str);
741 if (arg->name == NULL)
742 return -ENOMEM;
11a1ca35 743 pr_debug("name:%s ", arg->name);
48481938
MH
744 str = tmp + 1;
745 }
746
11a1ca35
MH
747 tmp = strchr(str, ':');
748 if (tmp) { /* Type setting */
749 *tmp = '\0';
02b95dad
MH
750 arg->type = strdup(tmp + 1);
751 if (arg->type == NULL)
752 return -ENOMEM;
11a1ca35
MH
753 pr_debug("type:%s ", arg->type);
754 }
755
b2a3c12b 756 tmp = strpbrk(str, "-.[");
7df2f329
MH
757 if (!is_c_varname(str) || !tmp) {
758 /* A variable, register, symbol or special value */
02b95dad
MH
759 arg->var = strdup(str);
760 if (arg->var == NULL)
761 return -ENOMEM;
48481938 762 pr_debug("%s\n", arg->var);
146a1439 763 return 0;
7df2f329
MH
764 }
765
b2a3c12b 766 /* Structure fields or array element */
02b95dad
MH
767 arg->var = strndup(str, tmp - str);
768 if (arg->var == NULL)
769 return -ENOMEM;
b2a3c12b 770 goodname = arg->var;
48481938 771 pr_debug("%s, ", arg->var);
7df2f329
MH
772 fieldp = &arg->field;
773
774 do {
e334016f
MH
775 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
776 if (*fieldp == NULL)
777 return -ENOMEM;
b2a3c12b
MH
778 if (*tmp == '[') { /* Array */
779 str = tmp;
780 (*fieldp)->index = strtol(str + 1, &tmp, 0);
7df2f329 781 (*fieldp)->ref = true;
b2a3c12b
MH
782 if (*tmp != ']' || tmp == str + 1) {
783 semantic_error("Array index must be a"
784 " number.\n");
785 return -EINVAL;
786 }
787 tmp++;
788 if (*tmp == '\0')
789 tmp = NULL;
790 } else { /* Structure */
791 if (*tmp == '.') {
792 str = tmp + 1;
793 (*fieldp)->ref = false;
794 } else if (tmp[1] == '>') {
795 str = tmp + 2;
796 (*fieldp)->ref = true;
797 } else {
798 semantic_error("Argument parse error: %s\n",
799 str);
800 return -EINVAL;
801 }
802 tmp = strpbrk(str, "-.[");
146a1439 803 }
7df2f329 804 if (tmp) {
02b95dad
MH
805 (*fieldp)->name = strndup(str, tmp - str);
806 if ((*fieldp)->name == NULL)
807 return -ENOMEM;
b2a3c12b
MH
808 if (*str != '[')
809 goodname = (*fieldp)->name;
7df2f329
MH
810 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
811 fieldp = &(*fieldp)->next;
812 }
813 } while (tmp);
02b95dad
MH
814 (*fieldp)->name = strdup(str);
815 if ((*fieldp)->name == NULL)
816 return -ENOMEM;
b2a3c12b
MH
817 if (*str != '[')
818 goodname = (*fieldp)->name;
7df2f329 819 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
df0faf4b 820
b2a3c12b 821 /* If no name is specified, set the last field name (not array index)*/
02b95dad 822 if (!arg->name) {
b2a3c12b 823 arg->name = strdup(goodname);
02b95dad
MH
824 if (arg->name == NULL)
825 return -ENOMEM;
826 }
146a1439 827 return 0;
7df2f329
MH
828}
829
4235b045 830/* Parse perf-probe event command */
146a1439 831int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
50656eec 832{
e1c01d61 833 char **argv;
146a1439 834 int argc, i, ret = 0;
fac13fd5 835
4235b045 836 argv = argv_split(cmd, &argc);
146a1439
MH
837 if (!argv) {
838 pr_debug("Failed to split arguments.\n");
839 return -ENOMEM;
840 }
841 if (argc - 1 > MAX_PROBE_ARGS) {
842 semantic_error("Too many probe arguments (%d).\n", argc - 1);
843 ret = -ERANGE;
844 goto out;
845 }
50656eec 846 /* Parse probe point */
146a1439
MH
847 ret = parse_perf_probe_point(argv[0], pev);
848 if (ret < 0)
849 goto out;
50656eec 850
e1c01d61 851 /* Copy arguments and ensure return probe has no C argument */
4235b045 852 pev->nargs = argc - 1;
e334016f
MH
853 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
854 if (pev->args == NULL) {
855 ret = -ENOMEM;
856 goto out;
857 }
146a1439
MH
858 for (i = 0; i < pev->nargs && ret >= 0; i++) {
859 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
860 if (ret >= 0 &&
861 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
4235b045 862 semantic_error("You can't specify local variable for"
146a1439
MH
863 " kretprobe.\n");
864 ret = -EINVAL;
865 }
e1c01d61 866 }
146a1439 867out:
e1c01d61 868 argv_free(argv);
146a1439
MH
869
870 return ret;
50656eec
MH
871}
872
4235b045
MH
873/* Return true if this perf_probe_event requires debuginfo */
874bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
875{
876 int i;
877
878 if (pev->point.file || pev->point.line || pev->point.lazy_line)
879 return true;
880
881 for (i = 0; i < pev->nargs; i++)
48481938 882 if (is_c_varname(pev->args[i].var))
4235b045
MH
883 return true;
884
885 return false;
886}
887
0e60836b
SD
888/* Parse probe_events event into struct probe_point */
889static int parse_probe_trace_command(const char *cmd,
890 struct probe_trace_event *tev)
4de189fe 891{
0e60836b 892 struct probe_trace_point *tp = &tev->point;
4de189fe
MH
893 char pr;
894 char *p;
895 int ret, i, argc;
896 char **argv;
897
0e60836b 898 pr_debug("Parsing probe_events: %s\n", cmd);
4235b045 899 argv = argv_split(cmd, &argc);
146a1439
MH
900 if (!argv) {
901 pr_debug("Failed to split arguments.\n");
902 return -ENOMEM;
903 }
904 if (argc < 2) {
905 semantic_error("Too few probe arguments.\n");
906 ret = -ERANGE;
907 goto out;
908 }
4de189fe
MH
909
910 /* Scan event and group name. */
93aaa45a 911 ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
4235b045
MH
912 &pr, (float *)(void *)&tev->group,
913 (float *)(void *)&tev->event);
146a1439
MH
914 if (ret != 3) {
915 semantic_error("Failed to parse event name: %s\n", argv[0]);
916 ret = -EINVAL;
917 goto out;
918 }
4235b045 919 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
4de189fe 920
4235b045 921 tp->retprobe = (pr == 'r');
4de189fe
MH
922
923 /* Scan function name and offset */
4235b045
MH
924 ret = sscanf(argv[1], "%a[^+]+%lu", (float *)(void *)&tp->symbol,
925 &tp->offset);
4de189fe 926 if (ret == 1)
4235b045 927 tp->offset = 0;
4de189fe 928
4235b045 929 tev->nargs = argc - 2;
0e60836b 930 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
e334016f
MH
931 if (tev->args == NULL) {
932 ret = -ENOMEM;
933 goto out;
934 }
4235b045 935 for (i = 0; i < tev->nargs; i++) {
4de189fe
MH
936 p = strchr(argv[i + 2], '=');
937 if (p) /* We don't need which register is assigned. */
4235b045
MH
938 *p++ = '\0';
939 else
940 p = argv[i + 2];
02b95dad 941 tev->args[i].name = strdup(argv[i + 2]);
4235b045 942 /* TODO: parse regs and offset */
02b95dad
MH
943 tev->args[i].value = strdup(p);
944 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
945 ret = -ENOMEM;
946 goto out;
947 }
4de189fe 948 }
146a1439
MH
949 ret = 0;
950out:
4de189fe 951 argv_free(argv);
146a1439 952 return ret;
4de189fe
MH
953}
954
7df2f329
MH
955/* Compose only probe arg */
956int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
957{
958 struct perf_probe_arg_field *field = pa->field;
959 int ret;
960 char *tmp = buf;
961
48481938
MH
962 if (pa->name && pa->var)
963 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
964 else
965 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
7df2f329
MH
966 if (ret <= 0)
967 goto error;
968 tmp += ret;
969 len -= ret;
970
971 while (field) {
b2a3c12b
MH
972 if (field->name[0] == '[')
973 ret = e_snprintf(tmp, len, "%s", field->name);
974 else
975 ret = e_snprintf(tmp, len, "%s%s",
976 field->ref ? "->" : ".", field->name);
7df2f329
MH
977 if (ret <= 0)
978 goto error;
979 tmp += ret;
980 len -= ret;
981 field = field->next;
982 }
11a1ca35
MH
983
984 if (pa->type) {
985 ret = e_snprintf(tmp, len, ":%s", pa->type);
986 if (ret <= 0)
987 goto error;
988 tmp += ret;
989 len -= ret;
990 }
991
7df2f329
MH
992 return tmp - buf;
993error:
0e43e5d2 994 pr_debug("Failed to synthesize perf probe argument: %s\n",
146a1439
MH
995 strerror(-ret));
996 return ret;
7df2f329
MH
997}
998
4235b045
MH
999/* Compose only probe point (not argument) */
1000static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
4de189fe 1001{
fb1587d8
MH
1002 char *buf, *tmp;
1003 char offs[32] = "", line[32] = "", file[32] = "";
1004 int ret, len;
4de189fe 1005
e334016f
MH
1006 buf = zalloc(MAX_CMDLEN);
1007 if (buf == NULL) {
1008 ret = -ENOMEM;
1009 goto error;
1010 }
4de189fe 1011 if (pp->offset) {
fb1587d8 1012 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
4de189fe
MH
1013 if (ret <= 0)
1014 goto error;
1015 }
1016 if (pp->line) {
fb1587d8
MH
1017 ret = e_snprintf(line, 32, ":%d", pp->line);
1018 if (ret <= 0)
1019 goto error;
1020 }
1021 if (pp->file) {
dd259c5d 1022 len = strlen(pp->file) - 31;
fb1587d8
MH
1023 if (len < 0)
1024 len = 0;
1025 tmp = strchr(pp->file + len, '/');
1026 if (!tmp)
dd259c5d 1027 tmp = pp->file + len;
fb1587d8 1028 ret = e_snprintf(file, 32, "@%s", tmp + 1);
4de189fe
MH
1029 if (ret <= 0)
1030 goto error;
1031 }
1032
1033 if (pp->function)
fb1587d8
MH
1034 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1035 offs, pp->retprobe ? "%return" : "", line,
1036 file);
4de189fe 1037 else
fb1587d8 1038 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
4235b045
MH
1039 if (ret <= 0)
1040 goto error;
1041
1042 return buf;
7ef17aaf 1043error:
0e43e5d2 1044 pr_debug("Failed to synthesize perf probe point: %s\n",
146a1439 1045 strerror(-ret));
e334016f
MH
1046 if (buf)
1047 free(buf);
146a1439 1048 return NULL;
7ef17aaf
MH
1049}
1050
4235b045
MH
1051#if 0
1052char *synthesize_perf_probe_command(struct perf_probe_event *pev)
7ef17aaf
MH
1053{
1054 char *buf;
1055 int i, len, ret;
1056
4235b045
MH
1057 buf = synthesize_perf_probe_point(&pev->point);
1058 if (!buf)
1059 return NULL;
4de189fe 1060
4235b045
MH
1061 len = strlen(buf);
1062 for (i = 0; i < pev->nargs; i++) {
4de189fe 1063 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
4235b045
MH
1064 pev->args[i].name);
1065 if (ret <= 0) {
1066 free(buf);
1067 return NULL;
1068 }
4de189fe
MH
1069 len += ret;
1070 }
4de189fe 1071
4235b045
MH
1072 return buf;
1073}
1074#endif
1075
0e60836b 1076static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
4235b045
MH
1077 char **buf, size_t *buflen,
1078 int depth)
1079{
1080 int ret;
1081 if (ref->next) {
0e60836b 1082 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
4235b045
MH
1083 buflen, depth + 1);
1084 if (depth < 0)
1085 goto out;
1086 }
1087
1088 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1089 if (ret < 0)
1090 depth = ret;
1091 else {
1092 *buf += ret;
1093 *buflen -= ret;
1094 }
1095out:
1096 return depth;
4de189fe 1097
4de189fe
MH
1098}
1099
0e60836b 1100static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
4235b045 1101 char *buf, size_t buflen)
50656eec 1102{
0e60836b 1103 struct probe_trace_arg_ref *ref = arg->ref;
4235b045
MH
1104 int ret, depth = 0;
1105 char *tmp = buf;
1106
1107 /* Argument name or separator */
1108 if (arg->name)
1109 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1110 else
1111 ret = e_snprintf(buf, buflen, " ");
1112 if (ret < 0)
1113 return ret;
1114 buf += ret;
1115 buflen -= ret;
1116
b7dcb857
MH
1117 /* Special case: @XXX */
1118 if (arg->value[0] == '@' && arg->ref)
1119 ref = ref->next;
1120
4235b045 1121 /* Dereferencing arguments */
b7dcb857 1122 if (ref) {
0e60836b 1123 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
4235b045
MH
1124 &buflen, 1);
1125 if (depth < 0)
1126 return depth;
1127 }
1128
1129 /* Print argument value */
b7dcb857
MH
1130 if (arg->value[0] == '@' && arg->ref)
1131 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1132 arg->ref->offset);
1133 else
1134 ret = e_snprintf(buf, buflen, "%s", arg->value);
4235b045
MH
1135 if (ret < 0)
1136 return ret;
1137 buf += ret;
1138 buflen -= ret;
1139
1140 /* Closing */
1141 while (depth--) {
1142 ret = e_snprintf(buf, buflen, ")");
1143 if (ret < 0)
1144 return ret;
1145 buf += ret;
1146 buflen -= ret;
1147 }
4984912e
MH
1148 /* Print argument type */
1149 if (arg->type) {
1150 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1151 if (ret <= 0)
1152 return ret;
1153 buf += ret;
1154 }
4235b045
MH
1155
1156 return buf - tmp;
1157}
1158
0e60836b 1159char *synthesize_probe_trace_command(struct probe_trace_event *tev)
4235b045 1160{
0e60836b 1161 struct probe_trace_point *tp = &tev->point;
50656eec
MH
1162 char *buf;
1163 int i, len, ret;
1164
e334016f
MH
1165 buf = zalloc(MAX_CMDLEN);
1166 if (buf == NULL)
1167 return NULL;
1168
4235b045
MH
1169 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s+%lu",
1170 tp->retprobe ? 'r' : 'p',
1171 tev->group, tev->event,
1172 tp->symbol, tp->offset);
1173 if (len <= 0)
50656eec 1174 goto error;
50656eec 1175
4235b045 1176 for (i = 0; i < tev->nargs; i++) {
0e60836b 1177 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
4235b045 1178 MAX_CMDLEN - len);
4de189fe 1179 if (ret <= 0)
50656eec
MH
1180 goto error;
1181 len += ret;
1182 }
50656eec 1183
4235b045 1184 return buf;
50656eec 1185error:
4235b045
MH
1186 free(buf);
1187 return NULL;
1188}
50656eec 1189
0e60836b 1190static int convert_to_perf_probe_event(struct probe_trace_event *tev,
469b9b88 1191 struct perf_probe_event *pev)
4235b045 1192{
02b95dad 1193 char buf[64] = "";
146a1439 1194 int i, ret;
4235b045 1195
4b4da7f7 1196 /* Convert event/group name */
02b95dad
MH
1197 pev->event = strdup(tev->event);
1198 pev->group = strdup(tev->group);
1199 if (pev->event == NULL || pev->group == NULL)
1200 return -ENOMEM;
fb1587d8 1201
4b4da7f7 1202 /* Convert trace_point to probe_point */
0e60836b 1203 ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
146a1439
MH
1204 if (ret < 0)
1205 return ret;
4b4da7f7 1206
4235b045
MH
1207 /* Convert trace_arg to probe_arg */
1208 pev->nargs = tev->nargs;
e334016f
MH
1209 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1210 if (pev->args == NULL)
1211 return -ENOMEM;
02b95dad 1212 for (i = 0; i < tev->nargs && ret >= 0; i++) {
4235b045 1213 if (tev->args[i].name)
02b95dad 1214 pev->args[i].name = strdup(tev->args[i].name);
4235b045 1215 else {
0e60836b 1216 ret = synthesize_probe_trace_arg(&tev->args[i],
146a1439 1217 buf, 64);
02b95dad 1218 pev->args[i].name = strdup(buf);
4235b045 1219 }
02b95dad
MH
1220 if (pev->args[i].name == NULL && ret >= 0)
1221 ret = -ENOMEM;
1222 }
146a1439
MH
1223
1224 if (ret < 0)
1225 clear_perf_probe_event(pev);
1226
1227 return ret;
4235b045
MH
1228}
1229
1230void clear_perf_probe_event(struct perf_probe_event *pev)
1231{
1232 struct perf_probe_point *pp = &pev->point;
7df2f329 1233 struct perf_probe_arg_field *field, *next;
4235b045
MH
1234 int i;
1235
1236 if (pev->event)
1237 free(pev->event);
1238 if (pev->group)
1239 free(pev->group);
1240 if (pp->file)
1241 free(pp->file);
1242 if (pp->function)
1243 free(pp->function);
1244 if (pp->lazy_line)
1245 free(pp->lazy_line);
7df2f329 1246 for (i = 0; i < pev->nargs; i++) {
4235b045
MH
1247 if (pev->args[i].name)
1248 free(pev->args[i].name);
48481938
MH
1249 if (pev->args[i].var)
1250 free(pev->args[i].var);
11a1ca35
MH
1251 if (pev->args[i].type)
1252 free(pev->args[i].type);
7df2f329
MH
1253 field = pev->args[i].field;
1254 while (field) {
1255 next = field->next;
1256 if (field->name)
1257 free(field->name);
1258 free(field);
1259 field = next;
1260 }
1261 }
4235b045
MH
1262 if (pev->args)
1263 free(pev->args);
1264 memset(pev, 0, sizeof(*pev));
1265}
1266
0e60836b 1267static void clear_probe_trace_event(struct probe_trace_event *tev)
4235b045 1268{
0e60836b 1269 struct probe_trace_arg_ref *ref, *next;
4235b045
MH
1270 int i;
1271
1272 if (tev->event)
1273 free(tev->event);
1274 if (tev->group)
1275 free(tev->group);
1276 if (tev->point.symbol)
1277 free(tev->point.symbol);
1278 for (i = 0; i < tev->nargs; i++) {
1279 if (tev->args[i].name)
1280 free(tev->args[i].name);
1281 if (tev->args[i].value)
1282 free(tev->args[i].value);
4984912e
MH
1283 if (tev->args[i].type)
1284 free(tev->args[i].type);
4235b045
MH
1285 ref = tev->args[i].ref;
1286 while (ref) {
1287 next = ref->next;
1288 free(ref);
1289 ref = next;
1290 }
1291 }
1292 if (tev->args)
1293 free(tev->args);
1294 memset(tev, 0, sizeof(*tev));
50656eec
MH
1295}
1296
f4d7da49 1297static int open_kprobe_events(bool readwrite)
4de189fe
MH
1298{
1299 char buf[PATH_MAX];
7ca5989d 1300 const char *__debugfs;
4de189fe
MH
1301 int ret;
1302
7ca5989d
MH
1303 __debugfs = debugfs_find_mountpoint();
1304 if (__debugfs == NULL) {
1305 pr_warning("Debugfs is not mounted.\n");
1306 return -ENOENT;
1307 }
1308
1309 ret = e_snprintf(buf, PATH_MAX, "%stracing/kprobe_events", __debugfs);
146a1439 1310 if (ret >= 0) {
7ca5989d 1311 pr_debug("Opening %s write=%d\n", buf, readwrite);
146a1439
MH
1312 if (readwrite && !probe_event_dry_run)
1313 ret = open(buf, O_RDWR, O_APPEND);
1314 else
1315 ret = open(buf, O_RDONLY, 0);
1316 }
f4d7da49 1317
4de189fe
MH
1318 if (ret < 0) {
1319 if (errno == ENOENT)
146a1439
MH
1320 pr_warning("kprobe_events file does not exist - please"
1321 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
4de189fe 1322 else
146a1439
MH
1323 pr_warning("Failed to open kprobe_events file: %s\n",
1324 strerror(errno));
4de189fe
MH
1325 }
1326 return ret;
1327}
1328
1329/* Get raw string list of current kprobe_events */
0e60836b 1330static struct strlist *get_probe_trace_command_rawlist(int fd)
4de189fe
MH
1331{
1332 int ret, idx;
1333 FILE *fp;
1334 char buf[MAX_CMDLEN];
1335 char *p;
1336 struct strlist *sl;
1337
1338 sl = strlist__new(true, NULL);
1339
1340 fp = fdopen(dup(fd), "r");
1341 while (!feof(fp)) {
1342 p = fgets(buf, MAX_CMDLEN, fp);
1343 if (!p)
1344 break;
1345
1346 idx = strlen(p) - 1;
1347 if (p[idx] == '\n')
1348 p[idx] = '\0';
1349 ret = strlist__add(sl, buf);
146a1439
MH
1350 if (ret < 0) {
1351 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1352 strlist__delete(sl);
1353 return NULL;
1354 }
4de189fe
MH
1355 }
1356 fclose(fp);
1357
1358 return sl;
1359}
1360
278498d4 1361/* Show an event */
146a1439 1362static int show_perf_probe_event(struct perf_probe_event *pev)
278498d4 1363{
7e990a51 1364 int i, ret;
278498d4 1365 char buf[128];
4235b045 1366 char *place;
278498d4 1367
4235b045
MH
1368 /* Synthesize only event probe point */
1369 place = synthesize_perf_probe_point(&pev->point);
146a1439
MH
1370 if (!place)
1371 return -EINVAL;
4235b045
MH
1372
1373 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
7e990a51 1374 if (ret < 0)
146a1439
MH
1375 return ret;
1376
fb1587d8 1377 printf(" %-20s (on %s", buf, place);
278498d4 1378
4235b045 1379 if (pev->nargs > 0) {
278498d4 1380 printf(" with");
7df2f329 1381 for (i = 0; i < pev->nargs; i++) {
146a1439
MH
1382 ret = synthesize_perf_probe_arg(&pev->args[i],
1383 buf, 128);
1384 if (ret < 0)
1385 break;
7df2f329
MH
1386 printf(" %s", buf);
1387 }
278498d4
MH
1388 }
1389 printf(")\n");
4235b045 1390 free(place);
146a1439 1391 return ret;
278498d4
MH
1392}
1393
4de189fe 1394/* List up current perf-probe events */
146a1439 1395int show_perf_probe_events(void)
4de189fe 1396{
146a1439 1397 int fd, ret;
0e60836b 1398 struct probe_trace_event tev;
4235b045 1399 struct perf_probe_event pev;
4de189fe
MH
1400 struct strlist *rawlist;
1401 struct str_node *ent;
1402
72041334 1403 setup_pager();
146a1439
MH
1404 ret = init_vmlinux();
1405 if (ret < 0)
1406 return ret;
4235b045
MH
1407
1408 memset(&tev, 0, sizeof(tev));
1409 memset(&pev, 0, sizeof(pev));
72041334 1410
f4d7da49 1411 fd = open_kprobe_events(false);
146a1439
MH
1412 if (fd < 0)
1413 return fd;
1414
0e60836b 1415 rawlist = get_probe_trace_command_rawlist(fd);
4de189fe 1416 close(fd);
146a1439
MH
1417 if (!rawlist)
1418 return -ENOENT;
4de189fe 1419
adf365f4 1420 strlist__for_each(ent, rawlist) {
0e60836b 1421 ret = parse_probe_trace_command(ent->s, &tev);
146a1439
MH
1422 if (ret >= 0) {
1423 ret = convert_to_perf_probe_event(&tev, &pev);
1424 if (ret >= 0)
1425 ret = show_perf_probe_event(&pev);
1426 }
4235b045 1427 clear_perf_probe_event(&pev);
0e60836b 1428 clear_probe_trace_event(&tev);
146a1439
MH
1429 if (ret < 0)
1430 break;
4de189fe 1431 }
4de189fe 1432 strlist__delete(rawlist);
146a1439
MH
1433
1434 return ret;
4de189fe
MH
1435}
1436
b498ce1f 1437/* Get current perf-probe event names */
0e60836b 1438static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
b498ce1f 1439{
fa28244d 1440 char buf[128];
b498ce1f
MH
1441 struct strlist *sl, *rawlist;
1442 struct str_node *ent;
0e60836b 1443 struct probe_trace_event tev;
146a1439 1444 int ret = 0;
b498ce1f 1445
4235b045 1446 memset(&tev, 0, sizeof(tev));
0e60836b 1447 rawlist = get_probe_trace_command_rawlist(fd);
e1d2017b 1448 sl = strlist__new(true, NULL);
adf365f4 1449 strlist__for_each(ent, rawlist) {
0e60836b 1450 ret = parse_probe_trace_command(ent->s, &tev);
146a1439
MH
1451 if (ret < 0)
1452 break;
fa28244d 1453 if (include_group) {
146a1439
MH
1454 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1455 tev.event);
1456 if (ret >= 0)
1457 ret = strlist__add(sl, buf);
fa28244d 1458 } else
146a1439 1459 ret = strlist__add(sl, tev.event);
0e60836b 1460 clear_probe_trace_event(&tev);
146a1439
MH
1461 if (ret < 0)
1462 break;
b498ce1f 1463 }
b498ce1f
MH
1464 strlist__delete(rawlist);
1465
146a1439
MH
1466 if (ret < 0) {
1467 strlist__delete(sl);
1468 return NULL;
1469 }
b498ce1f
MH
1470 return sl;
1471}
1472
0e60836b 1473static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
50656eec 1474{
6eca8cc3 1475 int ret = 0;
0e60836b 1476 char *buf = synthesize_probe_trace_command(tev);
50656eec 1477
146a1439 1478 if (!buf) {
0e60836b 1479 pr_debug("Failed to synthesize probe trace event.\n");
146a1439
MH
1480 return -EINVAL;
1481 }
1482
fa28244d 1483 pr_debug("Writing event: %s\n", buf);
f4d7da49
MH
1484 if (!probe_event_dry_run) {
1485 ret = write(fd, buf, strlen(buf));
1486 if (ret <= 0)
146a1439
MH
1487 pr_warning("Failed to write event: %s\n",
1488 strerror(errno));
f4d7da49 1489 }
4235b045 1490 free(buf);
146a1439 1491 return ret;
50656eec
MH
1492}
1493
146a1439
MH
1494static int get_new_event_name(char *buf, size_t len, const char *base,
1495 struct strlist *namelist, bool allow_suffix)
b498ce1f
MH
1496{
1497 int i, ret;
17f88fcd
MH
1498
1499 /* Try no suffix */
1500 ret = e_snprintf(buf, len, "%s", base);
146a1439
MH
1501 if (ret < 0) {
1502 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1503 return ret;
1504 }
17f88fcd 1505 if (!strlist__has_entry(namelist, buf))
146a1439 1506 return 0;
17f88fcd 1507
d761b08b
MH
1508 if (!allow_suffix) {
1509 pr_warning("Error: event \"%s\" already exists. "
1510 "(Use -f to force duplicates.)\n", base);
146a1439 1511 return -EEXIST;
d761b08b
MH
1512 }
1513
17f88fcd
MH
1514 /* Try to add suffix */
1515 for (i = 1; i < MAX_EVENT_INDEX; i++) {
b498ce1f 1516 ret = e_snprintf(buf, len, "%s_%d", base, i);
146a1439
MH
1517 if (ret < 0) {
1518 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1519 return ret;
1520 }
b498ce1f
MH
1521 if (!strlist__has_entry(namelist, buf))
1522 break;
1523 }
146a1439
MH
1524 if (i == MAX_EVENT_INDEX) {
1525 pr_warning("Too many events are on the same function.\n");
1526 ret = -ERANGE;
1527 }
1528
1529 return ret;
b498ce1f
MH
1530}
1531
0e60836b
SD
1532static int __add_probe_trace_events(struct perf_probe_event *pev,
1533 struct probe_trace_event *tevs,
146a1439 1534 int ntevs, bool allow_suffix)
50656eec 1535{
146a1439 1536 int i, fd, ret;
0e60836b 1537 struct probe_trace_event *tev = NULL;
4235b045
MH
1538 char buf[64];
1539 const char *event, *group;
b498ce1f 1540 struct strlist *namelist;
50656eec 1541
f4d7da49 1542 fd = open_kprobe_events(true);
146a1439
MH
1543 if (fd < 0)
1544 return fd;
b498ce1f 1545 /* Get current event names */
0e60836b 1546 namelist = get_probe_trace_event_names(fd, false);
146a1439
MH
1547 if (!namelist) {
1548 pr_debug("Failed to get current event list.\n");
1549 return -EIO;
1550 }
4235b045 1551
146a1439 1552 ret = 0;
4235b045 1553 printf("Add new event%s\n", (ntevs > 1) ? "s:" : ":");
02b95dad 1554 for (i = 0; i < ntevs; i++) {
4235b045
MH
1555 tev = &tevs[i];
1556 if (pev->event)
1557 event = pev->event;
1558 else
1559 if (pev->point.function)
1560 event = pev->point.function;
1561 else
1562 event = tev->point.symbol;
1563 if (pev->group)
1564 group = pev->group;
1565 else
1566 group = PERFPROBE_GROUP;
1567
1568 /* Get an unused new event name */
146a1439
MH
1569 ret = get_new_event_name(buf, 64, event,
1570 namelist, allow_suffix);
1571 if (ret < 0)
1572 break;
4235b045
MH
1573 event = buf;
1574
02b95dad
MH
1575 tev->event = strdup(event);
1576 tev->group = strdup(group);
1577 if (tev->event == NULL || tev->group == NULL) {
1578 ret = -ENOMEM;
1579 break;
1580 }
0e60836b 1581 ret = write_probe_trace_event(fd, tev);
146a1439
MH
1582 if (ret < 0)
1583 break;
4235b045
MH
1584 /* Add added event name to namelist */
1585 strlist__add(namelist, event);
1586
1587 /* Trick here - save current event/group */
1588 event = pev->event;
1589 group = pev->group;
1590 pev->event = tev->event;
1591 pev->group = tev->group;
1592 show_perf_probe_event(pev);
1593 /* Trick here - restore current event/group */
1594 pev->event = (char *)event;
1595 pev->group = (char *)group;
1596
1597 /*
1598 * Probes after the first probe which comes from same
1599 * user input are always allowed to add suffix, because
1600 * there might be several addresses corresponding to
1601 * one code line.
1602 */
1603 allow_suffix = true;
50656eec 1604 }
146a1439
MH
1605
1606 if (ret >= 0) {
1607 /* Show how to use the event. */
1608 printf("\nYou can now use it on all perf tools, such as:\n\n");
1609 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
1610 tev->event);
1611 }
a9b495b0 1612
e1d2017b 1613 strlist__delete(namelist);
50656eec 1614 close(fd);
146a1439 1615 return ret;
50656eec 1616}
fa28244d 1617
0e60836b
SD
1618static int convert_to_probe_trace_events(struct perf_probe_event *pev,
1619 struct probe_trace_event **tevs,
469b9b88 1620 int max_tevs, const char *module)
e0faa8d3
MH
1621{
1622 struct symbol *sym;
e334016f 1623 int ret = 0, i;
0e60836b 1624 struct probe_trace_event *tev;
4235b045 1625
4b4da7f7 1626 /* Convert perf_probe_event with debuginfo */
469b9b88 1627 ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, module);
e334016f
MH
1628 if (ret != 0)
1629 return ret;
e0faa8d3 1630
4235b045 1631 /* Allocate trace event buffer */
0e60836b 1632 tev = *tevs = zalloc(sizeof(struct probe_trace_event));
e334016f
MH
1633 if (tev == NULL)
1634 return -ENOMEM;
4235b045
MH
1635
1636 /* Copy parameters */
02b95dad
MH
1637 tev->point.symbol = strdup(pev->point.function);
1638 if (tev->point.symbol == NULL) {
1639 ret = -ENOMEM;
1640 goto error;
1641 }
4235b045 1642 tev->point.offset = pev->point.offset;
04ddd04b 1643 tev->point.retprobe = pev->point.retprobe;
4235b045
MH
1644 tev->nargs = pev->nargs;
1645 if (tev->nargs) {
0e60836b 1646 tev->args = zalloc(sizeof(struct probe_trace_arg)
e334016f
MH
1647 * tev->nargs);
1648 if (tev->args == NULL) {
02b95dad
MH
1649 ret = -ENOMEM;
1650 goto error;
e334016f 1651 }
48481938 1652 for (i = 0; i < tev->nargs; i++) {
02b95dad
MH
1653 if (pev->args[i].name) {
1654 tev->args[i].name = strdup(pev->args[i].name);
1655 if (tev->args[i].name == NULL) {
1656 ret = -ENOMEM;
1657 goto error;
1658 }
1659 }
1660 tev->args[i].value = strdup(pev->args[i].var);
1661 if (tev->args[i].value == NULL) {
1662 ret = -ENOMEM;
1663 goto error;
1664 }
1665 if (pev->args[i].type) {
1666 tev->args[i].type = strdup(pev->args[i].type);
1667 if (tev->args[i].type == NULL) {
1668 ret = -ENOMEM;
1669 goto error;
1670 }
1671 }
48481938 1672 }
4235b045
MH
1673 }
1674
1675 /* Currently just checking function name from symbol map */
469b9b88 1676 sym = __find_kernel_function_by_name(tev->point.symbol, NULL);
146a1439
MH
1677 if (!sym) {
1678 pr_warning("Kernel symbol \'%s\' not found.\n",
1679 tev->point.symbol);
02b95dad
MH
1680 ret = -ENOENT;
1681 goto error;
1682 }
e334016f 1683
02b95dad
MH
1684 return 1;
1685error:
0e60836b 1686 clear_probe_trace_event(tev);
02b95dad
MH
1687 free(tev);
1688 *tevs = NULL;
e334016f 1689 return ret;
4235b045
MH
1690}
1691
1692struct __event_package {
1693 struct perf_probe_event *pev;
0e60836b 1694 struct probe_trace_event *tevs;
4235b045
MH
1695 int ntevs;
1696};
1697
146a1439 1698int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
469b9b88 1699 int max_tevs, const char *module, bool force_add)
4235b045 1700{
146a1439 1701 int i, j, ret;
4235b045
MH
1702 struct __event_package *pkgs;
1703
e334016f
MH
1704 pkgs = zalloc(sizeof(struct __event_package) * npevs);
1705 if (pkgs == NULL)
1706 return -ENOMEM;
4235b045
MH
1707
1708 /* Init vmlinux path */
146a1439 1709 ret = init_vmlinux();
449e5b24
MH
1710 if (ret < 0) {
1711 free(pkgs);
146a1439 1712 return ret;
449e5b24 1713 }
4235b045
MH
1714
1715 /* Loop 1: convert all events */
1716 for (i = 0; i < npevs; i++) {
1717 pkgs[i].pev = &pevs[i];
1718 /* Convert with or without debuginfo */
0e60836b 1719 ret = convert_to_probe_trace_events(pkgs[i].pev,
469b9b88
MH
1720 &pkgs[i].tevs,
1721 max_tevs,
1722 module);
146a1439
MH
1723 if (ret < 0)
1724 goto end;
1725 pkgs[i].ntevs = ret;
e0faa8d3
MH
1726 }
1727
4235b045 1728 /* Loop 2: add all events */
146a1439 1729 for (i = 0; i < npevs && ret >= 0; i++)
0e60836b 1730 ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
146a1439
MH
1731 pkgs[i].ntevs, force_add);
1732end:
449e5b24
MH
1733 /* Loop 3: cleanup and free trace events */
1734 for (i = 0; i < npevs; i++) {
146a1439 1735 for (j = 0; j < pkgs[i].ntevs; j++)
0e60836b 1736 clear_probe_trace_event(&pkgs[i].tevs[j]);
449e5b24
MH
1737 free(pkgs[i].tevs);
1738 }
1739 free(pkgs);
146a1439
MH
1740
1741 return ret;
e0faa8d3
MH
1742}
1743
0e60836b 1744static int __del_trace_probe_event(int fd, struct str_node *ent)
bbbb521b
MH
1745{
1746 char *p;
1747 char buf[128];
4235b045 1748 int ret;
bbbb521b 1749
0e60836b 1750 /* Convert from perf-probe event to trace-probe event */
146a1439
MH
1751 ret = e_snprintf(buf, 128, "-:%s", ent->s);
1752 if (ret < 0)
1753 goto error;
1754
bbbb521b 1755 p = strchr(buf + 2, ':');
146a1439
MH
1756 if (!p) {
1757 pr_debug("Internal error: %s should have ':' but not.\n",
1758 ent->s);
1759 ret = -ENOTSUP;
1760 goto error;
1761 }
bbbb521b
MH
1762 *p = '/';
1763
4235b045
MH
1764 pr_debug("Writing event: %s\n", buf);
1765 ret = write(fd, buf, strlen(buf));
146a1439
MH
1766 if (ret < 0)
1767 goto error;
1768
bbbb521b 1769 printf("Remove event: %s\n", ent->s);
146a1439
MH
1770 return 0;
1771error:
1772 pr_warning("Failed to delete event: %s\n", strerror(-ret));
1773 return ret;
bbbb521b
MH
1774}
1775
0e60836b 1776static int del_trace_probe_event(int fd, const char *group,
146a1439 1777 const char *event, struct strlist *namelist)
fa28244d
MH
1778{
1779 char buf[128];
bbbb521b 1780 struct str_node *ent, *n;
146a1439 1781 int found = 0, ret = 0;
fa28244d 1782
146a1439
MH
1783 ret = e_snprintf(buf, 128, "%s:%s", group, event);
1784 if (ret < 0) {
0e43e5d2 1785 pr_err("Failed to copy event.\n");
146a1439
MH
1786 return ret;
1787 }
fa28244d 1788
bbbb521b
MH
1789 if (strpbrk(buf, "*?")) { /* Glob-exp */
1790 strlist__for_each_safe(ent, n, namelist)
1791 if (strglobmatch(ent->s, buf)) {
1792 found++;
0e60836b 1793 ret = __del_trace_probe_event(fd, ent);
146a1439
MH
1794 if (ret < 0)
1795 break;
bbbb521b
MH
1796 strlist__remove(namelist, ent);
1797 }
1798 } else {
1799 ent = strlist__find(namelist, buf);
1800 if (ent) {
1801 found++;
0e60836b 1802 ret = __del_trace_probe_event(fd, ent);
146a1439
MH
1803 if (ret >= 0)
1804 strlist__remove(namelist, ent);
bbbb521b
MH
1805 }
1806 }
146a1439
MH
1807 if (found == 0 && ret >= 0)
1808 pr_info("Info: Event \"%s\" does not exist.\n", buf);
1809
1810 return ret;
fa28244d
MH
1811}
1812
146a1439 1813int del_perf_probe_events(struct strlist *dellist)
fa28244d 1814{
146a1439 1815 int fd, ret = 0;
fa28244d
MH
1816 const char *group, *event;
1817 char *p, *str;
1818 struct str_node *ent;
1819 struct strlist *namelist;
1820
f4d7da49 1821 fd = open_kprobe_events(true);
146a1439
MH
1822 if (fd < 0)
1823 return fd;
1824
fa28244d 1825 /* Get current event names */
0e60836b 1826 namelist = get_probe_trace_event_names(fd, true);
146a1439
MH
1827 if (namelist == NULL)
1828 return -EINVAL;
fa28244d 1829
adf365f4 1830 strlist__for_each(ent, dellist) {
02b95dad
MH
1831 str = strdup(ent->s);
1832 if (str == NULL) {
1833 ret = -ENOMEM;
1834 break;
1835 }
bbbb521b 1836 pr_debug("Parsing: %s\n", str);
fa28244d
MH
1837 p = strchr(str, ':');
1838 if (p) {
1839 group = str;
1840 *p = '\0';
1841 event = p + 1;
1842 } else {
bbbb521b 1843 group = "*";
fa28244d
MH
1844 event = str;
1845 }
bbbb521b 1846 pr_debug("Group: %s, Event: %s\n", group, event);
0e60836b 1847 ret = del_trace_probe_event(fd, group, event, namelist);
fa28244d 1848 free(str);
146a1439
MH
1849 if (ret < 0)
1850 break;
fa28244d
MH
1851 }
1852 strlist__delete(namelist);
1853 close(fd);
146a1439
MH
1854
1855 return ret;
fa28244d
MH
1856}
1857