Lynx framebuffers multidomain implementation.
[linux/elbrus.git] / tools / perf / util / probe-event.c
blobd8b048c20cdee51ac894b5394b15c70a1897c106
1 /*
2 * probe-event.c : perf-probe definition to probe_events format converter
4 * Written by Masami Hiramatsu <mhiramat@redhat.com>
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.
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.
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.
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>
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"
49 #define MAX_CMDLEN 256
50 #define PERFPROBE_GROUP "probe"
52 bool probe_event_dry_run; /* Dry run flag */
54 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
56 /* If there is no space to write, returns -E2BIG. */
57 static int e_snprintf(char *str, size_t size, const char *format, ...)
58 __attribute__((format(printf, 3, 4)));
60 static int e_snprintf(char *str, size_t size, const char *format, ...)
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;
72 static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
73 static int convert_name_to_addr(struct perf_probe_event *pev,
74 const char *exec);
75 static void clear_probe_trace_event(struct probe_trace_event *tev);
76 static struct machine machine;
78 /* Initialize symbol maps and path of vmlinux/modules */
79 static int init_vmlinux(void)
81 int ret;
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;
94 ret = machine__init(&machine, "", HOST_KERNEL_ID);
95 if (ret < 0)
96 goto out;
98 if (machine__create_kernel_maps(&machine) < 0) {
99 pr_debug("machine__create_kernel_maps() failed.\n");
100 goto out;
102 out:
103 if (ret < 0)
104 pr_warning("Failed to init vmlinux path.\n");
105 return ret;
108 static struct symbol *__find_kernel_function_by_name(const char *name,
109 struct map **mapp)
111 return machine__find_kernel_function_by_name(&machine, name, mapp,
112 NULL);
115 static struct map *kernel_get_module_map(const char *module)
117 struct rb_node *nd;
118 struct map_groups *grp = &machine.kmaps;
120 /* A file path -- this is an offline module */
121 if (module && strchr(module, '/'))
122 return machine__new_module(&machine, 0, module);
124 if (!module)
125 module = "kernel";
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;
134 return NULL;
137 static struct dso *kernel_get_module_dso(const char *module)
139 struct dso *dso;
140 struct map *map;
141 const char *vmlinux_name;
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;
149 pr_debug("Failed to find module %s.\n", module);
150 return NULL;
153 map = machine.vmlinux_maps[MAP__FUNCTION];
154 dso = map->dso;
156 vmlinux_name = symbol_conf.vmlinux_name;
157 if (vmlinux_name) {
158 if (dso__load_vmlinux(dso, map, vmlinux_name, false, 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;
166 found:
167 return dso;
170 const char *kernel_get_module_path(const char *module)
172 struct dso *dso = kernel_get_module_dso(module);
173 return (dso) ? dso->long_name : NULL;
176 static int init_user_exec(void)
178 int ret = 0;
180 symbol_conf.try_vmlinux_path = false;
181 symbol_conf.sort_by_name = true;
182 ret = symbol__init();
184 if (ret < 0)
185 pr_debug("Failed to init symbol map.\n");
187 return ret;
190 static int convert_exec_to_group(const char *exec, char **result)
192 char *ptr1, *ptr2, *exec_copy;
193 char buf[64];
194 int ret;
196 exec_copy = strdup(exec);
197 if (!exec_copy)
198 return -ENOMEM;
200 ptr1 = basename(exec_copy);
201 if (!ptr1) {
202 ret = -EINVAL;
203 goto out;
206 ptr2 = strpbrk(ptr1, "-._");
207 if (ptr2)
208 *ptr2 = '\0';
209 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
210 if (ret < 0)
211 goto out;
213 *result = strdup(buf);
214 ret = *result ? 0 : -ENOMEM;
216 out:
217 free(exec_copy);
218 return ret;
221 static int convert_to_perf_probe_point(struct probe_trace_point *tp,
222 struct perf_probe_point *pp)
224 pp->function = strdup(tp->symbol);
226 if (pp->function == NULL)
227 return -ENOMEM;
229 pp->offset = tp->offset;
230 pp->retprobe = tp->retprobe;
232 return 0;
235 #ifdef HAVE_DWARF_SUPPORT
236 /* Open new debuginfo of given module */
237 static struct debuginfo *open_debuginfo(const char *module)
239 const char *path;
241 /* A file path -- this is an offline module */
242 if (module && strchr(module, '/'))
243 path = module;
244 else {
245 path = kernel_get_module_path(module);
247 if (!path) {
248 pr_err("Failed to find path of %s module.\n",
249 module ?: "kernel");
250 return NULL;
253 return debuginfo__new(path);
257 * Convert trace point to probe point with debuginfo
258 * Currently only handles kprobes.
260 static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
261 struct perf_probe_point *pp)
263 struct symbol *sym;
264 struct map *map;
265 u64 addr;
266 int ret = -ENOENT;
267 struct debuginfo *dinfo;
269 sym = __find_kernel_function_by_name(tp->symbol, &map);
270 if (sym) {
271 addr = map->unmap_ip(map, sym->start + tp->offset);
272 pr_debug("try to find %s+%ld@%" PRIx64 "\n", tp->symbol,
273 tp->offset, addr);
275 dinfo = debuginfo__new_online_kernel(addr);
276 if (dinfo) {
277 ret = debuginfo__find_probe_point(dinfo,
278 (unsigned long)addr, pp);
279 debuginfo__delete(dinfo);
280 } else {
281 pr_debug("Failed to open debuginfo at 0x%" PRIx64 "\n",
282 addr);
283 ret = -ENOENT;
286 if (ret <= 0) {
287 pr_debug("Failed to find corresponding probes from "
288 "debuginfo. Use kprobe event information.\n");
289 return convert_to_perf_probe_point(tp, pp);
291 pp->retprobe = tp->retprobe;
293 return 0;
296 static int get_text_start_address(const char *exec, unsigned long *address)
298 Elf *elf;
299 GElf_Ehdr ehdr;
300 GElf_Shdr shdr;
301 int fd, ret = -ENOENT;
303 fd = open(exec, O_RDONLY);
304 if (fd < 0)
305 return -errno;
307 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
308 if (elf == NULL)
309 return -EINVAL;
311 if (gelf_getehdr(elf, &ehdr) == NULL)
312 goto out;
314 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
315 goto out;
317 *address = shdr.sh_addr - shdr.sh_offset;
318 ret = 0;
319 out:
320 elf_end(elf);
321 return ret;
324 static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
325 int ntevs, const char *exec)
327 int i, ret = 0;
328 unsigned long offset, stext = 0;
329 char buf[32];
331 if (!exec)
332 return 0;
334 ret = get_text_start_address(exec, &stext);
335 if (ret < 0)
336 return ret;
338 for (i = 0; i < ntevs && ret >= 0; i++) {
339 /* point.address is the addres of point.symbol + point.offset */
340 offset = tevs[i].point.address - stext;
341 tevs[i].point.offset = 0;
342 zfree(&tevs[i].point.symbol);
343 ret = e_snprintf(buf, 32, "0x%lx", offset);
344 if (ret < 0)
345 break;
346 tevs[i].point.module = strdup(exec);
347 tevs[i].point.symbol = strdup(buf);
348 if (!tevs[i].point.symbol || !tevs[i].point.module) {
349 ret = -ENOMEM;
350 break;
352 tevs[i].uprobes = true;
355 return ret;
358 static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
359 int ntevs, const char *module)
361 int i, ret = 0;
362 char *tmp;
364 if (!module)
365 return 0;
367 tmp = strrchr(module, '/');
368 if (tmp) {
369 /* This is a module path -- get the module name */
370 module = strdup(tmp + 1);
371 if (!module)
372 return -ENOMEM;
373 tmp = strchr(module, '.');
374 if (tmp)
375 *tmp = '\0';
376 tmp = (char *)module; /* For free() */
379 for (i = 0; i < ntevs; i++) {
380 tevs[i].point.module = strdup(module);
381 if (!tevs[i].point.module) {
382 ret = -ENOMEM;
383 break;
387 free(tmp);
388 return ret;
391 static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
393 int i;
395 for (i = 0; i < ntevs; i++)
396 clear_probe_trace_event(tevs + i);
399 /* Try to find perf_probe_event with debuginfo */
400 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
401 struct probe_trace_event **tevs,
402 int max_tevs, const char *target)
404 bool need_dwarf = perf_probe_event_need_dwarf(pev);
405 struct debuginfo *dinfo;
406 int ntevs, ret = 0;
408 dinfo = open_debuginfo(target);
410 if (!dinfo) {
411 if (need_dwarf) {
412 pr_warning("Failed to open debuginfo file.\n");
413 return -ENOENT;
415 pr_debug("Could not open debuginfo. Try to use symbols.\n");
416 return 0;
419 /* Searching trace events corresponding to a probe event */
420 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);
422 debuginfo__delete(dinfo);
424 if (ntevs > 0) { /* Succeeded to find trace events */
425 pr_debug("find %d probe_trace_events.\n", ntevs);
426 if (target) {
427 if (pev->uprobes)
428 ret = add_exec_to_probe_trace_events(*tevs,
429 ntevs, target);
430 else
431 ret = add_module_to_probe_trace_events(*tevs,
432 ntevs, target);
434 if (ret < 0) {
435 clear_probe_trace_events(*tevs, ntevs);
436 zfree(tevs);
438 return ret < 0 ? ret : ntevs;
441 if (ntevs == 0) { /* No error but failed to find probe point. */
442 pr_warning("Probe point '%s' not found.\n",
443 synthesize_perf_probe_point(&pev->point));
444 return -ENOENT;
446 /* Error path : ntevs < 0 */
447 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
448 if (ntevs == -EBADF) {
449 pr_warning("Warning: No dwarf info found in the vmlinux - "
450 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
451 if (!need_dwarf) {
452 pr_debug("Trying to use symbols.\n");
453 return 0;
456 return ntevs;
460 * Find a src file from a DWARF tag path. Prepend optional source path prefix
461 * and chop off leading directories that do not exist. Result is passed back as
462 * a newly allocated path on success.
463 * Return 0 if file was found and readable, -errno otherwise.
465 static int get_real_path(const char *raw_path, const char *comp_dir,
466 char **new_path)
468 const char *prefix = symbol_conf.source_prefix;
470 if (!prefix) {
471 if (raw_path[0] != '/' && comp_dir)
472 /* If not an absolute path, try to use comp_dir */
473 prefix = comp_dir;
474 else {
475 if (access(raw_path, R_OK) == 0) {
476 *new_path = strdup(raw_path);
477 return 0;
478 } else
479 return -errno;
483 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
484 if (!*new_path)
485 return -ENOMEM;
487 for (;;) {
488 sprintf(*new_path, "%s/%s", prefix, raw_path);
490 if (access(*new_path, R_OK) == 0)
491 return 0;
493 if (!symbol_conf.source_prefix)
494 /* In case of searching comp_dir, don't retry */
495 return -errno;
497 switch (errno) {
498 case ENAMETOOLONG:
499 case ENOENT:
500 case EROFS:
501 case EFAULT:
502 raw_path = strchr(++raw_path, '/');
503 if (!raw_path) {
504 zfree(new_path);
505 return -ENOENT;
507 continue;
509 default:
510 zfree(new_path);
511 return -errno;
516 #define LINEBUF_SIZE 256
517 #define NR_ADDITIONAL_LINES 2
519 static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
521 char buf[LINEBUF_SIZE];
522 const char *color = show_num ? "" : PERF_COLOR_BLUE;
523 const char *prefix = NULL;
525 do {
526 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
527 goto error;
528 if (skip)
529 continue;
530 if (!prefix) {
531 prefix = show_num ? "%7d " : " ";
532 color_fprintf(stdout, color, prefix, l);
534 color_fprintf(stdout, color, "%s", buf);
536 } while (strchr(buf, '\n') == NULL);
538 return 1;
539 error:
540 if (ferror(fp)) {
541 pr_warning("File read error: %s\n", strerror(errno));
542 return -1;
544 return 0;
547 static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
549 int rv = __show_one_line(fp, l, skip, show_num);
550 if (rv == 0) {
551 pr_warning("Source file is shorter than expected.\n");
552 rv = -1;
554 return rv;
557 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
558 #define show_one_line(f,l) _show_one_line(f,l,false,false)
559 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
560 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
563 * Show line-range always requires debuginfo to find source file and
564 * line number.
566 int show_line_range(struct line_range *lr, const char *module)
568 int l = 1;
569 struct line_node *ln;
570 struct debuginfo *dinfo;
571 FILE *fp;
572 int ret;
573 char *tmp;
575 /* Search a line range */
576 ret = init_vmlinux();
577 if (ret < 0)
578 return ret;
580 dinfo = open_debuginfo(module);
581 if (!dinfo) {
582 pr_warning("Failed to open debuginfo file.\n");
583 return -ENOENT;
586 ret = debuginfo__find_line_range(dinfo, lr);
587 debuginfo__delete(dinfo);
588 if (ret == 0) {
589 pr_warning("Specified source line is not found.\n");
590 return -ENOENT;
591 } else if (ret < 0) {
592 pr_warning("Debuginfo analysis failed. (%d)\n", ret);
593 return ret;
596 /* Convert source file path */
597 tmp = lr->path;
598 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
599 free(tmp); /* Free old path */
600 if (ret < 0) {
601 pr_warning("Failed to find source file. (%d)\n", ret);
602 return ret;
605 setup_pager();
607 if (lr->function)
608 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
609 lr->start - lr->offset);
610 else
611 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
613 fp = fopen(lr->path, "r");
614 if (fp == NULL) {
615 pr_warning("Failed to open %s: %s\n", lr->path,
616 strerror(errno));
617 return -errno;
619 /* Skip to starting line number */
620 while (l < lr->start) {
621 ret = skip_one_line(fp, l++);
622 if (ret < 0)
623 goto end;
626 list_for_each_entry(ln, &lr->line_list, list) {
627 for (; ln->line > l; l++) {
628 ret = show_one_line(fp, l - lr->offset);
629 if (ret < 0)
630 goto end;
632 ret = show_one_line_with_num(fp, l++ - lr->offset);
633 if (ret < 0)
634 goto end;
637 if (lr->end == INT_MAX)
638 lr->end = l + NR_ADDITIONAL_LINES;
639 while (l <= lr->end) {
640 ret = show_one_line_or_eof(fp, l++ - lr->offset);
641 if (ret <= 0)
642 break;
644 end:
645 fclose(fp);
646 return ret;
649 static int show_available_vars_at(struct debuginfo *dinfo,
650 struct perf_probe_event *pev,
651 int max_vls, struct strfilter *_filter,
652 bool externs)
654 char *buf;
655 int ret, i, nvars;
656 struct str_node *node;
657 struct variable_list *vls = NULL, *vl;
658 const char *var;
660 buf = synthesize_perf_probe_point(&pev->point);
661 if (!buf)
662 return -EINVAL;
663 pr_debug("Searching variables at %s\n", buf);
665 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
666 max_vls, externs);
667 if (ret <= 0) {
668 pr_err("Failed to find variables at %s (%d)\n", buf, ret);
669 goto end;
671 /* Some variables are found */
672 fprintf(stdout, "Available variables at %s\n", buf);
673 for (i = 0; i < ret; i++) {
674 vl = &vls[i];
676 * A probe point might be converted to
677 * several trace points.
679 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
680 vl->point.offset);
681 zfree(&vl->point.symbol);
682 nvars = 0;
683 if (vl->vars) {
684 strlist__for_each(node, vl->vars) {
685 var = strchr(node->s, '\t') + 1;
686 if (strfilter__compare(_filter, var)) {
687 fprintf(stdout, "\t\t%s\n", node->s);
688 nvars++;
691 strlist__delete(vl->vars);
693 if (nvars == 0)
694 fprintf(stdout, "\t\t(No matched variables)\n");
696 free(vls);
697 end:
698 free(buf);
699 return ret;
702 /* Show available variables on given probe point */
703 int show_available_vars(struct perf_probe_event *pevs, int npevs,
704 int max_vls, const char *module,
705 struct strfilter *_filter, bool externs)
707 int i, ret = 0;
708 struct debuginfo *dinfo;
710 ret = init_vmlinux();
711 if (ret < 0)
712 return ret;
714 dinfo = open_debuginfo(module);
715 if (!dinfo) {
716 pr_warning("Failed to open debuginfo file.\n");
717 return -ENOENT;
720 setup_pager();
722 for (i = 0; i < npevs && ret >= 0; i++)
723 ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
724 externs);
726 debuginfo__delete(dinfo);
727 return ret;
730 #else /* !HAVE_DWARF_SUPPORT */
732 static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
733 struct perf_probe_point *pp)
735 struct symbol *sym;
737 sym = __find_kernel_function_by_name(tp->symbol, NULL);
738 if (!sym) {
739 pr_err("Failed to find symbol %s in kernel.\n", tp->symbol);
740 return -ENOENT;
743 return convert_to_perf_probe_point(tp, pp);
746 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
747 struct probe_trace_event **tevs __maybe_unused,
748 int max_tevs __maybe_unused,
749 const char *target __maybe_unused)
751 if (perf_probe_event_need_dwarf(pev)) {
752 pr_warning("Debuginfo-analysis is not supported.\n");
753 return -ENOSYS;
756 return 0;
759 int show_line_range(struct line_range *lr __maybe_unused,
760 const char *module __maybe_unused)
762 pr_warning("Debuginfo-analysis is not supported.\n");
763 return -ENOSYS;
766 int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
767 int npevs __maybe_unused, int max_vls __maybe_unused,
768 const char *module __maybe_unused,
769 struct strfilter *filter __maybe_unused,
770 bool externs __maybe_unused)
772 pr_warning("Debuginfo-analysis is not supported.\n");
773 return -ENOSYS;
775 #endif
777 void line_range__clear(struct line_range *lr)
779 struct line_node *ln;
781 free(lr->function);
782 free(lr->file);
783 free(lr->path);
784 free(lr->comp_dir);
785 while (!list_empty(&lr->line_list)) {
786 ln = list_first_entry(&lr->line_list, struct line_node, list);
787 list_del(&ln->list);
788 free(ln);
790 memset(lr, 0, sizeof(*lr));
793 void line_range__init(struct line_range *lr)
795 memset(lr, 0, sizeof(*lr));
796 INIT_LIST_HEAD(&lr->line_list);
799 static int parse_line_num(char **ptr, int *val, const char *what)
801 const char *start = *ptr;
803 errno = 0;
804 *val = strtol(*ptr, ptr, 0);
805 if (errno || *ptr == start) {
806 semantic_error("'%s' is not a valid number.\n", what);
807 return -EINVAL;
809 return 0;
813 * Stuff 'lr' according to the line range described by 'arg'.
814 * The line range syntax is described by:
816 * SRC[:SLN[+NUM|-ELN]]
817 * FNC[@SRC][:SLN[+NUM|-ELN]]
819 int parse_line_range_desc(const char *arg, struct line_range *lr)
821 char *range, *file, *name = strdup(arg);
822 int err;
824 if (!name)
825 return -ENOMEM;
827 lr->start = 0;
828 lr->end = INT_MAX;
830 range = strchr(name, ':');
831 if (range) {
832 *range++ = '\0';
834 err = parse_line_num(&range, &lr->start, "start line");
835 if (err)
836 goto err;
838 if (*range == '+' || *range == '-') {
839 const char c = *range++;
841 err = parse_line_num(&range, &lr->end, "end line");
842 if (err)
843 goto err;
845 if (c == '+') {
846 lr->end += lr->start;
848 * Adjust the number of lines here.
849 * If the number of lines == 1, the
850 * the end of line should be equal to
851 * the start of line.
853 lr->end--;
857 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
859 err = -EINVAL;
860 if (lr->start > lr->end) {
861 semantic_error("Start line must be smaller"
862 " than end line.\n");
863 goto err;
865 if (*range != '\0') {
866 semantic_error("Tailing with invalid str '%s'.\n", range);
867 goto err;
871 file = strchr(name, '@');
872 if (file) {
873 *file = '\0';
874 lr->file = strdup(++file);
875 if (lr->file == NULL) {
876 err = -ENOMEM;
877 goto err;
879 lr->function = name;
880 } else if (strchr(name, '.'))
881 lr->file = name;
882 else
883 lr->function = name;
885 return 0;
886 err:
887 free(name);
888 return err;
891 /* Check the name is good for event/group */
892 static bool check_event_name(const char *name)
894 if (!isalpha(*name) && *name != '_')
895 return false;
896 while (*++name != '\0') {
897 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
898 return false;
900 return true;
903 /* Parse probepoint definition. */
904 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
906 struct perf_probe_point *pp = &pev->point;
907 char *ptr, *tmp;
908 char c, nc = 0;
910 * <Syntax>
911 * perf probe [EVENT=]SRC[:LN|;PTN]
912 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
914 * TODO:Group name support
917 ptr = strpbrk(arg, ";=@+%");
918 if (ptr && *ptr == '=') { /* Event name */
919 *ptr = '\0';
920 tmp = ptr + 1;
921 if (strchr(arg, ':')) {
922 semantic_error("Group name is not supported yet.\n");
923 return -ENOTSUP;
925 if (!check_event_name(arg)) {
926 semantic_error("%s is bad for event name -it must "
927 "follow C symbol-naming rule.\n", arg);
928 return -EINVAL;
930 pev->event = strdup(arg);
931 if (pev->event == NULL)
932 return -ENOMEM;
933 pev->group = NULL;
934 arg = tmp;
937 ptr = strpbrk(arg, ";:+@%");
938 if (ptr) {
939 nc = *ptr;
940 *ptr++ = '\0';
943 tmp = strdup(arg);
944 if (tmp == NULL)
945 return -ENOMEM;
947 /* Check arg is function or file and copy it */
948 if (strchr(tmp, '.')) /* File */
949 pp->file = tmp;
950 else /* Function */
951 pp->function = tmp;
953 /* Parse other options */
954 while (ptr) {
955 arg = ptr;
956 c = nc;
957 if (c == ';') { /* Lazy pattern must be the last part */
958 pp->lazy_line = strdup(arg);
959 if (pp->lazy_line == NULL)
960 return -ENOMEM;
961 break;
963 ptr = strpbrk(arg, ";:+@%");
964 if (ptr) {
965 nc = *ptr;
966 *ptr++ = '\0';
968 switch (c) {
969 case ':': /* Line number */
970 pp->line = strtoul(arg, &tmp, 0);
971 if (*tmp != '\0') {
972 semantic_error("There is non-digit char"
973 " in line number.\n");
974 return -EINVAL;
976 break;
977 case '+': /* Byte offset from a symbol */
978 pp->offset = strtoul(arg, &tmp, 0);
979 if (*tmp != '\0') {
980 semantic_error("There is non-digit character"
981 " in offset.\n");
982 return -EINVAL;
984 break;
985 case '@': /* File name */
986 if (pp->file) {
987 semantic_error("SRC@SRC is not allowed.\n");
988 return -EINVAL;
990 pp->file = strdup(arg);
991 if (pp->file == NULL)
992 return -ENOMEM;
993 break;
994 case '%': /* Probe places */
995 if (strcmp(arg, "return") == 0) {
996 pp->retprobe = 1;
997 } else { /* Others not supported yet */
998 semantic_error("%%%s is not supported.\n", arg);
999 return -ENOTSUP;
1001 break;
1002 default: /* Buggy case */
1003 pr_err("This program has a bug at %s:%d.\n",
1004 __FILE__, __LINE__);
1005 return -ENOTSUP;
1006 break;
1010 /* Exclusion check */
1011 if (pp->lazy_line && pp->line) {
1012 semantic_error("Lazy pattern can't be used with"
1013 " line number.\n");
1014 return -EINVAL;
1017 if (pp->lazy_line && pp->offset) {
1018 semantic_error("Lazy pattern can't be used with offset.\n");
1019 return -EINVAL;
1022 if (pp->line && pp->offset) {
1023 semantic_error("Offset can't be used with line number.\n");
1024 return -EINVAL;
1027 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1028 semantic_error("File always requires line number or "
1029 "lazy pattern.\n");
1030 return -EINVAL;
1033 if (pp->offset && !pp->function) {
1034 semantic_error("Offset requires an entry function.\n");
1035 return -EINVAL;
1038 if (pp->retprobe && !pp->function) {
1039 semantic_error("Return probe requires an entry function.\n");
1040 return -EINVAL;
1043 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1044 semantic_error("Offset/Line/Lazy pattern can't be used with "
1045 "return probe.\n");
1046 return -EINVAL;
1049 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1050 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1051 pp->lazy_line);
1052 return 0;
1055 /* Parse perf-probe event argument */
1056 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1058 char *tmp, *goodname;
1059 struct perf_probe_arg_field **fieldp;
1061 pr_debug("parsing arg: %s into ", str);
1063 tmp = strchr(str, '=');
1064 if (tmp) {
1065 arg->name = strndup(str, tmp - str);
1066 if (arg->name == NULL)
1067 return -ENOMEM;
1068 pr_debug("name:%s ", arg->name);
1069 str = tmp + 1;
1072 tmp = strchr(str, ':');
1073 if (tmp) { /* Type setting */
1074 *tmp = '\0';
1075 arg->type = strdup(tmp + 1);
1076 if (arg->type == NULL)
1077 return -ENOMEM;
1078 pr_debug("type:%s ", arg->type);
1081 tmp = strpbrk(str, "-.[");
1082 if (!is_c_varname(str) || !tmp) {
1083 /* A variable, register, symbol or special value */
1084 arg->var = strdup(str);
1085 if (arg->var == NULL)
1086 return -ENOMEM;
1087 pr_debug("%s\n", arg->var);
1088 return 0;
1091 /* Structure fields or array element */
1092 arg->var = strndup(str, tmp - str);
1093 if (arg->var == NULL)
1094 return -ENOMEM;
1095 goodname = arg->var;
1096 pr_debug("%s, ", arg->var);
1097 fieldp = &arg->field;
1099 do {
1100 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1101 if (*fieldp == NULL)
1102 return -ENOMEM;
1103 if (*tmp == '[') { /* Array */
1104 str = tmp;
1105 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1106 (*fieldp)->ref = true;
1107 if (*tmp != ']' || tmp == str + 1) {
1108 semantic_error("Array index must be a"
1109 " number.\n");
1110 return -EINVAL;
1112 tmp++;
1113 if (*tmp == '\0')
1114 tmp = NULL;
1115 } else { /* Structure */
1116 if (*tmp == '.') {
1117 str = tmp + 1;
1118 (*fieldp)->ref = false;
1119 } else if (tmp[1] == '>') {
1120 str = tmp + 2;
1121 (*fieldp)->ref = true;
1122 } else {
1123 semantic_error("Argument parse error: %s\n",
1124 str);
1125 return -EINVAL;
1127 tmp = strpbrk(str, "-.[");
1129 if (tmp) {
1130 (*fieldp)->name = strndup(str, tmp - str);
1131 if ((*fieldp)->name == NULL)
1132 return -ENOMEM;
1133 if (*str != '[')
1134 goodname = (*fieldp)->name;
1135 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1136 fieldp = &(*fieldp)->next;
1138 } while (tmp);
1139 (*fieldp)->name = strdup(str);
1140 if ((*fieldp)->name == NULL)
1141 return -ENOMEM;
1142 if (*str != '[')
1143 goodname = (*fieldp)->name;
1144 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1146 /* If no name is specified, set the last field name (not array index)*/
1147 if (!arg->name) {
1148 arg->name = strdup(goodname);
1149 if (arg->name == NULL)
1150 return -ENOMEM;
1152 return 0;
1155 /* Parse perf-probe event command */
1156 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1158 char **argv;
1159 int argc, i, ret = 0;
1161 argv = argv_split(cmd, &argc);
1162 if (!argv) {
1163 pr_debug("Failed to split arguments.\n");
1164 return -ENOMEM;
1166 if (argc - 1 > MAX_PROBE_ARGS) {
1167 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1168 ret = -ERANGE;
1169 goto out;
1171 /* Parse probe point */
1172 ret = parse_perf_probe_point(argv[0], pev);
1173 if (ret < 0)
1174 goto out;
1176 /* Copy arguments and ensure return probe has no C argument */
1177 pev->nargs = argc - 1;
1178 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1179 if (pev->args == NULL) {
1180 ret = -ENOMEM;
1181 goto out;
1183 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1184 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1185 if (ret >= 0 &&
1186 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1187 semantic_error("You can't specify local variable for"
1188 " kretprobe.\n");
1189 ret = -EINVAL;
1192 out:
1193 argv_free(argv);
1195 return ret;
1198 /* Return true if this perf_probe_event requires debuginfo */
1199 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1201 int i;
1203 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1204 return true;
1206 for (i = 0; i < pev->nargs; i++)
1207 if (is_c_varname(pev->args[i].var))
1208 return true;
1210 return false;
1213 /* Parse probe_events event into struct probe_point */
1214 static int parse_probe_trace_command(const char *cmd,
1215 struct probe_trace_event *tev)
1217 struct probe_trace_point *tp = &tev->point;
1218 char pr;
1219 char *p;
1220 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1221 int ret, i, argc;
1222 char **argv;
1224 pr_debug("Parsing probe_events: %s\n", cmd);
1225 argv = argv_split(cmd, &argc);
1226 if (!argv) {
1227 pr_debug("Failed to split arguments.\n");
1228 return -ENOMEM;
1230 if (argc < 2) {
1231 semantic_error("Too few probe arguments.\n");
1232 ret = -ERANGE;
1233 goto out;
1236 /* Scan event and group name. */
1237 argv0_str = strdup(argv[0]);
1238 if (argv0_str == NULL) {
1239 ret = -ENOMEM;
1240 goto out;
1242 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1243 fmt2_str = strtok_r(NULL, "/", &fmt);
1244 fmt3_str = strtok_r(NULL, " \t", &fmt);
1245 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
1246 || fmt3_str == NULL) {
1247 semantic_error("Failed to parse event name: %s\n", argv[0]);
1248 ret = -EINVAL;
1249 goto out;
1251 pr = fmt1_str[0];
1252 tev->group = strdup(fmt2_str);
1253 tev->event = strdup(fmt3_str);
1254 if (tev->group == NULL || tev->event == NULL) {
1255 ret = -ENOMEM;
1256 goto out;
1258 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1260 tp->retprobe = (pr == 'r');
1262 /* Scan module name(if there), function name and offset */
1263 p = strchr(argv[1], ':');
1264 if (p) {
1265 tp->module = strndup(argv[1], p - argv[1]);
1266 p++;
1267 } else
1268 p = argv[1];
1269 fmt1_str = strtok_r(p, "+", &fmt);
1270 tp->symbol = strdup(fmt1_str);
1271 if (tp->symbol == NULL) {
1272 ret = -ENOMEM;
1273 goto out;
1275 fmt2_str = strtok_r(NULL, "", &fmt);
1276 if (fmt2_str == NULL)
1277 tp->offset = 0;
1278 else
1279 tp->offset = strtoul(fmt2_str, NULL, 10);
1281 tev->nargs = argc - 2;
1282 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1283 if (tev->args == NULL) {
1284 ret = -ENOMEM;
1285 goto out;
1287 for (i = 0; i < tev->nargs; i++) {
1288 p = strchr(argv[i + 2], '=');
1289 if (p) /* We don't need which register is assigned. */
1290 *p++ = '\0';
1291 else
1292 p = argv[i + 2];
1293 tev->args[i].name = strdup(argv[i + 2]);
1294 /* TODO: parse regs and offset */
1295 tev->args[i].value = strdup(p);
1296 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1297 ret = -ENOMEM;
1298 goto out;
1301 ret = 0;
1302 out:
1303 free(argv0_str);
1304 argv_free(argv);
1305 return ret;
1308 /* Compose only probe arg */
1309 int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1311 struct perf_probe_arg_field *field = pa->field;
1312 int ret;
1313 char *tmp = buf;
1315 if (pa->name && pa->var)
1316 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1317 else
1318 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1319 if (ret <= 0)
1320 goto error;
1321 tmp += ret;
1322 len -= ret;
1324 while (field) {
1325 if (field->name[0] == '[')
1326 ret = e_snprintf(tmp, len, "%s", field->name);
1327 else
1328 ret = e_snprintf(tmp, len, "%s%s",
1329 field->ref ? "->" : ".", field->name);
1330 if (ret <= 0)
1331 goto error;
1332 tmp += ret;
1333 len -= ret;
1334 field = field->next;
1337 if (pa->type) {
1338 ret = e_snprintf(tmp, len, ":%s", pa->type);
1339 if (ret <= 0)
1340 goto error;
1341 tmp += ret;
1342 len -= ret;
1345 return tmp - buf;
1346 error:
1347 pr_debug("Failed to synthesize perf probe argument: %s\n",
1348 strerror(-ret));
1349 return ret;
1352 /* Compose only probe point (not argument) */
1353 static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1355 char *buf, *tmp;
1356 char offs[32] = "", line[32] = "", file[32] = "";
1357 int ret, len;
1359 buf = zalloc(MAX_CMDLEN);
1360 if (buf == NULL) {
1361 ret = -ENOMEM;
1362 goto error;
1364 if (pp->offset) {
1365 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1366 if (ret <= 0)
1367 goto error;
1369 if (pp->line) {
1370 ret = e_snprintf(line, 32, ":%d", pp->line);
1371 if (ret <= 0)
1372 goto error;
1374 if (pp->file) {
1375 tmp = pp->file;
1376 len = strlen(tmp);
1377 if (len > 30) {
1378 tmp = strchr(pp->file + len - 30, '/');
1379 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1381 ret = e_snprintf(file, 32, "@%s", tmp);
1382 if (ret <= 0)
1383 goto error;
1386 if (pp->function)
1387 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1388 offs, pp->retprobe ? "%return" : "", line,
1389 file);
1390 else
1391 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1392 if (ret <= 0)
1393 goto error;
1395 return buf;
1396 error:
1397 pr_debug("Failed to synthesize perf probe point: %s\n",
1398 strerror(-ret));
1399 free(buf);
1400 return NULL;
1403 #if 0
1404 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1406 char *buf;
1407 int i, len, ret;
1409 buf = synthesize_perf_probe_point(&pev->point);
1410 if (!buf)
1411 return NULL;
1413 len = strlen(buf);
1414 for (i = 0; i < pev->nargs; i++) {
1415 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1416 pev->args[i].name);
1417 if (ret <= 0) {
1418 free(buf);
1419 return NULL;
1421 len += ret;
1424 return buf;
1426 #endif
1428 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1429 char **buf, size_t *buflen,
1430 int depth)
1432 int ret;
1433 if (ref->next) {
1434 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1435 buflen, depth + 1);
1436 if (depth < 0)
1437 goto out;
1440 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1441 if (ret < 0)
1442 depth = ret;
1443 else {
1444 *buf += ret;
1445 *buflen -= ret;
1447 out:
1448 return depth;
1452 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1453 char *buf, size_t buflen)
1455 struct probe_trace_arg_ref *ref = arg->ref;
1456 int ret, depth = 0;
1457 char *tmp = buf;
1459 /* Argument name or separator */
1460 if (arg->name)
1461 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1462 else
1463 ret = e_snprintf(buf, buflen, " ");
1464 if (ret < 0)
1465 return ret;
1466 buf += ret;
1467 buflen -= ret;
1469 /* Special case: @XXX */
1470 if (arg->value[0] == '@' && arg->ref)
1471 ref = ref->next;
1473 /* Dereferencing arguments */
1474 if (ref) {
1475 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1476 &buflen, 1);
1477 if (depth < 0)
1478 return depth;
1481 /* Print argument value */
1482 if (arg->value[0] == '@' && arg->ref)
1483 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1484 arg->ref->offset);
1485 else
1486 ret = e_snprintf(buf, buflen, "%s", arg->value);
1487 if (ret < 0)
1488 return ret;
1489 buf += ret;
1490 buflen -= ret;
1492 /* Closing */
1493 while (depth--) {
1494 ret = e_snprintf(buf, buflen, ")");
1495 if (ret < 0)
1496 return ret;
1497 buf += ret;
1498 buflen -= ret;
1500 /* Print argument type */
1501 if (arg->type) {
1502 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1503 if (ret <= 0)
1504 return ret;
1505 buf += ret;
1508 return buf - tmp;
1511 char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1513 struct probe_trace_point *tp = &tev->point;
1514 char *buf;
1515 int i, len, ret;
1517 buf = zalloc(MAX_CMDLEN);
1518 if (buf == NULL)
1519 return NULL;
1521 if (tev->uprobes)
1522 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s:%s",
1523 tp->retprobe ? 'r' : 'p',
1524 tev->group, tev->event,
1525 tp->module, tp->symbol);
1526 else
1527 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s%s%s+%lu",
1528 tp->retprobe ? 'r' : 'p',
1529 tev->group, tev->event,
1530 tp->module ?: "", tp->module ? ":" : "",
1531 tp->symbol, tp->offset);
1533 if (len <= 0)
1534 goto error;
1536 for (i = 0; i < tev->nargs; i++) {
1537 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1538 MAX_CMDLEN - len);
1539 if (ret <= 0)
1540 goto error;
1541 len += ret;
1544 return buf;
1545 error:
1546 free(buf);
1547 return NULL;
1550 static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1551 struct perf_probe_event *pev, bool is_kprobe)
1553 char buf[64] = "";
1554 int i, ret;
1556 /* Convert event/group name */
1557 pev->event = strdup(tev->event);
1558 pev->group = strdup(tev->group);
1559 if (pev->event == NULL || pev->group == NULL)
1560 return -ENOMEM;
1562 /* Convert trace_point to probe_point */
1563 if (is_kprobe)
1564 ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
1565 else
1566 ret = convert_to_perf_probe_point(&tev->point, &pev->point);
1568 if (ret < 0)
1569 return ret;
1571 /* Convert trace_arg to probe_arg */
1572 pev->nargs = tev->nargs;
1573 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1574 if (pev->args == NULL)
1575 return -ENOMEM;
1576 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1577 if (tev->args[i].name)
1578 pev->args[i].name = strdup(tev->args[i].name);
1579 else {
1580 ret = synthesize_probe_trace_arg(&tev->args[i],
1581 buf, 64);
1582 pev->args[i].name = strdup(buf);
1584 if (pev->args[i].name == NULL && ret >= 0)
1585 ret = -ENOMEM;
1588 if (ret < 0)
1589 clear_perf_probe_event(pev);
1591 return ret;
1594 void clear_perf_probe_event(struct perf_probe_event *pev)
1596 struct perf_probe_point *pp = &pev->point;
1597 struct perf_probe_arg_field *field, *next;
1598 int i;
1600 free(pev->event);
1601 free(pev->group);
1602 free(pp->file);
1603 free(pp->function);
1604 free(pp->lazy_line);
1606 for (i = 0; i < pev->nargs; i++) {
1607 free(pev->args[i].name);
1608 free(pev->args[i].var);
1609 free(pev->args[i].type);
1610 field = pev->args[i].field;
1611 while (field) {
1612 next = field->next;
1613 zfree(&field->name);
1614 free(field);
1615 field = next;
1618 free(pev->args);
1619 memset(pev, 0, sizeof(*pev));
1622 static void clear_probe_trace_event(struct probe_trace_event *tev)
1624 struct probe_trace_arg_ref *ref, *next;
1625 int i;
1627 free(tev->event);
1628 free(tev->group);
1629 free(tev->point.symbol);
1630 free(tev->point.module);
1631 for (i = 0; i < tev->nargs; i++) {
1632 free(tev->args[i].name);
1633 free(tev->args[i].value);
1634 free(tev->args[i].type);
1635 ref = tev->args[i].ref;
1636 while (ref) {
1637 next = ref->next;
1638 free(ref);
1639 ref = next;
1642 free(tev->args);
1643 memset(tev, 0, sizeof(*tev));
1646 static void print_warn_msg(const char *file, bool is_kprobe)
1649 if (errno == ENOENT) {
1650 const char *config;
1652 if (!is_kprobe)
1653 config = "CONFIG_UPROBE_EVENTS";
1654 else
1655 config = "CONFIG_KPROBE_EVENTS";
1657 pr_warning("%s file does not exist - please rebuild kernel"
1658 " with %s.\n", file, config);
1659 } else
1660 pr_warning("Failed to open %s file: %s\n", file,
1661 strerror(errno));
1664 static int open_probe_events(const char *trace_file, bool readwrite,
1665 bool is_kprobe)
1667 char buf[PATH_MAX];
1668 const char *__debugfs;
1669 int ret;
1671 __debugfs = debugfs_find_mountpoint();
1672 if (__debugfs == NULL) {
1673 pr_warning("Debugfs is not mounted.\n");
1674 return -ENOENT;
1677 ret = e_snprintf(buf, PATH_MAX, "%s/%s", __debugfs, trace_file);
1678 if (ret >= 0) {
1679 pr_debug("Opening %s write=%d\n", buf, readwrite);
1680 if (readwrite && !probe_event_dry_run)
1681 ret = open(buf, O_RDWR, O_APPEND);
1682 else
1683 ret = open(buf, O_RDONLY, 0);
1685 if (ret < 0)
1686 print_warn_msg(buf, is_kprobe);
1688 return ret;
1691 static int open_kprobe_events(bool readwrite)
1693 return open_probe_events("tracing/kprobe_events", readwrite, true);
1696 static int open_uprobe_events(bool readwrite)
1698 return open_probe_events("tracing/uprobe_events", readwrite, false);
1701 /* Get raw string list of current kprobe_events or uprobe_events */
1702 static struct strlist *get_probe_trace_command_rawlist(int fd)
1704 int ret, idx;
1705 FILE *fp;
1706 char buf[MAX_CMDLEN];
1707 char *p;
1708 struct strlist *sl;
1710 sl = strlist__new(true, NULL);
1712 fp = fdopen(dup(fd), "r");
1713 while (!feof(fp)) {
1714 p = fgets(buf, MAX_CMDLEN, fp);
1715 if (!p)
1716 break;
1718 idx = strlen(p) - 1;
1719 if (p[idx] == '\n')
1720 p[idx] = '\0';
1721 ret = strlist__add(sl, buf);
1722 if (ret < 0) {
1723 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1724 strlist__delete(sl);
1725 return NULL;
1728 fclose(fp);
1730 return sl;
1733 /* Show an event */
1734 static int show_perf_probe_event(struct perf_probe_event *pev)
1736 int i, ret;
1737 char buf[128];
1738 char *place;
1740 /* Synthesize only event probe point */
1741 place = synthesize_perf_probe_point(&pev->point);
1742 if (!place)
1743 return -EINVAL;
1745 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1746 if (ret < 0)
1747 return ret;
1749 printf(" %-20s (on %s", buf, place);
1751 if (pev->nargs > 0) {
1752 printf(" with");
1753 for (i = 0; i < pev->nargs; i++) {
1754 ret = synthesize_perf_probe_arg(&pev->args[i],
1755 buf, 128);
1756 if (ret < 0)
1757 break;
1758 printf(" %s", buf);
1761 printf(")\n");
1762 free(place);
1763 return ret;
1766 static int __show_perf_probe_events(int fd, bool is_kprobe)
1768 int ret = 0;
1769 struct probe_trace_event tev;
1770 struct perf_probe_event pev;
1771 struct strlist *rawlist;
1772 struct str_node *ent;
1774 memset(&tev, 0, sizeof(tev));
1775 memset(&pev, 0, sizeof(pev));
1777 rawlist = get_probe_trace_command_rawlist(fd);
1778 if (!rawlist)
1779 return -ENOENT;
1781 strlist__for_each(ent, rawlist) {
1782 ret = parse_probe_trace_command(ent->s, &tev);
1783 if (ret >= 0) {
1784 ret = convert_to_perf_probe_event(&tev, &pev,
1785 is_kprobe);
1786 if (ret >= 0)
1787 ret = show_perf_probe_event(&pev);
1789 clear_perf_probe_event(&pev);
1790 clear_probe_trace_event(&tev);
1791 if (ret < 0)
1792 break;
1794 strlist__delete(rawlist);
1796 return ret;
1799 /* List up current perf-probe events */
1800 int show_perf_probe_events(void)
1802 int fd, ret;
1804 setup_pager();
1805 fd = open_kprobe_events(false);
1807 if (fd < 0)
1808 return fd;
1810 ret = init_vmlinux();
1811 if (ret < 0)
1812 return ret;
1814 ret = __show_perf_probe_events(fd, true);
1815 close(fd);
1817 fd = open_uprobe_events(false);
1818 if (fd >= 0) {
1819 ret = __show_perf_probe_events(fd, false);
1820 close(fd);
1823 return ret;
1826 /* Get current perf-probe event names */
1827 static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
1829 char buf[128];
1830 struct strlist *sl, *rawlist;
1831 struct str_node *ent;
1832 struct probe_trace_event tev;
1833 int ret = 0;
1835 memset(&tev, 0, sizeof(tev));
1836 rawlist = get_probe_trace_command_rawlist(fd);
1837 sl = strlist__new(true, NULL);
1838 strlist__for_each(ent, rawlist) {
1839 ret = parse_probe_trace_command(ent->s, &tev);
1840 if (ret < 0)
1841 break;
1842 if (include_group) {
1843 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1844 tev.event);
1845 if (ret >= 0)
1846 ret = strlist__add(sl, buf);
1847 } else
1848 ret = strlist__add(sl, tev.event);
1849 clear_probe_trace_event(&tev);
1850 if (ret < 0)
1851 break;
1853 strlist__delete(rawlist);
1855 if (ret < 0) {
1856 strlist__delete(sl);
1857 return NULL;
1859 return sl;
1862 static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
1864 int ret = 0;
1865 char *buf = synthesize_probe_trace_command(tev);
1867 if (!buf) {
1868 pr_debug("Failed to synthesize probe trace event.\n");
1869 return -EINVAL;
1872 pr_debug("Writing event: %s\n", buf);
1873 if (!probe_event_dry_run) {
1874 ret = write(fd, buf, strlen(buf));
1875 if (ret <= 0)
1876 pr_warning("Failed to write event: %s\n",
1877 strerror(errno));
1879 free(buf);
1880 return ret;
1883 static int get_new_event_name(char *buf, size_t len, const char *base,
1884 struct strlist *namelist, bool allow_suffix)
1886 int i, ret;
1888 /* Try no suffix */
1889 ret = e_snprintf(buf, len, "%s", base);
1890 if (ret < 0) {
1891 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1892 return ret;
1894 if (!strlist__has_entry(namelist, buf))
1895 return 0;
1897 if (!allow_suffix) {
1898 pr_warning("Error: event \"%s\" already exists. "
1899 "(Use -f to force duplicates.)\n", base);
1900 return -EEXIST;
1903 /* Try to add suffix */
1904 for (i = 1; i < MAX_EVENT_INDEX; i++) {
1905 ret = e_snprintf(buf, len, "%s_%d", base, i);
1906 if (ret < 0) {
1907 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1908 return ret;
1910 if (!strlist__has_entry(namelist, buf))
1911 break;
1913 if (i == MAX_EVENT_INDEX) {
1914 pr_warning("Too many events are on the same function.\n");
1915 ret = -ERANGE;
1918 return ret;
1921 static int __add_probe_trace_events(struct perf_probe_event *pev,
1922 struct probe_trace_event *tevs,
1923 int ntevs, bool allow_suffix)
1925 int i, fd, ret;
1926 struct probe_trace_event *tev = NULL;
1927 char buf[64];
1928 const char *event, *group;
1929 struct strlist *namelist;
1931 if (pev->uprobes)
1932 fd = open_uprobe_events(true);
1933 else
1934 fd = open_kprobe_events(true);
1936 if (fd < 0)
1937 return fd;
1938 /* Get current event names */
1939 namelist = get_probe_trace_event_names(fd, false);
1940 if (!namelist) {
1941 pr_debug("Failed to get current event list.\n");
1942 return -EIO;
1945 ret = 0;
1946 printf("Added new event%s\n", (ntevs > 1) ? "s:" : ":");
1947 for (i = 0; i < ntevs; i++) {
1948 tev = &tevs[i];
1949 if (pev->event)
1950 event = pev->event;
1951 else
1952 if (pev->point.function)
1953 event = pev->point.function;
1954 else
1955 event = tev->point.symbol;
1956 if (pev->group)
1957 group = pev->group;
1958 else
1959 group = PERFPROBE_GROUP;
1961 /* Get an unused new event name */
1962 ret = get_new_event_name(buf, 64, event,
1963 namelist, allow_suffix);
1964 if (ret < 0)
1965 break;
1966 event = buf;
1968 tev->event = strdup(event);
1969 tev->group = strdup(group);
1970 if (tev->event == NULL || tev->group == NULL) {
1971 ret = -ENOMEM;
1972 break;
1974 ret = write_probe_trace_event(fd, tev);
1975 if (ret < 0)
1976 break;
1977 /* Add added event name to namelist */
1978 strlist__add(namelist, event);
1980 /* Trick here - save current event/group */
1981 event = pev->event;
1982 group = pev->group;
1983 pev->event = tev->event;
1984 pev->group = tev->group;
1985 show_perf_probe_event(pev);
1986 /* Trick here - restore current event/group */
1987 pev->event = (char *)event;
1988 pev->group = (char *)group;
1991 * Probes after the first probe which comes from same
1992 * user input are always allowed to add suffix, because
1993 * there might be several addresses corresponding to
1994 * one code line.
1996 allow_suffix = true;
1999 if (ret >= 0) {
2000 /* Show how to use the event. */
2001 printf("\nYou can now use it in all perf tools, such as:\n\n");
2002 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
2003 tev->event);
2006 strlist__delete(namelist);
2007 close(fd);
2008 return ret;
2011 static int convert_to_probe_trace_events(struct perf_probe_event *pev,
2012 struct probe_trace_event **tevs,
2013 int max_tevs, const char *target)
2015 struct symbol *sym;
2016 int ret, i;
2017 struct probe_trace_event *tev;
2019 if (pev->uprobes && !pev->group) {
2020 /* Replace group name if not given */
2021 ret = convert_exec_to_group(target, &pev->group);
2022 if (ret != 0) {
2023 pr_warning("Failed to make a group name.\n");
2024 return ret;
2028 /* Convert perf_probe_event with debuginfo */
2029 ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, target);
2030 if (ret != 0)
2031 return ret; /* Found in debuginfo or got an error */
2033 if (pev->uprobes) {
2034 ret = convert_name_to_addr(pev, target);
2035 if (ret < 0)
2036 return ret;
2039 /* Allocate trace event buffer */
2040 tev = *tevs = zalloc(sizeof(struct probe_trace_event));
2041 if (tev == NULL)
2042 return -ENOMEM;
2044 /* Copy parameters */
2045 tev->point.symbol = strdup(pev->point.function);
2046 if (tev->point.symbol == NULL) {
2047 ret = -ENOMEM;
2048 goto error;
2051 if (target) {
2052 tev->point.module = strdup(target);
2053 if (tev->point.module == NULL) {
2054 ret = -ENOMEM;
2055 goto error;
2059 tev->point.offset = pev->point.offset;
2060 tev->point.retprobe = pev->point.retprobe;
2061 tev->nargs = pev->nargs;
2062 tev->uprobes = pev->uprobes;
2064 if (tev->nargs) {
2065 tev->args = zalloc(sizeof(struct probe_trace_arg)
2066 * tev->nargs);
2067 if (tev->args == NULL) {
2068 ret = -ENOMEM;
2069 goto error;
2071 for (i = 0; i < tev->nargs; i++) {
2072 if (pev->args[i].name) {
2073 tev->args[i].name = strdup(pev->args[i].name);
2074 if (tev->args[i].name == NULL) {
2075 ret = -ENOMEM;
2076 goto error;
2079 tev->args[i].value = strdup(pev->args[i].var);
2080 if (tev->args[i].value == NULL) {
2081 ret = -ENOMEM;
2082 goto error;
2084 if (pev->args[i].type) {
2085 tev->args[i].type = strdup(pev->args[i].type);
2086 if (tev->args[i].type == NULL) {
2087 ret = -ENOMEM;
2088 goto error;
2094 if (pev->uprobes)
2095 return 1;
2097 /* Currently just checking function name from symbol map */
2098 sym = __find_kernel_function_by_name(tev->point.symbol, NULL);
2099 if (!sym) {
2100 pr_warning("Kernel symbol \'%s\' not found.\n",
2101 tev->point.symbol);
2102 ret = -ENOENT;
2103 goto error;
2104 } else if (tev->point.offset > sym->end - sym->start) {
2105 pr_warning("Offset specified is greater than size of %s\n",
2106 tev->point.symbol);
2107 ret = -ENOENT;
2108 goto error;
2112 return 1;
2113 error:
2114 clear_probe_trace_event(tev);
2115 free(tev);
2116 *tevs = NULL;
2117 return ret;
2120 struct __event_package {
2121 struct perf_probe_event *pev;
2122 struct probe_trace_event *tevs;
2123 int ntevs;
2126 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
2127 int max_tevs, const char *target, bool force_add)
2129 int i, j, ret;
2130 struct __event_package *pkgs;
2132 ret = 0;
2133 pkgs = zalloc(sizeof(struct __event_package) * npevs);
2135 if (pkgs == NULL)
2136 return -ENOMEM;
2138 if (!pevs->uprobes)
2139 /* Init vmlinux path */
2140 ret = init_vmlinux();
2141 else
2142 ret = init_user_exec();
2144 if (ret < 0) {
2145 free(pkgs);
2146 return ret;
2149 /* Loop 1: convert all events */
2150 for (i = 0; i < npevs; i++) {
2151 pkgs[i].pev = &pevs[i];
2152 /* Convert with or without debuginfo */
2153 ret = convert_to_probe_trace_events(pkgs[i].pev,
2154 &pkgs[i].tevs,
2155 max_tevs,
2156 target);
2157 if (ret < 0)
2158 goto end;
2159 pkgs[i].ntevs = ret;
2162 /* Loop 2: add all events */
2163 for (i = 0; i < npevs; i++) {
2164 ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
2165 pkgs[i].ntevs, force_add);
2166 if (ret < 0)
2167 break;
2169 end:
2170 /* Loop 3: cleanup and free trace events */
2171 for (i = 0; i < npevs; i++) {
2172 for (j = 0; j < pkgs[i].ntevs; j++)
2173 clear_probe_trace_event(&pkgs[i].tevs[j]);
2174 zfree(&pkgs[i].tevs);
2176 free(pkgs);
2178 return ret;
2181 static int __del_trace_probe_event(int fd, struct str_node *ent)
2183 char *p;
2184 char buf[128];
2185 int ret;
2187 /* Convert from perf-probe event to trace-probe event */
2188 ret = e_snprintf(buf, 128, "-:%s", ent->s);
2189 if (ret < 0)
2190 goto error;
2192 p = strchr(buf + 2, ':');
2193 if (!p) {
2194 pr_debug("Internal error: %s should have ':' but not.\n",
2195 ent->s);
2196 ret = -ENOTSUP;
2197 goto error;
2199 *p = '/';
2201 pr_debug("Writing event: %s\n", buf);
2202 ret = write(fd, buf, strlen(buf));
2203 if (ret < 0) {
2204 ret = -errno;
2205 goto error;
2208 printf("Removed event: %s\n", ent->s);
2209 return 0;
2210 error:
2211 pr_warning("Failed to delete event: %s\n", strerror(-ret));
2212 return ret;
2215 static int del_trace_probe_event(int fd, const char *buf,
2216 struct strlist *namelist)
2218 struct str_node *ent, *n;
2219 int ret = -1;
2221 if (strpbrk(buf, "*?")) { /* Glob-exp */
2222 strlist__for_each_safe(ent, n, namelist)
2223 if (strglobmatch(ent->s, buf)) {
2224 ret = __del_trace_probe_event(fd, ent);
2225 if (ret < 0)
2226 break;
2227 strlist__remove(namelist, ent);
2229 } else {
2230 ent = strlist__find(namelist, buf);
2231 if (ent) {
2232 ret = __del_trace_probe_event(fd, ent);
2233 if (ret >= 0)
2234 strlist__remove(namelist, ent);
2238 return ret;
2241 int del_perf_probe_events(struct strlist *dellist)
2243 int ret = -1, ufd = -1, kfd = -1;
2244 char buf[128];
2245 const char *group, *event;
2246 char *p, *str;
2247 struct str_node *ent;
2248 struct strlist *namelist = NULL, *unamelist = NULL;
2250 /* Get current event names */
2251 kfd = open_kprobe_events(true);
2252 if (kfd < 0)
2253 return kfd;
2255 namelist = get_probe_trace_event_names(kfd, true);
2256 ufd = open_uprobe_events(true);
2258 if (ufd >= 0)
2259 unamelist = get_probe_trace_event_names(ufd, true);
2261 if (namelist == NULL && unamelist == NULL)
2262 goto error;
2264 strlist__for_each(ent, dellist) {
2265 str = strdup(ent->s);
2266 if (str == NULL) {
2267 ret = -ENOMEM;
2268 goto error;
2270 pr_debug("Parsing: %s\n", str);
2271 p = strchr(str, ':');
2272 if (p) {
2273 group = str;
2274 *p = '\0';
2275 event = p + 1;
2276 } else {
2277 group = "*";
2278 event = str;
2281 ret = e_snprintf(buf, 128, "%s:%s", group, event);
2282 if (ret < 0) {
2283 pr_err("Failed to copy event.");
2284 free(str);
2285 goto error;
2288 pr_debug("Group: %s, Event: %s\n", group, event);
2290 if (namelist)
2291 ret = del_trace_probe_event(kfd, buf, namelist);
2293 if (unamelist && ret != 0)
2294 ret = del_trace_probe_event(ufd, buf, unamelist);
2296 if (ret != 0)
2297 pr_info("Info: Event \"%s\" does not exist.\n", buf);
2299 free(str);
2302 error:
2303 if (kfd >= 0) {
2304 strlist__delete(namelist);
2305 close(kfd);
2308 if (ufd >= 0) {
2309 strlist__delete(unamelist);
2310 close(ufd);
2313 return ret;
2316 /* TODO: don't use a global variable for filter ... */
2317 static struct strfilter *available_func_filter;
2320 * If a symbol corresponds to a function with global binding and
2321 * matches filter return 0. For all others return 1.
2323 static int filter_available_functions(struct map *map __maybe_unused,
2324 struct symbol *sym)
2326 if (sym->binding == STB_GLOBAL &&
2327 strfilter__compare(available_func_filter, sym->name))
2328 return 0;
2329 return 1;
2332 static int __show_available_funcs(struct map *map)
2334 if (map__load(map, filter_available_functions)) {
2335 pr_err("Failed to load map.\n");
2336 return -EINVAL;
2338 if (!dso__sorted_by_name(map->dso, map->type))
2339 dso__sort_by_name(map->dso, map->type);
2341 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2342 return 0;
2345 static int available_kernel_funcs(const char *module)
2347 struct map *map;
2348 int ret;
2350 ret = init_vmlinux();
2351 if (ret < 0)
2352 return ret;
2354 map = kernel_get_module_map(module);
2355 if (!map) {
2356 pr_err("Failed to find %s map.\n", (module) ? : "kernel");
2357 return -EINVAL;
2359 return __show_available_funcs(map);
2362 static int available_user_funcs(const char *target)
2364 struct map *map;
2365 int ret;
2367 ret = init_user_exec();
2368 if (ret < 0)
2369 return ret;
2371 map = dso__new_map(target);
2372 ret = __show_available_funcs(map);
2373 dso__delete(map->dso);
2374 map__delete(map);
2375 return ret;
2378 int show_available_funcs(const char *target, struct strfilter *_filter,
2379 bool user)
2381 setup_pager();
2382 available_func_filter = _filter;
2384 if (!user)
2385 return available_kernel_funcs(target);
2387 return available_user_funcs(target);
2391 * uprobe_events only accepts address:
2392 * Convert function and any offset to address
2394 static int convert_name_to_addr(struct perf_probe_event *pev, const char *exec)
2396 struct perf_probe_point *pp = &pev->point;
2397 struct symbol *sym;
2398 struct map *map = NULL;
2399 char *function = NULL;
2400 int ret = -EINVAL;
2401 unsigned long long vaddr = 0;
2403 if (!pp->function) {
2404 pr_warning("No function specified for uprobes");
2405 goto out;
2408 function = strdup(pp->function);
2409 if (!function) {
2410 pr_warning("Failed to allocate memory by strdup.\n");
2411 ret = -ENOMEM;
2412 goto out;
2415 map = dso__new_map(exec);
2416 if (!map) {
2417 pr_warning("Cannot find appropriate DSO for %s.\n", exec);
2418 goto out;
2420 available_func_filter = strfilter__new(function, NULL);
2421 if (map__load(map, filter_available_functions)) {
2422 pr_err("Failed to load map.\n");
2423 goto out;
2426 sym = map__find_symbol_by_name(map, function, NULL);
2427 if (!sym) {
2428 pr_warning("Cannot find %s in DSO %s\n", function, exec);
2429 goto out;
2432 if (map->start > sym->start)
2433 vaddr = map->start;
2434 vaddr += sym->start + pp->offset + map->pgoff;
2435 pp->offset = 0;
2437 if (!pev->event) {
2438 pev->event = function;
2439 function = NULL;
2441 if (!pev->group) {
2442 char *ptr1, *ptr2, *exec_copy;
2444 pev->group = zalloc(sizeof(char *) * 64);
2445 exec_copy = strdup(exec);
2446 if (!exec_copy) {
2447 ret = -ENOMEM;
2448 pr_warning("Failed to copy exec string.\n");
2449 goto out;
2452 ptr1 = strdup(basename(exec_copy));
2453 if (ptr1) {
2454 ptr2 = strpbrk(ptr1, "-._");
2455 if (ptr2)
2456 *ptr2 = '\0';
2457 e_snprintf(pev->group, 64, "%s_%s", PERFPROBE_GROUP,
2458 ptr1);
2459 free(ptr1);
2461 free(exec_copy);
2463 free(pp->function);
2464 pp->function = zalloc(sizeof(char *) * MAX_PROBE_ARGS);
2465 if (!pp->function) {
2466 ret = -ENOMEM;
2467 pr_warning("Failed to allocate memory by zalloc.\n");
2468 goto out;
2470 e_snprintf(pp->function, MAX_PROBE_ARGS, "0x%llx", vaddr);
2471 ret = 0;
2473 out:
2474 if (map) {
2475 dso__delete(map->dso);
2476 map__delete(map);
2478 if (function)
2479 free(function);
2480 return ret;