Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[cris-mirror.git] / tools / perf / util / probe-event.c
blobe1dbc9821617025c04086bae0cfdeaf3f3a7f025
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 <inttypes.h>
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>
36 #include "util.h"
37 #include "event.h"
38 #include "strlist.h"
39 #include "strfilter.h"
40 #include "debug.h"
41 #include "cache.h"
42 #include "color.h"
43 #include "symbol.h"
44 #include "thread.h"
45 #include <api/fs/fs.h>
46 #include "trace-event.h" /* For __maybe_unused */
47 #include "probe-event.h"
48 #include "probe-finder.h"
49 #include "probe-file.h"
50 #include "session.h"
51 #include "string2.h"
53 #include "sane_ctype.h"
55 #define PERFPROBE_GROUP "probe"
57 bool probe_event_dry_run; /* Dry run flag */
58 struct probe_conf probe_conf;
60 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
62 int e_snprintf(char *str, size_t size, const char *format, ...)
64 int ret;
65 va_list ap;
66 va_start(ap, format);
67 ret = vsnprintf(str, size, format, ap);
68 va_end(ap);
69 if (ret >= (int)size)
70 ret = -E2BIG;
71 return ret;
74 static struct machine *host_machine;
76 /* Initialize symbol maps and path of vmlinux/modules */
77 int init_probe_symbol_maps(bool user_only)
79 int ret;
81 symbol_conf.sort_by_name = true;
82 symbol_conf.allow_aliases = true;
83 ret = symbol__init(NULL);
84 if (ret < 0) {
85 pr_debug("Failed to init symbol map.\n");
86 goto out;
89 if (host_machine || user_only) /* already initialized */
90 return 0;
92 if (symbol_conf.vmlinux_name)
93 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
95 host_machine = machine__new_host();
96 if (!host_machine) {
97 pr_debug("machine__new_host() failed.\n");
98 symbol__exit();
99 ret = -1;
101 out:
102 if (ret < 0)
103 pr_warning("Failed to init vmlinux path.\n");
104 return ret;
107 void exit_probe_symbol_maps(void)
109 machine__delete(host_machine);
110 host_machine = NULL;
111 symbol__exit();
114 static struct symbol *__find_kernel_function_by_name(const char *name,
115 struct map **mapp)
117 return machine__find_kernel_function_by_name(host_machine, name, mapp);
120 static struct symbol *__find_kernel_function(u64 addr, struct map **mapp)
122 return machine__find_kernel_function(host_machine, addr, mapp);
125 static struct ref_reloc_sym *kernel_get_ref_reloc_sym(void)
127 /* kmap->ref_reloc_sym should be set if host_machine is initialized */
128 struct kmap *kmap;
129 struct map *map = machine__kernel_map(host_machine);
131 if (map__load(map) < 0)
132 return NULL;
134 kmap = map__kmap(map);
135 if (!kmap)
136 return NULL;
137 return kmap->ref_reloc_sym;
140 static int kernel_get_symbol_address_by_name(const char *name, u64 *addr,
141 bool reloc, bool reladdr)
143 struct ref_reloc_sym *reloc_sym;
144 struct symbol *sym;
145 struct map *map;
147 /* ref_reloc_sym is just a label. Need a special fix*/
148 reloc_sym = kernel_get_ref_reloc_sym();
149 if (reloc_sym && strcmp(name, reloc_sym->name) == 0)
150 *addr = (reloc) ? reloc_sym->addr : reloc_sym->unrelocated_addr;
151 else {
152 sym = __find_kernel_function_by_name(name, &map);
153 if (!sym)
154 return -ENOENT;
155 *addr = map->unmap_ip(map, sym->start) -
156 ((reloc) ? 0 : map->reloc) -
157 ((reladdr) ? map->start : 0);
159 return 0;
162 static struct map *kernel_get_module_map(const char *module)
164 struct map_groups *grp = &host_machine->kmaps;
165 struct maps *maps = &grp->maps[MAP__FUNCTION];
166 struct map *pos;
168 /* A file path -- this is an offline module */
169 if (module && strchr(module, '/'))
170 return dso__new_map(module);
172 if (!module)
173 module = "kernel";
175 for (pos = maps__first(maps); pos; pos = map__next(pos)) {
176 /* short_name is "[module]" */
177 if (strncmp(pos->dso->short_name + 1, module,
178 pos->dso->short_name_len - 2) == 0 &&
179 module[pos->dso->short_name_len - 2] == '\0') {
180 map__get(pos);
181 return pos;
184 return NULL;
187 struct map *get_target_map(const char *target, struct nsinfo *nsi, bool user)
189 /* Init maps of given executable or kernel */
190 if (user) {
191 struct map *map;
193 map = dso__new_map(target);
194 if (map && map->dso)
195 map->dso->nsinfo = nsinfo__get(nsi);
196 return map;
197 } else {
198 return kernel_get_module_map(target);
202 static int convert_exec_to_group(const char *exec, char **result)
204 char *ptr1, *ptr2, *exec_copy;
205 char buf[64];
206 int ret;
208 exec_copy = strdup(exec);
209 if (!exec_copy)
210 return -ENOMEM;
212 ptr1 = basename(exec_copy);
213 if (!ptr1) {
214 ret = -EINVAL;
215 goto out;
218 for (ptr2 = ptr1; *ptr2 != '\0'; ptr2++) {
219 if (!isalnum(*ptr2) && *ptr2 != '_') {
220 *ptr2 = '\0';
221 break;
225 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
226 if (ret < 0)
227 goto out;
229 *result = strdup(buf);
230 ret = *result ? 0 : -ENOMEM;
232 out:
233 free(exec_copy);
234 return ret;
237 static void clear_perf_probe_point(struct perf_probe_point *pp)
239 free(pp->file);
240 free(pp->function);
241 free(pp->lazy_line);
244 static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
246 int i;
248 for (i = 0; i < ntevs; i++)
249 clear_probe_trace_event(tevs + i);
252 static bool kprobe_blacklist__listed(unsigned long address);
253 static bool kprobe_warn_out_range(const char *symbol, unsigned long address)
255 u64 etext_addr = 0;
256 int ret;
258 /* Get the address of _etext for checking non-probable text symbol */
259 ret = kernel_get_symbol_address_by_name("_etext", &etext_addr,
260 false, false);
262 if (ret == 0 && etext_addr < address)
263 pr_warning("%s is out of .text, skip it.\n", symbol);
264 else if (kprobe_blacklist__listed(address))
265 pr_warning("%s is blacklisted function, skip it.\n", symbol);
266 else
267 return false;
269 return true;
273 * @module can be module name of module file path. In case of path,
274 * inspect elf and find out what is actual module name.
275 * Caller has to free mod_name after using it.
277 static char *find_module_name(const char *module)
279 int fd;
280 Elf *elf;
281 GElf_Ehdr ehdr;
282 GElf_Shdr shdr;
283 Elf_Data *data;
284 Elf_Scn *sec;
285 char *mod_name = NULL;
286 int name_offset;
288 fd = open(module, O_RDONLY);
289 if (fd < 0)
290 return NULL;
292 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
293 if (elf == NULL)
294 goto elf_err;
296 if (gelf_getehdr(elf, &ehdr) == NULL)
297 goto ret_err;
299 sec = elf_section_by_name(elf, &ehdr, &shdr,
300 ".gnu.linkonce.this_module", NULL);
301 if (!sec)
302 goto ret_err;
304 data = elf_getdata(sec, NULL);
305 if (!data || !data->d_buf)
306 goto ret_err;
309 * NOTE:
310 * '.gnu.linkonce.this_module' section of kernel module elf directly
311 * maps to 'struct module' from linux/module.h. This section contains
312 * actual module name which will be used by kernel after loading it.
313 * But, we cannot use 'struct module' here since linux/module.h is not
314 * exposed to user-space. Offset of 'name' has remained same from long
315 * time, so hardcoding it here.
317 if (ehdr.e_ident[EI_CLASS] == ELFCLASS32)
318 name_offset = 12;
319 else /* expect ELFCLASS64 by default */
320 name_offset = 24;
322 mod_name = strdup((char *)data->d_buf + name_offset);
324 ret_err:
325 elf_end(elf);
326 elf_err:
327 close(fd);
328 return mod_name;
331 #ifdef HAVE_DWARF_SUPPORT
333 static int kernel_get_module_dso(const char *module, struct dso **pdso)
335 struct dso *dso;
336 struct map *map;
337 const char *vmlinux_name;
338 int ret = 0;
340 if (module) {
341 char module_name[128];
343 snprintf(module_name, sizeof(module_name), "[%s]", module);
344 map = map_groups__find_by_name(&host_machine->kmaps, MAP__FUNCTION, module_name);
345 if (map) {
346 dso = map->dso;
347 goto found;
349 pr_debug("Failed to find module %s.\n", module);
350 return -ENOENT;
353 map = machine__kernel_map(host_machine);
354 dso = map->dso;
356 vmlinux_name = symbol_conf.vmlinux_name;
357 dso->load_errno = 0;
358 if (vmlinux_name)
359 ret = dso__load_vmlinux(dso, map, vmlinux_name, false);
360 else
361 ret = dso__load_vmlinux_path(dso, map);
362 found:
363 *pdso = dso;
364 return ret;
368 * Some binaries like glibc have special symbols which are on the symbol
369 * table, but not in the debuginfo. If we can find the address of the
370 * symbol from map, we can translate the address back to the probe point.
372 static int find_alternative_probe_point(struct debuginfo *dinfo,
373 struct perf_probe_point *pp,
374 struct perf_probe_point *result,
375 const char *target, struct nsinfo *nsi,
376 bool uprobes)
378 struct map *map = NULL;
379 struct symbol *sym;
380 u64 address = 0;
381 int ret = -ENOENT;
383 /* This can work only for function-name based one */
384 if (!pp->function || pp->file)
385 return -ENOTSUP;
387 map = get_target_map(target, nsi, uprobes);
388 if (!map)
389 return -EINVAL;
391 /* Find the address of given function */
392 map__for_each_symbol_by_name(map, pp->function, sym) {
393 if (uprobes)
394 address = sym->start;
395 else
396 address = map->unmap_ip(map, sym->start) - map->reloc;
397 break;
399 if (!address) {
400 ret = -ENOENT;
401 goto out;
403 pr_debug("Symbol %s address found : %" PRIx64 "\n",
404 pp->function, address);
406 ret = debuginfo__find_probe_point(dinfo, (unsigned long)address,
407 result);
408 if (ret <= 0)
409 ret = (!ret) ? -ENOENT : ret;
410 else {
411 result->offset += pp->offset;
412 result->line += pp->line;
413 result->retprobe = pp->retprobe;
414 ret = 0;
417 out:
418 map__put(map);
419 return ret;
423 static int get_alternative_probe_event(struct debuginfo *dinfo,
424 struct perf_probe_event *pev,
425 struct perf_probe_point *tmp)
427 int ret;
429 memcpy(tmp, &pev->point, sizeof(*tmp));
430 memset(&pev->point, 0, sizeof(pev->point));
431 ret = find_alternative_probe_point(dinfo, tmp, &pev->point, pev->target,
432 pev->nsi, pev->uprobes);
433 if (ret < 0)
434 memcpy(&pev->point, tmp, sizeof(*tmp));
436 return ret;
439 static int get_alternative_line_range(struct debuginfo *dinfo,
440 struct line_range *lr,
441 const char *target, bool user)
443 struct perf_probe_point pp = { .function = lr->function,
444 .file = lr->file,
445 .line = lr->start };
446 struct perf_probe_point result;
447 int ret, len = 0;
449 memset(&result, 0, sizeof(result));
451 if (lr->end != INT_MAX)
452 len = lr->end - lr->start;
453 ret = find_alternative_probe_point(dinfo, &pp, &result,
454 target, NULL, user);
455 if (!ret) {
456 lr->function = result.function;
457 lr->file = result.file;
458 lr->start = result.line;
459 if (lr->end != INT_MAX)
460 lr->end = lr->start + len;
461 clear_perf_probe_point(&pp);
463 return ret;
466 /* Open new debuginfo of given module */
467 static struct debuginfo *open_debuginfo(const char *module, struct nsinfo *nsi,
468 bool silent)
470 const char *path = module;
471 char reason[STRERR_BUFSIZE];
472 struct debuginfo *ret = NULL;
473 struct dso *dso = NULL;
474 struct nscookie nsc;
475 int err;
477 if (!module || !strchr(module, '/')) {
478 err = kernel_get_module_dso(module, &dso);
479 if (err < 0) {
480 if (!dso || dso->load_errno == 0) {
481 if (!str_error_r(-err, reason, STRERR_BUFSIZE))
482 strcpy(reason, "(unknown)");
483 } else
484 dso__strerror_load(dso, reason, STRERR_BUFSIZE);
485 if (!silent)
486 pr_err("Failed to find the path for %s: %s\n",
487 module ?: "kernel", reason);
488 return NULL;
490 path = dso->long_name;
492 nsinfo__mountns_enter(nsi, &nsc);
493 ret = debuginfo__new(path);
494 if (!ret && !silent) {
495 pr_warning("The %s file has no debug information.\n", path);
496 if (!module || !strtailcmp(path, ".ko"))
497 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
498 else
499 pr_warning("Rebuild with -g, ");
500 pr_warning("or install an appropriate debuginfo package.\n");
502 nsinfo__mountns_exit(&nsc);
503 return ret;
506 /* For caching the last debuginfo */
507 static struct debuginfo *debuginfo_cache;
508 static char *debuginfo_cache_path;
510 static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
512 const char *path = module;
514 /* If the module is NULL, it should be the kernel. */
515 if (!module)
516 path = "kernel";
518 if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path))
519 goto out;
521 /* Copy module path */
522 free(debuginfo_cache_path);
523 debuginfo_cache_path = strdup(path);
524 if (!debuginfo_cache_path) {
525 debuginfo__delete(debuginfo_cache);
526 debuginfo_cache = NULL;
527 goto out;
530 debuginfo_cache = open_debuginfo(module, NULL, silent);
531 if (!debuginfo_cache)
532 zfree(&debuginfo_cache_path);
533 out:
534 return debuginfo_cache;
537 static void debuginfo_cache__exit(void)
539 debuginfo__delete(debuginfo_cache);
540 debuginfo_cache = NULL;
541 zfree(&debuginfo_cache_path);
545 static int get_text_start_address(const char *exec, unsigned long *address,
546 struct nsinfo *nsi)
548 Elf *elf;
549 GElf_Ehdr ehdr;
550 GElf_Shdr shdr;
551 int fd, ret = -ENOENT;
552 struct nscookie nsc;
554 nsinfo__mountns_enter(nsi, &nsc);
555 fd = open(exec, O_RDONLY);
556 nsinfo__mountns_exit(&nsc);
557 if (fd < 0)
558 return -errno;
560 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
561 if (elf == NULL) {
562 ret = -EINVAL;
563 goto out_close;
566 if (gelf_getehdr(elf, &ehdr) == NULL)
567 goto out;
569 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
570 goto out;
572 *address = shdr.sh_addr - shdr.sh_offset;
573 ret = 0;
574 out:
575 elf_end(elf);
576 out_close:
577 close(fd);
579 return ret;
583 * Convert trace point to probe point with debuginfo
585 static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
586 struct perf_probe_point *pp,
587 bool is_kprobe)
589 struct debuginfo *dinfo = NULL;
590 unsigned long stext = 0;
591 u64 addr = tp->address;
592 int ret = -ENOENT;
594 /* convert the address to dwarf address */
595 if (!is_kprobe) {
596 if (!addr) {
597 ret = -EINVAL;
598 goto error;
600 ret = get_text_start_address(tp->module, &stext, NULL);
601 if (ret < 0)
602 goto error;
603 addr += stext;
604 } else if (tp->symbol) {
605 /* If the module is given, this returns relative address */
606 ret = kernel_get_symbol_address_by_name(tp->symbol, &addr,
607 false, !!tp->module);
608 if (ret != 0)
609 goto error;
610 addr += tp->offset;
613 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
614 tp->module ? : "kernel");
616 dinfo = debuginfo_cache__open(tp->module, verbose <= 0);
617 if (dinfo)
618 ret = debuginfo__find_probe_point(dinfo,
619 (unsigned long)addr, pp);
620 else
621 ret = -ENOENT;
623 if (ret > 0) {
624 pp->retprobe = tp->retprobe;
625 return 0;
627 error:
628 pr_debug("Failed to find corresponding probes from debuginfo.\n");
629 return ret ? : -ENOENT;
632 /* Adjust symbol name and address */
633 static int post_process_probe_trace_point(struct probe_trace_point *tp,
634 struct map *map, unsigned long offs)
636 struct symbol *sym;
637 u64 addr = tp->address - offs;
639 sym = map__find_symbol(map, addr);
640 if (!sym)
641 return -ENOENT;
643 if (strcmp(sym->name, tp->symbol)) {
644 /* If we have no realname, use symbol for it */
645 if (!tp->realname)
646 tp->realname = tp->symbol;
647 else
648 free(tp->symbol);
649 tp->symbol = strdup(sym->name);
650 if (!tp->symbol)
651 return -ENOMEM;
653 tp->offset = addr - sym->start;
654 tp->address -= offs;
656 return 0;
660 * Rename DWARF symbols to ELF symbols -- gcc sometimes optimizes functions
661 * and generate new symbols with suffixes such as .constprop.N or .isra.N
662 * etc. Since those symbols are not recorded in DWARF, we have to find
663 * correct generated symbols from offline ELF binary.
664 * For online kernel or uprobes we don't need this because those are
665 * rebased on _text, or already a section relative address.
667 static int
668 post_process_offline_probe_trace_events(struct probe_trace_event *tevs,
669 int ntevs, const char *pathname)
671 struct map *map;
672 unsigned long stext = 0;
673 int i, ret = 0;
675 /* Prepare a map for offline binary */
676 map = dso__new_map(pathname);
677 if (!map || get_text_start_address(pathname, &stext, NULL) < 0) {
678 pr_warning("Failed to get ELF symbols for %s\n", pathname);
679 return -EINVAL;
682 for (i = 0; i < ntevs; i++) {
683 ret = post_process_probe_trace_point(&tevs[i].point,
684 map, stext);
685 if (ret < 0)
686 break;
688 map__put(map);
690 return ret;
693 static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
694 int ntevs, const char *exec,
695 struct nsinfo *nsi)
697 int i, ret = 0;
698 unsigned long stext = 0;
700 if (!exec)
701 return 0;
703 ret = get_text_start_address(exec, &stext, nsi);
704 if (ret < 0)
705 return ret;
707 for (i = 0; i < ntevs && ret >= 0; i++) {
708 /* point.address is the addres of point.symbol + point.offset */
709 tevs[i].point.address -= stext;
710 tevs[i].point.module = strdup(exec);
711 if (!tevs[i].point.module) {
712 ret = -ENOMEM;
713 break;
715 tevs[i].uprobes = true;
718 return ret;
721 static int
722 post_process_module_probe_trace_events(struct probe_trace_event *tevs,
723 int ntevs, const char *module,
724 struct debuginfo *dinfo)
726 Dwarf_Addr text_offs = 0;
727 int i, ret = 0;
728 char *mod_name = NULL;
729 struct map *map;
731 if (!module)
732 return 0;
734 map = get_target_map(module, NULL, false);
735 if (!map || debuginfo__get_text_offset(dinfo, &text_offs, true) < 0) {
736 pr_warning("Failed to get ELF symbols for %s\n", module);
737 return -EINVAL;
740 mod_name = find_module_name(module);
741 for (i = 0; i < ntevs; i++) {
742 ret = post_process_probe_trace_point(&tevs[i].point,
743 map, (unsigned long)text_offs);
744 if (ret < 0)
745 break;
746 tevs[i].point.module =
747 strdup(mod_name ? mod_name : module);
748 if (!tevs[i].point.module) {
749 ret = -ENOMEM;
750 break;
754 free(mod_name);
755 map__put(map);
757 return ret;
760 static int
761 post_process_kernel_probe_trace_events(struct probe_trace_event *tevs,
762 int ntevs)
764 struct ref_reloc_sym *reloc_sym;
765 char *tmp;
766 int i, skipped = 0;
768 /* Skip post process if the target is an offline kernel */
769 if (symbol_conf.ignore_vmlinux_buildid)
770 return post_process_offline_probe_trace_events(tevs, ntevs,
771 symbol_conf.vmlinux_name);
773 reloc_sym = kernel_get_ref_reloc_sym();
774 if (!reloc_sym) {
775 pr_warning("Relocated base symbol is not found!\n");
776 return -EINVAL;
779 for (i = 0; i < ntevs; i++) {
780 if (!tevs[i].point.address)
781 continue;
782 if (tevs[i].point.retprobe && !kretprobe_offset_is_supported())
783 continue;
784 /* If we found a wrong one, mark it by NULL symbol */
785 if (kprobe_warn_out_range(tevs[i].point.symbol,
786 tevs[i].point.address)) {
787 tmp = NULL;
788 skipped++;
789 } else {
790 tmp = strdup(reloc_sym->name);
791 if (!tmp)
792 return -ENOMEM;
794 /* If we have no realname, use symbol for it */
795 if (!tevs[i].point.realname)
796 tevs[i].point.realname = tevs[i].point.symbol;
797 else
798 free(tevs[i].point.symbol);
799 tevs[i].point.symbol = tmp;
800 tevs[i].point.offset = tevs[i].point.address -
801 reloc_sym->unrelocated_addr;
803 return skipped;
806 void __weak
807 arch__post_process_probe_trace_events(struct perf_probe_event *pev __maybe_unused,
808 int ntevs __maybe_unused)
812 /* Post processing the probe events */
813 static int post_process_probe_trace_events(struct perf_probe_event *pev,
814 struct probe_trace_event *tevs,
815 int ntevs, const char *module,
816 bool uprobe, struct debuginfo *dinfo)
818 int ret;
820 if (uprobe)
821 ret = add_exec_to_probe_trace_events(tevs, ntevs, module,
822 pev->nsi);
823 else if (module)
824 /* Currently ref_reloc_sym based probe is not for drivers */
825 ret = post_process_module_probe_trace_events(tevs, ntevs,
826 module, dinfo);
827 else
828 ret = post_process_kernel_probe_trace_events(tevs, ntevs);
830 if (ret >= 0)
831 arch__post_process_probe_trace_events(pev, ntevs);
833 return ret;
836 /* Try to find perf_probe_event with debuginfo */
837 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
838 struct probe_trace_event **tevs)
840 bool need_dwarf = perf_probe_event_need_dwarf(pev);
841 struct perf_probe_point tmp;
842 struct debuginfo *dinfo;
843 int ntevs, ret = 0;
845 dinfo = open_debuginfo(pev->target, pev->nsi, !need_dwarf);
846 if (!dinfo) {
847 if (need_dwarf)
848 return -ENOENT;
849 pr_debug("Could not open debuginfo. Try to use symbols.\n");
850 return 0;
853 pr_debug("Try to find probe point from debuginfo.\n");
854 /* Searching trace events corresponding to a probe event */
855 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
857 if (ntevs == 0) { /* Not found, retry with an alternative */
858 ret = get_alternative_probe_event(dinfo, pev, &tmp);
859 if (!ret) {
860 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
862 * Write back to the original probe_event for
863 * setting appropriate (user given) event name
865 clear_perf_probe_point(&pev->point);
866 memcpy(&pev->point, &tmp, sizeof(tmp));
870 if (ntevs > 0) { /* Succeeded to find trace events */
871 pr_debug("Found %d probe_trace_events.\n", ntevs);
872 ret = post_process_probe_trace_events(pev, *tevs, ntevs,
873 pev->target, pev->uprobes, dinfo);
874 if (ret < 0 || ret == ntevs) {
875 pr_debug("Post processing failed or all events are skipped. (%d)\n", ret);
876 clear_probe_trace_events(*tevs, ntevs);
877 zfree(tevs);
878 ntevs = 0;
882 debuginfo__delete(dinfo);
884 if (ntevs == 0) { /* No error but failed to find probe point. */
885 pr_warning("Probe point '%s' not found.\n",
886 synthesize_perf_probe_point(&pev->point));
887 return -ENOENT;
888 } else if (ntevs < 0) {
889 /* Error path : ntevs < 0 */
890 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
891 if (ntevs == -EBADF)
892 pr_warning("Warning: No dwarf info found in the vmlinux - "
893 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
894 if (!need_dwarf) {
895 pr_debug("Trying to use symbols.\n");
896 return 0;
899 return ntevs;
902 #define LINEBUF_SIZE 256
903 #define NR_ADDITIONAL_LINES 2
905 static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
907 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
908 const char *color = show_num ? "" : PERF_COLOR_BLUE;
909 const char *prefix = NULL;
911 do {
912 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
913 goto error;
914 if (skip)
915 continue;
916 if (!prefix) {
917 prefix = show_num ? "%7d " : " ";
918 color_fprintf(stdout, color, prefix, l);
920 color_fprintf(stdout, color, "%s", buf);
922 } while (strchr(buf, '\n') == NULL);
924 return 1;
925 error:
926 if (ferror(fp)) {
927 pr_warning("File read error: %s\n",
928 str_error_r(errno, sbuf, sizeof(sbuf)));
929 return -1;
931 return 0;
934 static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
936 int rv = __show_one_line(fp, l, skip, show_num);
937 if (rv == 0) {
938 pr_warning("Source file is shorter than expected.\n");
939 rv = -1;
941 return rv;
944 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
945 #define show_one_line(f,l) _show_one_line(f,l,false,false)
946 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
947 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
950 * Show line-range always requires debuginfo to find source file and
951 * line number.
953 static int __show_line_range(struct line_range *lr, const char *module,
954 bool user)
956 int l = 1;
957 struct int_node *ln;
958 struct debuginfo *dinfo;
959 FILE *fp;
960 int ret;
961 char *tmp;
962 char sbuf[STRERR_BUFSIZE];
964 /* Search a line range */
965 dinfo = open_debuginfo(module, NULL, false);
966 if (!dinfo)
967 return -ENOENT;
969 ret = debuginfo__find_line_range(dinfo, lr);
970 if (!ret) { /* Not found, retry with an alternative */
971 ret = get_alternative_line_range(dinfo, lr, module, user);
972 if (!ret)
973 ret = debuginfo__find_line_range(dinfo, lr);
975 debuginfo__delete(dinfo);
976 if (ret == 0 || ret == -ENOENT) {
977 pr_warning("Specified source line is not found.\n");
978 return -ENOENT;
979 } else if (ret < 0) {
980 pr_warning("Debuginfo analysis failed.\n");
981 return ret;
984 /* Convert source file path */
985 tmp = lr->path;
986 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
988 /* Free old path when new path is assigned */
989 if (tmp != lr->path)
990 free(tmp);
992 if (ret < 0) {
993 pr_warning("Failed to find source file path.\n");
994 return ret;
997 setup_pager();
999 if (lr->function)
1000 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
1001 lr->start - lr->offset);
1002 else
1003 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
1005 fp = fopen(lr->path, "r");
1006 if (fp == NULL) {
1007 pr_warning("Failed to open %s: %s\n", lr->path,
1008 str_error_r(errno, sbuf, sizeof(sbuf)));
1009 return -errno;
1011 /* Skip to starting line number */
1012 while (l < lr->start) {
1013 ret = skip_one_line(fp, l++);
1014 if (ret < 0)
1015 goto end;
1018 intlist__for_each_entry(ln, lr->line_list) {
1019 for (; ln->i > l; l++) {
1020 ret = show_one_line(fp, l - lr->offset);
1021 if (ret < 0)
1022 goto end;
1024 ret = show_one_line_with_num(fp, l++ - lr->offset);
1025 if (ret < 0)
1026 goto end;
1029 if (lr->end == INT_MAX)
1030 lr->end = l + NR_ADDITIONAL_LINES;
1031 while (l <= lr->end) {
1032 ret = show_one_line_or_eof(fp, l++ - lr->offset);
1033 if (ret <= 0)
1034 break;
1036 end:
1037 fclose(fp);
1038 return ret;
1041 int show_line_range(struct line_range *lr, const char *module,
1042 struct nsinfo *nsi, bool user)
1044 int ret;
1045 struct nscookie nsc;
1047 ret = init_probe_symbol_maps(user);
1048 if (ret < 0)
1049 return ret;
1050 nsinfo__mountns_enter(nsi, &nsc);
1051 ret = __show_line_range(lr, module, user);
1052 nsinfo__mountns_exit(&nsc);
1053 exit_probe_symbol_maps();
1055 return ret;
1058 static int show_available_vars_at(struct debuginfo *dinfo,
1059 struct perf_probe_event *pev,
1060 struct strfilter *_filter)
1062 char *buf;
1063 int ret, i, nvars;
1064 struct str_node *node;
1065 struct variable_list *vls = NULL, *vl;
1066 struct perf_probe_point tmp;
1067 const char *var;
1069 buf = synthesize_perf_probe_point(&pev->point);
1070 if (!buf)
1071 return -EINVAL;
1072 pr_debug("Searching variables at %s\n", buf);
1074 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
1075 if (!ret) { /* Not found, retry with an alternative */
1076 ret = get_alternative_probe_event(dinfo, pev, &tmp);
1077 if (!ret) {
1078 ret = debuginfo__find_available_vars_at(dinfo, pev,
1079 &vls);
1080 /* Release the old probe_point */
1081 clear_perf_probe_point(&tmp);
1084 if (ret <= 0) {
1085 if (ret == 0 || ret == -ENOENT) {
1086 pr_err("Failed to find the address of %s\n", buf);
1087 ret = -ENOENT;
1088 } else
1089 pr_warning("Debuginfo analysis failed.\n");
1090 goto end;
1093 /* Some variables are found */
1094 fprintf(stdout, "Available variables at %s\n", buf);
1095 for (i = 0; i < ret; i++) {
1096 vl = &vls[i];
1098 * A probe point might be converted to
1099 * several trace points.
1101 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
1102 vl->point.offset);
1103 zfree(&vl->point.symbol);
1104 nvars = 0;
1105 if (vl->vars) {
1106 strlist__for_each_entry(node, vl->vars) {
1107 var = strchr(node->s, '\t') + 1;
1108 if (strfilter__compare(_filter, var)) {
1109 fprintf(stdout, "\t\t%s\n", node->s);
1110 nvars++;
1113 strlist__delete(vl->vars);
1115 if (nvars == 0)
1116 fprintf(stdout, "\t\t(No matched variables)\n");
1118 free(vls);
1119 end:
1120 free(buf);
1121 return ret;
1124 /* Show available variables on given probe point */
1125 int show_available_vars(struct perf_probe_event *pevs, int npevs,
1126 struct strfilter *_filter)
1128 int i, ret = 0;
1129 struct debuginfo *dinfo;
1131 ret = init_probe_symbol_maps(pevs->uprobes);
1132 if (ret < 0)
1133 return ret;
1135 dinfo = open_debuginfo(pevs->target, pevs->nsi, false);
1136 if (!dinfo) {
1137 ret = -ENOENT;
1138 goto out;
1141 setup_pager();
1143 for (i = 0; i < npevs && ret >= 0; i++)
1144 ret = show_available_vars_at(dinfo, &pevs[i], _filter);
1146 debuginfo__delete(dinfo);
1147 out:
1148 exit_probe_symbol_maps();
1149 return ret;
1152 #else /* !HAVE_DWARF_SUPPORT */
1154 static void debuginfo_cache__exit(void)
1158 static int
1159 find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
1160 struct perf_probe_point *pp __maybe_unused,
1161 bool is_kprobe __maybe_unused)
1163 return -ENOSYS;
1166 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
1167 struct probe_trace_event **tevs __maybe_unused)
1169 if (perf_probe_event_need_dwarf(pev)) {
1170 pr_warning("Debuginfo-analysis is not supported.\n");
1171 return -ENOSYS;
1174 return 0;
1177 int show_line_range(struct line_range *lr __maybe_unused,
1178 const char *module __maybe_unused,
1179 struct nsinfo *nsi __maybe_unused,
1180 bool user __maybe_unused)
1182 pr_warning("Debuginfo-analysis is not supported.\n");
1183 return -ENOSYS;
1186 int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1187 int npevs __maybe_unused,
1188 struct strfilter *filter __maybe_unused)
1190 pr_warning("Debuginfo-analysis is not supported.\n");
1191 return -ENOSYS;
1193 #endif
1195 void line_range__clear(struct line_range *lr)
1197 free(lr->function);
1198 free(lr->file);
1199 free(lr->path);
1200 free(lr->comp_dir);
1201 intlist__delete(lr->line_list);
1202 memset(lr, 0, sizeof(*lr));
1205 int line_range__init(struct line_range *lr)
1207 memset(lr, 0, sizeof(*lr));
1208 lr->line_list = intlist__new(NULL);
1209 if (!lr->line_list)
1210 return -ENOMEM;
1211 else
1212 return 0;
1215 static int parse_line_num(char **ptr, int *val, const char *what)
1217 const char *start = *ptr;
1219 errno = 0;
1220 *val = strtol(*ptr, ptr, 0);
1221 if (errno || *ptr == start) {
1222 semantic_error("'%s' is not a valid number.\n", what);
1223 return -EINVAL;
1225 return 0;
1228 /* Check the name is good for event, group or function */
1229 static bool is_c_func_name(const char *name)
1231 if (!isalpha(*name) && *name != '_')
1232 return false;
1233 while (*++name != '\0') {
1234 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1235 return false;
1237 return true;
1241 * Stuff 'lr' according to the line range described by 'arg'.
1242 * The line range syntax is described by:
1244 * SRC[:SLN[+NUM|-ELN]]
1245 * FNC[@SRC][:SLN[+NUM|-ELN]]
1247 int parse_line_range_desc(const char *arg, struct line_range *lr)
1249 char *range, *file, *name = strdup(arg);
1250 int err;
1252 if (!name)
1253 return -ENOMEM;
1255 lr->start = 0;
1256 lr->end = INT_MAX;
1258 range = strchr(name, ':');
1259 if (range) {
1260 *range++ = '\0';
1262 err = parse_line_num(&range, &lr->start, "start line");
1263 if (err)
1264 goto err;
1266 if (*range == '+' || *range == '-') {
1267 const char c = *range++;
1269 err = parse_line_num(&range, &lr->end, "end line");
1270 if (err)
1271 goto err;
1273 if (c == '+') {
1274 lr->end += lr->start;
1276 * Adjust the number of lines here.
1277 * If the number of lines == 1, the
1278 * the end of line should be equal to
1279 * the start of line.
1281 lr->end--;
1285 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1287 err = -EINVAL;
1288 if (lr->start > lr->end) {
1289 semantic_error("Start line must be smaller"
1290 " than end line.\n");
1291 goto err;
1293 if (*range != '\0') {
1294 semantic_error("Tailing with invalid str '%s'.\n", range);
1295 goto err;
1299 file = strchr(name, '@');
1300 if (file) {
1301 *file = '\0';
1302 lr->file = strdup(++file);
1303 if (lr->file == NULL) {
1304 err = -ENOMEM;
1305 goto err;
1307 lr->function = name;
1308 } else if (strchr(name, '/') || strchr(name, '.'))
1309 lr->file = name;
1310 else if (is_c_func_name(name))/* We reuse it for checking funcname */
1311 lr->function = name;
1312 else { /* Invalid name */
1313 semantic_error("'%s' is not a valid function name.\n", name);
1314 err = -EINVAL;
1315 goto err;
1318 return 0;
1319 err:
1320 free(name);
1321 return err;
1324 static int parse_perf_probe_event_name(char **arg, struct perf_probe_event *pev)
1326 char *ptr;
1328 ptr = strpbrk_esc(*arg, ":");
1329 if (ptr) {
1330 *ptr = '\0';
1331 if (!pev->sdt && !is_c_func_name(*arg))
1332 goto ng_name;
1333 pev->group = strdup_esc(*arg);
1334 if (!pev->group)
1335 return -ENOMEM;
1336 *arg = ptr + 1;
1337 } else
1338 pev->group = NULL;
1340 pev->event = strdup_esc(*arg);
1341 if (pev->event == NULL)
1342 return -ENOMEM;
1344 if (!pev->sdt && !is_c_func_name(pev->event)) {
1345 zfree(&pev->event);
1346 ng_name:
1347 zfree(&pev->group);
1348 semantic_error("%s is bad for event name -it must "
1349 "follow C symbol-naming rule.\n", *arg);
1350 return -EINVAL;
1352 return 0;
1355 /* Parse probepoint definition. */
1356 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1358 struct perf_probe_point *pp = &pev->point;
1359 char *ptr, *tmp;
1360 char c, nc = 0;
1361 bool file_spec = false;
1362 int ret;
1365 * <Syntax>
1366 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN]
1367 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1368 * perf probe %[GRP:]SDT_EVENT
1370 if (!arg)
1371 return -EINVAL;
1373 if (is_sdt_event(arg)) {
1374 pev->sdt = true;
1375 if (arg[0] == '%')
1376 arg++;
1379 ptr = strpbrk_esc(arg, ";=@+%");
1380 if (pev->sdt) {
1381 if (ptr) {
1382 if (*ptr != '@') {
1383 semantic_error("%s must be an SDT name.\n",
1384 arg);
1385 return -EINVAL;
1387 /* This must be a target file name or build id */
1388 tmp = build_id_cache__complement(ptr + 1);
1389 if (tmp) {
1390 pev->target = build_id_cache__origname(tmp);
1391 free(tmp);
1392 } else
1393 pev->target = strdup_esc(ptr + 1);
1394 if (!pev->target)
1395 return -ENOMEM;
1396 *ptr = '\0';
1398 ret = parse_perf_probe_event_name(&arg, pev);
1399 if (ret == 0) {
1400 if (asprintf(&pev->point.function, "%%%s", pev->event) < 0)
1401 ret = -errno;
1403 return ret;
1406 if (ptr && *ptr == '=') { /* Event name */
1407 *ptr = '\0';
1408 tmp = ptr + 1;
1409 ret = parse_perf_probe_event_name(&arg, pev);
1410 if (ret < 0)
1411 return ret;
1413 arg = tmp;
1417 * Check arg is function or file name and copy it.
1419 * We consider arg to be a file spec if and only if it satisfies
1420 * all of the below criteria::
1421 * - it does not include any of "+@%",
1422 * - it includes one of ":;", and
1423 * - it has a period '.' in the name.
1425 * Otherwise, we consider arg to be a function specification.
1427 if (!strpbrk_esc(arg, "+@%")) {
1428 ptr = strpbrk_esc(arg, ";:");
1429 /* This is a file spec if it includes a '.' before ; or : */
1430 if (ptr && memchr(arg, '.', ptr - arg))
1431 file_spec = true;
1434 ptr = strpbrk_esc(arg, ";:+@%");
1435 if (ptr) {
1436 nc = *ptr;
1437 *ptr++ = '\0';
1440 if (arg[0] == '\0')
1441 tmp = NULL;
1442 else {
1443 tmp = strdup_esc(arg);
1444 if (tmp == NULL)
1445 return -ENOMEM;
1448 if (file_spec)
1449 pp->file = tmp;
1450 else {
1451 pp->function = tmp;
1454 * Keep pp->function even if this is absolute address,
1455 * so it can mark whether abs_address is valid.
1456 * Which make 'perf probe lib.bin 0x0' possible.
1458 * Note that checking length of tmp is not needed
1459 * because when we access tmp[1] we know tmp[0] is '0',
1460 * so tmp[1] should always valid (but could be '\0').
1462 if (tmp && !strncmp(tmp, "0x", 2)) {
1463 pp->abs_address = strtoul(pp->function, &tmp, 0);
1464 if (*tmp != '\0') {
1465 semantic_error("Invalid absolute address.\n");
1466 return -EINVAL;
1471 /* Parse other options */
1472 while (ptr) {
1473 arg = ptr;
1474 c = nc;
1475 if (c == ';') { /* Lazy pattern must be the last part */
1476 pp->lazy_line = strdup(arg); /* let leave escapes */
1477 if (pp->lazy_line == NULL)
1478 return -ENOMEM;
1479 break;
1481 ptr = strpbrk_esc(arg, ";:+@%");
1482 if (ptr) {
1483 nc = *ptr;
1484 *ptr++ = '\0';
1486 switch (c) {
1487 case ':': /* Line number */
1488 pp->line = strtoul(arg, &tmp, 0);
1489 if (*tmp != '\0') {
1490 semantic_error("There is non-digit char"
1491 " in line number.\n");
1492 return -EINVAL;
1494 break;
1495 case '+': /* Byte offset from a symbol */
1496 pp->offset = strtoul(arg, &tmp, 0);
1497 if (*tmp != '\0') {
1498 semantic_error("There is non-digit character"
1499 " in offset.\n");
1500 return -EINVAL;
1502 break;
1503 case '@': /* File name */
1504 if (pp->file) {
1505 semantic_error("SRC@SRC is not allowed.\n");
1506 return -EINVAL;
1508 pp->file = strdup_esc(arg);
1509 if (pp->file == NULL)
1510 return -ENOMEM;
1511 break;
1512 case '%': /* Probe places */
1513 if (strcmp(arg, "return") == 0) {
1514 pp->retprobe = 1;
1515 } else { /* Others not supported yet */
1516 semantic_error("%%%s is not supported.\n", arg);
1517 return -ENOTSUP;
1519 break;
1520 default: /* Buggy case */
1521 pr_err("This program has a bug at %s:%d.\n",
1522 __FILE__, __LINE__);
1523 return -ENOTSUP;
1524 break;
1528 /* Exclusion check */
1529 if (pp->lazy_line && pp->line) {
1530 semantic_error("Lazy pattern can't be used with"
1531 " line number.\n");
1532 return -EINVAL;
1535 if (pp->lazy_line && pp->offset) {
1536 semantic_error("Lazy pattern can't be used with offset.\n");
1537 return -EINVAL;
1540 if (pp->line && pp->offset) {
1541 semantic_error("Offset can't be used with line number.\n");
1542 return -EINVAL;
1545 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1546 semantic_error("File always requires line number or "
1547 "lazy pattern.\n");
1548 return -EINVAL;
1551 if (pp->offset && !pp->function) {
1552 semantic_error("Offset requires an entry function.\n");
1553 return -EINVAL;
1556 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1557 semantic_error("Offset/Line/Lazy pattern can't be used with "
1558 "return probe.\n");
1559 return -EINVAL;
1562 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1563 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1564 pp->lazy_line);
1565 return 0;
1568 /* Parse perf-probe event argument */
1569 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1571 char *tmp, *goodname;
1572 struct perf_probe_arg_field **fieldp;
1574 pr_debug("parsing arg: %s into ", str);
1576 tmp = strchr(str, '=');
1577 if (tmp) {
1578 arg->name = strndup(str, tmp - str);
1579 if (arg->name == NULL)
1580 return -ENOMEM;
1581 pr_debug("name:%s ", arg->name);
1582 str = tmp + 1;
1585 tmp = strchr(str, ':');
1586 if (tmp) { /* Type setting */
1587 *tmp = '\0';
1588 arg->type = strdup(tmp + 1);
1589 if (arg->type == NULL)
1590 return -ENOMEM;
1591 pr_debug("type:%s ", arg->type);
1594 tmp = strpbrk(str, "-.[");
1595 if (!is_c_varname(str) || !tmp) {
1596 /* A variable, register, symbol or special value */
1597 arg->var = strdup(str);
1598 if (arg->var == NULL)
1599 return -ENOMEM;
1600 pr_debug("%s\n", arg->var);
1601 return 0;
1604 /* Structure fields or array element */
1605 arg->var = strndup(str, tmp - str);
1606 if (arg->var == NULL)
1607 return -ENOMEM;
1608 goodname = arg->var;
1609 pr_debug("%s, ", arg->var);
1610 fieldp = &arg->field;
1612 do {
1613 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1614 if (*fieldp == NULL)
1615 return -ENOMEM;
1616 if (*tmp == '[') { /* Array */
1617 str = tmp;
1618 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1619 (*fieldp)->ref = true;
1620 if (*tmp != ']' || tmp == str + 1) {
1621 semantic_error("Array index must be a"
1622 " number.\n");
1623 return -EINVAL;
1625 tmp++;
1626 if (*tmp == '\0')
1627 tmp = NULL;
1628 } else { /* Structure */
1629 if (*tmp == '.') {
1630 str = tmp + 1;
1631 (*fieldp)->ref = false;
1632 } else if (tmp[1] == '>') {
1633 str = tmp + 2;
1634 (*fieldp)->ref = true;
1635 } else {
1636 semantic_error("Argument parse error: %s\n",
1637 str);
1638 return -EINVAL;
1640 tmp = strpbrk(str, "-.[");
1642 if (tmp) {
1643 (*fieldp)->name = strndup(str, tmp - str);
1644 if ((*fieldp)->name == NULL)
1645 return -ENOMEM;
1646 if (*str != '[')
1647 goodname = (*fieldp)->name;
1648 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1649 fieldp = &(*fieldp)->next;
1651 } while (tmp);
1652 (*fieldp)->name = strdup(str);
1653 if ((*fieldp)->name == NULL)
1654 return -ENOMEM;
1655 if (*str != '[')
1656 goodname = (*fieldp)->name;
1657 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1659 /* If no name is specified, set the last field name (not array index)*/
1660 if (!arg->name) {
1661 arg->name = strdup(goodname);
1662 if (arg->name == NULL)
1663 return -ENOMEM;
1665 return 0;
1668 /* Parse perf-probe event command */
1669 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1671 char **argv;
1672 int argc, i, ret = 0;
1674 argv = argv_split(cmd, &argc);
1675 if (!argv) {
1676 pr_debug("Failed to split arguments.\n");
1677 return -ENOMEM;
1679 if (argc - 1 > MAX_PROBE_ARGS) {
1680 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1681 ret = -ERANGE;
1682 goto out;
1684 /* Parse probe point */
1685 ret = parse_perf_probe_point(argv[0], pev);
1686 if (ret < 0)
1687 goto out;
1689 /* Copy arguments and ensure return probe has no C argument */
1690 pev->nargs = argc - 1;
1691 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1692 if (pev->args == NULL) {
1693 ret = -ENOMEM;
1694 goto out;
1696 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1697 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1698 if (ret >= 0 &&
1699 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1700 semantic_error("You can't specify local variable for"
1701 " kretprobe.\n");
1702 ret = -EINVAL;
1705 out:
1706 argv_free(argv);
1708 return ret;
1711 /* Returns true if *any* ARG is either C variable, $params or $vars. */
1712 bool perf_probe_with_var(struct perf_probe_event *pev)
1714 int i = 0;
1716 for (i = 0; i < pev->nargs; i++)
1717 if (is_c_varname(pev->args[i].var) ||
1718 !strcmp(pev->args[i].var, PROBE_ARG_PARAMS) ||
1719 !strcmp(pev->args[i].var, PROBE_ARG_VARS))
1720 return true;
1721 return false;
1724 /* Return true if this perf_probe_event requires debuginfo */
1725 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1727 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1728 return true;
1730 if (perf_probe_with_var(pev))
1731 return true;
1733 return false;
1736 /* Parse probe_events event into struct probe_point */
1737 int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1739 struct probe_trace_point *tp = &tev->point;
1740 char pr;
1741 char *p;
1742 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1743 int ret, i, argc;
1744 char **argv;
1746 pr_debug("Parsing probe_events: %s\n", cmd);
1747 argv = argv_split(cmd, &argc);
1748 if (!argv) {
1749 pr_debug("Failed to split arguments.\n");
1750 return -ENOMEM;
1752 if (argc < 2) {
1753 semantic_error("Too few probe arguments.\n");
1754 ret = -ERANGE;
1755 goto out;
1758 /* Scan event and group name. */
1759 argv0_str = strdup(argv[0]);
1760 if (argv0_str == NULL) {
1761 ret = -ENOMEM;
1762 goto out;
1764 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1765 fmt2_str = strtok_r(NULL, "/", &fmt);
1766 fmt3_str = strtok_r(NULL, " \t", &fmt);
1767 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
1768 || fmt3_str == NULL) {
1769 semantic_error("Failed to parse event name: %s\n", argv[0]);
1770 ret = -EINVAL;
1771 goto out;
1773 pr = fmt1_str[0];
1774 tev->group = strdup(fmt2_str);
1775 tev->event = strdup(fmt3_str);
1776 if (tev->group == NULL || tev->event == NULL) {
1777 ret = -ENOMEM;
1778 goto out;
1780 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1782 tp->retprobe = (pr == 'r');
1784 /* Scan module name(if there), function name and offset */
1785 p = strchr(argv[1], ':');
1786 if (p) {
1787 tp->module = strndup(argv[1], p - argv[1]);
1788 if (!tp->module) {
1789 ret = -ENOMEM;
1790 goto out;
1792 tev->uprobes = (tp->module[0] == '/');
1793 p++;
1794 } else
1795 p = argv[1];
1796 fmt1_str = strtok_r(p, "+", &fmt);
1797 /* only the address started with 0x */
1798 if (fmt1_str[0] == '0') {
1800 * Fix a special case:
1801 * if address == 0, kernel reports something like:
1802 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1803 * Newer kernel may fix that, but we want to
1804 * support old kernel also.
1806 if (strcmp(fmt1_str, "0x") == 0) {
1807 if (!argv[2] || strcmp(argv[2], "(null)")) {
1808 ret = -EINVAL;
1809 goto out;
1811 tp->address = 0;
1813 free(argv[2]);
1814 for (i = 2; argv[i + 1] != NULL; i++)
1815 argv[i] = argv[i + 1];
1817 argv[i] = NULL;
1818 argc -= 1;
1819 } else
1820 tp->address = strtoul(fmt1_str, NULL, 0);
1821 } else {
1822 /* Only the symbol-based probe has offset */
1823 tp->symbol = strdup(fmt1_str);
1824 if (tp->symbol == NULL) {
1825 ret = -ENOMEM;
1826 goto out;
1828 fmt2_str = strtok_r(NULL, "", &fmt);
1829 if (fmt2_str == NULL)
1830 tp->offset = 0;
1831 else
1832 tp->offset = strtoul(fmt2_str, NULL, 10);
1835 tev->nargs = argc - 2;
1836 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1837 if (tev->args == NULL) {
1838 ret = -ENOMEM;
1839 goto out;
1841 for (i = 0; i < tev->nargs; i++) {
1842 p = strchr(argv[i + 2], '=');
1843 if (p) /* We don't need which register is assigned. */
1844 *p++ = '\0';
1845 else
1846 p = argv[i + 2];
1847 tev->args[i].name = strdup(argv[i + 2]);
1848 /* TODO: parse regs and offset */
1849 tev->args[i].value = strdup(p);
1850 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1851 ret = -ENOMEM;
1852 goto out;
1855 ret = 0;
1856 out:
1857 free(argv0_str);
1858 argv_free(argv);
1859 return ret;
1862 /* Compose only probe arg */
1863 char *synthesize_perf_probe_arg(struct perf_probe_arg *pa)
1865 struct perf_probe_arg_field *field = pa->field;
1866 struct strbuf buf;
1867 char *ret = NULL;
1868 int err;
1870 if (strbuf_init(&buf, 64) < 0)
1871 return NULL;
1873 if (pa->name && pa->var)
1874 err = strbuf_addf(&buf, "%s=%s", pa->name, pa->var);
1875 else
1876 err = strbuf_addstr(&buf, pa->name ?: pa->var);
1877 if (err)
1878 goto out;
1880 while (field) {
1881 if (field->name[0] == '[')
1882 err = strbuf_addstr(&buf, field->name);
1883 else
1884 err = strbuf_addf(&buf, "%s%s", field->ref ? "->" : ".",
1885 field->name);
1886 field = field->next;
1887 if (err)
1888 goto out;
1891 if (pa->type)
1892 if (strbuf_addf(&buf, ":%s", pa->type) < 0)
1893 goto out;
1895 ret = strbuf_detach(&buf, NULL);
1896 out:
1897 strbuf_release(&buf);
1898 return ret;
1901 /* Compose only probe point (not argument) */
1902 char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1904 struct strbuf buf;
1905 char *tmp, *ret = NULL;
1906 int len, err = 0;
1908 if (strbuf_init(&buf, 64) < 0)
1909 return NULL;
1911 if (pp->function) {
1912 if (strbuf_addstr(&buf, pp->function) < 0)
1913 goto out;
1914 if (pp->offset)
1915 err = strbuf_addf(&buf, "+%lu", pp->offset);
1916 else if (pp->line)
1917 err = strbuf_addf(&buf, ":%d", pp->line);
1918 else if (pp->retprobe)
1919 err = strbuf_addstr(&buf, "%return");
1920 if (err)
1921 goto out;
1923 if (pp->file) {
1924 tmp = pp->file;
1925 len = strlen(tmp);
1926 if (len > 30) {
1927 tmp = strchr(pp->file + len - 30, '/');
1928 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1930 err = strbuf_addf(&buf, "@%s", tmp);
1931 if (!err && !pp->function && pp->line)
1932 err = strbuf_addf(&buf, ":%d", pp->line);
1934 if (!err)
1935 ret = strbuf_detach(&buf, NULL);
1936 out:
1937 strbuf_release(&buf);
1938 return ret;
1941 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1943 struct strbuf buf;
1944 char *tmp, *ret = NULL;
1945 int i;
1947 if (strbuf_init(&buf, 64))
1948 return NULL;
1949 if (pev->event)
1950 if (strbuf_addf(&buf, "%s:%s=", pev->group ?: PERFPROBE_GROUP,
1951 pev->event) < 0)
1952 goto out;
1954 tmp = synthesize_perf_probe_point(&pev->point);
1955 if (!tmp || strbuf_addstr(&buf, tmp) < 0)
1956 goto out;
1957 free(tmp);
1959 for (i = 0; i < pev->nargs; i++) {
1960 tmp = synthesize_perf_probe_arg(pev->args + i);
1961 if (!tmp || strbuf_addf(&buf, " %s", tmp) < 0)
1962 goto out;
1963 free(tmp);
1966 ret = strbuf_detach(&buf, NULL);
1967 out:
1968 strbuf_release(&buf);
1969 return ret;
1972 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1973 struct strbuf *buf, int depth)
1975 int err;
1976 if (ref->next) {
1977 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1978 depth + 1);
1979 if (depth < 0)
1980 return depth;
1982 err = strbuf_addf(buf, "%+ld(", ref->offset);
1983 return (err < 0) ? err : depth;
1986 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1987 struct strbuf *buf)
1989 struct probe_trace_arg_ref *ref = arg->ref;
1990 int depth = 0, err;
1992 /* Argument name or separator */
1993 if (arg->name)
1994 err = strbuf_addf(buf, " %s=", arg->name);
1995 else
1996 err = strbuf_addch(buf, ' ');
1997 if (err)
1998 return err;
2000 /* Special case: @XXX */
2001 if (arg->value[0] == '@' && arg->ref)
2002 ref = ref->next;
2004 /* Dereferencing arguments */
2005 if (ref) {
2006 depth = __synthesize_probe_trace_arg_ref(ref, buf, 1);
2007 if (depth < 0)
2008 return depth;
2011 /* Print argument value */
2012 if (arg->value[0] == '@' && arg->ref)
2013 err = strbuf_addf(buf, "%s%+ld", arg->value, arg->ref->offset);
2014 else
2015 err = strbuf_addstr(buf, arg->value);
2017 /* Closing */
2018 while (!err && depth--)
2019 err = strbuf_addch(buf, ')');
2021 /* Print argument type */
2022 if (!err && arg->type)
2023 err = strbuf_addf(buf, ":%s", arg->type);
2025 return err;
2028 char *synthesize_probe_trace_command(struct probe_trace_event *tev)
2030 struct probe_trace_point *tp = &tev->point;
2031 struct strbuf buf;
2032 char *ret = NULL;
2033 int i, err;
2035 /* Uprobes must have tp->module */
2036 if (tev->uprobes && !tp->module)
2037 return NULL;
2039 if (strbuf_init(&buf, 32) < 0)
2040 return NULL;
2042 if (strbuf_addf(&buf, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
2043 tev->group, tev->event) < 0)
2044 goto error;
2046 * If tp->address == 0, then this point must be a
2047 * absolute address uprobe.
2048 * try_to_find_absolute_address() should have made
2049 * tp->symbol to "0x0".
2051 if (tev->uprobes && !tp->address) {
2052 if (!tp->symbol || strcmp(tp->symbol, "0x0"))
2053 goto error;
2056 /* Use the tp->address for uprobes */
2057 if (tev->uprobes)
2058 err = strbuf_addf(&buf, "%s:0x%lx", tp->module, tp->address);
2059 else if (!strncmp(tp->symbol, "0x", 2))
2060 /* Absolute address. See try_to_find_absolute_address() */
2061 err = strbuf_addf(&buf, "%s%s0x%lx", tp->module ?: "",
2062 tp->module ? ":" : "", tp->address);
2063 else
2064 err = strbuf_addf(&buf, "%s%s%s+%lu", tp->module ?: "",
2065 tp->module ? ":" : "", tp->symbol, tp->offset);
2066 if (err)
2067 goto error;
2069 for (i = 0; i < tev->nargs; i++)
2070 if (synthesize_probe_trace_arg(&tev->args[i], &buf) < 0)
2071 goto error;
2073 ret = strbuf_detach(&buf, NULL);
2074 error:
2075 strbuf_release(&buf);
2076 return ret;
2079 static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
2080 struct perf_probe_point *pp,
2081 bool is_kprobe)
2083 struct symbol *sym = NULL;
2084 struct map *map = NULL;
2085 u64 addr = tp->address;
2086 int ret = -ENOENT;
2088 if (!is_kprobe) {
2089 map = dso__new_map(tp->module);
2090 if (!map)
2091 goto out;
2092 sym = map__find_symbol(map, addr);
2093 } else {
2094 if (tp->symbol && !addr) {
2095 if (kernel_get_symbol_address_by_name(tp->symbol,
2096 &addr, true, false) < 0)
2097 goto out;
2099 if (addr) {
2100 addr += tp->offset;
2101 sym = __find_kernel_function(addr, &map);
2105 if (!sym)
2106 goto out;
2108 pp->retprobe = tp->retprobe;
2109 pp->offset = addr - map->unmap_ip(map, sym->start);
2110 pp->function = strdup(sym->name);
2111 ret = pp->function ? 0 : -ENOMEM;
2113 out:
2114 if (map && !is_kprobe) {
2115 map__put(map);
2118 return ret;
2121 static int convert_to_perf_probe_point(struct probe_trace_point *tp,
2122 struct perf_probe_point *pp,
2123 bool is_kprobe)
2125 char buf[128];
2126 int ret;
2128 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
2129 if (!ret)
2130 return 0;
2131 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
2132 if (!ret)
2133 return 0;
2135 pr_debug("Failed to find probe point from both of dwarf and map.\n");
2137 if (tp->symbol) {
2138 pp->function = strdup(tp->symbol);
2139 pp->offset = tp->offset;
2140 } else {
2141 ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address);
2142 if (ret < 0)
2143 return ret;
2144 pp->function = strdup(buf);
2145 pp->offset = 0;
2147 if (pp->function == NULL)
2148 return -ENOMEM;
2150 pp->retprobe = tp->retprobe;
2152 return 0;
2155 static int convert_to_perf_probe_event(struct probe_trace_event *tev,
2156 struct perf_probe_event *pev, bool is_kprobe)
2158 struct strbuf buf = STRBUF_INIT;
2159 int i, ret;
2161 /* Convert event/group name */
2162 pev->event = strdup(tev->event);
2163 pev->group = strdup(tev->group);
2164 if (pev->event == NULL || pev->group == NULL)
2165 return -ENOMEM;
2167 /* Convert trace_point to probe_point */
2168 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
2169 if (ret < 0)
2170 return ret;
2172 /* Convert trace_arg to probe_arg */
2173 pev->nargs = tev->nargs;
2174 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
2175 if (pev->args == NULL)
2176 return -ENOMEM;
2177 for (i = 0; i < tev->nargs && ret >= 0; i++) {
2178 if (tev->args[i].name)
2179 pev->args[i].name = strdup(tev->args[i].name);
2180 else {
2181 if ((ret = strbuf_init(&buf, 32)) < 0)
2182 goto error;
2183 ret = synthesize_probe_trace_arg(&tev->args[i], &buf);
2184 pev->args[i].name = strbuf_detach(&buf, NULL);
2186 if (pev->args[i].name == NULL && ret >= 0)
2187 ret = -ENOMEM;
2189 error:
2190 if (ret < 0)
2191 clear_perf_probe_event(pev);
2193 return ret;
2196 void clear_perf_probe_event(struct perf_probe_event *pev)
2198 struct perf_probe_arg_field *field, *next;
2199 int i;
2201 free(pev->event);
2202 free(pev->group);
2203 free(pev->target);
2204 clear_perf_probe_point(&pev->point);
2206 for (i = 0; i < pev->nargs; i++) {
2207 free(pev->args[i].name);
2208 free(pev->args[i].var);
2209 free(pev->args[i].type);
2210 field = pev->args[i].field;
2211 while (field) {
2212 next = field->next;
2213 zfree(&field->name);
2214 free(field);
2215 field = next;
2218 free(pev->args);
2219 memset(pev, 0, sizeof(*pev));
2222 #define strdup_or_goto(str, label) \
2223 ({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; })
2225 static int perf_probe_point__copy(struct perf_probe_point *dst,
2226 struct perf_probe_point *src)
2228 dst->file = strdup_or_goto(src->file, out_err);
2229 dst->function = strdup_or_goto(src->function, out_err);
2230 dst->lazy_line = strdup_or_goto(src->lazy_line, out_err);
2231 dst->line = src->line;
2232 dst->retprobe = src->retprobe;
2233 dst->offset = src->offset;
2234 return 0;
2236 out_err:
2237 clear_perf_probe_point(dst);
2238 return -ENOMEM;
2241 static int perf_probe_arg__copy(struct perf_probe_arg *dst,
2242 struct perf_probe_arg *src)
2244 struct perf_probe_arg_field *field, **ppfield;
2246 dst->name = strdup_or_goto(src->name, out_err);
2247 dst->var = strdup_or_goto(src->var, out_err);
2248 dst->type = strdup_or_goto(src->type, out_err);
2250 field = src->field;
2251 ppfield = &(dst->field);
2252 while (field) {
2253 *ppfield = zalloc(sizeof(*field));
2254 if (!*ppfield)
2255 goto out_err;
2256 (*ppfield)->name = strdup_or_goto(field->name, out_err);
2257 (*ppfield)->index = field->index;
2258 (*ppfield)->ref = field->ref;
2259 field = field->next;
2260 ppfield = &((*ppfield)->next);
2262 return 0;
2263 out_err:
2264 return -ENOMEM;
2267 int perf_probe_event__copy(struct perf_probe_event *dst,
2268 struct perf_probe_event *src)
2270 int i;
2272 dst->event = strdup_or_goto(src->event, out_err);
2273 dst->group = strdup_or_goto(src->group, out_err);
2274 dst->target = strdup_or_goto(src->target, out_err);
2275 dst->uprobes = src->uprobes;
2277 if (perf_probe_point__copy(&dst->point, &src->point) < 0)
2278 goto out_err;
2280 dst->args = zalloc(sizeof(struct perf_probe_arg) * src->nargs);
2281 if (!dst->args)
2282 goto out_err;
2283 dst->nargs = src->nargs;
2285 for (i = 0; i < src->nargs; i++)
2286 if (perf_probe_arg__copy(&dst->args[i], &src->args[i]) < 0)
2287 goto out_err;
2288 return 0;
2290 out_err:
2291 clear_perf_probe_event(dst);
2292 return -ENOMEM;
2295 void clear_probe_trace_event(struct probe_trace_event *tev)
2297 struct probe_trace_arg_ref *ref, *next;
2298 int i;
2300 free(tev->event);
2301 free(tev->group);
2302 free(tev->point.symbol);
2303 free(tev->point.realname);
2304 free(tev->point.module);
2305 for (i = 0; i < tev->nargs; i++) {
2306 free(tev->args[i].name);
2307 free(tev->args[i].value);
2308 free(tev->args[i].type);
2309 ref = tev->args[i].ref;
2310 while (ref) {
2311 next = ref->next;
2312 free(ref);
2313 ref = next;
2316 free(tev->args);
2317 memset(tev, 0, sizeof(*tev));
2320 struct kprobe_blacklist_node {
2321 struct list_head list;
2322 unsigned long start;
2323 unsigned long end;
2324 char *symbol;
2327 static void kprobe_blacklist__delete(struct list_head *blacklist)
2329 struct kprobe_blacklist_node *node;
2331 while (!list_empty(blacklist)) {
2332 node = list_first_entry(blacklist,
2333 struct kprobe_blacklist_node, list);
2334 list_del(&node->list);
2335 free(node->symbol);
2336 free(node);
2340 static int kprobe_blacklist__load(struct list_head *blacklist)
2342 struct kprobe_blacklist_node *node;
2343 const char *__debugfs = debugfs__mountpoint();
2344 char buf[PATH_MAX], *p;
2345 FILE *fp;
2346 int ret;
2348 if (__debugfs == NULL)
2349 return -ENOTSUP;
2351 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
2352 if (ret < 0)
2353 return ret;
2355 fp = fopen(buf, "r");
2356 if (!fp)
2357 return -errno;
2359 ret = 0;
2360 while (fgets(buf, PATH_MAX, fp)) {
2361 node = zalloc(sizeof(*node));
2362 if (!node) {
2363 ret = -ENOMEM;
2364 break;
2366 INIT_LIST_HEAD(&node->list);
2367 list_add_tail(&node->list, blacklist);
2368 if (sscanf(buf, "0x%lx-0x%lx", &node->start, &node->end) != 2) {
2369 ret = -EINVAL;
2370 break;
2372 p = strchr(buf, '\t');
2373 if (p) {
2374 p++;
2375 if (p[strlen(p) - 1] == '\n')
2376 p[strlen(p) - 1] = '\0';
2377 } else
2378 p = (char *)"unknown";
2379 node->symbol = strdup(p);
2380 if (!node->symbol) {
2381 ret = -ENOMEM;
2382 break;
2384 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
2385 node->start, node->end, node->symbol);
2386 ret++;
2388 if (ret < 0)
2389 kprobe_blacklist__delete(blacklist);
2390 fclose(fp);
2392 return ret;
2395 static struct kprobe_blacklist_node *
2396 kprobe_blacklist__find_by_address(struct list_head *blacklist,
2397 unsigned long address)
2399 struct kprobe_blacklist_node *node;
2401 list_for_each_entry(node, blacklist, list) {
2402 if (node->start <= address && address < node->end)
2403 return node;
2406 return NULL;
2409 static LIST_HEAD(kprobe_blacklist);
2411 static void kprobe_blacklist__init(void)
2413 if (!list_empty(&kprobe_blacklist))
2414 return;
2416 if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
2417 pr_debug("No kprobe blacklist support, ignored\n");
2420 static void kprobe_blacklist__release(void)
2422 kprobe_blacklist__delete(&kprobe_blacklist);
2425 static bool kprobe_blacklist__listed(unsigned long address)
2427 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
2430 static int perf_probe_event__sprintf(const char *group, const char *event,
2431 struct perf_probe_event *pev,
2432 const char *module,
2433 struct strbuf *result)
2435 int i, ret;
2436 char *buf;
2438 if (asprintf(&buf, "%s:%s", group, event) < 0)
2439 return -errno;
2440 ret = strbuf_addf(result, " %-20s (on ", buf);
2441 free(buf);
2442 if (ret)
2443 return ret;
2445 /* Synthesize only event probe point */
2446 buf = synthesize_perf_probe_point(&pev->point);
2447 if (!buf)
2448 return -ENOMEM;
2449 ret = strbuf_addstr(result, buf);
2450 free(buf);
2452 if (!ret && module)
2453 ret = strbuf_addf(result, " in %s", module);
2455 if (!ret && pev->nargs > 0) {
2456 ret = strbuf_add(result, " with", 5);
2457 for (i = 0; !ret && i < pev->nargs; i++) {
2458 buf = synthesize_perf_probe_arg(&pev->args[i]);
2459 if (!buf)
2460 return -ENOMEM;
2461 ret = strbuf_addf(result, " %s", buf);
2462 free(buf);
2465 if (!ret)
2466 ret = strbuf_addch(result, ')');
2468 return ret;
2471 /* Show an event */
2472 int show_perf_probe_event(const char *group, const char *event,
2473 struct perf_probe_event *pev,
2474 const char *module, bool use_stdout)
2476 struct strbuf buf = STRBUF_INIT;
2477 int ret;
2479 ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2480 if (ret >= 0) {
2481 if (use_stdout)
2482 printf("%s\n", buf.buf);
2483 else
2484 pr_info("%s\n", buf.buf);
2486 strbuf_release(&buf);
2488 return ret;
2491 static bool filter_probe_trace_event(struct probe_trace_event *tev,
2492 struct strfilter *filter)
2494 char tmp[128];
2496 /* At first, check the event name itself */
2497 if (strfilter__compare(filter, tev->event))
2498 return true;
2500 /* Next, check the combination of name and group */
2501 if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0)
2502 return false;
2503 return strfilter__compare(filter, tmp);
2506 static int __show_perf_probe_events(int fd, bool is_kprobe,
2507 struct strfilter *filter)
2509 int ret = 0;
2510 struct probe_trace_event tev;
2511 struct perf_probe_event pev;
2512 struct strlist *rawlist;
2513 struct str_node *ent;
2515 memset(&tev, 0, sizeof(tev));
2516 memset(&pev, 0, sizeof(pev));
2518 rawlist = probe_file__get_rawlist(fd);
2519 if (!rawlist)
2520 return -ENOMEM;
2522 strlist__for_each_entry(ent, rawlist) {
2523 ret = parse_probe_trace_command(ent->s, &tev);
2524 if (ret >= 0) {
2525 if (!filter_probe_trace_event(&tev, filter))
2526 goto next;
2527 ret = convert_to_perf_probe_event(&tev, &pev,
2528 is_kprobe);
2529 if (ret < 0)
2530 goto next;
2531 ret = show_perf_probe_event(pev.group, pev.event,
2532 &pev, tev.point.module,
2533 true);
2535 next:
2536 clear_perf_probe_event(&pev);
2537 clear_probe_trace_event(&tev);
2538 if (ret < 0)
2539 break;
2541 strlist__delete(rawlist);
2542 /* Cleanup cached debuginfo if needed */
2543 debuginfo_cache__exit();
2545 return ret;
2548 /* List up current perf-probe events */
2549 int show_perf_probe_events(struct strfilter *filter)
2551 int kp_fd, up_fd, ret;
2553 setup_pager();
2555 if (probe_conf.cache)
2556 return probe_cache__show_all_caches(filter);
2558 ret = init_probe_symbol_maps(false);
2559 if (ret < 0)
2560 return ret;
2562 ret = probe_file__open_both(&kp_fd, &up_fd, 0);
2563 if (ret < 0)
2564 return ret;
2566 if (kp_fd >= 0)
2567 ret = __show_perf_probe_events(kp_fd, true, filter);
2568 if (up_fd >= 0 && ret >= 0)
2569 ret = __show_perf_probe_events(up_fd, false, filter);
2570 if (kp_fd > 0)
2571 close(kp_fd);
2572 if (up_fd > 0)
2573 close(up_fd);
2574 exit_probe_symbol_maps();
2576 return ret;
2579 static int get_new_event_name(char *buf, size_t len, const char *base,
2580 struct strlist *namelist, bool ret_event,
2581 bool allow_suffix)
2583 int i, ret;
2584 char *p, *nbase;
2586 if (*base == '.')
2587 base++;
2588 nbase = strdup(base);
2589 if (!nbase)
2590 return -ENOMEM;
2592 /* Cut off the dot suffixes (e.g. .const, .isra) and version suffixes */
2593 p = strpbrk(nbase, ".@");
2594 if (p && p != nbase)
2595 *p = '\0';
2597 /* Try no suffix number */
2598 ret = e_snprintf(buf, len, "%s%s", nbase, ret_event ? "__return" : "");
2599 if (ret < 0) {
2600 pr_debug("snprintf() failed: %d\n", ret);
2601 goto out;
2603 if (!strlist__has_entry(namelist, buf))
2604 goto out;
2606 if (!allow_suffix) {
2607 pr_warning("Error: event \"%s\" already exists.\n"
2608 " Hint: Remove existing event by 'perf probe -d'\n"
2609 " or force duplicates by 'perf probe -f'\n"
2610 " or set 'force=yes' in BPF source.\n",
2611 buf);
2612 ret = -EEXIST;
2613 goto out;
2616 /* Try to add suffix */
2617 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2618 ret = e_snprintf(buf, len, "%s_%d", nbase, i);
2619 if (ret < 0) {
2620 pr_debug("snprintf() failed: %d\n", ret);
2621 goto out;
2623 if (!strlist__has_entry(namelist, buf))
2624 break;
2626 if (i == MAX_EVENT_INDEX) {
2627 pr_warning("Too many events are on the same function.\n");
2628 ret = -ERANGE;
2631 out:
2632 free(nbase);
2634 /* Final validation */
2635 if (ret >= 0 && !is_c_func_name(buf)) {
2636 pr_warning("Internal error: \"%s\" is an invalid event name.\n",
2637 buf);
2638 ret = -EINVAL;
2641 return ret;
2644 /* Warn if the current kernel's uprobe implementation is old */
2645 static void warn_uprobe_event_compat(struct probe_trace_event *tev)
2647 int i;
2648 char *buf = synthesize_probe_trace_command(tev);
2650 /* Old uprobe event doesn't support memory dereference */
2651 if (!tev->uprobes || tev->nargs == 0 || !buf)
2652 goto out;
2654 for (i = 0; i < tev->nargs; i++)
2655 if (strglobmatch(tev->args[i].value, "[$@+-]*")) {
2656 pr_warning("Please upgrade your kernel to at least "
2657 "3.14 to have access to feature %s\n",
2658 tev->args[i].value);
2659 break;
2661 out:
2662 free(buf);
2665 /* Set new name from original perf_probe_event and namelist */
2666 static int probe_trace_event__set_name(struct probe_trace_event *tev,
2667 struct perf_probe_event *pev,
2668 struct strlist *namelist,
2669 bool allow_suffix)
2671 const char *event, *group;
2672 char buf[64];
2673 int ret;
2675 /* If probe_event or trace_event already have the name, reuse it */
2676 if (pev->event && !pev->sdt)
2677 event = pev->event;
2678 else if (tev->event)
2679 event = tev->event;
2680 else {
2681 /* Or generate new one from probe point */
2682 if (pev->point.function &&
2683 (strncmp(pev->point.function, "0x", 2) != 0) &&
2684 !strisglob(pev->point.function))
2685 event = pev->point.function;
2686 else
2687 event = tev->point.realname;
2689 if (pev->group && !pev->sdt)
2690 group = pev->group;
2691 else if (tev->group)
2692 group = tev->group;
2693 else
2694 group = PERFPROBE_GROUP;
2696 /* Get an unused new event name */
2697 ret = get_new_event_name(buf, 64, event, namelist,
2698 tev->point.retprobe, allow_suffix);
2699 if (ret < 0)
2700 return ret;
2702 event = buf;
2704 tev->event = strdup(event);
2705 tev->group = strdup(group);
2706 if (tev->event == NULL || tev->group == NULL)
2707 return -ENOMEM;
2709 /* Add added event name to namelist */
2710 strlist__add(namelist, event);
2711 return 0;
2714 static int __open_probe_file_and_namelist(bool uprobe,
2715 struct strlist **namelist)
2717 int fd;
2719 fd = probe_file__open(PF_FL_RW | (uprobe ? PF_FL_UPROBE : 0));
2720 if (fd < 0)
2721 return fd;
2723 /* Get current event names */
2724 *namelist = probe_file__get_namelist(fd);
2725 if (!(*namelist)) {
2726 pr_debug("Failed to get current event list.\n");
2727 close(fd);
2728 return -ENOMEM;
2730 return fd;
2733 static int __add_probe_trace_events(struct perf_probe_event *pev,
2734 struct probe_trace_event *tevs,
2735 int ntevs, bool allow_suffix)
2737 int i, fd[2] = {-1, -1}, up, ret;
2738 struct probe_trace_event *tev = NULL;
2739 struct probe_cache *cache = NULL;
2740 struct strlist *namelist[2] = {NULL, NULL};
2741 struct nscookie nsc;
2743 up = pev->uprobes ? 1 : 0;
2744 fd[up] = __open_probe_file_and_namelist(up, &namelist[up]);
2745 if (fd[up] < 0)
2746 return fd[up];
2748 ret = 0;
2749 for (i = 0; i < ntevs; i++) {
2750 tev = &tevs[i];
2751 up = tev->uprobes ? 1 : 0;
2752 if (fd[up] == -1) { /* Open the kprobe/uprobe_events */
2753 fd[up] = __open_probe_file_and_namelist(up,
2754 &namelist[up]);
2755 if (fd[up] < 0)
2756 goto close_out;
2758 /* Skip if the symbol is out of .text or blacklisted */
2759 if (!tev->point.symbol && !pev->uprobes)
2760 continue;
2762 /* Set new name for tev (and update namelist) */
2763 ret = probe_trace_event__set_name(tev, pev, namelist[up],
2764 allow_suffix);
2765 if (ret < 0)
2766 break;
2768 nsinfo__mountns_enter(pev->nsi, &nsc);
2769 ret = probe_file__add_event(fd[up], tev);
2770 nsinfo__mountns_exit(&nsc);
2771 if (ret < 0)
2772 break;
2775 * Probes after the first probe which comes from same
2776 * user input are always allowed to add suffix, because
2777 * there might be several addresses corresponding to
2778 * one code line.
2780 allow_suffix = true;
2782 if (ret == -EINVAL && pev->uprobes)
2783 warn_uprobe_event_compat(tev);
2784 if (ret == 0 && probe_conf.cache) {
2785 cache = probe_cache__new(pev->target, pev->nsi);
2786 if (!cache ||
2787 probe_cache__add_entry(cache, pev, tevs, ntevs) < 0 ||
2788 probe_cache__commit(cache) < 0)
2789 pr_warning("Failed to add event to probe cache\n");
2790 probe_cache__delete(cache);
2793 close_out:
2794 for (up = 0; up < 2; up++) {
2795 strlist__delete(namelist[up]);
2796 if (fd[up] >= 0)
2797 close(fd[up]);
2799 return ret;
2802 static int find_probe_functions(struct map *map, char *name,
2803 struct symbol **syms)
2805 int found = 0;
2806 struct symbol *sym;
2807 struct rb_node *tmp;
2808 const char *norm, *ver;
2809 char *buf = NULL;
2810 bool cut_version = true;
2812 if (map__load(map) < 0)
2813 return 0;
2815 /* If user gives a version, don't cut off the version from symbols */
2816 if (strchr(name, '@'))
2817 cut_version = false;
2819 map__for_each_symbol(map, sym, tmp) {
2820 norm = arch__normalize_symbol_name(sym->name);
2821 if (!norm)
2822 continue;
2824 if (cut_version) {
2825 /* We don't care about default symbol or not */
2826 ver = strchr(norm, '@');
2827 if (ver) {
2828 buf = strndup(norm, ver - norm);
2829 if (!buf)
2830 return -ENOMEM;
2831 norm = buf;
2835 if (strglobmatch(norm, name)) {
2836 found++;
2837 if (syms && found < probe_conf.max_probes)
2838 syms[found - 1] = sym;
2840 if (buf)
2841 zfree(&buf);
2844 return found;
2847 void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
2848 struct probe_trace_event *tev __maybe_unused,
2849 struct map *map __maybe_unused,
2850 struct symbol *sym __maybe_unused) { }
2853 * Find probe function addresses from map.
2854 * Return an error or the number of found probe_trace_event
2856 static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
2857 struct probe_trace_event **tevs)
2859 struct map *map = NULL;
2860 struct ref_reloc_sym *reloc_sym = NULL;
2861 struct symbol *sym;
2862 struct symbol **syms = NULL;
2863 struct probe_trace_event *tev;
2864 struct perf_probe_point *pp = &pev->point;
2865 struct probe_trace_point *tp;
2866 int num_matched_functions;
2867 int ret, i, j, skipped = 0;
2868 char *mod_name;
2870 map = get_target_map(pev->target, pev->nsi, pev->uprobes);
2871 if (!map) {
2872 ret = -EINVAL;
2873 goto out;
2876 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
2877 if (!syms) {
2878 ret = -ENOMEM;
2879 goto out;
2883 * Load matched symbols: Since the different local symbols may have
2884 * same name but different addresses, this lists all the symbols.
2886 num_matched_functions = find_probe_functions(map, pp->function, syms);
2887 if (num_matched_functions <= 0) {
2888 pr_err("Failed to find symbol %s in %s\n", pp->function,
2889 pev->target ? : "kernel");
2890 ret = -ENOENT;
2891 goto out;
2892 } else if (num_matched_functions > probe_conf.max_probes) {
2893 pr_err("Too many functions matched in %s\n",
2894 pev->target ? : "kernel");
2895 ret = -E2BIG;
2896 goto out;
2899 /* Note that the symbols in the kmodule are not relocated */
2900 if (!pev->uprobes && !pev->target &&
2901 (!pp->retprobe || kretprobe_offset_is_supported())) {
2902 reloc_sym = kernel_get_ref_reloc_sym();
2903 if (!reloc_sym) {
2904 pr_warning("Relocated base symbol is not found!\n");
2905 ret = -EINVAL;
2906 goto out;
2910 /* Setup result trace-probe-events */
2911 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
2912 if (!*tevs) {
2913 ret = -ENOMEM;
2914 goto out;
2917 ret = 0;
2919 for (j = 0; j < num_matched_functions; j++) {
2920 sym = syms[j];
2922 tev = (*tevs) + ret;
2923 tp = &tev->point;
2924 if (ret == num_matched_functions) {
2925 pr_warning("Too many symbols are listed. Skip it.\n");
2926 break;
2928 ret++;
2930 if (pp->offset > sym->end - sym->start) {
2931 pr_warning("Offset %ld is bigger than the size of %s\n",
2932 pp->offset, sym->name);
2933 ret = -ENOENT;
2934 goto err_out;
2936 /* Add one probe point */
2937 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
2939 /* Check the kprobe (not in module) is within .text */
2940 if (!pev->uprobes && !pev->target &&
2941 kprobe_warn_out_range(sym->name, tp->address)) {
2942 tp->symbol = NULL; /* Skip it */
2943 skipped++;
2944 } else if (reloc_sym) {
2945 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
2946 tp->offset = tp->address - reloc_sym->addr;
2947 } else {
2948 tp->symbol = strdup_or_goto(sym->name, nomem_out);
2949 tp->offset = pp->offset;
2951 tp->realname = strdup_or_goto(sym->name, nomem_out);
2953 tp->retprobe = pp->retprobe;
2954 if (pev->target) {
2955 if (pev->uprobes) {
2956 tev->point.module = strdup_or_goto(pev->target,
2957 nomem_out);
2958 } else {
2959 mod_name = find_module_name(pev->target);
2960 tev->point.module =
2961 strdup(mod_name ? mod_name : pev->target);
2962 free(mod_name);
2963 if (!tev->point.module)
2964 goto nomem_out;
2967 tev->uprobes = pev->uprobes;
2968 tev->nargs = pev->nargs;
2969 if (tev->nargs) {
2970 tev->args = zalloc(sizeof(struct probe_trace_arg) *
2971 tev->nargs);
2972 if (tev->args == NULL)
2973 goto nomem_out;
2975 for (i = 0; i < tev->nargs; i++) {
2976 if (pev->args[i].name)
2977 tev->args[i].name =
2978 strdup_or_goto(pev->args[i].name,
2979 nomem_out);
2981 tev->args[i].value = strdup_or_goto(pev->args[i].var,
2982 nomem_out);
2983 if (pev->args[i].type)
2984 tev->args[i].type =
2985 strdup_or_goto(pev->args[i].type,
2986 nomem_out);
2988 arch__fix_tev_from_maps(pev, tev, map, sym);
2990 if (ret == skipped) {
2991 ret = -ENOENT;
2992 goto err_out;
2995 out:
2996 map__put(map);
2997 free(syms);
2998 return ret;
3000 nomem_out:
3001 ret = -ENOMEM;
3002 err_out:
3003 clear_probe_trace_events(*tevs, num_matched_functions);
3004 zfree(tevs);
3005 goto out;
3008 static int try_to_find_absolute_address(struct perf_probe_event *pev,
3009 struct probe_trace_event **tevs)
3011 struct perf_probe_point *pp = &pev->point;
3012 struct probe_trace_event *tev;
3013 struct probe_trace_point *tp;
3014 int i, err;
3016 if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2)))
3017 return -EINVAL;
3018 if (perf_probe_event_need_dwarf(pev))
3019 return -EINVAL;
3022 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
3023 * absolute address.
3025 * Only one tev can be generated by this.
3027 *tevs = zalloc(sizeof(*tev));
3028 if (!*tevs)
3029 return -ENOMEM;
3031 tev = *tevs;
3032 tp = &tev->point;
3035 * Don't use tp->offset, use address directly, because
3036 * in synthesize_probe_trace_command() address cannot be
3037 * zero.
3039 tp->address = pev->point.abs_address;
3040 tp->retprobe = pp->retprobe;
3041 tev->uprobes = pev->uprobes;
3043 err = -ENOMEM;
3045 * Give it a '0x' leading symbol name.
3046 * In __add_probe_trace_events, a NULL symbol is interpreted as
3047 * invalud.
3049 if (asprintf(&tp->symbol, "0x%lx", tp->address) < 0)
3050 goto errout;
3052 /* For kprobe, check range */
3053 if ((!tev->uprobes) &&
3054 (kprobe_warn_out_range(tev->point.symbol,
3055 tev->point.address))) {
3056 err = -EACCES;
3057 goto errout;
3060 if (asprintf(&tp->realname, "abs_%lx", tp->address) < 0)
3061 goto errout;
3063 if (pev->target) {
3064 tp->module = strdup(pev->target);
3065 if (!tp->module)
3066 goto errout;
3069 if (tev->group) {
3070 tev->group = strdup(pev->group);
3071 if (!tev->group)
3072 goto errout;
3075 if (pev->event) {
3076 tev->event = strdup(pev->event);
3077 if (!tev->event)
3078 goto errout;
3081 tev->nargs = pev->nargs;
3082 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
3083 if (!tev->args)
3084 goto errout;
3086 for (i = 0; i < tev->nargs; i++)
3087 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);
3089 return 1;
3091 errout:
3092 clear_probe_trace_events(*tevs, 1);
3093 *tevs = NULL;
3094 return err;
3097 /* Concatinate two arrays */
3098 static void *memcat(void *a, size_t sz_a, void *b, size_t sz_b)
3100 void *ret;
3102 ret = malloc(sz_a + sz_b);
3103 if (ret) {
3104 memcpy(ret, a, sz_a);
3105 memcpy(ret + sz_a, b, sz_b);
3107 return ret;
3110 static int
3111 concat_probe_trace_events(struct probe_trace_event **tevs, int *ntevs,
3112 struct probe_trace_event **tevs2, int ntevs2)
3114 struct probe_trace_event *new_tevs;
3115 int ret = 0;
3117 if (*ntevs == 0) {
3118 *tevs = *tevs2;
3119 *ntevs = ntevs2;
3120 *tevs2 = NULL;
3121 return 0;
3124 if (*ntevs + ntevs2 > probe_conf.max_probes)
3125 ret = -E2BIG;
3126 else {
3127 /* Concatinate the array of probe_trace_event */
3128 new_tevs = memcat(*tevs, (*ntevs) * sizeof(**tevs),
3129 *tevs2, ntevs2 * sizeof(**tevs2));
3130 if (!new_tevs)
3131 ret = -ENOMEM;
3132 else {
3133 free(*tevs);
3134 *tevs = new_tevs;
3135 *ntevs += ntevs2;
3138 if (ret < 0)
3139 clear_probe_trace_events(*tevs2, ntevs2);
3140 zfree(tevs2);
3142 return ret;
3146 * Try to find probe_trace_event from given probe caches. Return the number
3147 * of cached events found, if an error occurs return the error.
3149 static int find_cached_events(struct perf_probe_event *pev,
3150 struct probe_trace_event **tevs,
3151 const char *target)
3153 struct probe_cache *cache;
3154 struct probe_cache_entry *entry;
3155 struct probe_trace_event *tmp_tevs = NULL;
3156 int ntevs = 0;
3157 int ret = 0;
3159 cache = probe_cache__new(target, pev->nsi);
3160 /* Return 0 ("not found") if the target has no probe cache. */
3161 if (!cache)
3162 return 0;
3164 for_each_probe_cache_entry(entry, cache) {
3165 /* Skip the cache entry which has no name */
3166 if (!entry->pev.event || !entry->pev.group)
3167 continue;
3168 if ((!pev->group || strglobmatch(entry->pev.group, pev->group)) &&
3169 strglobmatch(entry->pev.event, pev->event)) {
3170 ret = probe_cache_entry__get_event(entry, &tmp_tevs);
3171 if (ret > 0)
3172 ret = concat_probe_trace_events(tevs, &ntevs,
3173 &tmp_tevs, ret);
3174 if (ret < 0)
3175 break;
3178 probe_cache__delete(cache);
3179 if (ret < 0) {
3180 clear_probe_trace_events(*tevs, ntevs);
3181 zfree(tevs);
3182 } else {
3183 ret = ntevs;
3184 if (ntevs > 0 && target && target[0] == '/')
3185 pev->uprobes = true;
3188 return ret;
3191 /* Try to find probe_trace_event from all probe caches */
3192 static int find_cached_events_all(struct perf_probe_event *pev,
3193 struct probe_trace_event **tevs)
3195 struct probe_trace_event *tmp_tevs = NULL;
3196 struct strlist *bidlist;
3197 struct str_node *nd;
3198 char *pathname;
3199 int ntevs = 0;
3200 int ret;
3202 /* Get the buildid list of all valid caches */
3203 bidlist = build_id_cache__list_all(true);
3204 if (!bidlist) {
3205 ret = -errno;
3206 pr_debug("Failed to get buildids: %d\n", ret);
3207 return ret;
3210 ret = 0;
3211 strlist__for_each_entry(nd, bidlist) {
3212 pathname = build_id_cache__origname(nd->s);
3213 ret = find_cached_events(pev, &tmp_tevs, pathname);
3214 /* In the case of cnt == 0, we just skip it */
3215 if (ret > 0)
3216 ret = concat_probe_trace_events(tevs, &ntevs,
3217 &tmp_tevs, ret);
3218 free(pathname);
3219 if (ret < 0)
3220 break;
3222 strlist__delete(bidlist);
3224 if (ret < 0) {
3225 clear_probe_trace_events(*tevs, ntevs);
3226 zfree(tevs);
3227 } else
3228 ret = ntevs;
3230 return ret;
3233 static int find_probe_trace_events_from_cache(struct perf_probe_event *pev,
3234 struct probe_trace_event **tevs)
3236 struct probe_cache *cache;
3237 struct probe_cache_entry *entry;
3238 struct probe_trace_event *tev;
3239 struct str_node *node;
3240 int ret, i;
3242 if (pev->sdt) {
3243 /* For SDT/cached events, we use special search functions */
3244 if (!pev->target)
3245 return find_cached_events_all(pev, tevs);
3246 else
3247 return find_cached_events(pev, tevs, pev->target);
3249 cache = probe_cache__new(pev->target, pev->nsi);
3250 if (!cache)
3251 return 0;
3253 entry = probe_cache__find(cache, pev);
3254 if (!entry) {
3255 /* SDT must be in the cache */
3256 ret = pev->sdt ? -ENOENT : 0;
3257 goto out;
3260 ret = strlist__nr_entries(entry->tevlist);
3261 if (ret > probe_conf.max_probes) {
3262 pr_debug("Too many entries matched in the cache of %s\n",
3263 pev->target ? : "kernel");
3264 ret = -E2BIG;
3265 goto out;
3268 *tevs = zalloc(ret * sizeof(*tev));
3269 if (!*tevs) {
3270 ret = -ENOMEM;
3271 goto out;
3274 i = 0;
3275 strlist__for_each_entry(node, entry->tevlist) {
3276 tev = &(*tevs)[i++];
3277 ret = parse_probe_trace_command(node->s, tev);
3278 if (ret < 0)
3279 goto out;
3280 /* Set the uprobes attribute as same as original */
3281 tev->uprobes = pev->uprobes;
3283 ret = i;
3285 out:
3286 probe_cache__delete(cache);
3287 return ret;
3290 static int convert_to_probe_trace_events(struct perf_probe_event *pev,
3291 struct probe_trace_event **tevs)
3293 int ret;
3295 if (!pev->group && !pev->sdt) {
3296 /* Set group name if not given */
3297 if (!pev->uprobes) {
3298 pev->group = strdup(PERFPROBE_GROUP);
3299 ret = pev->group ? 0 : -ENOMEM;
3300 } else
3301 ret = convert_exec_to_group(pev->target, &pev->group);
3302 if (ret != 0) {
3303 pr_warning("Failed to make a group name.\n");
3304 return ret;
3308 ret = try_to_find_absolute_address(pev, tevs);
3309 if (ret > 0)
3310 return ret;
3312 /* At first, we need to lookup cache entry */
3313 ret = find_probe_trace_events_from_cache(pev, tevs);
3314 if (ret > 0 || pev->sdt) /* SDT can be found only in the cache */
3315 return ret == 0 ? -ENOENT : ret; /* Found in probe cache */
3317 /* Convert perf_probe_event with debuginfo */
3318 ret = try_to_find_probe_trace_events(pev, tevs);
3319 if (ret != 0)
3320 return ret; /* Found in debuginfo or got an error */
3322 return find_probe_trace_events_from_map(pev, tevs);
3325 int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3327 int i, ret;
3329 /* Loop 1: convert all events */
3330 for (i = 0; i < npevs; i++) {
3331 /* Init kprobe blacklist if needed */
3332 if (!pevs[i].uprobes)
3333 kprobe_blacklist__init();
3334 /* Convert with or without debuginfo */
3335 ret = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
3336 if (ret < 0)
3337 return ret;
3338 pevs[i].ntevs = ret;
3340 /* This just release blacklist only if allocated */
3341 kprobe_blacklist__release();
3343 return 0;
3346 static int show_probe_trace_event(struct probe_trace_event *tev)
3348 char *buf = synthesize_probe_trace_command(tev);
3350 if (!buf) {
3351 pr_debug("Failed to synthesize probe trace event.\n");
3352 return -EINVAL;
3355 /* Showing definition always go stdout */
3356 printf("%s\n", buf);
3357 free(buf);
3359 return 0;
3362 int show_probe_trace_events(struct perf_probe_event *pevs, int npevs)
3364 struct strlist *namelist = strlist__new(NULL, NULL);
3365 struct probe_trace_event *tev;
3366 struct perf_probe_event *pev;
3367 int i, j, ret = 0;
3369 if (!namelist)
3370 return -ENOMEM;
3372 for (j = 0; j < npevs && !ret; j++) {
3373 pev = &pevs[j];
3374 for (i = 0; i < pev->ntevs && !ret; i++) {
3375 tev = &pev->tevs[i];
3376 /* Skip if the symbol is out of .text or blacklisted */
3377 if (!tev->point.symbol && !pev->uprobes)
3378 continue;
3380 /* Set new name for tev (and update namelist) */
3381 ret = probe_trace_event__set_name(tev, pev,
3382 namelist, true);
3383 if (!ret)
3384 ret = show_probe_trace_event(tev);
3387 strlist__delete(namelist);
3389 return ret;
3392 int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3394 int i, ret = 0;
3396 /* Loop 2: add all events */
3397 for (i = 0; i < npevs; i++) {
3398 ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
3399 pevs[i].ntevs,
3400 probe_conf.force_add);
3401 if (ret < 0)
3402 break;
3404 return ret;
3407 void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3409 int i, j;
3410 struct perf_probe_event *pev;
3412 /* Loop 3: cleanup and free trace events */
3413 for (i = 0; i < npevs; i++) {
3414 pev = &pevs[i];
3415 for (j = 0; j < pevs[i].ntevs; j++)
3416 clear_probe_trace_event(&pevs[i].tevs[j]);
3417 zfree(&pevs[i].tevs);
3418 pevs[i].ntevs = 0;
3419 nsinfo__zput(pev->nsi);
3420 clear_perf_probe_event(&pevs[i]);
3424 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3426 int ret;
3428 ret = init_probe_symbol_maps(pevs->uprobes);
3429 if (ret < 0)
3430 return ret;
3432 ret = convert_perf_probe_events(pevs, npevs);
3433 if (ret == 0)
3434 ret = apply_perf_probe_events(pevs, npevs);
3436 cleanup_perf_probe_events(pevs, npevs);
3438 exit_probe_symbol_maps();
3439 return ret;
3442 int del_perf_probe_events(struct strfilter *filter)
3444 int ret, ret2, ufd = -1, kfd = -1;
3445 char *str = strfilter__string(filter);
3447 if (!str)
3448 return -EINVAL;
3450 /* Get current event names */
3451 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
3452 if (ret < 0)
3453 goto out;
3455 ret = probe_file__del_events(kfd, filter);
3456 if (ret < 0 && ret != -ENOENT)
3457 goto error;
3459 ret2 = probe_file__del_events(ufd, filter);
3460 if (ret2 < 0 && ret2 != -ENOENT) {
3461 ret = ret2;
3462 goto error;
3464 ret = 0;
3466 error:
3467 if (kfd >= 0)
3468 close(kfd);
3469 if (ufd >= 0)
3470 close(ufd);
3471 out:
3472 free(str);
3474 return ret;
3477 int show_available_funcs(const char *target, struct nsinfo *nsi,
3478 struct strfilter *_filter, bool user)
3480 struct rb_node *nd;
3481 struct map *map;
3482 int ret;
3484 ret = init_probe_symbol_maps(user);
3485 if (ret < 0)
3486 return ret;
3488 /* Get a symbol map */
3489 map = get_target_map(target, nsi, user);
3490 if (!map) {
3491 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
3492 return -EINVAL;
3495 ret = map__load(map);
3496 if (ret) {
3497 if (ret == -2) {
3498 char *str = strfilter__string(_filter);
3499 pr_err("Failed to find symbols matched to \"%s\"\n",
3500 str);
3501 free(str);
3502 } else
3503 pr_err("Failed to load symbols in %s\n",
3504 (target) ? : "kernel");
3505 goto end;
3507 if (!dso__sorted_by_name(map->dso, map->type))
3508 dso__sort_by_name(map->dso, map->type);
3510 /* Show all (filtered) symbols */
3511 setup_pager();
3513 for (nd = rb_first(&map->dso->symbol_names[map->type]); nd; nd = rb_next(nd)) {
3514 struct symbol_name_rb_node *pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
3516 if (strfilter__compare(_filter, pos->sym.name))
3517 printf("%s\n", pos->sym.name);
3520 end:
3521 map__put(map);
3522 exit_probe_symbol_maps();
3524 return ret;
3527 int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
3528 struct perf_probe_arg *pvar)
3530 tvar->value = strdup(pvar->var);
3531 if (tvar->value == NULL)
3532 return -ENOMEM;
3533 if (pvar->type) {
3534 tvar->type = strdup(pvar->type);
3535 if (tvar->type == NULL)
3536 return -ENOMEM;
3538 if (pvar->name) {
3539 tvar->name = strdup(pvar->name);
3540 if (tvar->name == NULL)
3541 return -ENOMEM;
3542 } else
3543 tvar->name = NULL;
3544 return 0;