Loading...
1/*
2 * probe-event.c : perf-probe definition to probe_events format converter
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>
32#include <stdarg.h>
33#include <limits.h>
34#include <elf.h>
35
36#undef _GNU_SOURCE
37#include "util.h"
38#include "event.h"
39#include "string.h"
40#include "strlist.h"
41#include "debug.h"
42#include "cache.h"
43#include "color.h"
44#include "symbol.h"
45#include "thread.h"
46#include "debugfs.h"
47#include "trace-event.h" /* For __unused */
48#include "probe-event.h"
49#include "probe-finder.h"
50
51#define MAX_CMDLEN 256
52#define MAX_PROBE_ARGS 128
53#define PERFPROBE_GROUP "probe"
54
55bool probe_event_dry_run; /* Dry run flag */
56
57#define semantic_error(msg ...) pr_err("Semantic error :" msg)
58
59/* If there is no space to write, returns -E2BIG. */
60static int e_snprintf(char *str, size_t size, const char *format, ...)
61 __attribute__((format(printf, 3, 4)));
62
63static int e_snprintf(char *str, size_t size, const char *format, ...)
64{
65 int ret;
66 va_list ap;
67 va_start(ap, format);
68 ret = vsnprintf(str, size, format, ap);
69 va_end(ap);
70 if (ret >= (int)size)
71 ret = -E2BIG;
72 return ret;
73}
74
75static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
76static struct machine machine;
77
78/* Initialize symbol maps and path of vmlinux/modules */
79static int init_vmlinux(void)
80{
81 int ret;
82
83 symbol_conf.sort_by_name = true;
84 if (symbol_conf.vmlinux_name == NULL)
85 symbol_conf.try_vmlinux_path = true;
86 else
87 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
88 ret = symbol__init();
89 if (ret < 0) {
90 pr_debug("Failed to init symbol map.\n");
91 goto out;
92 }
93
94 ret = machine__init(&machine, "", HOST_KERNEL_ID);
95 if (ret < 0)
96 goto out;
97
98 if (machine__create_kernel_maps(&machine) < 0) {
99 pr_debug("machine__create_kernel_maps() failed.\n");
100 goto out;
101 }
102out:
103 if (ret < 0)
104 pr_warning("Failed to init vmlinux path.\n");
105 return ret;
106}
107
108static struct symbol *__find_kernel_function_by_name(const char *name,
109 struct map **mapp)
110{
111 return machine__find_kernel_function_by_name(&machine, name, mapp,
112 NULL);
113}
114
115static struct map *kernel_get_module_map(const char *module)
116{
117 struct rb_node *nd;
118 struct map_groups *grp = &machine.kmaps;
119
120 /* A file path -- this is an offline module */
121 if (module && strchr(module, '/'))
122 return machine__new_module(&machine, 0, module);
123
124 if (!module)
125 module = "kernel";
126
127 for (nd = rb_first(&grp->maps[MAP__FUNCTION]); nd; nd = rb_next(nd)) {
128 struct map *pos = rb_entry(nd, struct map, rb_node);
129 if (strncmp(pos->dso->short_name + 1, module,
130 pos->dso->short_name_len - 2) == 0) {
131 return pos;
132 }
133 }
134 return NULL;
135}
136
137static struct dso *kernel_get_module_dso(const char *module)
138{
139 struct dso *dso;
140 struct map *map;
141 const char *vmlinux_name;
142
143 if (module) {
144 list_for_each_entry(dso, &machine.kernel_dsos, node) {
145 if (strncmp(dso->short_name + 1, module,
146 dso->short_name_len - 2) == 0)
147 goto found;
148 }
149 pr_debug("Failed to find module %s.\n", module);
150 return NULL;
151 }
152
153 map = machine.vmlinux_maps[MAP__FUNCTION];
154 dso = map->dso;
155
156 vmlinux_name = symbol_conf.vmlinux_name;
157 if (vmlinux_name) {
158 if (dso__load_vmlinux(dso, map, vmlinux_name, NULL) <= 0)
159 return NULL;
160 } else {
161 if (dso__load_vmlinux_path(dso, map, NULL) <= 0) {
162 pr_debug("Failed to load kernel map.\n");
163 return NULL;
164 }
165 }
166found:
167 return dso;
168}
169
170const char *kernel_get_module_path(const char *module)
171{
172 struct dso *dso = kernel_get_module_dso(module);
173 return (dso) ? dso->long_name : NULL;
174}
175
176#ifdef DWARF_SUPPORT
177/* Open new debuginfo of given module */
178static struct debuginfo *open_debuginfo(const char *module)
179{
180 const char *path;
181
182 /* A file path -- this is an offline module */
183 if (module && strchr(module, '/'))
184 path = module;
185 else {
186 path = kernel_get_module_path(module);
187
188 if (!path) {
189 pr_err("Failed to find path of %s module.\n",
190 module ?: "kernel");
191 return NULL;
192 }
193 }
194 return debuginfo__new(path);
195}
196
197/*
198 * Convert trace point to probe point with debuginfo
199 * Currently only handles kprobes.
200 */
201static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
202 struct perf_probe_point *pp)
203{
204 struct symbol *sym;
205 struct map *map;
206 u64 addr;
207 int ret = -ENOENT;
208 struct debuginfo *dinfo;
209
210 sym = __find_kernel_function_by_name(tp->symbol, &map);
211 if (sym) {
212 addr = map->unmap_ip(map, sym->start + tp->offset);
213 pr_debug("try to find %s+%ld@%" PRIx64 "\n", tp->symbol,
214 tp->offset, addr);
215
216 dinfo = debuginfo__new_online_kernel(addr);
217 if (dinfo) {
218 ret = debuginfo__find_probe_point(dinfo,
219 (unsigned long)addr, pp);
220 debuginfo__delete(dinfo);
221 } else {
222 pr_debug("Failed to open debuginfo at 0x%" PRIx64 "\n",
223 addr);
224 ret = -ENOENT;
225 }
226 }
227 if (ret <= 0) {
228 pr_debug("Failed to find corresponding probes from "
229 "debuginfo. Use kprobe event information.\n");
230 pp->function = strdup(tp->symbol);
231 if (pp->function == NULL)
232 return -ENOMEM;
233 pp->offset = tp->offset;
234 }
235 pp->retprobe = tp->retprobe;
236
237 return 0;
238}
239
240static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
241 int ntevs, const char *module)
242{
243 int i, ret = 0;
244 char *tmp;
245
246 if (!module)
247 return 0;
248
249 tmp = strrchr(module, '/');
250 if (tmp) {
251 /* This is a module path -- get the module name */
252 module = strdup(tmp + 1);
253 if (!module)
254 return -ENOMEM;
255 tmp = strchr(module, '.');
256 if (tmp)
257 *tmp = '\0';
258 tmp = (char *)module; /* For free() */
259 }
260
261 for (i = 0; i < ntevs; i++) {
262 tevs[i].point.module = strdup(module);
263 if (!tevs[i].point.module) {
264 ret = -ENOMEM;
265 break;
266 }
267 }
268
269 if (tmp)
270 free(tmp);
271
272 return ret;
273}
274
275/* Try to find perf_probe_event with debuginfo */
276static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
277 struct probe_trace_event **tevs,
278 int max_tevs, const char *module)
279{
280 bool need_dwarf = perf_probe_event_need_dwarf(pev);
281 struct debuginfo *dinfo = open_debuginfo(module);
282 int ntevs, ret = 0;
283
284 if (!dinfo) {
285 if (need_dwarf) {
286 pr_warning("Failed to open debuginfo file.\n");
287 return -ENOENT;
288 }
289 pr_debug("Could not open debuginfo. Try to use symbols.\n");
290 return 0;
291 }
292
293 /* Searching trace events corresponding to a probe event */
294 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);
295
296 debuginfo__delete(dinfo);
297
298 if (ntevs > 0) { /* Succeeded to find trace events */
299 pr_debug("find %d probe_trace_events.\n", ntevs);
300 if (module)
301 ret = add_module_to_probe_trace_events(*tevs, ntevs,
302 module);
303 return ret < 0 ? ret : ntevs;
304 }
305
306 if (ntevs == 0) { /* No error but failed to find probe point. */
307 pr_warning("Probe point '%s' not found.\n",
308 synthesize_perf_probe_point(&pev->point));
309 return -ENOENT;
310 }
311 /* Error path : ntevs < 0 */
312 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
313 if (ntevs == -EBADF) {
314 pr_warning("Warning: No dwarf info found in the vmlinux - "
315 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
316 if (!need_dwarf) {
317 pr_debug("Trying to use symbols.\n");
318 return 0;
319 }
320 }
321 return ntevs;
322}
323
324/*
325 * Find a src file from a DWARF tag path. Prepend optional source path prefix
326 * and chop off leading directories that do not exist. Result is passed back as
327 * a newly allocated path on success.
328 * Return 0 if file was found and readable, -errno otherwise.
329 */
330static int get_real_path(const char *raw_path, const char *comp_dir,
331 char **new_path)
332{
333 const char *prefix = symbol_conf.source_prefix;
334
335 if (!prefix) {
336 if (raw_path[0] != '/' && comp_dir)
337 /* If not an absolute path, try to use comp_dir */
338 prefix = comp_dir;
339 else {
340 if (access(raw_path, R_OK) == 0) {
341 *new_path = strdup(raw_path);
342 return 0;
343 } else
344 return -errno;
345 }
346 }
347
348 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
349 if (!*new_path)
350 return -ENOMEM;
351
352 for (;;) {
353 sprintf(*new_path, "%s/%s", prefix, raw_path);
354
355 if (access(*new_path, R_OK) == 0)
356 return 0;
357
358 if (!symbol_conf.source_prefix)
359 /* In case of searching comp_dir, don't retry */
360 return -errno;
361
362 switch (errno) {
363 case ENAMETOOLONG:
364 case ENOENT:
365 case EROFS:
366 case EFAULT:
367 raw_path = strchr(++raw_path, '/');
368 if (!raw_path) {
369 free(*new_path);
370 *new_path = NULL;
371 return -ENOENT;
372 }
373 continue;
374
375 default:
376 free(*new_path);
377 *new_path = NULL;
378 return -errno;
379 }
380 }
381}
382
383#define LINEBUF_SIZE 256
384#define NR_ADDITIONAL_LINES 2
385
386static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
387{
388 char buf[LINEBUF_SIZE];
389 const char *color = show_num ? "" : PERF_COLOR_BLUE;
390 const char *prefix = NULL;
391
392 do {
393 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
394 goto error;
395 if (skip)
396 continue;
397 if (!prefix) {
398 prefix = show_num ? "%7d " : " ";
399 color_fprintf(stdout, color, prefix, l);
400 }
401 color_fprintf(stdout, color, "%s", buf);
402
403 } while (strchr(buf, '\n') == NULL);
404
405 return 1;
406error:
407 if (ferror(fp)) {
408 pr_warning("File read error: %s\n", strerror(errno));
409 return -1;
410 }
411 return 0;
412}
413
414static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
415{
416 int rv = __show_one_line(fp, l, skip, show_num);
417 if (rv == 0) {
418 pr_warning("Source file is shorter than expected.\n");
419 rv = -1;
420 }
421 return rv;
422}
423
424#define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
425#define show_one_line(f,l) _show_one_line(f,l,false,false)
426#define skip_one_line(f,l) _show_one_line(f,l,true,false)
427#define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
428
429/*
430 * Show line-range always requires debuginfo to find source file and
431 * line number.
432 */
433int show_line_range(struct line_range *lr, const char *module)
434{
435 int l = 1;
436 struct line_node *ln;
437 struct debuginfo *dinfo;
438 FILE *fp;
439 int ret;
440 char *tmp;
441
442 /* Search a line range */
443 ret = init_vmlinux();
444 if (ret < 0)
445 return ret;
446
447 dinfo = open_debuginfo(module);
448 if (!dinfo) {
449 pr_warning("Failed to open debuginfo file.\n");
450 return -ENOENT;
451 }
452
453 ret = debuginfo__find_line_range(dinfo, lr);
454 debuginfo__delete(dinfo);
455 if (ret == 0) {
456 pr_warning("Specified source line is not found.\n");
457 return -ENOENT;
458 } else if (ret < 0) {
459 pr_warning("Debuginfo analysis failed. (%d)\n", ret);
460 return ret;
461 }
462
463 /* Convert source file path */
464 tmp = lr->path;
465 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
466 free(tmp); /* Free old path */
467 if (ret < 0) {
468 pr_warning("Failed to find source file. (%d)\n", ret);
469 return ret;
470 }
471
472 setup_pager();
473
474 if (lr->function)
475 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
476 lr->start - lr->offset);
477 else
478 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
479
480 fp = fopen(lr->path, "r");
481 if (fp == NULL) {
482 pr_warning("Failed to open %s: %s\n", lr->path,
483 strerror(errno));
484 return -errno;
485 }
486 /* Skip to starting line number */
487 while (l < lr->start) {
488 ret = skip_one_line(fp, l++);
489 if (ret < 0)
490 goto end;
491 }
492
493 list_for_each_entry(ln, &lr->line_list, list) {
494 for (; ln->line > l; l++) {
495 ret = show_one_line(fp, l - lr->offset);
496 if (ret < 0)
497 goto end;
498 }
499 ret = show_one_line_with_num(fp, l++ - lr->offset);
500 if (ret < 0)
501 goto end;
502 }
503
504 if (lr->end == INT_MAX)
505 lr->end = l + NR_ADDITIONAL_LINES;
506 while (l <= lr->end) {
507 ret = show_one_line_or_eof(fp, l++ - lr->offset);
508 if (ret <= 0)
509 break;
510 }
511end:
512 fclose(fp);
513 return ret;
514}
515
516static int show_available_vars_at(struct debuginfo *dinfo,
517 struct perf_probe_event *pev,
518 int max_vls, struct strfilter *_filter,
519 bool externs)
520{
521 char *buf;
522 int ret, i, nvars;
523 struct str_node *node;
524 struct variable_list *vls = NULL, *vl;
525 const char *var;
526
527 buf = synthesize_perf_probe_point(&pev->point);
528 if (!buf)
529 return -EINVAL;
530 pr_debug("Searching variables at %s\n", buf);
531
532 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
533 max_vls, externs);
534 if (ret <= 0) {
535 pr_err("Failed to find variables at %s (%d)\n", buf, ret);
536 goto end;
537 }
538 /* Some variables are found */
539 fprintf(stdout, "Available variables at %s\n", buf);
540 for (i = 0; i < ret; i++) {
541 vl = &vls[i];
542 /*
543 * A probe point might be converted to
544 * several trace points.
545 */
546 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
547 vl->point.offset);
548 free(vl->point.symbol);
549 nvars = 0;
550 if (vl->vars) {
551 strlist__for_each(node, vl->vars) {
552 var = strchr(node->s, '\t') + 1;
553 if (strfilter__compare(_filter, var)) {
554 fprintf(stdout, "\t\t%s\n", node->s);
555 nvars++;
556 }
557 }
558 strlist__delete(vl->vars);
559 }
560 if (nvars == 0)
561 fprintf(stdout, "\t\t(No matched variables)\n");
562 }
563 free(vls);
564end:
565 free(buf);
566 return ret;
567}
568
569/* Show available variables on given probe point */
570int show_available_vars(struct perf_probe_event *pevs, int npevs,
571 int max_vls, const char *module,
572 struct strfilter *_filter, bool externs)
573{
574 int i, ret = 0;
575 struct debuginfo *dinfo;
576
577 ret = init_vmlinux();
578 if (ret < 0)
579 return ret;
580
581 dinfo = open_debuginfo(module);
582 if (!dinfo) {
583 pr_warning("Failed to open debuginfo file.\n");
584 return -ENOENT;
585 }
586
587 setup_pager();
588
589 for (i = 0; i < npevs && ret >= 0; i++)
590 ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
591 externs);
592
593 debuginfo__delete(dinfo);
594 return ret;
595}
596
597#else /* !DWARF_SUPPORT */
598
599static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
600 struct perf_probe_point *pp)
601{
602 struct symbol *sym;
603
604 sym = __find_kernel_function_by_name(tp->symbol, NULL);
605 if (!sym) {
606 pr_err("Failed to find symbol %s in kernel.\n", tp->symbol);
607 return -ENOENT;
608 }
609 pp->function = strdup(tp->symbol);
610 if (pp->function == NULL)
611 return -ENOMEM;
612 pp->offset = tp->offset;
613 pp->retprobe = tp->retprobe;
614
615 return 0;
616}
617
618static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
619 struct probe_trace_event **tevs __unused,
620 int max_tevs __unused, const char *mod __unused)
621{
622 if (perf_probe_event_need_dwarf(pev)) {
623 pr_warning("Debuginfo-analysis is not supported.\n");
624 return -ENOSYS;
625 }
626 return 0;
627}
628
629int show_line_range(struct line_range *lr __unused, const char *module __unused)
630{
631 pr_warning("Debuginfo-analysis is not supported.\n");
632 return -ENOSYS;
633}
634
635int show_available_vars(struct perf_probe_event *pevs __unused,
636 int npevs __unused, int max_vls __unused,
637 const char *module __unused,
638 struct strfilter *filter __unused,
639 bool externs __unused)
640{
641 pr_warning("Debuginfo-analysis is not supported.\n");
642 return -ENOSYS;
643}
644#endif
645
646static int parse_line_num(char **ptr, int *val, const char *what)
647{
648 const char *start = *ptr;
649
650 errno = 0;
651 *val = strtol(*ptr, ptr, 0);
652 if (errno || *ptr == start) {
653 semantic_error("'%s' is not a valid number.\n", what);
654 return -EINVAL;
655 }
656 return 0;
657}
658
659/*
660 * Stuff 'lr' according to the line range described by 'arg'.
661 * The line range syntax is described by:
662 *
663 * SRC[:SLN[+NUM|-ELN]]
664 * FNC[@SRC][:SLN[+NUM|-ELN]]
665 */
666int parse_line_range_desc(const char *arg, struct line_range *lr)
667{
668 char *range, *file, *name = strdup(arg);
669 int err;
670
671 if (!name)
672 return -ENOMEM;
673
674 lr->start = 0;
675 lr->end = INT_MAX;
676
677 range = strchr(name, ':');
678 if (range) {
679 *range++ = '\0';
680
681 err = parse_line_num(&range, &lr->start, "start line");
682 if (err)
683 goto err;
684
685 if (*range == '+' || *range == '-') {
686 const char c = *range++;
687
688 err = parse_line_num(&range, &lr->end, "end line");
689 if (err)
690 goto err;
691
692 if (c == '+') {
693 lr->end += lr->start;
694 /*
695 * Adjust the number of lines here.
696 * If the number of lines == 1, the
697 * the end of line should be equal to
698 * the start of line.
699 */
700 lr->end--;
701 }
702 }
703
704 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
705
706 err = -EINVAL;
707 if (lr->start > lr->end) {
708 semantic_error("Start line must be smaller"
709 " than end line.\n");
710 goto err;
711 }
712 if (*range != '\0') {
713 semantic_error("Tailing with invalid str '%s'.\n", range);
714 goto err;
715 }
716 }
717
718 file = strchr(name, '@');
719 if (file) {
720 *file = '\0';
721 lr->file = strdup(++file);
722 if (lr->file == NULL) {
723 err = -ENOMEM;
724 goto err;
725 }
726 lr->function = name;
727 } else if (strchr(name, '.'))
728 lr->file = name;
729 else
730 lr->function = name;
731
732 return 0;
733err:
734 free(name);
735 return err;
736}
737
738/* Check the name is good for event/group */
739static bool check_event_name(const char *name)
740{
741 if (!isalpha(*name) && *name != '_')
742 return false;
743 while (*++name != '\0') {
744 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
745 return false;
746 }
747 return true;
748}
749
750/* Parse probepoint definition. */
751static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
752{
753 struct perf_probe_point *pp = &pev->point;
754 char *ptr, *tmp;
755 char c, nc = 0;
756 /*
757 * <Syntax>
758 * perf probe [EVENT=]SRC[:LN|;PTN]
759 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
760 *
761 * TODO:Group name support
762 */
763
764 ptr = strpbrk(arg, ";=@+%");
765 if (ptr && *ptr == '=') { /* Event name */
766 *ptr = '\0';
767 tmp = ptr + 1;
768 if (strchr(arg, ':')) {
769 semantic_error("Group name is not supported yet.\n");
770 return -ENOTSUP;
771 }
772 if (!check_event_name(arg)) {
773 semantic_error("%s is bad for event name -it must "
774 "follow C symbol-naming rule.\n", arg);
775 return -EINVAL;
776 }
777 pev->event = strdup(arg);
778 if (pev->event == NULL)
779 return -ENOMEM;
780 pev->group = NULL;
781 arg = tmp;
782 }
783
784 ptr = strpbrk(arg, ";:+@%");
785 if (ptr) {
786 nc = *ptr;
787 *ptr++ = '\0';
788 }
789
790 tmp = strdup(arg);
791 if (tmp == NULL)
792 return -ENOMEM;
793
794 /* Check arg is function or file and copy it */
795 if (strchr(tmp, '.')) /* File */
796 pp->file = tmp;
797 else /* Function */
798 pp->function = tmp;
799
800 /* Parse other options */
801 while (ptr) {
802 arg = ptr;
803 c = nc;
804 if (c == ';') { /* Lazy pattern must be the last part */
805 pp->lazy_line = strdup(arg);
806 if (pp->lazy_line == NULL)
807 return -ENOMEM;
808 break;
809 }
810 ptr = strpbrk(arg, ";:+@%");
811 if (ptr) {
812 nc = *ptr;
813 *ptr++ = '\0';
814 }
815 switch (c) {
816 case ':': /* Line number */
817 pp->line = strtoul(arg, &tmp, 0);
818 if (*tmp != '\0') {
819 semantic_error("There is non-digit char"
820 " in line number.\n");
821 return -EINVAL;
822 }
823 break;
824 case '+': /* Byte offset from a symbol */
825 pp->offset = strtoul(arg, &tmp, 0);
826 if (*tmp != '\0') {
827 semantic_error("There is non-digit character"
828 " in offset.\n");
829 return -EINVAL;
830 }
831 break;
832 case '@': /* File name */
833 if (pp->file) {
834 semantic_error("SRC@SRC is not allowed.\n");
835 return -EINVAL;
836 }
837 pp->file = strdup(arg);
838 if (pp->file == NULL)
839 return -ENOMEM;
840 break;
841 case '%': /* Probe places */
842 if (strcmp(arg, "return") == 0) {
843 pp->retprobe = 1;
844 } else { /* Others not supported yet */
845 semantic_error("%%%s is not supported.\n", arg);
846 return -ENOTSUP;
847 }
848 break;
849 default: /* Buggy case */
850 pr_err("This program has a bug at %s:%d.\n",
851 __FILE__, __LINE__);
852 return -ENOTSUP;
853 break;
854 }
855 }
856
857 /* Exclusion check */
858 if (pp->lazy_line && pp->line) {
859 semantic_error("Lazy pattern can't be used with"
860 " line number.\n");
861 return -EINVAL;
862 }
863
864 if (pp->lazy_line && pp->offset) {
865 semantic_error("Lazy pattern can't be used with offset.\n");
866 return -EINVAL;
867 }
868
869 if (pp->line && pp->offset) {
870 semantic_error("Offset can't be used with line number.\n");
871 return -EINVAL;
872 }
873
874 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
875 semantic_error("File always requires line number or "
876 "lazy pattern.\n");
877 return -EINVAL;
878 }
879
880 if (pp->offset && !pp->function) {
881 semantic_error("Offset requires an entry function.\n");
882 return -EINVAL;
883 }
884
885 if (pp->retprobe && !pp->function) {
886 semantic_error("Return probe requires an entry function.\n");
887 return -EINVAL;
888 }
889
890 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
891 semantic_error("Offset/Line/Lazy pattern can't be used with "
892 "return probe.\n");
893 return -EINVAL;
894 }
895
896 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
897 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
898 pp->lazy_line);
899 return 0;
900}
901
902/* Parse perf-probe event argument */
903static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
904{
905 char *tmp, *goodname;
906 struct perf_probe_arg_field **fieldp;
907
908 pr_debug("parsing arg: %s into ", str);
909
910 tmp = strchr(str, '=');
911 if (tmp) {
912 arg->name = strndup(str, tmp - str);
913 if (arg->name == NULL)
914 return -ENOMEM;
915 pr_debug("name:%s ", arg->name);
916 str = tmp + 1;
917 }
918
919 tmp = strchr(str, ':');
920 if (tmp) { /* Type setting */
921 *tmp = '\0';
922 arg->type = strdup(tmp + 1);
923 if (arg->type == NULL)
924 return -ENOMEM;
925 pr_debug("type:%s ", arg->type);
926 }
927
928 tmp = strpbrk(str, "-.[");
929 if (!is_c_varname(str) || !tmp) {
930 /* A variable, register, symbol or special value */
931 arg->var = strdup(str);
932 if (arg->var == NULL)
933 return -ENOMEM;
934 pr_debug("%s\n", arg->var);
935 return 0;
936 }
937
938 /* Structure fields or array element */
939 arg->var = strndup(str, tmp - str);
940 if (arg->var == NULL)
941 return -ENOMEM;
942 goodname = arg->var;
943 pr_debug("%s, ", arg->var);
944 fieldp = &arg->field;
945
946 do {
947 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
948 if (*fieldp == NULL)
949 return -ENOMEM;
950 if (*tmp == '[') { /* Array */
951 str = tmp;
952 (*fieldp)->index = strtol(str + 1, &tmp, 0);
953 (*fieldp)->ref = true;
954 if (*tmp != ']' || tmp == str + 1) {
955 semantic_error("Array index must be a"
956 " number.\n");
957 return -EINVAL;
958 }
959 tmp++;
960 if (*tmp == '\0')
961 tmp = NULL;
962 } else { /* Structure */
963 if (*tmp == '.') {
964 str = tmp + 1;
965 (*fieldp)->ref = false;
966 } else if (tmp[1] == '>') {
967 str = tmp + 2;
968 (*fieldp)->ref = true;
969 } else {
970 semantic_error("Argument parse error: %s\n",
971 str);
972 return -EINVAL;
973 }
974 tmp = strpbrk(str, "-.[");
975 }
976 if (tmp) {
977 (*fieldp)->name = strndup(str, tmp - str);
978 if ((*fieldp)->name == NULL)
979 return -ENOMEM;
980 if (*str != '[')
981 goodname = (*fieldp)->name;
982 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
983 fieldp = &(*fieldp)->next;
984 }
985 } while (tmp);
986 (*fieldp)->name = strdup(str);
987 if ((*fieldp)->name == NULL)
988 return -ENOMEM;
989 if (*str != '[')
990 goodname = (*fieldp)->name;
991 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
992
993 /* If no name is specified, set the last field name (not array index)*/
994 if (!arg->name) {
995 arg->name = strdup(goodname);
996 if (arg->name == NULL)
997 return -ENOMEM;
998 }
999 return 0;
1000}
1001
1002/* Parse perf-probe event command */
1003int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1004{
1005 char **argv;
1006 int argc, i, ret = 0;
1007
1008 argv = argv_split(cmd, &argc);
1009 if (!argv) {
1010 pr_debug("Failed to split arguments.\n");
1011 return -ENOMEM;
1012 }
1013 if (argc - 1 > MAX_PROBE_ARGS) {
1014 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1015 ret = -ERANGE;
1016 goto out;
1017 }
1018 /* Parse probe point */
1019 ret = parse_perf_probe_point(argv[0], pev);
1020 if (ret < 0)
1021 goto out;
1022
1023 /* Copy arguments and ensure return probe has no C argument */
1024 pev->nargs = argc - 1;
1025 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1026 if (pev->args == NULL) {
1027 ret = -ENOMEM;
1028 goto out;
1029 }
1030 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1031 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1032 if (ret >= 0 &&
1033 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1034 semantic_error("You can't specify local variable for"
1035 " kretprobe.\n");
1036 ret = -EINVAL;
1037 }
1038 }
1039out:
1040 argv_free(argv);
1041
1042 return ret;
1043}
1044
1045/* Return true if this perf_probe_event requires debuginfo */
1046bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1047{
1048 int i;
1049
1050 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1051 return true;
1052
1053 for (i = 0; i < pev->nargs; i++)
1054 if (is_c_varname(pev->args[i].var))
1055 return true;
1056
1057 return false;
1058}
1059
1060/* Parse probe_events event into struct probe_point */
1061static int parse_probe_trace_command(const char *cmd,
1062 struct probe_trace_event *tev)
1063{
1064 struct probe_trace_point *tp = &tev->point;
1065 char pr;
1066 char *p;
1067 int ret, i, argc;
1068 char **argv;
1069
1070 pr_debug("Parsing probe_events: %s\n", cmd);
1071 argv = argv_split(cmd, &argc);
1072 if (!argv) {
1073 pr_debug("Failed to split arguments.\n");
1074 return -ENOMEM;
1075 }
1076 if (argc < 2) {
1077 semantic_error("Too few probe arguments.\n");
1078 ret = -ERANGE;
1079 goto out;
1080 }
1081
1082 /* Scan event and group name. */
1083 ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
1084 &pr, (float *)(void *)&tev->group,
1085 (float *)(void *)&tev->event);
1086 if (ret != 3) {
1087 semantic_error("Failed to parse event name: %s\n", argv[0]);
1088 ret = -EINVAL;
1089 goto out;
1090 }
1091 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1092
1093 tp->retprobe = (pr == 'r');
1094
1095 /* Scan module name(if there), function name and offset */
1096 p = strchr(argv[1], ':');
1097 if (p) {
1098 tp->module = strndup(argv[1], p - argv[1]);
1099 p++;
1100 } else
1101 p = argv[1];
1102 ret = sscanf(p, "%a[^+]+%lu", (float *)(void *)&tp->symbol,
1103 &tp->offset);
1104 if (ret == 1)
1105 tp->offset = 0;
1106
1107 tev->nargs = argc - 2;
1108 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1109 if (tev->args == NULL) {
1110 ret = -ENOMEM;
1111 goto out;
1112 }
1113 for (i = 0; i < tev->nargs; i++) {
1114 p = strchr(argv[i + 2], '=');
1115 if (p) /* We don't need which register is assigned. */
1116 *p++ = '\0';
1117 else
1118 p = argv[i + 2];
1119 tev->args[i].name = strdup(argv[i + 2]);
1120 /* TODO: parse regs and offset */
1121 tev->args[i].value = strdup(p);
1122 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1123 ret = -ENOMEM;
1124 goto out;
1125 }
1126 }
1127 ret = 0;
1128out:
1129 argv_free(argv);
1130 return ret;
1131}
1132
1133/* Compose only probe arg */
1134int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1135{
1136 struct perf_probe_arg_field *field = pa->field;
1137 int ret;
1138 char *tmp = buf;
1139
1140 if (pa->name && pa->var)
1141 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1142 else
1143 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1144 if (ret <= 0)
1145 goto error;
1146 tmp += ret;
1147 len -= ret;
1148
1149 while (field) {
1150 if (field->name[0] == '[')
1151 ret = e_snprintf(tmp, len, "%s", field->name);
1152 else
1153 ret = e_snprintf(tmp, len, "%s%s",
1154 field->ref ? "->" : ".", field->name);
1155 if (ret <= 0)
1156 goto error;
1157 tmp += ret;
1158 len -= ret;
1159 field = field->next;
1160 }
1161
1162 if (pa->type) {
1163 ret = e_snprintf(tmp, len, ":%s", pa->type);
1164 if (ret <= 0)
1165 goto error;
1166 tmp += ret;
1167 len -= ret;
1168 }
1169
1170 return tmp - buf;
1171error:
1172 pr_debug("Failed to synthesize perf probe argument: %s\n",
1173 strerror(-ret));
1174 return ret;
1175}
1176
1177/* Compose only probe point (not argument) */
1178static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1179{
1180 char *buf, *tmp;
1181 char offs[32] = "", line[32] = "", file[32] = "";
1182 int ret, len;
1183
1184 buf = zalloc(MAX_CMDLEN);
1185 if (buf == NULL) {
1186 ret = -ENOMEM;
1187 goto error;
1188 }
1189 if (pp->offset) {
1190 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1191 if (ret <= 0)
1192 goto error;
1193 }
1194 if (pp->line) {
1195 ret = e_snprintf(line, 32, ":%d", pp->line);
1196 if (ret <= 0)
1197 goto error;
1198 }
1199 if (pp->file) {
1200 tmp = pp->file;
1201 len = strlen(tmp);
1202 if (len > 30) {
1203 tmp = strchr(pp->file + len - 30, '/');
1204 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1205 }
1206 ret = e_snprintf(file, 32, "@%s", tmp);
1207 if (ret <= 0)
1208 goto error;
1209 }
1210
1211 if (pp->function)
1212 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1213 offs, pp->retprobe ? "%return" : "", line,
1214 file);
1215 else
1216 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1217 if (ret <= 0)
1218 goto error;
1219
1220 return buf;
1221error:
1222 pr_debug("Failed to synthesize perf probe point: %s\n",
1223 strerror(-ret));
1224 if (buf)
1225 free(buf);
1226 return NULL;
1227}
1228
1229#if 0
1230char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1231{
1232 char *buf;
1233 int i, len, ret;
1234
1235 buf = synthesize_perf_probe_point(&pev->point);
1236 if (!buf)
1237 return NULL;
1238
1239 len = strlen(buf);
1240 for (i = 0; i < pev->nargs; i++) {
1241 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1242 pev->args[i].name);
1243 if (ret <= 0) {
1244 free(buf);
1245 return NULL;
1246 }
1247 len += ret;
1248 }
1249
1250 return buf;
1251}
1252#endif
1253
1254static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1255 char **buf, size_t *buflen,
1256 int depth)
1257{
1258 int ret;
1259 if (ref->next) {
1260 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1261 buflen, depth + 1);
1262 if (depth < 0)
1263 goto out;
1264 }
1265
1266 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1267 if (ret < 0)
1268 depth = ret;
1269 else {
1270 *buf += ret;
1271 *buflen -= ret;
1272 }
1273out:
1274 return depth;
1275
1276}
1277
1278static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1279 char *buf, size_t buflen)
1280{
1281 struct probe_trace_arg_ref *ref = arg->ref;
1282 int ret, depth = 0;
1283 char *tmp = buf;
1284
1285 /* Argument name or separator */
1286 if (arg->name)
1287 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1288 else
1289 ret = e_snprintf(buf, buflen, " ");
1290 if (ret < 0)
1291 return ret;
1292 buf += ret;
1293 buflen -= ret;
1294
1295 /* Special case: @XXX */
1296 if (arg->value[0] == '@' && arg->ref)
1297 ref = ref->next;
1298
1299 /* Dereferencing arguments */
1300 if (ref) {
1301 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1302 &buflen, 1);
1303 if (depth < 0)
1304 return depth;
1305 }
1306
1307 /* Print argument value */
1308 if (arg->value[0] == '@' && arg->ref)
1309 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1310 arg->ref->offset);
1311 else
1312 ret = e_snprintf(buf, buflen, "%s", arg->value);
1313 if (ret < 0)
1314 return ret;
1315 buf += ret;
1316 buflen -= ret;
1317
1318 /* Closing */
1319 while (depth--) {
1320 ret = e_snprintf(buf, buflen, ")");
1321 if (ret < 0)
1322 return ret;
1323 buf += ret;
1324 buflen -= ret;
1325 }
1326 /* Print argument type */
1327 if (arg->type) {
1328 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1329 if (ret <= 0)
1330 return ret;
1331 buf += ret;
1332 }
1333
1334 return buf - tmp;
1335}
1336
1337char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1338{
1339 struct probe_trace_point *tp = &tev->point;
1340 char *buf;
1341 int i, len, ret;
1342
1343 buf = zalloc(MAX_CMDLEN);
1344 if (buf == NULL)
1345 return NULL;
1346
1347 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s%s%s+%lu",
1348 tp->retprobe ? 'r' : 'p',
1349 tev->group, tev->event,
1350 tp->module ?: "", tp->module ? ":" : "",
1351 tp->symbol, tp->offset);
1352 if (len <= 0)
1353 goto error;
1354
1355 for (i = 0; i < tev->nargs; i++) {
1356 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1357 MAX_CMDLEN - len);
1358 if (ret <= 0)
1359 goto error;
1360 len += ret;
1361 }
1362
1363 return buf;
1364error:
1365 free(buf);
1366 return NULL;
1367}
1368
1369static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1370 struct perf_probe_event *pev)
1371{
1372 char buf[64] = "";
1373 int i, ret;
1374
1375 /* Convert event/group name */
1376 pev->event = strdup(tev->event);
1377 pev->group = strdup(tev->group);
1378 if (pev->event == NULL || pev->group == NULL)
1379 return -ENOMEM;
1380
1381 /* Convert trace_point to probe_point */
1382 ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
1383 if (ret < 0)
1384 return ret;
1385
1386 /* Convert trace_arg to probe_arg */
1387 pev->nargs = tev->nargs;
1388 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1389 if (pev->args == NULL)
1390 return -ENOMEM;
1391 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1392 if (tev->args[i].name)
1393 pev->args[i].name = strdup(tev->args[i].name);
1394 else {
1395 ret = synthesize_probe_trace_arg(&tev->args[i],
1396 buf, 64);
1397 pev->args[i].name = strdup(buf);
1398 }
1399 if (pev->args[i].name == NULL && ret >= 0)
1400 ret = -ENOMEM;
1401 }
1402
1403 if (ret < 0)
1404 clear_perf_probe_event(pev);
1405
1406 return ret;
1407}
1408
1409void clear_perf_probe_event(struct perf_probe_event *pev)
1410{
1411 struct perf_probe_point *pp = &pev->point;
1412 struct perf_probe_arg_field *field, *next;
1413 int i;
1414
1415 if (pev->event)
1416 free(pev->event);
1417 if (pev->group)
1418 free(pev->group);
1419 if (pp->file)
1420 free(pp->file);
1421 if (pp->function)
1422 free(pp->function);
1423 if (pp->lazy_line)
1424 free(pp->lazy_line);
1425 for (i = 0; i < pev->nargs; i++) {
1426 if (pev->args[i].name)
1427 free(pev->args[i].name);
1428 if (pev->args[i].var)
1429 free(pev->args[i].var);
1430 if (pev->args[i].type)
1431 free(pev->args[i].type);
1432 field = pev->args[i].field;
1433 while (field) {
1434 next = field->next;
1435 if (field->name)
1436 free(field->name);
1437 free(field);
1438 field = next;
1439 }
1440 }
1441 if (pev->args)
1442 free(pev->args);
1443 memset(pev, 0, sizeof(*pev));
1444}
1445
1446static void clear_probe_trace_event(struct probe_trace_event *tev)
1447{
1448 struct probe_trace_arg_ref *ref, *next;
1449 int i;
1450
1451 if (tev->event)
1452 free(tev->event);
1453 if (tev->group)
1454 free(tev->group);
1455 if (tev->point.symbol)
1456 free(tev->point.symbol);
1457 if (tev->point.module)
1458 free(tev->point.module);
1459 for (i = 0; i < tev->nargs; i++) {
1460 if (tev->args[i].name)
1461 free(tev->args[i].name);
1462 if (tev->args[i].value)
1463 free(tev->args[i].value);
1464 if (tev->args[i].type)
1465 free(tev->args[i].type);
1466 ref = tev->args[i].ref;
1467 while (ref) {
1468 next = ref->next;
1469 free(ref);
1470 ref = next;
1471 }
1472 }
1473 if (tev->args)
1474 free(tev->args);
1475 memset(tev, 0, sizeof(*tev));
1476}
1477
1478static int open_kprobe_events(bool readwrite)
1479{
1480 char buf[PATH_MAX];
1481 const char *__debugfs;
1482 int ret;
1483
1484 __debugfs = debugfs_find_mountpoint();
1485 if (__debugfs == NULL) {
1486 pr_warning("Debugfs is not mounted.\n");
1487 return -ENOENT;
1488 }
1489
1490 ret = e_snprintf(buf, PATH_MAX, "%stracing/kprobe_events", __debugfs);
1491 if (ret >= 0) {
1492 pr_debug("Opening %s write=%d\n", buf, readwrite);
1493 if (readwrite && !probe_event_dry_run)
1494 ret = open(buf, O_RDWR, O_APPEND);
1495 else
1496 ret = open(buf, O_RDONLY, 0);
1497 }
1498
1499 if (ret < 0) {
1500 if (errno == ENOENT)
1501 pr_warning("kprobe_events file does not exist - please"
1502 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
1503 else
1504 pr_warning("Failed to open kprobe_events file: %s\n",
1505 strerror(errno));
1506 }
1507 return ret;
1508}
1509
1510/* Get raw string list of current kprobe_events */
1511static struct strlist *get_probe_trace_command_rawlist(int fd)
1512{
1513 int ret, idx;
1514 FILE *fp;
1515 char buf[MAX_CMDLEN];
1516 char *p;
1517 struct strlist *sl;
1518
1519 sl = strlist__new(true, NULL);
1520
1521 fp = fdopen(dup(fd), "r");
1522 while (!feof(fp)) {
1523 p = fgets(buf, MAX_CMDLEN, fp);
1524 if (!p)
1525 break;
1526
1527 idx = strlen(p) - 1;
1528 if (p[idx] == '\n')
1529 p[idx] = '\0';
1530 ret = strlist__add(sl, buf);
1531 if (ret < 0) {
1532 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1533 strlist__delete(sl);
1534 return NULL;
1535 }
1536 }
1537 fclose(fp);
1538
1539 return sl;
1540}
1541
1542/* Show an event */
1543static int show_perf_probe_event(struct perf_probe_event *pev)
1544{
1545 int i, ret;
1546 char buf[128];
1547 char *place;
1548
1549 /* Synthesize only event probe point */
1550 place = synthesize_perf_probe_point(&pev->point);
1551 if (!place)
1552 return -EINVAL;
1553
1554 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1555 if (ret < 0)
1556 return ret;
1557
1558 printf(" %-20s (on %s", buf, place);
1559
1560 if (pev->nargs > 0) {
1561 printf(" with");
1562 for (i = 0; i < pev->nargs; i++) {
1563 ret = synthesize_perf_probe_arg(&pev->args[i],
1564 buf, 128);
1565 if (ret < 0)
1566 break;
1567 printf(" %s", buf);
1568 }
1569 }
1570 printf(")\n");
1571 free(place);
1572 return ret;
1573}
1574
1575/* List up current perf-probe events */
1576int show_perf_probe_events(void)
1577{
1578 int fd, ret;
1579 struct probe_trace_event tev;
1580 struct perf_probe_event pev;
1581 struct strlist *rawlist;
1582 struct str_node *ent;
1583
1584 setup_pager();
1585 ret = init_vmlinux();
1586 if (ret < 0)
1587 return ret;
1588
1589 memset(&tev, 0, sizeof(tev));
1590 memset(&pev, 0, sizeof(pev));
1591
1592 fd = open_kprobe_events(false);
1593 if (fd < 0)
1594 return fd;
1595
1596 rawlist = get_probe_trace_command_rawlist(fd);
1597 close(fd);
1598 if (!rawlist)
1599 return -ENOENT;
1600
1601 strlist__for_each(ent, rawlist) {
1602 ret = parse_probe_trace_command(ent->s, &tev);
1603 if (ret >= 0) {
1604 ret = convert_to_perf_probe_event(&tev, &pev);
1605 if (ret >= 0)
1606 ret = show_perf_probe_event(&pev);
1607 }
1608 clear_perf_probe_event(&pev);
1609 clear_probe_trace_event(&tev);
1610 if (ret < 0)
1611 break;
1612 }
1613 strlist__delete(rawlist);
1614
1615 return ret;
1616}
1617
1618/* Get current perf-probe event names */
1619static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
1620{
1621 char buf[128];
1622 struct strlist *sl, *rawlist;
1623 struct str_node *ent;
1624 struct probe_trace_event tev;
1625 int ret = 0;
1626
1627 memset(&tev, 0, sizeof(tev));
1628 rawlist = get_probe_trace_command_rawlist(fd);
1629 sl = strlist__new(true, NULL);
1630 strlist__for_each(ent, rawlist) {
1631 ret = parse_probe_trace_command(ent->s, &tev);
1632 if (ret < 0)
1633 break;
1634 if (include_group) {
1635 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1636 tev.event);
1637 if (ret >= 0)
1638 ret = strlist__add(sl, buf);
1639 } else
1640 ret = strlist__add(sl, tev.event);
1641 clear_probe_trace_event(&tev);
1642 if (ret < 0)
1643 break;
1644 }
1645 strlist__delete(rawlist);
1646
1647 if (ret < 0) {
1648 strlist__delete(sl);
1649 return NULL;
1650 }
1651 return sl;
1652}
1653
1654static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
1655{
1656 int ret = 0;
1657 char *buf = synthesize_probe_trace_command(tev);
1658
1659 if (!buf) {
1660 pr_debug("Failed to synthesize probe trace event.\n");
1661 return -EINVAL;
1662 }
1663
1664 pr_debug("Writing event: %s\n", buf);
1665 if (!probe_event_dry_run) {
1666 ret = write(fd, buf, strlen(buf));
1667 if (ret <= 0)
1668 pr_warning("Failed to write event: %s\n",
1669 strerror(errno));
1670 }
1671 free(buf);
1672 return ret;
1673}
1674
1675static int get_new_event_name(char *buf, size_t len, const char *base,
1676 struct strlist *namelist, bool allow_suffix)
1677{
1678 int i, ret;
1679
1680 /* Try no suffix */
1681 ret = e_snprintf(buf, len, "%s", base);
1682 if (ret < 0) {
1683 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1684 return ret;
1685 }
1686 if (!strlist__has_entry(namelist, buf))
1687 return 0;
1688
1689 if (!allow_suffix) {
1690 pr_warning("Error: event \"%s\" already exists. "
1691 "(Use -f to force duplicates.)\n", base);
1692 return -EEXIST;
1693 }
1694
1695 /* Try to add suffix */
1696 for (i = 1; i < MAX_EVENT_INDEX; i++) {
1697 ret = e_snprintf(buf, len, "%s_%d", base, i);
1698 if (ret < 0) {
1699 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1700 return ret;
1701 }
1702 if (!strlist__has_entry(namelist, buf))
1703 break;
1704 }
1705 if (i == MAX_EVENT_INDEX) {
1706 pr_warning("Too many events are on the same function.\n");
1707 ret = -ERANGE;
1708 }
1709
1710 return ret;
1711}
1712
1713static int __add_probe_trace_events(struct perf_probe_event *pev,
1714 struct probe_trace_event *tevs,
1715 int ntevs, bool allow_suffix)
1716{
1717 int i, fd, ret;
1718 struct probe_trace_event *tev = NULL;
1719 char buf[64];
1720 const char *event, *group;
1721 struct strlist *namelist;
1722
1723 fd = open_kprobe_events(true);
1724 if (fd < 0)
1725 return fd;
1726 /* Get current event names */
1727 namelist = get_probe_trace_event_names(fd, false);
1728 if (!namelist) {
1729 pr_debug("Failed to get current event list.\n");
1730 return -EIO;
1731 }
1732
1733 ret = 0;
1734 printf("Add new event%s\n", (ntevs > 1) ? "s:" : ":");
1735 for (i = 0; i < ntevs; i++) {
1736 tev = &tevs[i];
1737 if (pev->event)
1738 event = pev->event;
1739 else
1740 if (pev->point.function)
1741 event = pev->point.function;
1742 else
1743 event = tev->point.symbol;
1744 if (pev->group)
1745 group = pev->group;
1746 else
1747 group = PERFPROBE_GROUP;
1748
1749 /* Get an unused new event name */
1750 ret = get_new_event_name(buf, 64, event,
1751 namelist, allow_suffix);
1752 if (ret < 0)
1753 break;
1754 event = buf;
1755
1756 tev->event = strdup(event);
1757 tev->group = strdup(group);
1758 if (tev->event == NULL || tev->group == NULL) {
1759 ret = -ENOMEM;
1760 break;
1761 }
1762 ret = write_probe_trace_event(fd, tev);
1763 if (ret < 0)
1764 break;
1765 /* Add added event name to namelist */
1766 strlist__add(namelist, event);
1767
1768 /* Trick here - save current event/group */
1769 event = pev->event;
1770 group = pev->group;
1771 pev->event = tev->event;
1772 pev->group = tev->group;
1773 show_perf_probe_event(pev);
1774 /* Trick here - restore current event/group */
1775 pev->event = (char *)event;
1776 pev->group = (char *)group;
1777
1778 /*
1779 * Probes after the first probe which comes from same
1780 * user input are always allowed to add suffix, because
1781 * there might be several addresses corresponding to
1782 * one code line.
1783 */
1784 allow_suffix = true;
1785 }
1786
1787 if (ret >= 0) {
1788 /* Show how to use the event. */
1789 printf("\nYou can now use it on all perf tools, such as:\n\n");
1790 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
1791 tev->event);
1792 }
1793
1794 strlist__delete(namelist);
1795 close(fd);
1796 return ret;
1797}
1798
1799static int convert_to_probe_trace_events(struct perf_probe_event *pev,
1800 struct probe_trace_event **tevs,
1801 int max_tevs, const char *module)
1802{
1803 struct symbol *sym;
1804 int ret = 0, i;
1805 struct probe_trace_event *tev;
1806
1807 /* Convert perf_probe_event with debuginfo */
1808 ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, module);
1809 if (ret != 0)
1810 return ret; /* Found in debuginfo or got an error */
1811
1812 /* Allocate trace event buffer */
1813 tev = *tevs = zalloc(sizeof(struct probe_trace_event));
1814 if (tev == NULL)
1815 return -ENOMEM;
1816
1817 /* Copy parameters */
1818 tev->point.symbol = strdup(pev->point.function);
1819 if (tev->point.symbol == NULL) {
1820 ret = -ENOMEM;
1821 goto error;
1822 }
1823
1824 if (module) {
1825 tev->point.module = strdup(module);
1826 if (tev->point.module == NULL) {
1827 ret = -ENOMEM;
1828 goto error;
1829 }
1830 }
1831
1832 tev->point.offset = pev->point.offset;
1833 tev->point.retprobe = pev->point.retprobe;
1834 tev->nargs = pev->nargs;
1835 if (tev->nargs) {
1836 tev->args = zalloc(sizeof(struct probe_trace_arg)
1837 * tev->nargs);
1838 if (tev->args == NULL) {
1839 ret = -ENOMEM;
1840 goto error;
1841 }
1842 for (i = 0; i < tev->nargs; i++) {
1843 if (pev->args[i].name) {
1844 tev->args[i].name = strdup(pev->args[i].name);
1845 if (tev->args[i].name == NULL) {
1846 ret = -ENOMEM;
1847 goto error;
1848 }
1849 }
1850 tev->args[i].value = strdup(pev->args[i].var);
1851 if (tev->args[i].value == NULL) {
1852 ret = -ENOMEM;
1853 goto error;
1854 }
1855 if (pev->args[i].type) {
1856 tev->args[i].type = strdup(pev->args[i].type);
1857 if (tev->args[i].type == NULL) {
1858 ret = -ENOMEM;
1859 goto error;
1860 }
1861 }
1862 }
1863 }
1864
1865 /* Currently just checking function name from symbol map */
1866 sym = __find_kernel_function_by_name(tev->point.symbol, NULL);
1867 if (!sym) {
1868 pr_warning("Kernel symbol \'%s\' not found.\n",
1869 tev->point.symbol);
1870 ret = -ENOENT;
1871 goto error;
1872 }
1873
1874 return 1;
1875error:
1876 clear_probe_trace_event(tev);
1877 free(tev);
1878 *tevs = NULL;
1879 return ret;
1880}
1881
1882struct __event_package {
1883 struct perf_probe_event *pev;
1884 struct probe_trace_event *tevs;
1885 int ntevs;
1886};
1887
1888int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
1889 int max_tevs, const char *module, bool force_add)
1890{
1891 int i, j, ret;
1892 struct __event_package *pkgs;
1893
1894 pkgs = zalloc(sizeof(struct __event_package) * npevs);
1895 if (pkgs == NULL)
1896 return -ENOMEM;
1897
1898 /* Init vmlinux path */
1899 ret = init_vmlinux();
1900 if (ret < 0) {
1901 free(pkgs);
1902 return ret;
1903 }
1904
1905 /* Loop 1: convert all events */
1906 for (i = 0; i < npevs; i++) {
1907 pkgs[i].pev = &pevs[i];
1908 /* Convert with or without debuginfo */
1909 ret = convert_to_probe_trace_events(pkgs[i].pev,
1910 &pkgs[i].tevs,
1911 max_tevs,
1912 module);
1913 if (ret < 0)
1914 goto end;
1915 pkgs[i].ntevs = ret;
1916 }
1917
1918 /* Loop 2: add all events */
1919 for (i = 0; i < npevs; i++) {
1920 ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
1921 pkgs[i].ntevs, force_add);
1922 if (ret < 0)
1923 break;
1924 }
1925end:
1926 /* Loop 3: cleanup and free trace events */
1927 for (i = 0; i < npevs; i++) {
1928 for (j = 0; j < pkgs[i].ntevs; j++)
1929 clear_probe_trace_event(&pkgs[i].tevs[j]);
1930 free(pkgs[i].tevs);
1931 }
1932 free(pkgs);
1933
1934 return ret;
1935}
1936
1937static int __del_trace_probe_event(int fd, struct str_node *ent)
1938{
1939 char *p;
1940 char buf[128];
1941 int ret;
1942
1943 /* Convert from perf-probe event to trace-probe event */
1944 ret = e_snprintf(buf, 128, "-:%s", ent->s);
1945 if (ret < 0)
1946 goto error;
1947
1948 p = strchr(buf + 2, ':');
1949 if (!p) {
1950 pr_debug("Internal error: %s should have ':' but not.\n",
1951 ent->s);
1952 ret = -ENOTSUP;
1953 goto error;
1954 }
1955 *p = '/';
1956
1957 pr_debug("Writing event: %s\n", buf);
1958 ret = write(fd, buf, strlen(buf));
1959 if (ret < 0)
1960 goto error;
1961
1962 printf("Remove event: %s\n", ent->s);
1963 return 0;
1964error:
1965 pr_warning("Failed to delete event: %s\n", strerror(-ret));
1966 return ret;
1967}
1968
1969static int del_trace_probe_event(int fd, const char *group,
1970 const char *event, struct strlist *namelist)
1971{
1972 char buf[128];
1973 struct str_node *ent, *n;
1974 int found = 0, ret = 0;
1975
1976 ret = e_snprintf(buf, 128, "%s:%s", group, event);
1977 if (ret < 0) {
1978 pr_err("Failed to copy event.\n");
1979 return ret;
1980 }
1981
1982 if (strpbrk(buf, "*?")) { /* Glob-exp */
1983 strlist__for_each_safe(ent, n, namelist)
1984 if (strglobmatch(ent->s, buf)) {
1985 found++;
1986 ret = __del_trace_probe_event(fd, ent);
1987 if (ret < 0)
1988 break;
1989 strlist__remove(namelist, ent);
1990 }
1991 } else {
1992 ent = strlist__find(namelist, buf);
1993 if (ent) {
1994 found++;
1995 ret = __del_trace_probe_event(fd, ent);
1996 if (ret >= 0)
1997 strlist__remove(namelist, ent);
1998 }
1999 }
2000 if (found == 0 && ret >= 0)
2001 pr_info("Info: Event \"%s\" does not exist.\n", buf);
2002
2003 return ret;
2004}
2005
2006int del_perf_probe_events(struct strlist *dellist)
2007{
2008 int fd, ret = 0;
2009 const char *group, *event;
2010 char *p, *str;
2011 struct str_node *ent;
2012 struct strlist *namelist;
2013
2014 fd = open_kprobe_events(true);
2015 if (fd < 0)
2016 return fd;
2017
2018 /* Get current event names */
2019 namelist = get_probe_trace_event_names(fd, true);
2020 if (namelist == NULL)
2021 return -EINVAL;
2022
2023 strlist__for_each(ent, dellist) {
2024 str = strdup(ent->s);
2025 if (str == NULL) {
2026 ret = -ENOMEM;
2027 break;
2028 }
2029 pr_debug("Parsing: %s\n", str);
2030 p = strchr(str, ':');
2031 if (p) {
2032 group = str;
2033 *p = '\0';
2034 event = p + 1;
2035 } else {
2036 group = "*";
2037 event = str;
2038 }
2039 pr_debug("Group: %s, Event: %s\n", group, event);
2040 ret = del_trace_probe_event(fd, group, event, namelist);
2041 free(str);
2042 if (ret < 0)
2043 break;
2044 }
2045 strlist__delete(namelist);
2046 close(fd);
2047
2048 return ret;
2049}
2050/* TODO: don't use a global variable for filter ... */
2051static struct strfilter *available_func_filter;
2052
2053/*
2054 * If a symbol corresponds to a function with global binding and
2055 * matches filter return 0. For all others return 1.
2056 */
2057static int filter_available_functions(struct map *map __unused,
2058 struct symbol *sym)
2059{
2060 if (sym->binding == STB_GLOBAL &&
2061 strfilter__compare(available_func_filter, sym->name))
2062 return 0;
2063 return 1;
2064}
2065
2066int show_available_funcs(const char *module, struct strfilter *_filter)
2067{
2068 struct map *map;
2069 int ret;
2070
2071 setup_pager();
2072
2073 ret = init_vmlinux();
2074 if (ret < 0)
2075 return ret;
2076
2077 map = kernel_get_module_map(module);
2078 if (!map) {
2079 pr_err("Failed to find %s map.\n", (module) ? : "kernel");
2080 return -EINVAL;
2081 }
2082 available_func_filter = _filter;
2083 if (map__load(map, filter_available_functions)) {
2084 pr_err("Failed to load map.\n");
2085 return -EINVAL;
2086 }
2087 if (!dso__sorted_by_name(map->dso, map->type))
2088 dso__sort_by_name(map->dso, map->type);
2089
2090 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2091 return 0;
2092}
1/*
2 * probe-event.c : perf-probe definition to probe_events format converter
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#include <sys/utsname.h>
23#include <sys/types.h>
24#include <sys/stat.h>
25#include <fcntl.h>
26#include <errno.h>
27#include <stdio.h>
28#include <unistd.h>
29#include <stdlib.h>
30#include <string.h>
31#include <stdarg.h>
32#include <limits.h>
33#include <elf.h>
34
35#include "util.h"
36#include "event.h"
37#include "strlist.h"
38#include "debug.h"
39#include "cache.h"
40#include "color.h"
41#include "symbol.h"
42#include "thread.h"
43#include <api/fs/debugfs.h>
44#include "trace-event.h" /* For __maybe_unused */
45#include "probe-event.h"
46#include "probe-finder.h"
47#include "session.h"
48
49#define MAX_CMDLEN 256
50#define PERFPROBE_GROUP "probe"
51
52bool probe_event_dry_run; /* Dry run flag */
53
54#define semantic_error(msg ...) pr_err("Semantic error :" msg)
55
56/* If there is no space to write, returns -E2BIG. */
57static int e_snprintf(char *str, size_t size, const char *format, ...)
58 __attribute__((format(printf, 3, 4)));
59
60static int e_snprintf(char *str, size_t size, const char *format, ...)
61{
62 int ret;
63 va_list ap;
64 va_start(ap, format);
65 ret = vsnprintf(str, size, format, ap);
66 va_end(ap);
67 if (ret >= (int)size)
68 ret = -E2BIG;
69 return ret;
70}
71
72static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
73static void clear_probe_trace_event(struct probe_trace_event *tev);
74static struct machine *host_machine;
75
76/* Initialize symbol maps and path of vmlinux/modules */
77static int init_symbol_maps(bool user_only)
78{
79 int ret;
80
81 symbol_conf.sort_by_name = true;
82 ret = symbol__init();
83 if (ret < 0) {
84 pr_debug("Failed to init symbol map.\n");
85 goto out;
86 }
87
88 if (host_machine || user_only) /* already initialized */
89 return 0;
90
91 if (symbol_conf.vmlinux_name)
92 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
93
94 host_machine = machine__new_host();
95 if (!host_machine) {
96 pr_debug("machine__new_host() failed.\n");
97 symbol__exit();
98 ret = -1;
99 }
100out:
101 if (ret < 0)
102 pr_warning("Failed to init vmlinux path.\n");
103 return ret;
104}
105
106static void exit_symbol_maps(void)
107{
108 if (host_machine) {
109 machine__delete(host_machine);
110 host_machine = NULL;
111 }
112 symbol__exit();
113}
114
115static struct symbol *__find_kernel_function_by_name(const char *name,
116 struct map **mapp)
117{
118 return machine__find_kernel_function_by_name(host_machine, name, mapp,
119 NULL);
120}
121
122static struct symbol *__find_kernel_function(u64 addr, struct map **mapp)
123{
124 return machine__find_kernel_function(host_machine, addr, mapp, NULL);
125}
126
127static struct ref_reloc_sym *kernel_get_ref_reloc_sym(void)
128{
129 /* kmap->ref_reloc_sym should be set if host_machine is initialized */
130 struct kmap *kmap;
131
132 if (map__load(host_machine->vmlinux_maps[MAP__FUNCTION], NULL) < 0)
133 return NULL;
134
135 kmap = map__kmap(host_machine->vmlinux_maps[MAP__FUNCTION]);
136 return kmap->ref_reloc_sym;
137}
138
139static u64 kernel_get_symbol_address_by_name(const char *name, bool reloc)
140{
141 struct ref_reloc_sym *reloc_sym;
142 struct symbol *sym;
143 struct map *map;
144
145 /* ref_reloc_sym is just a label. Need a special fix*/
146 reloc_sym = kernel_get_ref_reloc_sym();
147 if (reloc_sym && strcmp(name, reloc_sym->name) == 0)
148 return (reloc) ? reloc_sym->addr : reloc_sym->unrelocated_addr;
149 else {
150 sym = __find_kernel_function_by_name(name, &map);
151 if (sym)
152 return map->unmap_ip(map, sym->start) -
153 (reloc) ? 0 : map->reloc;
154 }
155 return 0;
156}
157
158static struct map *kernel_get_module_map(const char *module)
159{
160 struct rb_node *nd;
161 struct map_groups *grp = &host_machine->kmaps;
162
163 /* A file path -- this is an offline module */
164 if (module && strchr(module, '/'))
165 return machine__new_module(host_machine, 0, module);
166
167 if (!module)
168 module = "kernel";
169
170 for (nd = rb_first(&grp->maps[MAP__FUNCTION]); nd; nd = rb_next(nd)) {
171 struct map *pos = rb_entry(nd, struct map, rb_node);
172 if (strncmp(pos->dso->short_name + 1, module,
173 pos->dso->short_name_len - 2) == 0) {
174 return pos;
175 }
176 }
177 return NULL;
178}
179
180static struct dso *kernel_get_module_dso(const char *module)
181{
182 struct dso *dso;
183 struct map *map;
184 const char *vmlinux_name;
185
186 if (module) {
187 list_for_each_entry(dso, &host_machine->kernel_dsos, node) {
188 if (strncmp(dso->short_name + 1, module,
189 dso->short_name_len - 2) == 0)
190 goto found;
191 }
192 pr_debug("Failed to find module %s.\n", module);
193 return NULL;
194 }
195
196 map = host_machine->vmlinux_maps[MAP__FUNCTION];
197 dso = map->dso;
198
199 vmlinux_name = symbol_conf.vmlinux_name;
200 if (vmlinux_name) {
201 if (dso__load_vmlinux(dso, map, vmlinux_name, false, NULL) <= 0)
202 return NULL;
203 } else {
204 if (dso__load_vmlinux_path(dso, map, NULL) <= 0) {
205 pr_debug("Failed to load kernel map.\n");
206 return NULL;
207 }
208 }
209found:
210 return dso;
211}
212
213const char *kernel_get_module_path(const char *module)
214{
215 struct dso *dso = kernel_get_module_dso(module);
216 return (dso) ? dso->long_name : NULL;
217}
218
219static int convert_exec_to_group(const char *exec, char **result)
220{
221 char *ptr1, *ptr2, *exec_copy;
222 char buf[64];
223 int ret;
224
225 exec_copy = strdup(exec);
226 if (!exec_copy)
227 return -ENOMEM;
228
229 ptr1 = basename(exec_copy);
230 if (!ptr1) {
231 ret = -EINVAL;
232 goto out;
233 }
234
235 ptr2 = strpbrk(ptr1, "-._");
236 if (ptr2)
237 *ptr2 = '\0';
238 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
239 if (ret < 0)
240 goto out;
241
242 *result = strdup(buf);
243 ret = *result ? 0 : -ENOMEM;
244
245out:
246 free(exec_copy);
247 return ret;
248}
249
250static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
251{
252 int i;
253
254 for (i = 0; i < ntevs; i++)
255 clear_probe_trace_event(tevs + i);
256}
257
258#ifdef HAVE_DWARF_SUPPORT
259
260/* Open new debuginfo of given module */
261static struct debuginfo *open_debuginfo(const char *module)
262{
263 const char *path = module;
264
265 if (!module || !strchr(module, '/')) {
266 path = kernel_get_module_path(module);
267 if (!path) {
268 pr_err("Failed to find path of %s module.\n",
269 module ?: "kernel");
270 return NULL;
271 }
272 }
273 return debuginfo__new(path);
274}
275
276static int get_text_start_address(const char *exec, unsigned long *address)
277{
278 Elf *elf;
279 GElf_Ehdr ehdr;
280 GElf_Shdr shdr;
281 int fd, ret = -ENOENT;
282
283 fd = open(exec, O_RDONLY);
284 if (fd < 0)
285 return -errno;
286
287 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
288 if (elf == NULL)
289 return -EINVAL;
290
291 if (gelf_getehdr(elf, &ehdr) == NULL)
292 goto out;
293
294 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
295 goto out;
296
297 *address = shdr.sh_addr - shdr.sh_offset;
298 ret = 0;
299out:
300 elf_end(elf);
301 return ret;
302}
303
304/*
305 * Convert trace point to probe point with debuginfo
306 */
307static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
308 struct perf_probe_point *pp,
309 bool is_kprobe)
310{
311 struct debuginfo *dinfo = NULL;
312 unsigned long stext = 0;
313 u64 addr = tp->address;
314 int ret = -ENOENT;
315
316 /* convert the address to dwarf address */
317 if (!is_kprobe) {
318 if (!addr) {
319 ret = -EINVAL;
320 goto error;
321 }
322 ret = get_text_start_address(tp->module, &stext);
323 if (ret < 0)
324 goto error;
325 addr += stext;
326 } else {
327 addr = kernel_get_symbol_address_by_name(tp->symbol, false);
328 if (addr == 0)
329 goto error;
330 addr += tp->offset;
331 }
332
333 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
334 tp->module ? : "kernel");
335
336 dinfo = open_debuginfo(tp->module);
337 if (dinfo) {
338 ret = debuginfo__find_probe_point(dinfo,
339 (unsigned long)addr, pp);
340 debuginfo__delete(dinfo);
341 } else {
342 pr_debug("Failed to open debuginfo at 0x%" PRIx64 "\n", addr);
343 ret = -ENOENT;
344 }
345
346 if (ret > 0) {
347 pp->retprobe = tp->retprobe;
348 return 0;
349 }
350error:
351 pr_debug("Failed to find corresponding probes from debuginfo.\n");
352 return ret ? : -ENOENT;
353}
354
355static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
356 int ntevs, const char *exec)
357{
358 int i, ret = 0;
359 unsigned long stext = 0;
360
361 if (!exec)
362 return 0;
363
364 ret = get_text_start_address(exec, &stext);
365 if (ret < 0)
366 return ret;
367
368 for (i = 0; i < ntevs && ret >= 0; i++) {
369 /* point.address is the addres of point.symbol + point.offset */
370 tevs[i].point.address -= stext;
371 tevs[i].point.module = strdup(exec);
372 if (!tevs[i].point.module) {
373 ret = -ENOMEM;
374 break;
375 }
376 tevs[i].uprobes = true;
377 }
378
379 return ret;
380}
381
382static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
383 int ntevs, const char *module)
384{
385 int i, ret = 0;
386 char *tmp;
387
388 if (!module)
389 return 0;
390
391 tmp = strrchr(module, '/');
392 if (tmp) {
393 /* This is a module path -- get the module name */
394 module = strdup(tmp + 1);
395 if (!module)
396 return -ENOMEM;
397 tmp = strchr(module, '.');
398 if (tmp)
399 *tmp = '\0';
400 tmp = (char *)module; /* For free() */
401 }
402
403 for (i = 0; i < ntevs; i++) {
404 tevs[i].point.module = strdup(module);
405 if (!tevs[i].point.module) {
406 ret = -ENOMEM;
407 break;
408 }
409 }
410
411 free(tmp);
412 return ret;
413}
414
415/* Post processing the probe events */
416static int post_process_probe_trace_events(struct probe_trace_event *tevs,
417 int ntevs, const char *module,
418 bool uprobe)
419{
420 struct ref_reloc_sym *reloc_sym;
421 char *tmp;
422 int i;
423
424 if (uprobe)
425 return add_exec_to_probe_trace_events(tevs, ntevs, module);
426
427 /* Note that currently ref_reloc_sym based probe is not for drivers */
428 if (module)
429 return add_module_to_probe_trace_events(tevs, ntevs, module);
430
431 reloc_sym = kernel_get_ref_reloc_sym();
432 if (!reloc_sym) {
433 pr_warning("Relocated base symbol is not found!\n");
434 return -EINVAL;
435 }
436
437 for (i = 0; i < ntevs; i++) {
438 if (tevs[i].point.address) {
439 tmp = strdup(reloc_sym->name);
440 if (!tmp)
441 return -ENOMEM;
442 free(tevs[i].point.symbol);
443 tevs[i].point.symbol = tmp;
444 tevs[i].point.offset = tevs[i].point.address -
445 reloc_sym->unrelocated_addr;
446 }
447 }
448 return 0;
449}
450
451/* Try to find perf_probe_event with debuginfo */
452static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
453 struct probe_trace_event **tevs,
454 int max_tevs, const char *target)
455{
456 bool need_dwarf = perf_probe_event_need_dwarf(pev);
457 struct debuginfo *dinfo;
458 int ntevs, ret = 0;
459
460 dinfo = open_debuginfo(target);
461
462 if (!dinfo) {
463 if (need_dwarf) {
464 pr_warning("Failed to open debuginfo file.\n");
465 return -ENOENT;
466 }
467 pr_debug("Could not open debuginfo. Try to use symbols.\n");
468 return 0;
469 }
470
471 pr_debug("Try to find probe point from debuginfo.\n");
472 /* Searching trace events corresponding to a probe event */
473 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);
474
475 debuginfo__delete(dinfo);
476
477 if (ntevs > 0) { /* Succeeded to find trace events */
478 pr_debug("Found %d probe_trace_events.\n", ntevs);
479 ret = post_process_probe_trace_events(*tevs, ntevs,
480 target, pev->uprobes);
481 if (ret < 0) {
482 clear_probe_trace_events(*tevs, ntevs);
483 zfree(tevs);
484 }
485 return ret < 0 ? ret : ntevs;
486 }
487
488 if (ntevs == 0) { /* No error but failed to find probe point. */
489 pr_warning("Probe point '%s' not found.\n",
490 synthesize_perf_probe_point(&pev->point));
491 return -ENOENT;
492 }
493 /* Error path : ntevs < 0 */
494 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
495 if (ntevs == -EBADF) {
496 pr_warning("Warning: No dwarf info found in the vmlinux - "
497 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
498 if (!need_dwarf) {
499 pr_debug("Trying to use symbols.\n");
500 return 0;
501 }
502 }
503 return ntevs;
504}
505
506/*
507 * Find a src file from a DWARF tag path. Prepend optional source path prefix
508 * and chop off leading directories that do not exist. Result is passed back as
509 * a newly allocated path on success.
510 * Return 0 if file was found and readable, -errno otherwise.
511 */
512static int get_real_path(const char *raw_path, const char *comp_dir,
513 char **new_path)
514{
515 const char *prefix = symbol_conf.source_prefix;
516
517 if (!prefix) {
518 if (raw_path[0] != '/' && comp_dir)
519 /* If not an absolute path, try to use comp_dir */
520 prefix = comp_dir;
521 else {
522 if (access(raw_path, R_OK) == 0) {
523 *new_path = strdup(raw_path);
524 return 0;
525 } else
526 return -errno;
527 }
528 }
529
530 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
531 if (!*new_path)
532 return -ENOMEM;
533
534 for (;;) {
535 sprintf(*new_path, "%s/%s", prefix, raw_path);
536
537 if (access(*new_path, R_OK) == 0)
538 return 0;
539
540 if (!symbol_conf.source_prefix)
541 /* In case of searching comp_dir, don't retry */
542 return -errno;
543
544 switch (errno) {
545 case ENAMETOOLONG:
546 case ENOENT:
547 case EROFS:
548 case EFAULT:
549 raw_path = strchr(++raw_path, '/');
550 if (!raw_path) {
551 zfree(new_path);
552 return -ENOENT;
553 }
554 continue;
555
556 default:
557 zfree(new_path);
558 return -errno;
559 }
560 }
561}
562
563#define LINEBUF_SIZE 256
564#define NR_ADDITIONAL_LINES 2
565
566static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
567{
568 char buf[LINEBUF_SIZE];
569 const char *color = show_num ? "" : PERF_COLOR_BLUE;
570 const char *prefix = NULL;
571
572 do {
573 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
574 goto error;
575 if (skip)
576 continue;
577 if (!prefix) {
578 prefix = show_num ? "%7d " : " ";
579 color_fprintf(stdout, color, prefix, l);
580 }
581 color_fprintf(stdout, color, "%s", buf);
582
583 } while (strchr(buf, '\n') == NULL);
584
585 return 1;
586error:
587 if (ferror(fp)) {
588 pr_warning("File read error: %s\n", strerror(errno));
589 return -1;
590 }
591 return 0;
592}
593
594static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
595{
596 int rv = __show_one_line(fp, l, skip, show_num);
597 if (rv == 0) {
598 pr_warning("Source file is shorter than expected.\n");
599 rv = -1;
600 }
601 return rv;
602}
603
604#define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
605#define show_one_line(f,l) _show_one_line(f,l,false,false)
606#define skip_one_line(f,l) _show_one_line(f,l,true,false)
607#define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
608
609/*
610 * Show line-range always requires debuginfo to find source file and
611 * line number.
612 */
613static int __show_line_range(struct line_range *lr, const char *module)
614{
615 int l = 1;
616 struct int_node *ln;
617 struct debuginfo *dinfo;
618 FILE *fp;
619 int ret;
620 char *tmp;
621
622 /* Search a line range */
623 dinfo = open_debuginfo(module);
624 if (!dinfo) {
625 pr_warning("Failed to open debuginfo file.\n");
626 return -ENOENT;
627 }
628
629 ret = debuginfo__find_line_range(dinfo, lr);
630 debuginfo__delete(dinfo);
631 if (ret == 0) {
632 pr_warning("Specified source line is not found.\n");
633 return -ENOENT;
634 } else if (ret < 0) {
635 pr_warning("Debuginfo analysis failed. (%d)\n", ret);
636 return ret;
637 }
638
639 /* Convert source file path */
640 tmp = lr->path;
641 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
642 free(tmp); /* Free old path */
643 if (ret < 0) {
644 pr_warning("Failed to find source file. (%d)\n", ret);
645 return ret;
646 }
647
648 setup_pager();
649
650 if (lr->function)
651 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
652 lr->start - lr->offset);
653 else
654 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
655
656 fp = fopen(lr->path, "r");
657 if (fp == NULL) {
658 pr_warning("Failed to open %s: %s\n", lr->path,
659 strerror(errno));
660 return -errno;
661 }
662 /* Skip to starting line number */
663 while (l < lr->start) {
664 ret = skip_one_line(fp, l++);
665 if (ret < 0)
666 goto end;
667 }
668
669 intlist__for_each(ln, lr->line_list) {
670 for (; ln->i > l; l++) {
671 ret = show_one_line(fp, l - lr->offset);
672 if (ret < 0)
673 goto end;
674 }
675 ret = show_one_line_with_num(fp, l++ - lr->offset);
676 if (ret < 0)
677 goto end;
678 }
679
680 if (lr->end == INT_MAX)
681 lr->end = l + NR_ADDITIONAL_LINES;
682 while (l <= lr->end) {
683 ret = show_one_line_or_eof(fp, l++ - lr->offset);
684 if (ret <= 0)
685 break;
686 }
687end:
688 fclose(fp);
689 return ret;
690}
691
692int show_line_range(struct line_range *lr, const char *module)
693{
694 int ret;
695
696 ret = init_symbol_maps(false);
697 if (ret < 0)
698 return ret;
699 ret = __show_line_range(lr, module);
700 exit_symbol_maps();
701
702 return ret;
703}
704
705static int show_available_vars_at(struct debuginfo *dinfo,
706 struct perf_probe_event *pev,
707 int max_vls, struct strfilter *_filter,
708 bool externs)
709{
710 char *buf;
711 int ret, i, nvars;
712 struct str_node *node;
713 struct variable_list *vls = NULL, *vl;
714 const char *var;
715
716 buf = synthesize_perf_probe_point(&pev->point);
717 if (!buf)
718 return -EINVAL;
719 pr_debug("Searching variables at %s\n", buf);
720
721 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
722 max_vls, externs);
723 if (ret <= 0) {
724 pr_err("Failed to find variables at %s (%d)\n", buf, ret);
725 goto end;
726 }
727 /* Some variables are found */
728 fprintf(stdout, "Available variables at %s\n", buf);
729 for (i = 0; i < ret; i++) {
730 vl = &vls[i];
731 /*
732 * A probe point might be converted to
733 * several trace points.
734 */
735 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
736 vl->point.offset);
737 zfree(&vl->point.symbol);
738 nvars = 0;
739 if (vl->vars) {
740 strlist__for_each(node, vl->vars) {
741 var = strchr(node->s, '\t') + 1;
742 if (strfilter__compare(_filter, var)) {
743 fprintf(stdout, "\t\t%s\n", node->s);
744 nvars++;
745 }
746 }
747 strlist__delete(vl->vars);
748 }
749 if (nvars == 0)
750 fprintf(stdout, "\t\t(No matched variables)\n");
751 }
752 free(vls);
753end:
754 free(buf);
755 return ret;
756}
757
758/* Show available variables on given probe point */
759int show_available_vars(struct perf_probe_event *pevs, int npevs,
760 int max_vls, const char *module,
761 struct strfilter *_filter, bool externs)
762{
763 int i, ret = 0;
764 struct debuginfo *dinfo;
765
766 ret = init_symbol_maps(false);
767 if (ret < 0)
768 return ret;
769
770 dinfo = open_debuginfo(module);
771 if (!dinfo) {
772 pr_warning("Failed to open debuginfo file.\n");
773 ret = -ENOENT;
774 goto out;
775 }
776
777 setup_pager();
778
779 for (i = 0; i < npevs && ret >= 0; i++)
780 ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
781 externs);
782
783 debuginfo__delete(dinfo);
784out:
785 exit_symbol_maps();
786 return ret;
787}
788
789#else /* !HAVE_DWARF_SUPPORT */
790
791static int
792find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
793 struct perf_probe_point *pp __maybe_unused,
794 bool is_kprobe __maybe_unused)
795{
796 return -ENOSYS;
797}
798
799static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
800 struct probe_trace_event **tevs __maybe_unused,
801 int max_tevs __maybe_unused,
802 const char *target __maybe_unused)
803{
804 if (perf_probe_event_need_dwarf(pev)) {
805 pr_warning("Debuginfo-analysis is not supported.\n");
806 return -ENOSYS;
807 }
808
809 return 0;
810}
811
812int show_line_range(struct line_range *lr __maybe_unused,
813 const char *module __maybe_unused)
814{
815 pr_warning("Debuginfo-analysis is not supported.\n");
816 return -ENOSYS;
817}
818
819int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
820 int npevs __maybe_unused, int max_vls __maybe_unused,
821 const char *module __maybe_unused,
822 struct strfilter *filter __maybe_unused,
823 bool externs __maybe_unused)
824{
825 pr_warning("Debuginfo-analysis is not supported.\n");
826 return -ENOSYS;
827}
828#endif
829
830void line_range__clear(struct line_range *lr)
831{
832 free(lr->function);
833 free(lr->file);
834 free(lr->path);
835 free(lr->comp_dir);
836 intlist__delete(lr->line_list);
837 memset(lr, 0, sizeof(*lr));
838}
839
840int line_range__init(struct line_range *lr)
841{
842 memset(lr, 0, sizeof(*lr));
843 lr->line_list = intlist__new(NULL);
844 if (!lr->line_list)
845 return -ENOMEM;
846 else
847 return 0;
848}
849
850static int parse_line_num(char **ptr, int *val, const char *what)
851{
852 const char *start = *ptr;
853
854 errno = 0;
855 *val = strtol(*ptr, ptr, 0);
856 if (errno || *ptr == start) {
857 semantic_error("'%s' is not a valid number.\n", what);
858 return -EINVAL;
859 }
860 return 0;
861}
862
863/*
864 * Stuff 'lr' according to the line range described by 'arg'.
865 * The line range syntax is described by:
866 *
867 * SRC[:SLN[+NUM|-ELN]]
868 * FNC[@SRC][:SLN[+NUM|-ELN]]
869 */
870int parse_line_range_desc(const char *arg, struct line_range *lr)
871{
872 char *range, *file, *name = strdup(arg);
873 int err;
874
875 if (!name)
876 return -ENOMEM;
877
878 lr->start = 0;
879 lr->end = INT_MAX;
880
881 range = strchr(name, ':');
882 if (range) {
883 *range++ = '\0';
884
885 err = parse_line_num(&range, &lr->start, "start line");
886 if (err)
887 goto err;
888
889 if (*range == '+' || *range == '-') {
890 const char c = *range++;
891
892 err = parse_line_num(&range, &lr->end, "end line");
893 if (err)
894 goto err;
895
896 if (c == '+') {
897 lr->end += lr->start;
898 /*
899 * Adjust the number of lines here.
900 * If the number of lines == 1, the
901 * the end of line should be equal to
902 * the start of line.
903 */
904 lr->end--;
905 }
906 }
907
908 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
909
910 err = -EINVAL;
911 if (lr->start > lr->end) {
912 semantic_error("Start line must be smaller"
913 " than end line.\n");
914 goto err;
915 }
916 if (*range != '\0') {
917 semantic_error("Tailing with invalid str '%s'.\n", range);
918 goto err;
919 }
920 }
921
922 file = strchr(name, '@');
923 if (file) {
924 *file = '\0';
925 lr->file = strdup(++file);
926 if (lr->file == NULL) {
927 err = -ENOMEM;
928 goto err;
929 }
930 lr->function = name;
931 } else if (strchr(name, '.'))
932 lr->file = name;
933 else
934 lr->function = name;
935
936 return 0;
937err:
938 free(name);
939 return err;
940}
941
942/* Check the name is good for event/group */
943static bool check_event_name(const char *name)
944{
945 if (!isalpha(*name) && *name != '_')
946 return false;
947 while (*++name != '\0') {
948 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
949 return false;
950 }
951 return true;
952}
953
954/* Parse probepoint definition. */
955static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
956{
957 struct perf_probe_point *pp = &pev->point;
958 char *ptr, *tmp;
959 char c, nc = 0;
960 /*
961 * <Syntax>
962 * perf probe [EVENT=]SRC[:LN|;PTN]
963 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
964 *
965 * TODO:Group name support
966 */
967
968 ptr = strpbrk(arg, ";=@+%");
969 if (ptr && *ptr == '=') { /* Event name */
970 *ptr = '\0';
971 tmp = ptr + 1;
972 if (strchr(arg, ':')) {
973 semantic_error("Group name is not supported yet.\n");
974 return -ENOTSUP;
975 }
976 if (!check_event_name(arg)) {
977 semantic_error("%s is bad for event name -it must "
978 "follow C symbol-naming rule.\n", arg);
979 return -EINVAL;
980 }
981 pev->event = strdup(arg);
982 if (pev->event == NULL)
983 return -ENOMEM;
984 pev->group = NULL;
985 arg = tmp;
986 }
987
988 ptr = strpbrk(arg, ";:+@%");
989 if (ptr) {
990 nc = *ptr;
991 *ptr++ = '\0';
992 }
993
994 tmp = strdup(arg);
995 if (tmp == NULL)
996 return -ENOMEM;
997
998 /* Check arg is function or file and copy it */
999 if (strchr(tmp, '.')) /* File */
1000 pp->file = tmp;
1001 else /* Function */
1002 pp->function = tmp;
1003
1004 /* Parse other options */
1005 while (ptr) {
1006 arg = ptr;
1007 c = nc;
1008 if (c == ';') { /* Lazy pattern must be the last part */
1009 pp->lazy_line = strdup(arg);
1010 if (pp->lazy_line == NULL)
1011 return -ENOMEM;
1012 break;
1013 }
1014 ptr = strpbrk(arg, ";:+@%");
1015 if (ptr) {
1016 nc = *ptr;
1017 *ptr++ = '\0';
1018 }
1019 switch (c) {
1020 case ':': /* Line number */
1021 pp->line = strtoul(arg, &tmp, 0);
1022 if (*tmp != '\0') {
1023 semantic_error("There is non-digit char"
1024 " in line number.\n");
1025 return -EINVAL;
1026 }
1027 break;
1028 case '+': /* Byte offset from a symbol */
1029 pp->offset = strtoul(arg, &tmp, 0);
1030 if (*tmp != '\0') {
1031 semantic_error("There is non-digit character"
1032 " in offset.\n");
1033 return -EINVAL;
1034 }
1035 break;
1036 case '@': /* File name */
1037 if (pp->file) {
1038 semantic_error("SRC@SRC is not allowed.\n");
1039 return -EINVAL;
1040 }
1041 pp->file = strdup(arg);
1042 if (pp->file == NULL)
1043 return -ENOMEM;
1044 break;
1045 case '%': /* Probe places */
1046 if (strcmp(arg, "return") == 0) {
1047 pp->retprobe = 1;
1048 } else { /* Others not supported yet */
1049 semantic_error("%%%s is not supported.\n", arg);
1050 return -ENOTSUP;
1051 }
1052 break;
1053 default: /* Buggy case */
1054 pr_err("This program has a bug at %s:%d.\n",
1055 __FILE__, __LINE__);
1056 return -ENOTSUP;
1057 break;
1058 }
1059 }
1060
1061 /* Exclusion check */
1062 if (pp->lazy_line && pp->line) {
1063 semantic_error("Lazy pattern can't be used with"
1064 " line number.\n");
1065 return -EINVAL;
1066 }
1067
1068 if (pp->lazy_line && pp->offset) {
1069 semantic_error("Lazy pattern can't be used with offset.\n");
1070 return -EINVAL;
1071 }
1072
1073 if (pp->line && pp->offset) {
1074 semantic_error("Offset can't be used with line number.\n");
1075 return -EINVAL;
1076 }
1077
1078 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1079 semantic_error("File always requires line number or "
1080 "lazy pattern.\n");
1081 return -EINVAL;
1082 }
1083
1084 if (pp->offset && !pp->function) {
1085 semantic_error("Offset requires an entry function.\n");
1086 return -EINVAL;
1087 }
1088
1089 if (pp->retprobe && !pp->function) {
1090 semantic_error("Return probe requires an entry function.\n");
1091 return -EINVAL;
1092 }
1093
1094 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1095 semantic_error("Offset/Line/Lazy pattern can't be used with "
1096 "return probe.\n");
1097 return -EINVAL;
1098 }
1099
1100 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1101 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1102 pp->lazy_line);
1103 return 0;
1104}
1105
1106/* Parse perf-probe event argument */
1107static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1108{
1109 char *tmp, *goodname;
1110 struct perf_probe_arg_field **fieldp;
1111
1112 pr_debug("parsing arg: %s into ", str);
1113
1114 tmp = strchr(str, '=');
1115 if (tmp) {
1116 arg->name = strndup(str, tmp - str);
1117 if (arg->name == NULL)
1118 return -ENOMEM;
1119 pr_debug("name:%s ", arg->name);
1120 str = tmp + 1;
1121 }
1122
1123 tmp = strchr(str, ':');
1124 if (tmp) { /* Type setting */
1125 *tmp = '\0';
1126 arg->type = strdup(tmp + 1);
1127 if (arg->type == NULL)
1128 return -ENOMEM;
1129 pr_debug("type:%s ", arg->type);
1130 }
1131
1132 tmp = strpbrk(str, "-.[");
1133 if (!is_c_varname(str) || !tmp) {
1134 /* A variable, register, symbol or special value */
1135 arg->var = strdup(str);
1136 if (arg->var == NULL)
1137 return -ENOMEM;
1138 pr_debug("%s\n", arg->var);
1139 return 0;
1140 }
1141
1142 /* Structure fields or array element */
1143 arg->var = strndup(str, tmp - str);
1144 if (arg->var == NULL)
1145 return -ENOMEM;
1146 goodname = arg->var;
1147 pr_debug("%s, ", arg->var);
1148 fieldp = &arg->field;
1149
1150 do {
1151 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1152 if (*fieldp == NULL)
1153 return -ENOMEM;
1154 if (*tmp == '[') { /* Array */
1155 str = tmp;
1156 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1157 (*fieldp)->ref = true;
1158 if (*tmp != ']' || tmp == str + 1) {
1159 semantic_error("Array index must be a"
1160 " number.\n");
1161 return -EINVAL;
1162 }
1163 tmp++;
1164 if (*tmp == '\0')
1165 tmp = NULL;
1166 } else { /* Structure */
1167 if (*tmp == '.') {
1168 str = tmp + 1;
1169 (*fieldp)->ref = false;
1170 } else if (tmp[1] == '>') {
1171 str = tmp + 2;
1172 (*fieldp)->ref = true;
1173 } else {
1174 semantic_error("Argument parse error: %s\n",
1175 str);
1176 return -EINVAL;
1177 }
1178 tmp = strpbrk(str, "-.[");
1179 }
1180 if (tmp) {
1181 (*fieldp)->name = strndup(str, tmp - str);
1182 if ((*fieldp)->name == NULL)
1183 return -ENOMEM;
1184 if (*str != '[')
1185 goodname = (*fieldp)->name;
1186 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1187 fieldp = &(*fieldp)->next;
1188 }
1189 } while (tmp);
1190 (*fieldp)->name = strdup(str);
1191 if ((*fieldp)->name == NULL)
1192 return -ENOMEM;
1193 if (*str != '[')
1194 goodname = (*fieldp)->name;
1195 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1196
1197 /* If no name is specified, set the last field name (not array index)*/
1198 if (!arg->name) {
1199 arg->name = strdup(goodname);
1200 if (arg->name == NULL)
1201 return -ENOMEM;
1202 }
1203 return 0;
1204}
1205
1206/* Parse perf-probe event command */
1207int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1208{
1209 char **argv;
1210 int argc, i, ret = 0;
1211
1212 argv = argv_split(cmd, &argc);
1213 if (!argv) {
1214 pr_debug("Failed to split arguments.\n");
1215 return -ENOMEM;
1216 }
1217 if (argc - 1 > MAX_PROBE_ARGS) {
1218 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1219 ret = -ERANGE;
1220 goto out;
1221 }
1222 /* Parse probe point */
1223 ret = parse_perf_probe_point(argv[0], pev);
1224 if (ret < 0)
1225 goto out;
1226
1227 /* Copy arguments and ensure return probe has no C argument */
1228 pev->nargs = argc - 1;
1229 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1230 if (pev->args == NULL) {
1231 ret = -ENOMEM;
1232 goto out;
1233 }
1234 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1235 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1236 if (ret >= 0 &&
1237 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1238 semantic_error("You can't specify local variable for"
1239 " kretprobe.\n");
1240 ret = -EINVAL;
1241 }
1242 }
1243out:
1244 argv_free(argv);
1245
1246 return ret;
1247}
1248
1249/* Return true if this perf_probe_event requires debuginfo */
1250bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1251{
1252 int i;
1253
1254 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1255 return true;
1256
1257 for (i = 0; i < pev->nargs; i++)
1258 if (is_c_varname(pev->args[i].var))
1259 return true;
1260
1261 return false;
1262}
1263
1264/* Parse probe_events event into struct probe_point */
1265static int parse_probe_trace_command(const char *cmd,
1266 struct probe_trace_event *tev)
1267{
1268 struct probe_trace_point *tp = &tev->point;
1269 char pr;
1270 char *p;
1271 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1272 int ret, i, argc;
1273 char **argv;
1274
1275 pr_debug("Parsing probe_events: %s\n", cmd);
1276 argv = argv_split(cmd, &argc);
1277 if (!argv) {
1278 pr_debug("Failed to split arguments.\n");
1279 return -ENOMEM;
1280 }
1281 if (argc < 2) {
1282 semantic_error("Too few probe arguments.\n");
1283 ret = -ERANGE;
1284 goto out;
1285 }
1286
1287 /* Scan event and group name. */
1288 argv0_str = strdup(argv[0]);
1289 if (argv0_str == NULL) {
1290 ret = -ENOMEM;
1291 goto out;
1292 }
1293 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1294 fmt2_str = strtok_r(NULL, "/", &fmt);
1295 fmt3_str = strtok_r(NULL, " \t", &fmt);
1296 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
1297 || fmt3_str == NULL) {
1298 semantic_error("Failed to parse event name: %s\n", argv[0]);
1299 ret = -EINVAL;
1300 goto out;
1301 }
1302 pr = fmt1_str[0];
1303 tev->group = strdup(fmt2_str);
1304 tev->event = strdup(fmt3_str);
1305 if (tev->group == NULL || tev->event == NULL) {
1306 ret = -ENOMEM;
1307 goto out;
1308 }
1309 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1310
1311 tp->retprobe = (pr == 'r');
1312
1313 /* Scan module name(if there), function name and offset */
1314 p = strchr(argv[1], ':');
1315 if (p) {
1316 tp->module = strndup(argv[1], p - argv[1]);
1317 p++;
1318 } else
1319 p = argv[1];
1320 fmt1_str = strtok_r(p, "+", &fmt);
1321 if (fmt1_str[0] == '0') /* only the address started with 0x */
1322 tp->address = strtoul(fmt1_str, NULL, 0);
1323 else {
1324 /* Only the symbol-based probe has offset */
1325 tp->symbol = strdup(fmt1_str);
1326 if (tp->symbol == NULL) {
1327 ret = -ENOMEM;
1328 goto out;
1329 }
1330 fmt2_str = strtok_r(NULL, "", &fmt);
1331 if (fmt2_str == NULL)
1332 tp->offset = 0;
1333 else
1334 tp->offset = strtoul(fmt2_str, NULL, 10);
1335 }
1336
1337 tev->nargs = argc - 2;
1338 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1339 if (tev->args == NULL) {
1340 ret = -ENOMEM;
1341 goto out;
1342 }
1343 for (i = 0; i < tev->nargs; i++) {
1344 p = strchr(argv[i + 2], '=');
1345 if (p) /* We don't need which register is assigned. */
1346 *p++ = '\0';
1347 else
1348 p = argv[i + 2];
1349 tev->args[i].name = strdup(argv[i + 2]);
1350 /* TODO: parse regs and offset */
1351 tev->args[i].value = strdup(p);
1352 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1353 ret = -ENOMEM;
1354 goto out;
1355 }
1356 }
1357 ret = 0;
1358out:
1359 free(argv0_str);
1360 argv_free(argv);
1361 return ret;
1362}
1363
1364/* Compose only probe arg */
1365int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1366{
1367 struct perf_probe_arg_field *field = pa->field;
1368 int ret;
1369 char *tmp = buf;
1370
1371 if (pa->name && pa->var)
1372 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1373 else
1374 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1375 if (ret <= 0)
1376 goto error;
1377 tmp += ret;
1378 len -= ret;
1379
1380 while (field) {
1381 if (field->name[0] == '[')
1382 ret = e_snprintf(tmp, len, "%s", field->name);
1383 else
1384 ret = e_snprintf(tmp, len, "%s%s",
1385 field->ref ? "->" : ".", field->name);
1386 if (ret <= 0)
1387 goto error;
1388 tmp += ret;
1389 len -= ret;
1390 field = field->next;
1391 }
1392
1393 if (pa->type) {
1394 ret = e_snprintf(tmp, len, ":%s", pa->type);
1395 if (ret <= 0)
1396 goto error;
1397 tmp += ret;
1398 len -= ret;
1399 }
1400
1401 return tmp - buf;
1402error:
1403 pr_debug("Failed to synthesize perf probe argument: %s\n",
1404 strerror(-ret));
1405 return ret;
1406}
1407
1408/* Compose only probe point (not argument) */
1409static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1410{
1411 char *buf, *tmp;
1412 char offs[32] = "", line[32] = "", file[32] = "";
1413 int ret, len;
1414
1415 buf = zalloc(MAX_CMDLEN);
1416 if (buf == NULL) {
1417 ret = -ENOMEM;
1418 goto error;
1419 }
1420 if (pp->offset) {
1421 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1422 if (ret <= 0)
1423 goto error;
1424 }
1425 if (pp->line) {
1426 ret = e_snprintf(line, 32, ":%d", pp->line);
1427 if (ret <= 0)
1428 goto error;
1429 }
1430 if (pp->file) {
1431 tmp = pp->file;
1432 len = strlen(tmp);
1433 if (len > 30) {
1434 tmp = strchr(pp->file + len - 30, '/');
1435 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1436 }
1437 ret = e_snprintf(file, 32, "@%s", tmp);
1438 if (ret <= 0)
1439 goto error;
1440 }
1441
1442 if (pp->function)
1443 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1444 offs, pp->retprobe ? "%return" : "", line,
1445 file);
1446 else
1447 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1448 if (ret <= 0)
1449 goto error;
1450
1451 return buf;
1452error:
1453 pr_debug("Failed to synthesize perf probe point: %s\n",
1454 strerror(-ret));
1455 free(buf);
1456 return NULL;
1457}
1458
1459#if 0
1460char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1461{
1462 char *buf;
1463 int i, len, ret;
1464
1465 buf = synthesize_perf_probe_point(&pev->point);
1466 if (!buf)
1467 return NULL;
1468
1469 len = strlen(buf);
1470 for (i = 0; i < pev->nargs; i++) {
1471 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1472 pev->args[i].name);
1473 if (ret <= 0) {
1474 free(buf);
1475 return NULL;
1476 }
1477 len += ret;
1478 }
1479
1480 return buf;
1481}
1482#endif
1483
1484static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1485 char **buf, size_t *buflen,
1486 int depth)
1487{
1488 int ret;
1489 if (ref->next) {
1490 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1491 buflen, depth + 1);
1492 if (depth < 0)
1493 goto out;
1494 }
1495
1496 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1497 if (ret < 0)
1498 depth = ret;
1499 else {
1500 *buf += ret;
1501 *buflen -= ret;
1502 }
1503out:
1504 return depth;
1505
1506}
1507
1508static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1509 char *buf, size_t buflen)
1510{
1511 struct probe_trace_arg_ref *ref = arg->ref;
1512 int ret, depth = 0;
1513 char *tmp = buf;
1514
1515 /* Argument name or separator */
1516 if (arg->name)
1517 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1518 else
1519 ret = e_snprintf(buf, buflen, " ");
1520 if (ret < 0)
1521 return ret;
1522 buf += ret;
1523 buflen -= ret;
1524
1525 /* Special case: @XXX */
1526 if (arg->value[0] == '@' && arg->ref)
1527 ref = ref->next;
1528
1529 /* Dereferencing arguments */
1530 if (ref) {
1531 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1532 &buflen, 1);
1533 if (depth < 0)
1534 return depth;
1535 }
1536
1537 /* Print argument value */
1538 if (arg->value[0] == '@' && arg->ref)
1539 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1540 arg->ref->offset);
1541 else
1542 ret = e_snprintf(buf, buflen, "%s", arg->value);
1543 if (ret < 0)
1544 return ret;
1545 buf += ret;
1546 buflen -= ret;
1547
1548 /* Closing */
1549 while (depth--) {
1550 ret = e_snprintf(buf, buflen, ")");
1551 if (ret < 0)
1552 return ret;
1553 buf += ret;
1554 buflen -= ret;
1555 }
1556 /* Print argument type */
1557 if (arg->type) {
1558 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1559 if (ret <= 0)
1560 return ret;
1561 buf += ret;
1562 }
1563
1564 return buf - tmp;
1565}
1566
1567char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1568{
1569 struct probe_trace_point *tp = &tev->point;
1570 char *buf;
1571 int i, len, ret;
1572
1573 buf = zalloc(MAX_CMDLEN);
1574 if (buf == NULL)
1575 return NULL;
1576
1577 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
1578 tev->group, tev->event);
1579 if (len <= 0)
1580 goto error;
1581
1582 /* Uprobes must have tp->address and tp->module */
1583 if (tev->uprobes && (!tp->address || !tp->module))
1584 goto error;
1585
1586 /* Use the tp->address for uprobes */
1587 if (tev->uprobes)
1588 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s:0x%lx",
1589 tp->module, tp->address);
1590 else
1591 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s%s+%lu",
1592 tp->module ?: "", tp->module ? ":" : "",
1593 tp->symbol, tp->offset);
1594
1595 if (ret <= 0)
1596 goto error;
1597 len += ret;
1598
1599 for (i = 0; i < tev->nargs; i++) {
1600 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1601 MAX_CMDLEN - len);
1602 if (ret <= 0)
1603 goto error;
1604 len += ret;
1605 }
1606
1607 return buf;
1608error:
1609 free(buf);
1610 return NULL;
1611}
1612
1613static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
1614 struct perf_probe_point *pp,
1615 bool is_kprobe)
1616{
1617 struct symbol *sym = NULL;
1618 struct map *map;
1619 u64 addr;
1620 int ret = -ENOENT;
1621
1622 if (!is_kprobe) {
1623 map = dso__new_map(tp->module);
1624 if (!map)
1625 goto out;
1626 addr = tp->address;
1627 sym = map__find_symbol(map, addr, NULL);
1628 } else {
1629 addr = kernel_get_symbol_address_by_name(tp->symbol, true);
1630 if (addr) {
1631 addr += tp->offset;
1632 sym = __find_kernel_function(addr, &map);
1633 }
1634 }
1635 if (!sym)
1636 goto out;
1637
1638 pp->retprobe = tp->retprobe;
1639 pp->offset = addr - map->unmap_ip(map, sym->start);
1640 pp->function = strdup(sym->name);
1641 ret = pp->function ? 0 : -ENOMEM;
1642
1643out:
1644 if (map && !is_kprobe) {
1645 dso__delete(map->dso);
1646 map__delete(map);
1647 }
1648
1649 return ret;
1650}
1651
1652static int convert_to_perf_probe_point(struct probe_trace_point *tp,
1653 struct perf_probe_point *pp,
1654 bool is_kprobe)
1655{
1656 char buf[128];
1657 int ret;
1658
1659 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
1660 if (!ret)
1661 return 0;
1662 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
1663 if (!ret)
1664 return 0;
1665
1666 pr_debug("Failed to find probe point from both of dwarf and map.\n");
1667
1668 if (tp->symbol) {
1669 pp->function = strdup(tp->symbol);
1670 pp->offset = tp->offset;
1671 } else if (!tp->module && !is_kprobe) {
1672 ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address);
1673 if (ret < 0)
1674 return ret;
1675 pp->function = strdup(buf);
1676 pp->offset = 0;
1677 }
1678 if (pp->function == NULL)
1679 return -ENOMEM;
1680
1681 pp->retprobe = tp->retprobe;
1682
1683 return 0;
1684}
1685
1686static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1687 struct perf_probe_event *pev, bool is_kprobe)
1688{
1689 char buf[64] = "";
1690 int i, ret;
1691
1692 /* Convert event/group name */
1693 pev->event = strdup(tev->event);
1694 pev->group = strdup(tev->group);
1695 if (pev->event == NULL || pev->group == NULL)
1696 return -ENOMEM;
1697
1698 /* Convert trace_point to probe_point */
1699 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1700 if (ret < 0)
1701 return ret;
1702
1703 /* Convert trace_arg to probe_arg */
1704 pev->nargs = tev->nargs;
1705 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1706 if (pev->args == NULL)
1707 return -ENOMEM;
1708 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1709 if (tev->args[i].name)
1710 pev->args[i].name = strdup(tev->args[i].name);
1711 else {
1712 ret = synthesize_probe_trace_arg(&tev->args[i],
1713 buf, 64);
1714 pev->args[i].name = strdup(buf);
1715 }
1716 if (pev->args[i].name == NULL && ret >= 0)
1717 ret = -ENOMEM;
1718 }
1719
1720 if (ret < 0)
1721 clear_perf_probe_event(pev);
1722
1723 return ret;
1724}
1725
1726void clear_perf_probe_event(struct perf_probe_event *pev)
1727{
1728 struct perf_probe_point *pp = &pev->point;
1729 struct perf_probe_arg_field *field, *next;
1730 int i;
1731
1732 free(pev->event);
1733 free(pev->group);
1734 free(pp->file);
1735 free(pp->function);
1736 free(pp->lazy_line);
1737
1738 for (i = 0; i < pev->nargs; i++) {
1739 free(pev->args[i].name);
1740 free(pev->args[i].var);
1741 free(pev->args[i].type);
1742 field = pev->args[i].field;
1743 while (field) {
1744 next = field->next;
1745 zfree(&field->name);
1746 free(field);
1747 field = next;
1748 }
1749 }
1750 free(pev->args);
1751 memset(pev, 0, sizeof(*pev));
1752}
1753
1754static void clear_probe_trace_event(struct probe_trace_event *tev)
1755{
1756 struct probe_trace_arg_ref *ref, *next;
1757 int i;
1758
1759 free(tev->event);
1760 free(tev->group);
1761 free(tev->point.symbol);
1762 free(tev->point.module);
1763 for (i = 0; i < tev->nargs; i++) {
1764 free(tev->args[i].name);
1765 free(tev->args[i].value);
1766 free(tev->args[i].type);
1767 ref = tev->args[i].ref;
1768 while (ref) {
1769 next = ref->next;
1770 free(ref);
1771 ref = next;
1772 }
1773 }
1774 free(tev->args);
1775 memset(tev, 0, sizeof(*tev));
1776}
1777
1778static void print_warn_msg(const char *file, bool is_kprobe)
1779{
1780
1781 if (errno == ENOENT) {
1782 const char *config;
1783
1784 if (!is_kprobe)
1785 config = "CONFIG_UPROBE_EVENTS";
1786 else
1787 config = "CONFIG_KPROBE_EVENTS";
1788
1789 pr_warning("%s file does not exist - please rebuild kernel"
1790 " with %s.\n", file, config);
1791 } else
1792 pr_warning("Failed to open %s file: %s\n", file,
1793 strerror(errno));
1794}
1795
1796static int open_probe_events(const char *trace_file, bool readwrite,
1797 bool is_kprobe)
1798{
1799 char buf[PATH_MAX];
1800 const char *__debugfs;
1801 int ret;
1802
1803 __debugfs = debugfs_find_mountpoint();
1804 if (__debugfs == NULL) {
1805 pr_warning("Debugfs is not mounted.\n");
1806 return -ENOENT;
1807 }
1808
1809 ret = e_snprintf(buf, PATH_MAX, "%s/%s", __debugfs, trace_file);
1810 if (ret >= 0) {
1811 pr_debug("Opening %s write=%d\n", buf, readwrite);
1812 if (readwrite && !probe_event_dry_run)
1813 ret = open(buf, O_RDWR, O_APPEND);
1814 else
1815 ret = open(buf, O_RDONLY, 0);
1816
1817 if (ret < 0)
1818 print_warn_msg(buf, is_kprobe);
1819 }
1820 return ret;
1821}
1822
1823static int open_kprobe_events(bool readwrite)
1824{
1825 return open_probe_events("tracing/kprobe_events", readwrite, true);
1826}
1827
1828static int open_uprobe_events(bool readwrite)
1829{
1830 return open_probe_events("tracing/uprobe_events", readwrite, false);
1831}
1832
1833/* Get raw string list of current kprobe_events or uprobe_events */
1834static struct strlist *get_probe_trace_command_rawlist(int fd)
1835{
1836 int ret, idx;
1837 FILE *fp;
1838 char buf[MAX_CMDLEN];
1839 char *p;
1840 struct strlist *sl;
1841
1842 sl = strlist__new(true, NULL);
1843
1844 fp = fdopen(dup(fd), "r");
1845 while (!feof(fp)) {
1846 p = fgets(buf, MAX_CMDLEN, fp);
1847 if (!p)
1848 break;
1849
1850 idx = strlen(p) - 1;
1851 if (p[idx] == '\n')
1852 p[idx] = '\0';
1853 ret = strlist__add(sl, buf);
1854 if (ret < 0) {
1855 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1856 strlist__delete(sl);
1857 return NULL;
1858 }
1859 }
1860 fclose(fp);
1861
1862 return sl;
1863}
1864
1865/* Show an event */
1866static int show_perf_probe_event(struct perf_probe_event *pev,
1867 const char *module)
1868{
1869 int i, ret;
1870 char buf[128];
1871 char *place;
1872
1873 /* Synthesize only event probe point */
1874 place = synthesize_perf_probe_point(&pev->point);
1875 if (!place)
1876 return -EINVAL;
1877
1878 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1879 if (ret < 0)
1880 return ret;
1881
1882 printf(" %-20s (on %s", buf, place);
1883 if (module)
1884 printf(" in %s", module);
1885
1886 if (pev->nargs > 0) {
1887 printf(" with");
1888 for (i = 0; i < pev->nargs; i++) {
1889 ret = synthesize_perf_probe_arg(&pev->args[i],
1890 buf, 128);
1891 if (ret < 0)
1892 break;
1893 printf(" %s", buf);
1894 }
1895 }
1896 printf(")\n");
1897 free(place);
1898 return ret;
1899}
1900
1901static int __show_perf_probe_events(int fd, bool is_kprobe)
1902{
1903 int ret = 0;
1904 struct probe_trace_event tev;
1905 struct perf_probe_event pev;
1906 struct strlist *rawlist;
1907 struct str_node *ent;
1908
1909 memset(&tev, 0, sizeof(tev));
1910 memset(&pev, 0, sizeof(pev));
1911
1912 rawlist = get_probe_trace_command_rawlist(fd);
1913 if (!rawlist)
1914 return -ENOENT;
1915
1916 strlist__for_each(ent, rawlist) {
1917 ret = parse_probe_trace_command(ent->s, &tev);
1918 if (ret >= 0) {
1919 ret = convert_to_perf_probe_event(&tev, &pev,
1920 is_kprobe);
1921 if (ret >= 0)
1922 ret = show_perf_probe_event(&pev,
1923 tev.point.module);
1924 }
1925 clear_perf_probe_event(&pev);
1926 clear_probe_trace_event(&tev);
1927 if (ret < 0)
1928 break;
1929 }
1930 strlist__delete(rawlist);
1931
1932 return ret;
1933}
1934
1935/* List up current perf-probe events */
1936int show_perf_probe_events(void)
1937{
1938 int fd, ret;
1939
1940 setup_pager();
1941 fd = open_kprobe_events(false);
1942
1943 if (fd < 0)
1944 return fd;
1945
1946 ret = init_symbol_maps(false);
1947 if (ret < 0)
1948 return ret;
1949
1950 ret = __show_perf_probe_events(fd, true);
1951 close(fd);
1952
1953 fd = open_uprobe_events(false);
1954 if (fd >= 0) {
1955 ret = __show_perf_probe_events(fd, false);
1956 close(fd);
1957 }
1958
1959 exit_symbol_maps();
1960 return ret;
1961}
1962
1963/* Get current perf-probe event names */
1964static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
1965{
1966 char buf[128];
1967 struct strlist *sl, *rawlist;
1968 struct str_node *ent;
1969 struct probe_trace_event tev;
1970 int ret = 0;
1971
1972 memset(&tev, 0, sizeof(tev));
1973 rawlist = get_probe_trace_command_rawlist(fd);
1974 sl = strlist__new(true, NULL);
1975 strlist__for_each(ent, rawlist) {
1976 ret = parse_probe_trace_command(ent->s, &tev);
1977 if (ret < 0)
1978 break;
1979 if (include_group) {
1980 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1981 tev.event);
1982 if (ret >= 0)
1983 ret = strlist__add(sl, buf);
1984 } else
1985 ret = strlist__add(sl, tev.event);
1986 clear_probe_trace_event(&tev);
1987 if (ret < 0)
1988 break;
1989 }
1990 strlist__delete(rawlist);
1991
1992 if (ret < 0) {
1993 strlist__delete(sl);
1994 return NULL;
1995 }
1996 return sl;
1997}
1998
1999static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
2000{
2001 int ret = 0;
2002 char *buf = synthesize_probe_trace_command(tev);
2003
2004 if (!buf) {
2005 pr_debug("Failed to synthesize probe trace event.\n");
2006 return -EINVAL;
2007 }
2008
2009 pr_debug("Writing event: %s\n", buf);
2010 if (!probe_event_dry_run) {
2011 ret = write(fd, buf, strlen(buf));
2012 if (ret <= 0)
2013 pr_warning("Failed to write event: %s\n",
2014 strerror(errno));
2015 }
2016 free(buf);
2017 return ret;
2018}
2019
2020static int get_new_event_name(char *buf, size_t len, const char *base,
2021 struct strlist *namelist, bool allow_suffix)
2022{
2023 int i, ret;
2024
2025 /* Try no suffix */
2026 ret = e_snprintf(buf, len, "%s", base);
2027 if (ret < 0) {
2028 pr_debug("snprintf() failed: %s\n", strerror(-ret));
2029 return ret;
2030 }
2031 if (!strlist__has_entry(namelist, buf))
2032 return 0;
2033
2034 if (!allow_suffix) {
2035 pr_warning("Error: event \"%s\" already exists. "
2036 "(Use -f to force duplicates.)\n", base);
2037 return -EEXIST;
2038 }
2039
2040 /* Try to add suffix */
2041 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2042 ret = e_snprintf(buf, len, "%s_%d", base, i);
2043 if (ret < 0) {
2044 pr_debug("snprintf() failed: %s\n", strerror(-ret));
2045 return ret;
2046 }
2047 if (!strlist__has_entry(namelist, buf))
2048 break;
2049 }
2050 if (i == MAX_EVENT_INDEX) {
2051 pr_warning("Too many events are on the same function.\n");
2052 ret = -ERANGE;
2053 }
2054
2055 return ret;
2056}
2057
2058static int __add_probe_trace_events(struct perf_probe_event *pev,
2059 struct probe_trace_event *tevs,
2060 int ntevs, bool allow_suffix)
2061{
2062 int i, fd, ret;
2063 struct probe_trace_event *tev = NULL;
2064 char buf[64];
2065 const char *event, *group;
2066 struct strlist *namelist;
2067
2068 if (pev->uprobes)
2069 fd = open_uprobe_events(true);
2070 else
2071 fd = open_kprobe_events(true);
2072
2073 if (fd < 0)
2074 return fd;
2075 /* Get current event names */
2076 namelist = get_probe_trace_event_names(fd, false);
2077 if (!namelist) {
2078 pr_debug("Failed to get current event list.\n");
2079 return -EIO;
2080 }
2081
2082 ret = 0;
2083 printf("Added new event%s\n", (ntevs > 1) ? "s:" : ":");
2084 for (i = 0; i < ntevs; i++) {
2085 tev = &tevs[i];
2086 if (pev->event)
2087 event = pev->event;
2088 else
2089 if (pev->point.function)
2090 event = pev->point.function;
2091 else
2092 event = tev->point.symbol;
2093 if (pev->group)
2094 group = pev->group;
2095 else
2096 group = PERFPROBE_GROUP;
2097
2098 /* Get an unused new event name */
2099 ret = get_new_event_name(buf, 64, event,
2100 namelist, allow_suffix);
2101 if (ret < 0)
2102 break;
2103 event = buf;
2104
2105 tev->event = strdup(event);
2106 tev->group = strdup(group);
2107 if (tev->event == NULL || tev->group == NULL) {
2108 ret = -ENOMEM;
2109 break;
2110 }
2111 ret = write_probe_trace_event(fd, tev);
2112 if (ret < 0)
2113 break;
2114 /* Add added event name to namelist */
2115 strlist__add(namelist, event);
2116
2117 /* Trick here - save current event/group */
2118 event = pev->event;
2119 group = pev->group;
2120 pev->event = tev->event;
2121 pev->group = tev->group;
2122 show_perf_probe_event(pev, tev->point.module);
2123 /* Trick here - restore current event/group */
2124 pev->event = (char *)event;
2125 pev->group = (char *)group;
2126
2127 /*
2128 * Probes after the first probe which comes from same
2129 * user input are always allowed to add suffix, because
2130 * there might be several addresses corresponding to
2131 * one code line.
2132 */
2133 allow_suffix = true;
2134 }
2135
2136 if (ret >= 0) {
2137 /* Show how to use the event. */
2138 printf("\nYou can now use it in all perf tools, such as:\n\n");
2139 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
2140 tev->event);
2141 }
2142
2143 strlist__delete(namelist);
2144 close(fd);
2145 return ret;
2146}
2147
2148static char *looking_function_name;
2149static int num_matched_functions;
2150
2151static int probe_function_filter(struct map *map __maybe_unused,
2152 struct symbol *sym)
2153{
2154 if ((sym->binding == STB_GLOBAL || sym->binding == STB_LOCAL) &&
2155 strcmp(looking_function_name, sym->name) == 0) {
2156 num_matched_functions++;
2157 return 0;
2158 }
2159 return 1;
2160}
2161
2162#define strdup_or_goto(str, label) \
2163 ({ char *__p = strdup(str); if (!__p) goto label; __p; })
2164
2165/*
2166 * Find probe function addresses from map.
2167 * Return an error or the number of found probe_trace_event
2168 */
2169static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
2170 struct probe_trace_event **tevs,
2171 int max_tevs, const char *target)
2172{
2173 struct map *map = NULL;
2174 struct kmap *kmap = NULL;
2175 struct ref_reloc_sym *reloc_sym = NULL;
2176 struct symbol *sym;
2177 struct rb_node *nd;
2178 struct probe_trace_event *tev;
2179 struct perf_probe_point *pp = &pev->point;
2180 struct probe_trace_point *tp;
2181 int ret, i;
2182
2183 /* Init maps of given executable or kernel */
2184 if (pev->uprobes)
2185 map = dso__new_map(target);
2186 else
2187 map = kernel_get_module_map(target);
2188 if (!map) {
2189 ret = -EINVAL;
2190 goto out;
2191 }
2192
2193 /*
2194 * Load matched symbols: Since the different local symbols may have
2195 * same name but different addresses, this lists all the symbols.
2196 */
2197 num_matched_functions = 0;
2198 looking_function_name = pp->function;
2199 ret = map__load(map, probe_function_filter);
2200 if (ret || num_matched_functions == 0) {
2201 pr_err("Failed to find symbol %s in %s\n", pp->function,
2202 target ? : "kernel");
2203 ret = -ENOENT;
2204 goto out;
2205 } else if (num_matched_functions > max_tevs) {
2206 pr_err("Too many functions matched in %s\n",
2207 target ? : "kernel");
2208 ret = -E2BIG;
2209 goto out;
2210 }
2211
2212 if (!pev->uprobes) {
2213 kmap = map__kmap(map);
2214 reloc_sym = kmap->ref_reloc_sym;
2215 if (!reloc_sym) {
2216 pr_warning("Relocated base symbol is not found!\n");
2217 ret = -EINVAL;
2218 goto out;
2219 }
2220 }
2221
2222 /* Setup result trace-probe-events */
2223 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
2224 if (!*tevs) {
2225 ret = -ENOMEM;
2226 goto out;
2227 }
2228
2229 ret = 0;
2230 map__for_each_symbol(map, sym, nd) {
2231 tev = (*tevs) + ret;
2232 tp = &tev->point;
2233 if (ret == num_matched_functions) {
2234 pr_warning("Too many symbols are listed. Skip it.\n");
2235 break;
2236 }
2237 ret++;
2238
2239 if (pp->offset > sym->end - sym->start) {
2240 pr_warning("Offset %ld is bigger than the size of %s\n",
2241 pp->offset, sym->name);
2242 ret = -ENOENT;
2243 goto err_out;
2244 }
2245 /* Add one probe point */
2246 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
2247 if (reloc_sym) {
2248 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
2249 tp->offset = tp->address - reloc_sym->addr;
2250 } else {
2251 tp->symbol = strdup_or_goto(sym->name, nomem_out);
2252 tp->offset = pp->offset;
2253 }
2254 tp->retprobe = pp->retprobe;
2255 if (target)
2256 tev->point.module = strdup_or_goto(target, nomem_out);
2257 tev->uprobes = pev->uprobes;
2258 tev->nargs = pev->nargs;
2259 if (tev->nargs) {
2260 tev->args = zalloc(sizeof(struct probe_trace_arg) *
2261 tev->nargs);
2262 if (tev->args == NULL)
2263 goto nomem_out;
2264 }
2265 for (i = 0; i < tev->nargs; i++) {
2266 if (pev->args[i].name)
2267 tev->args[i].name =
2268 strdup_or_goto(pev->args[i].name,
2269 nomem_out);
2270
2271 tev->args[i].value = strdup_or_goto(pev->args[i].var,
2272 nomem_out);
2273 if (pev->args[i].type)
2274 tev->args[i].type =
2275 strdup_or_goto(pev->args[i].type,
2276 nomem_out);
2277 }
2278 }
2279
2280out:
2281 if (map && pev->uprobes) {
2282 /* Only when using uprobe(exec) map needs to be released */
2283 dso__delete(map->dso);
2284 map__delete(map);
2285 }
2286 return ret;
2287
2288nomem_out:
2289 ret = -ENOMEM;
2290err_out:
2291 clear_probe_trace_events(*tevs, num_matched_functions);
2292 zfree(tevs);
2293 goto out;
2294}
2295
2296static int convert_to_probe_trace_events(struct perf_probe_event *pev,
2297 struct probe_trace_event **tevs,
2298 int max_tevs, const char *target)
2299{
2300 int ret;
2301
2302 if (pev->uprobes && !pev->group) {
2303 /* Replace group name if not given */
2304 ret = convert_exec_to_group(target, &pev->group);
2305 if (ret != 0) {
2306 pr_warning("Failed to make a group name.\n");
2307 return ret;
2308 }
2309 }
2310
2311 /* Convert perf_probe_event with debuginfo */
2312 ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, target);
2313 if (ret != 0)
2314 return ret; /* Found in debuginfo or got an error */
2315
2316 return find_probe_trace_events_from_map(pev, tevs, max_tevs, target);
2317}
2318
2319struct __event_package {
2320 struct perf_probe_event *pev;
2321 struct probe_trace_event *tevs;
2322 int ntevs;
2323};
2324
2325int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
2326 int max_tevs, const char *target, bool force_add)
2327{
2328 int i, j, ret;
2329 struct __event_package *pkgs;
2330
2331 ret = 0;
2332 pkgs = zalloc(sizeof(struct __event_package) * npevs);
2333
2334 if (pkgs == NULL)
2335 return -ENOMEM;
2336
2337 ret = init_symbol_maps(pevs->uprobes);
2338 if (ret < 0) {
2339 free(pkgs);
2340 return ret;
2341 }
2342
2343 /* Loop 1: convert all events */
2344 for (i = 0; i < npevs; i++) {
2345 pkgs[i].pev = &pevs[i];
2346 /* Convert with or without debuginfo */
2347 ret = convert_to_probe_trace_events(pkgs[i].pev,
2348 &pkgs[i].tevs,
2349 max_tevs,
2350 target);
2351 if (ret < 0)
2352 goto end;
2353 pkgs[i].ntevs = ret;
2354 }
2355
2356 /* Loop 2: add all events */
2357 for (i = 0; i < npevs; i++) {
2358 ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
2359 pkgs[i].ntevs, force_add);
2360 if (ret < 0)
2361 break;
2362 }
2363end:
2364 /* Loop 3: cleanup and free trace events */
2365 for (i = 0; i < npevs; i++) {
2366 for (j = 0; j < pkgs[i].ntevs; j++)
2367 clear_probe_trace_event(&pkgs[i].tevs[j]);
2368 zfree(&pkgs[i].tevs);
2369 }
2370 free(pkgs);
2371 exit_symbol_maps();
2372
2373 return ret;
2374}
2375
2376static int __del_trace_probe_event(int fd, struct str_node *ent)
2377{
2378 char *p;
2379 char buf[128];
2380 int ret;
2381
2382 /* Convert from perf-probe event to trace-probe event */
2383 ret = e_snprintf(buf, 128, "-:%s", ent->s);
2384 if (ret < 0)
2385 goto error;
2386
2387 p = strchr(buf + 2, ':');
2388 if (!p) {
2389 pr_debug("Internal error: %s should have ':' but not.\n",
2390 ent->s);
2391 ret = -ENOTSUP;
2392 goto error;
2393 }
2394 *p = '/';
2395
2396 pr_debug("Writing event: %s\n", buf);
2397 ret = write(fd, buf, strlen(buf));
2398 if (ret < 0) {
2399 ret = -errno;
2400 goto error;
2401 }
2402
2403 printf("Removed event: %s\n", ent->s);
2404 return 0;
2405error:
2406 pr_warning("Failed to delete event: %s\n", strerror(-ret));
2407 return ret;
2408}
2409
2410static int del_trace_probe_event(int fd, const char *buf,
2411 struct strlist *namelist)
2412{
2413 struct str_node *ent, *n;
2414 int ret = -1;
2415
2416 if (strpbrk(buf, "*?")) { /* Glob-exp */
2417 strlist__for_each_safe(ent, n, namelist)
2418 if (strglobmatch(ent->s, buf)) {
2419 ret = __del_trace_probe_event(fd, ent);
2420 if (ret < 0)
2421 break;
2422 strlist__remove(namelist, ent);
2423 }
2424 } else {
2425 ent = strlist__find(namelist, buf);
2426 if (ent) {
2427 ret = __del_trace_probe_event(fd, ent);
2428 if (ret >= 0)
2429 strlist__remove(namelist, ent);
2430 }
2431 }
2432
2433 return ret;
2434}
2435
2436int del_perf_probe_events(struct strlist *dellist)
2437{
2438 int ret = -1, ufd = -1, kfd = -1;
2439 char buf[128];
2440 const char *group, *event;
2441 char *p, *str;
2442 struct str_node *ent;
2443 struct strlist *namelist = NULL, *unamelist = NULL;
2444
2445 /* Get current event names */
2446 kfd = open_kprobe_events(true);
2447 if (kfd < 0)
2448 return kfd;
2449
2450 namelist = get_probe_trace_event_names(kfd, true);
2451 ufd = open_uprobe_events(true);
2452
2453 if (ufd >= 0)
2454 unamelist = get_probe_trace_event_names(ufd, true);
2455
2456 if (namelist == NULL && unamelist == NULL)
2457 goto error;
2458
2459 strlist__for_each(ent, dellist) {
2460 str = strdup(ent->s);
2461 if (str == NULL) {
2462 ret = -ENOMEM;
2463 goto error;
2464 }
2465 pr_debug("Parsing: %s\n", str);
2466 p = strchr(str, ':');
2467 if (p) {
2468 group = str;
2469 *p = '\0';
2470 event = p + 1;
2471 } else {
2472 group = "*";
2473 event = str;
2474 }
2475
2476 ret = e_snprintf(buf, 128, "%s:%s", group, event);
2477 if (ret < 0) {
2478 pr_err("Failed to copy event.");
2479 free(str);
2480 goto error;
2481 }
2482
2483 pr_debug("Group: %s, Event: %s\n", group, event);
2484
2485 if (namelist)
2486 ret = del_trace_probe_event(kfd, buf, namelist);
2487
2488 if (unamelist && ret != 0)
2489 ret = del_trace_probe_event(ufd, buf, unamelist);
2490
2491 if (ret != 0)
2492 pr_info("Info: Event \"%s\" does not exist.\n", buf);
2493
2494 free(str);
2495 }
2496
2497error:
2498 if (kfd >= 0) {
2499 strlist__delete(namelist);
2500 close(kfd);
2501 }
2502
2503 if (ufd >= 0) {
2504 strlist__delete(unamelist);
2505 close(ufd);
2506 }
2507
2508 return ret;
2509}
2510
2511/* TODO: don't use a global variable for filter ... */
2512static struct strfilter *available_func_filter;
2513
2514/*
2515 * If a symbol corresponds to a function with global binding and
2516 * matches filter return 0. For all others return 1.
2517 */
2518static int filter_available_functions(struct map *map __maybe_unused,
2519 struct symbol *sym)
2520{
2521 if ((sym->binding == STB_GLOBAL || sym->binding == STB_LOCAL) &&
2522 strfilter__compare(available_func_filter, sym->name))
2523 return 0;
2524 return 1;
2525}
2526
2527int show_available_funcs(const char *target, struct strfilter *_filter,
2528 bool user)
2529{
2530 struct map *map;
2531 int ret;
2532
2533 ret = init_symbol_maps(user);
2534 if (ret < 0)
2535 return ret;
2536
2537 /* Get a symbol map */
2538 if (user)
2539 map = dso__new_map(target);
2540 else
2541 map = kernel_get_module_map(target);
2542 if (!map) {
2543 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
2544 return -EINVAL;
2545 }
2546
2547 /* Load symbols with given filter */
2548 available_func_filter = _filter;
2549 if (map__load(map, filter_available_functions)) {
2550 pr_err("Failed to load symbols in %s\n", (target) ? : "kernel");
2551 goto end;
2552 }
2553 if (!dso__sorted_by_name(map->dso, map->type))
2554 dso__sort_by_name(map->dso, map->type);
2555
2556 /* Show all (filtered) symbols */
2557 setup_pager();
2558 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2559end:
2560 if (user) {
2561 dso__delete(map->dso);
2562 map__delete(map);
2563 }
2564 exit_symbol_maps();
2565
2566 return ret;
2567}
2568