Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * probe-event.c : perf-probe definition to probe_events format converter
4 *
5 * Written by Masami Hiramatsu <mhiramat@redhat.com>
6 */
7
8#include <inttypes.h>
9#include <sys/utsname.h>
10#include <sys/types.h>
11#include <sys/stat.h>
12#include <fcntl.h>
13#include <errno.h>
14#include <stdio.h>
15#include <unistd.h>
16#include <stdlib.h>
17#include <string.h>
18#include <stdarg.h>
19#include <limits.h>
20#include <elf.h>
21
22#include "build-id.h"
23#include "event.h"
24#include "namespaces.h"
25#include "strlist.h"
26#include "strfilter.h"
27#include "debug.h"
28#include "dso.h"
29#include "color.h"
30#include "map.h"
31#include "maps.h"
32#include "symbol.h"
33#include <api/fs/fs.h>
34#include "trace-event.h" /* For __maybe_unused */
35#include "probe-event.h"
36#include "probe-finder.h"
37#include "probe-file.h"
38#include "session.h"
39#include "string2.h"
40#include "strbuf.h"
41
42#include <subcmd/pager.h>
43#include <linux/ctype.h>
44#include <linux/zalloc.h>
45
46#define PERFPROBE_GROUP "probe"
47
48bool probe_event_dry_run; /* Dry run flag */
49struct probe_conf probe_conf = { .magic_num = DEFAULT_PROBE_MAGIC_NUM };
50
51#define semantic_error(msg ...) pr_err("Semantic error :" msg)
52
53int e_snprintf(char *str, size_t size, const char *format, ...)
54{
55 int ret;
56 va_list ap;
57 va_start(ap, format);
58 ret = vsnprintf(str, size, format, ap);
59 va_end(ap);
60 if (ret >= (int)size)
61 ret = -E2BIG;
62 return ret;
63}
64
65static struct machine *host_machine;
66
67/* Initialize symbol maps and path of vmlinux/modules */
68int init_probe_symbol_maps(bool user_only)
69{
70 int ret;
71
72 symbol_conf.sort_by_name = true;
73 symbol_conf.allow_aliases = true;
74 ret = symbol__init(NULL);
75 if (ret < 0) {
76 pr_debug("Failed to init symbol map.\n");
77 goto out;
78 }
79
80 if (host_machine || user_only) /* already initialized */
81 return 0;
82
83 if (symbol_conf.vmlinux_name)
84 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
85
86 host_machine = machine__new_host();
87 if (!host_machine) {
88 pr_debug("machine__new_host() failed.\n");
89 symbol__exit();
90 ret = -1;
91 }
92out:
93 if (ret < 0)
94 pr_warning("Failed to init vmlinux path.\n");
95 return ret;
96}
97
98void exit_probe_symbol_maps(void)
99{
100 machine__delete(host_machine);
101 host_machine = NULL;
102 symbol__exit();
103}
104
105static struct ref_reloc_sym *kernel_get_ref_reloc_sym(struct map **pmap)
106{
107 /* kmap->ref_reloc_sym should be set if host_machine is initialized */
108 struct kmap *kmap;
109 struct map *map = machine__kernel_map(host_machine);
110
111 if (map__load(map) < 0)
112 return NULL;
113
114 kmap = map__kmap(map);
115 if (!kmap)
116 return NULL;
117
118 if (pmap)
119 *pmap = map;
120
121 return kmap->ref_reloc_sym;
122}
123
124static int kernel_get_symbol_address_by_name(const char *name, u64 *addr,
125 bool reloc, bool reladdr)
126{
127 struct ref_reloc_sym *reloc_sym;
128 struct symbol *sym;
129 struct map *map;
130
131 /* ref_reloc_sym is just a label. Need a special fix*/
132 reloc_sym = kernel_get_ref_reloc_sym(NULL);
133 if (reloc_sym && strcmp(name, reloc_sym->name) == 0)
134 *addr = (reloc) ? reloc_sym->addr : reloc_sym->unrelocated_addr;
135 else {
136 sym = machine__find_kernel_symbol_by_name(host_machine, name, &map);
137 if (!sym)
138 return -ENOENT;
139 *addr = map->unmap_ip(map, sym->start) -
140 ((reloc) ? 0 : map->reloc) -
141 ((reladdr) ? map->start : 0);
142 }
143 return 0;
144}
145
146static struct map *kernel_get_module_map(const char *module)
147{
148 struct maps *maps = machine__kernel_maps(host_machine);
149 struct map *pos;
150
151 /* A file path -- this is an offline module */
152 if (module && strchr(module, '/'))
153 return dso__new_map(module);
154
155 if (!module) {
156 pos = machine__kernel_map(host_machine);
157 return map__get(pos);
158 }
159
160 maps__for_each_entry(maps, pos) {
161 /* short_name is "[module]" */
162 if (strncmp(pos->dso->short_name + 1, module,
163 pos->dso->short_name_len - 2) == 0 &&
164 module[pos->dso->short_name_len - 2] == '\0') {
165 return map__get(pos);
166 }
167 }
168 return NULL;
169}
170
171struct map *get_target_map(const char *target, struct nsinfo *nsi, bool user)
172{
173 /* Init maps of given executable or kernel */
174 if (user) {
175 struct map *map;
176
177 map = dso__new_map(target);
178 if (map && map->dso)
179 map->dso->nsinfo = nsinfo__get(nsi);
180 return map;
181 } else {
182 return kernel_get_module_map(target);
183 }
184}
185
186static int convert_exec_to_group(const char *exec, char **result)
187{
188 char *ptr1, *ptr2, *exec_copy;
189 char buf[64];
190 int ret;
191
192 exec_copy = strdup(exec);
193 if (!exec_copy)
194 return -ENOMEM;
195
196 ptr1 = basename(exec_copy);
197 if (!ptr1) {
198 ret = -EINVAL;
199 goto out;
200 }
201
202 for (ptr2 = ptr1; *ptr2 != '\0'; ptr2++) {
203 if (!isalnum(*ptr2) && *ptr2 != '_') {
204 *ptr2 = '\0';
205 break;
206 }
207 }
208
209 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
210 if (ret < 0)
211 goto out;
212
213 *result = strdup(buf);
214 ret = *result ? 0 : -ENOMEM;
215
216out:
217 free(exec_copy);
218 return ret;
219}
220
221static void clear_perf_probe_point(struct perf_probe_point *pp)
222{
223 zfree(&pp->file);
224 zfree(&pp->function);
225 zfree(&pp->lazy_line);
226}
227
228static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
229{
230 int i;
231
232 for (i = 0; i < ntevs; i++)
233 clear_probe_trace_event(tevs + i);
234}
235
236static bool kprobe_blacklist__listed(unsigned long address);
237static bool kprobe_warn_out_range(const char *symbol, unsigned long address)
238{
239 struct map *map;
240 bool ret = false;
241
242 map = kernel_get_module_map(NULL);
243 if (map) {
244 ret = address <= map->start || map->end < address;
245 if (ret)
246 pr_warning("%s is out of .text, skip it.\n", symbol);
247 map__put(map);
248 }
249 if (!ret && kprobe_blacklist__listed(address)) {
250 pr_warning("%s is blacklisted function, skip it.\n", symbol);
251 ret = true;
252 }
253
254 return ret;
255}
256
257/*
258 * @module can be module name of module file path. In case of path,
259 * inspect elf and find out what is actual module name.
260 * Caller has to free mod_name after using it.
261 */
262static char *find_module_name(const char *module)
263{
264 int fd;
265 Elf *elf;
266 GElf_Ehdr ehdr;
267 GElf_Shdr shdr;
268 Elf_Data *data;
269 Elf_Scn *sec;
270 char *mod_name = NULL;
271 int name_offset;
272
273 fd = open(module, O_RDONLY);
274 if (fd < 0)
275 return NULL;
276
277 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
278 if (elf == NULL)
279 goto elf_err;
280
281 if (gelf_getehdr(elf, &ehdr) == NULL)
282 goto ret_err;
283
284 sec = elf_section_by_name(elf, &ehdr, &shdr,
285 ".gnu.linkonce.this_module", NULL);
286 if (!sec)
287 goto ret_err;
288
289 data = elf_getdata(sec, NULL);
290 if (!data || !data->d_buf)
291 goto ret_err;
292
293 /*
294 * NOTE:
295 * '.gnu.linkonce.this_module' section of kernel module elf directly
296 * maps to 'struct module' from linux/module.h. This section contains
297 * actual module name which will be used by kernel after loading it.
298 * But, we cannot use 'struct module' here since linux/module.h is not
299 * exposed to user-space. Offset of 'name' has remained same from long
300 * time, so hardcoding it here.
301 */
302 if (ehdr.e_ident[EI_CLASS] == ELFCLASS32)
303 name_offset = 12;
304 else /* expect ELFCLASS64 by default */
305 name_offset = 24;
306
307 mod_name = strdup((char *)data->d_buf + name_offset);
308
309ret_err:
310 elf_end(elf);
311elf_err:
312 close(fd);
313 return mod_name;
314}
315
316#ifdef HAVE_DWARF_SUPPORT
317
318static int kernel_get_module_dso(const char *module, struct dso **pdso)
319{
320 struct dso *dso;
321 struct map *map;
322 const char *vmlinux_name;
323 int ret = 0;
324
325 if (module) {
326 char module_name[128];
327
328 snprintf(module_name, sizeof(module_name), "[%s]", module);
329 map = maps__find_by_name(&host_machine->kmaps, module_name);
330 if (map) {
331 dso = map->dso;
332 goto found;
333 }
334 pr_debug("Failed to find module %s.\n", module);
335 return -ENOENT;
336 }
337
338 map = machine__kernel_map(host_machine);
339 dso = map->dso;
340
341 vmlinux_name = symbol_conf.vmlinux_name;
342 dso->load_errno = 0;
343 if (vmlinux_name)
344 ret = dso__load_vmlinux(dso, map, vmlinux_name, false);
345 else
346 ret = dso__load_vmlinux_path(dso, map);
347found:
348 *pdso = dso;
349 return ret;
350}
351
352/*
353 * Some binaries like glibc have special symbols which are on the symbol
354 * table, but not in the debuginfo. If we can find the address of the
355 * symbol from map, we can translate the address back to the probe point.
356 */
357static int find_alternative_probe_point(struct debuginfo *dinfo,
358 struct perf_probe_point *pp,
359 struct perf_probe_point *result,
360 const char *target, struct nsinfo *nsi,
361 bool uprobes)
362{
363 struct map *map = NULL;
364 struct symbol *sym;
365 u64 address = 0;
366 int ret = -ENOENT;
367
368 /* This can work only for function-name based one */
369 if (!pp->function || pp->file)
370 return -ENOTSUP;
371
372 map = get_target_map(target, nsi, uprobes);
373 if (!map)
374 return -EINVAL;
375
376 /* Find the address of given function */
377 map__for_each_symbol_by_name(map, pp->function, sym) {
378 if (uprobes) {
379 address = sym->start;
380 if (sym->type == STT_GNU_IFUNC)
381 pr_warning("Warning: The probe function (%s) is a GNU indirect function.\n"
382 "Consider identifying the final function used at run time and set the probe directly on that.\n",
383 pp->function);
384 } else
385 address = map->unmap_ip(map, sym->start) - map->reloc;
386 break;
387 }
388 if (!address) {
389 ret = -ENOENT;
390 goto out;
391 }
392 pr_debug("Symbol %s address found : %" PRIx64 "\n",
393 pp->function, address);
394
395 ret = debuginfo__find_probe_point(dinfo, (unsigned long)address,
396 result);
397 if (ret <= 0)
398 ret = (!ret) ? -ENOENT : ret;
399 else {
400 result->offset += pp->offset;
401 result->line += pp->line;
402 result->retprobe = pp->retprobe;
403 ret = 0;
404 }
405
406out:
407 map__put(map);
408 return ret;
409
410}
411
412static int get_alternative_probe_event(struct debuginfo *dinfo,
413 struct perf_probe_event *pev,
414 struct perf_probe_point *tmp)
415{
416 int ret;
417
418 memcpy(tmp, &pev->point, sizeof(*tmp));
419 memset(&pev->point, 0, sizeof(pev->point));
420 ret = find_alternative_probe_point(dinfo, tmp, &pev->point, pev->target,
421 pev->nsi, pev->uprobes);
422 if (ret < 0)
423 memcpy(&pev->point, tmp, sizeof(*tmp));
424
425 return ret;
426}
427
428static int get_alternative_line_range(struct debuginfo *dinfo,
429 struct line_range *lr,
430 const char *target, bool user)
431{
432 struct perf_probe_point pp = { .function = lr->function,
433 .file = lr->file,
434 .line = lr->start };
435 struct perf_probe_point result;
436 int ret, len = 0;
437
438 memset(&result, 0, sizeof(result));
439
440 if (lr->end != INT_MAX)
441 len = lr->end - lr->start;
442 ret = find_alternative_probe_point(dinfo, &pp, &result,
443 target, NULL, user);
444 if (!ret) {
445 lr->function = result.function;
446 lr->file = result.file;
447 lr->start = result.line;
448 if (lr->end != INT_MAX)
449 lr->end = lr->start + len;
450 clear_perf_probe_point(&pp);
451 }
452 return ret;
453}
454
455/* Open new debuginfo of given module */
456static struct debuginfo *open_debuginfo(const char *module, struct nsinfo *nsi,
457 bool silent)
458{
459 const char *path = module;
460 char reason[STRERR_BUFSIZE];
461 struct debuginfo *ret = NULL;
462 struct dso *dso = NULL;
463 struct nscookie nsc;
464 int err;
465
466 if (!module || !strchr(module, '/')) {
467 err = kernel_get_module_dso(module, &dso);
468 if (err < 0) {
469 if (!dso || dso->load_errno == 0) {
470 if (!str_error_r(-err, reason, STRERR_BUFSIZE))
471 strcpy(reason, "(unknown)");
472 } else
473 dso__strerror_load(dso, reason, STRERR_BUFSIZE);
474 if (!silent) {
475 if (module)
476 pr_err("Module %s is not loaded, please specify its full path name.\n", module);
477 else
478 pr_err("Failed to find the path for the kernel: %s\n", reason);
479 }
480 return NULL;
481 }
482 path = dso->long_name;
483 }
484 nsinfo__mountns_enter(nsi, &nsc);
485 ret = debuginfo__new(path);
486 if (!ret && !silent) {
487 pr_warning("The %s file has no debug information.\n", path);
488 if (!module || !strtailcmp(path, ".ko"))
489 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
490 else
491 pr_warning("Rebuild with -g, ");
492 pr_warning("or install an appropriate debuginfo package.\n");
493 }
494 nsinfo__mountns_exit(&nsc);
495 return ret;
496}
497
498/* For caching the last debuginfo */
499static struct debuginfo *debuginfo_cache;
500static char *debuginfo_cache_path;
501
502static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
503{
504 const char *path = module;
505
506 /* If the module is NULL, it should be the kernel. */
507 if (!module)
508 path = "kernel";
509
510 if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path))
511 goto out;
512
513 /* Copy module path */
514 free(debuginfo_cache_path);
515 debuginfo_cache_path = strdup(path);
516 if (!debuginfo_cache_path) {
517 debuginfo__delete(debuginfo_cache);
518 debuginfo_cache = NULL;
519 goto out;
520 }
521
522 debuginfo_cache = open_debuginfo(module, NULL, silent);
523 if (!debuginfo_cache)
524 zfree(&debuginfo_cache_path);
525out:
526 return debuginfo_cache;
527}
528
529static void debuginfo_cache__exit(void)
530{
531 debuginfo__delete(debuginfo_cache);
532 debuginfo_cache = NULL;
533 zfree(&debuginfo_cache_path);
534}
535
536
537static int get_text_start_address(const char *exec, unsigned long *address,
538 struct nsinfo *nsi)
539{
540 Elf *elf;
541 GElf_Ehdr ehdr;
542 GElf_Shdr shdr;
543 int fd, ret = -ENOENT;
544 struct nscookie nsc;
545
546 nsinfo__mountns_enter(nsi, &nsc);
547 fd = open(exec, O_RDONLY);
548 nsinfo__mountns_exit(&nsc);
549 if (fd < 0)
550 return -errno;
551
552 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
553 if (elf == NULL) {
554 ret = -EINVAL;
555 goto out_close;
556 }
557
558 if (gelf_getehdr(elf, &ehdr) == NULL)
559 goto out;
560
561 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
562 goto out;
563
564 *address = shdr.sh_addr - shdr.sh_offset;
565 ret = 0;
566out:
567 elf_end(elf);
568out_close:
569 close(fd);
570
571 return ret;
572}
573
574/*
575 * Convert trace point to probe point with debuginfo
576 */
577static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
578 struct perf_probe_point *pp,
579 bool is_kprobe)
580{
581 struct debuginfo *dinfo = NULL;
582 unsigned long stext = 0;
583 u64 addr = tp->address;
584 int ret = -ENOENT;
585
586 /* convert the address to dwarf address */
587 if (!is_kprobe) {
588 if (!addr) {
589 ret = -EINVAL;
590 goto error;
591 }
592 ret = get_text_start_address(tp->module, &stext, NULL);
593 if (ret < 0)
594 goto error;
595 addr += stext;
596 } else if (tp->symbol) {
597 /* If the module is given, this returns relative address */
598 ret = kernel_get_symbol_address_by_name(tp->symbol, &addr,
599 false, !!tp->module);
600 if (ret != 0)
601 goto error;
602 addr += tp->offset;
603 }
604
605 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
606 tp->module ? : "kernel");
607
608 dinfo = debuginfo_cache__open(tp->module, verbose <= 0);
609 if (dinfo)
610 ret = debuginfo__find_probe_point(dinfo,
611 (unsigned long)addr, pp);
612 else
613 ret = -ENOENT;
614
615 if (ret > 0) {
616 pp->retprobe = tp->retprobe;
617 return 0;
618 }
619error:
620 pr_debug("Failed to find corresponding probes from debuginfo.\n");
621 return ret ? : -ENOENT;
622}
623
624/* Adjust symbol name and address */
625static int post_process_probe_trace_point(struct probe_trace_point *tp,
626 struct map *map, unsigned long offs)
627{
628 struct symbol *sym;
629 u64 addr = tp->address - offs;
630
631 sym = map__find_symbol(map, addr);
632 if (!sym)
633 return -ENOENT;
634
635 if (strcmp(sym->name, tp->symbol)) {
636 /* If we have no realname, use symbol for it */
637 if (!tp->realname)
638 tp->realname = tp->symbol;
639 else
640 free(tp->symbol);
641 tp->symbol = strdup(sym->name);
642 if (!tp->symbol)
643 return -ENOMEM;
644 }
645 tp->offset = addr - sym->start;
646 tp->address -= offs;
647
648 return 0;
649}
650
651/*
652 * Rename DWARF symbols to ELF symbols -- gcc sometimes optimizes functions
653 * and generate new symbols with suffixes such as .constprop.N or .isra.N
654 * etc. Since those symbols are not recorded in DWARF, we have to find
655 * correct generated symbols from offline ELF binary.
656 * For online kernel or uprobes we don't need this because those are
657 * rebased on _text, or already a section relative address.
658 */
659static int
660post_process_offline_probe_trace_events(struct probe_trace_event *tevs,
661 int ntevs, const char *pathname)
662{
663 struct map *map;
664 unsigned long stext = 0;
665 int i, ret = 0;
666
667 /* Prepare a map for offline binary */
668 map = dso__new_map(pathname);
669 if (!map || get_text_start_address(pathname, &stext, NULL) < 0) {
670 pr_warning("Failed to get ELF symbols for %s\n", pathname);
671 return -EINVAL;
672 }
673
674 for (i = 0; i < ntevs; i++) {
675 ret = post_process_probe_trace_point(&tevs[i].point,
676 map, stext);
677 if (ret < 0)
678 break;
679 }
680 map__put(map);
681
682 return ret;
683}
684
685static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
686 int ntevs, const char *exec,
687 struct nsinfo *nsi)
688{
689 int i, ret = 0;
690 unsigned long stext = 0;
691
692 if (!exec)
693 return 0;
694
695 ret = get_text_start_address(exec, &stext, nsi);
696 if (ret < 0)
697 return ret;
698
699 for (i = 0; i < ntevs && ret >= 0; i++) {
700 /* point.address is the address of point.symbol + point.offset */
701 tevs[i].point.address -= stext;
702 tevs[i].point.module = strdup(exec);
703 if (!tevs[i].point.module) {
704 ret = -ENOMEM;
705 break;
706 }
707 tevs[i].uprobes = true;
708 }
709
710 return ret;
711}
712
713static int
714post_process_module_probe_trace_events(struct probe_trace_event *tevs,
715 int ntevs, const char *module,
716 struct debuginfo *dinfo)
717{
718 Dwarf_Addr text_offs = 0;
719 int i, ret = 0;
720 char *mod_name = NULL;
721 struct map *map;
722
723 if (!module)
724 return 0;
725
726 map = get_target_map(module, NULL, false);
727 if (!map || debuginfo__get_text_offset(dinfo, &text_offs, true) < 0) {
728 pr_warning("Failed to get ELF symbols for %s\n", module);
729 return -EINVAL;
730 }
731
732 mod_name = find_module_name(module);
733 for (i = 0; i < ntevs; i++) {
734 ret = post_process_probe_trace_point(&tevs[i].point,
735 map, (unsigned long)text_offs);
736 if (ret < 0)
737 break;
738 tevs[i].point.module =
739 strdup(mod_name ? mod_name : module);
740 if (!tevs[i].point.module) {
741 ret = -ENOMEM;
742 break;
743 }
744 }
745
746 free(mod_name);
747 map__put(map);
748
749 return ret;
750}
751
752static int
753post_process_kernel_probe_trace_events(struct probe_trace_event *tevs,
754 int ntevs)
755{
756 struct ref_reloc_sym *reloc_sym;
757 struct map *map;
758 char *tmp;
759 int i, skipped = 0;
760
761 /* Skip post process if the target is an offline kernel */
762 if (symbol_conf.ignore_vmlinux_buildid)
763 return post_process_offline_probe_trace_events(tevs, ntevs,
764 symbol_conf.vmlinux_name);
765
766 reloc_sym = kernel_get_ref_reloc_sym(&map);
767 if (!reloc_sym) {
768 pr_warning("Relocated base symbol is not found!\n");
769 return -EINVAL;
770 }
771
772 for (i = 0; i < ntevs; i++) {
773 if (!tevs[i].point.address)
774 continue;
775 if (tevs[i].point.retprobe && !kretprobe_offset_is_supported())
776 continue;
777 /*
778 * If we found a wrong one, mark it by NULL symbol.
779 * Since addresses in debuginfo is same as objdump, we need
780 * to convert it to addresses on memory.
781 */
782 if (kprobe_warn_out_range(tevs[i].point.symbol,
783 map__objdump_2mem(map, tevs[i].point.address))) {
784 tmp = NULL;
785 skipped++;
786 } else {
787 tmp = strdup(reloc_sym->name);
788 if (!tmp)
789 return -ENOMEM;
790 }
791 /* If we have no realname, use symbol for it */
792 if (!tevs[i].point.realname)
793 tevs[i].point.realname = tevs[i].point.symbol;
794 else
795 free(tevs[i].point.symbol);
796 tevs[i].point.symbol = tmp;
797 tevs[i].point.offset = tevs[i].point.address -
798 reloc_sym->unrelocated_addr;
799 }
800 return skipped;
801}
802
803void __weak
804arch__post_process_probe_trace_events(struct perf_probe_event *pev __maybe_unused,
805 int ntevs __maybe_unused)
806{
807}
808
809/* Post processing the probe events */
810static int post_process_probe_trace_events(struct perf_probe_event *pev,
811 struct probe_trace_event *tevs,
812 int ntevs, const char *module,
813 bool uprobe, struct debuginfo *dinfo)
814{
815 int ret;
816
817 if (uprobe)
818 ret = add_exec_to_probe_trace_events(tevs, ntevs, module,
819 pev->nsi);
820 else if (module)
821 /* Currently ref_reloc_sym based probe is not for drivers */
822 ret = post_process_module_probe_trace_events(tevs, ntevs,
823 module, dinfo);
824 else
825 ret = post_process_kernel_probe_trace_events(tevs, ntevs);
826
827 if (ret >= 0)
828 arch__post_process_probe_trace_events(pev, ntevs);
829
830 return ret;
831}
832
833/* Try to find perf_probe_event with debuginfo */
834static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
835 struct probe_trace_event **tevs)
836{
837 bool need_dwarf = perf_probe_event_need_dwarf(pev);
838 struct perf_probe_point tmp;
839 struct debuginfo *dinfo;
840 int ntevs, ret = 0;
841
842 dinfo = open_debuginfo(pev->target, pev->nsi, !need_dwarf);
843 if (!dinfo) {
844 if (need_dwarf)
845 return -ENOENT;
846 pr_debug("Could not open debuginfo. Try to use symbols.\n");
847 return 0;
848 }
849
850 pr_debug("Try to find probe point from debuginfo.\n");
851 /* Searching trace events corresponding to a probe event */
852 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
853
854 if (ntevs == 0) { /* Not found, retry with an alternative */
855 ret = get_alternative_probe_event(dinfo, pev, &tmp);
856 if (!ret) {
857 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
858 /*
859 * Write back to the original probe_event for
860 * setting appropriate (user given) event name
861 */
862 clear_perf_probe_point(&pev->point);
863 memcpy(&pev->point, &tmp, sizeof(tmp));
864 }
865 }
866
867 if (ntevs > 0) { /* Succeeded to find trace events */
868 pr_debug("Found %d probe_trace_events.\n", ntevs);
869 ret = post_process_probe_trace_events(pev, *tevs, ntevs,
870 pev->target, pev->uprobes, dinfo);
871 if (ret < 0 || ret == ntevs) {
872 pr_debug("Post processing failed or all events are skipped. (%d)\n", ret);
873 clear_probe_trace_events(*tevs, ntevs);
874 zfree(tevs);
875 ntevs = 0;
876 }
877 }
878
879 debuginfo__delete(dinfo);
880
881 if (ntevs == 0) { /* No error but failed to find probe point. */
882 pr_warning("Probe point '%s' not found.\n",
883 synthesize_perf_probe_point(&pev->point));
884 return -ENOENT;
885 } else if (ntevs < 0) {
886 /* Error path : ntevs < 0 */
887 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
888 if (ntevs == -EBADF)
889 pr_warning("Warning: No dwarf info found in the vmlinux - "
890 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
891 if (!need_dwarf) {
892 pr_debug("Trying to use symbols.\n");
893 return 0;
894 }
895 }
896 return ntevs;
897}
898
899#define LINEBUF_SIZE 256
900#define NR_ADDITIONAL_LINES 2
901
902static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
903{
904 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
905 const char *color = show_num ? "" : PERF_COLOR_BLUE;
906 const char *prefix = NULL;
907
908 do {
909 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
910 goto error;
911 if (skip)
912 continue;
913 if (!prefix) {
914 prefix = show_num ? "%7d " : " ";
915 color_fprintf(stdout, color, prefix, l);
916 }
917 color_fprintf(stdout, color, "%s", buf);
918
919 } while (strchr(buf, '\n') == NULL);
920
921 return 1;
922error:
923 if (ferror(fp)) {
924 pr_warning("File read error: %s\n",
925 str_error_r(errno, sbuf, sizeof(sbuf)));
926 return -1;
927 }
928 return 0;
929}
930
931static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
932{
933 int rv = __show_one_line(fp, l, skip, show_num);
934 if (rv == 0) {
935 pr_warning("Source file is shorter than expected.\n");
936 rv = -1;
937 }
938 return rv;
939}
940
941#define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
942#define show_one_line(f,l) _show_one_line(f,l,false,false)
943#define skip_one_line(f,l) _show_one_line(f,l,true,false)
944#define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
945
946/*
947 * Show line-range always requires debuginfo to find source file and
948 * line number.
949 */
950static int __show_line_range(struct line_range *lr, const char *module,
951 bool user)
952{
953 int l = 1;
954 struct int_node *ln;
955 struct debuginfo *dinfo;
956 FILE *fp;
957 int ret;
958 char *tmp;
959 char sbuf[STRERR_BUFSIZE];
960
961 /* Search a line range */
962 dinfo = open_debuginfo(module, NULL, false);
963 if (!dinfo)
964 return -ENOENT;
965
966 ret = debuginfo__find_line_range(dinfo, lr);
967 if (!ret) { /* Not found, retry with an alternative */
968 ret = get_alternative_line_range(dinfo, lr, module, user);
969 if (!ret)
970 ret = debuginfo__find_line_range(dinfo, lr);
971 }
972 debuginfo__delete(dinfo);
973 if (ret == 0 || ret == -ENOENT) {
974 pr_warning("Specified source line is not found.\n");
975 return -ENOENT;
976 } else if (ret < 0) {
977 pr_warning("Debuginfo analysis failed.\n");
978 return ret;
979 }
980
981 /* Convert source file path */
982 tmp = lr->path;
983 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
984
985 /* Free old path when new path is assigned */
986 if (tmp != lr->path)
987 free(tmp);
988
989 if (ret < 0) {
990 pr_warning("Failed to find source file path.\n");
991 return ret;
992 }
993
994 setup_pager();
995
996 if (lr->function)
997 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
998 lr->start - lr->offset);
999 else
1000 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
1001
1002 fp = fopen(lr->path, "r");
1003 if (fp == NULL) {
1004 pr_warning("Failed to open %s: %s\n", lr->path,
1005 str_error_r(errno, sbuf, sizeof(sbuf)));
1006 return -errno;
1007 }
1008 /* Skip to starting line number */
1009 while (l < lr->start) {
1010 ret = skip_one_line(fp, l++);
1011 if (ret < 0)
1012 goto end;
1013 }
1014
1015 intlist__for_each_entry(ln, lr->line_list) {
1016 for (; ln->i > l; l++) {
1017 ret = show_one_line(fp, l - lr->offset);
1018 if (ret < 0)
1019 goto end;
1020 }
1021 ret = show_one_line_with_num(fp, l++ - lr->offset);
1022 if (ret < 0)
1023 goto end;
1024 }
1025
1026 if (lr->end == INT_MAX)
1027 lr->end = l + NR_ADDITIONAL_LINES;
1028 while (l <= lr->end) {
1029 ret = show_one_line_or_eof(fp, l++ - lr->offset);
1030 if (ret <= 0)
1031 break;
1032 }
1033end:
1034 fclose(fp);
1035 return ret;
1036}
1037
1038int show_line_range(struct line_range *lr, const char *module,
1039 struct nsinfo *nsi, bool user)
1040{
1041 int ret;
1042 struct nscookie nsc;
1043
1044 ret = init_probe_symbol_maps(user);
1045 if (ret < 0)
1046 return ret;
1047 nsinfo__mountns_enter(nsi, &nsc);
1048 ret = __show_line_range(lr, module, user);
1049 nsinfo__mountns_exit(&nsc);
1050 exit_probe_symbol_maps();
1051
1052 return ret;
1053}
1054
1055static int show_available_vars_at(struct debuginfo *dinfo,
1056 struct perf_probe_event *pev,
1057 struct strfilter *_filter)
1058{
1059 char *buf;
1060 int ret, i, nvars;
1061 struct str_node *node;
1062 struct variable_list *vls = NULL, *vl;
1063 struct perf_probe_point tmp;
1064 const char *var;
1065
1066 buf = synthesize_perf_probe_point(&pev->point);
1067 if (!buf)
1068 return -EINVAL;
1069 pr_debug("Searching variables at %s\n", buf);
1070
1071 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
1072 if (!ret) { /* Not found, retry with an alternative */
1073 ret = get_alternative_probe_event(dinfo, pev, &tmp);
1074 if (!ret) {
1075 ret = debuginfo__find_available_vars_at(dinfo, pev,
1076 &vls);
1077 /* Release the old probe_point */
1078 clear_perf_probe_point(&tmp);
1079 }
1080 }
1081 if (ret <= 0) {
1082 if (ret == 0 || ret == -ENOENT) {
1083 pr_err("Failed to find the address of %s\n", buf);
1084 ret = -ENOENT;
1085 } else
1086 pr_warning("Debuginfo analysis failed.\n");
1087 goto end;
1088 }
1089
1090 /* Some variables are found */
1091 fprintf(stdout, "Available variables at %s\n", buf);
1092 for (i = 0; i < ret; i++) {
1093 vl = &vls[i];
1094 /*
1095 * A probe point might be converted to
1096 * several trace points.
1097 */
1098 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
1099 vl->point.offset);
1100 zfree(&vl->point.symbol);
1101 nvars = 0;
1102 if (vl->vars) {
1103 strlist__for_each_entry(node, vl->vars) {
1104 var = strchr(node->s, '\t') + 1;
1105 if (strfilter__compare(_filter, var)) {
1106 fprintf(stdout, "\t\t%s\n", node->s);
1107 nvars++;
1108 }
1109 }
1110 strlist__delete(vl->vars);
1111 }
1112 if (nvars == 0)
1113 fprintf(stdout, "\t\t(No matched variables)\n");
1114 }
1115 free(vls);
1116end:
1117 free(buf);
1118 return ret;
1119}
1120
1121/* Show available variables on given probe point */
1122int show_available_vars(struct perf_probe_event *pevs, int npevs,
1123 struct strfilter *_filter)
1124{
1125 int i, ret = 0;
1126 struct debuginfo *dinfo;
1127
1128 ret = init_probe_symbol_maps(pevs->uprobes);
1129 if (ret < 0)
1130 return ret;
1131
1132 dinfo = open_debuginfo(pevs->target, pevs->nsi, false);
1133 if (!dinfo) {
1134 ret = -ENOENT;
1135 goto out;
1136 }
1137
1138 setup_pager();
1139
1140 for (i = 0; i < npevs && ret >= 0; i++)
1141 ret = show_available_vars_at(dinfo, &pevs[i], _filter);
1142
1143 debuginfo__delete(dinfo);
1144out:
1145 exit_probe_symbol_maps();
1146 return ret;
1147}
1148
1149#else /* !HAVE_DWARF_SUPPORT */
1150
1151static void debuginfo_cache__exit(void)
1152{
1153}
1154
1155static int
1156find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
1157 struct perf_probe_point *pp __maybe_unused,
1158 bool is_kprobe __maybe_unused)
1159{
1160 return -ENOSYS;
1161}
1162
1163static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
1164 struct probe_trace_event **tevs __maybe_unused)
1165{
1166 if (perf_probe_event_need_dwarf(pev)) {
1167 pr_warning("Debuginfo-analysis is not supported.\n");
1168 return -ENOSYS;
1169 }
1170
1171 return 0;
1172}
1173
1174int show_line_range(struct line_range *lr __maybe_unused,
1175 const char *module __maybe_unused,
1176 struct nsinfo *nsi __maybe_unused,
1177 bool user __maybe_unused)
1178{
1179 pr_warning("Debuginfo-analysis is not supported.\n");
1180 return -ENOSYS;
1181}
1182
1183int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1184 int npevs __maybe_unused,
1185 struct strfilter *filter __maybe_unused)
1186{
1187 pr_warning("Debuginfo-analysis is not supported.\n");
1188 return -ENOSYS;
1189}
1190#endif
1191
1192void line_range__clear(struct line_range *lr)
1193{
1194 zfree(&lr->function);
1195 zfree(&lr->file);
1196 zfree(&lr->path);
1197 zfree(&lr->comp_dir);
1198 intlist__delete(lr->line_list);
1199}
1200
1201int line_range__init(struct line_range *lr)
1202{
1203 memset(lr, 0, sizeof(*lr));
1204 lr->line_list = intlist__new(NULL);
1205 if (!lr->line_list)
1206 return -ENOMEM;
1207 else
1208 return 0;
1209}
1210
1211static int parse_line_num(char **ptr, int *val, const char *what)
1212{
1213 const char *start = *ptr;
1214
1215 errno = 0;
1216 *val = strtol(*ptr, ptr, 0);
1217 if (errno || *ptr == start) {
1218 semantic_error("'%s' is not a valid number.\n", what);
1219 return -EINVAL;
1220 }
1221 return 0;
1222}
1223
1224/* Check the name is good for event, group or function */
1225static bool is_c_func_name(const char *name)
1226{
1227 if (!isalpha(*name) && *name != '_')
1228 return false;
1229 while (*++name != '\0') {
1230 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1231 return false;
1232 }
1233 return true;
1234}
1235
1236/*
1237 * Stuff 'lr' according to the line range described by 'arg'.
1238 * The line range syntax is described by:
1239 *
1240 * SRC[:SLN[+NUM|-ELN]]
1241 * FNC[@SRC][:SLN[+NUM|-ELN]]
1242 */
1243int parse_line_range_desc(const char *arg, struct line_range *lr)
1244{
1245 char *range, *file, *name = strdup(arg);
1246 int err;
1247
1248 if (!name)
1249 return -ENOMEM;
1250
1251 lr->start = 0;
1252 lr->end = INT_MAX;
1253
1254 range = strchr(name, ':');
1255 if (range) {
1256 *range++ = '\0';
1257
1258 err = parse_line_num(&range, &lr->start, "start line");
1259 if (err)
1260 goto err;
1261
1262 if (*range == '+' || *range == '-') {
1263 const char c = *range++;
1264
1265 err = parse_line_num(&range, &lr->end, "end line");
1266 if (err)
1267 goto err;
1268
1269 if (c == '+') {
1270 lr->end += lr->start;
1271 /*
1272 * Adjust the number of lines here.
1273 * If the number of lines == 1, the
1274 * the end of line should be equal to
1275 * the start of line.
1276 */
1277 lr->end--;
1278 }
1279 }
1280
1281 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1282
1283 err = -EINVAL;
1284 if (lr->start > lr->end) {
1285 semantic_error("Start line must be smaller"
1286 " than end line.\n");
1287 goto err;
1288 }
1289 if (*range != '\0') {
1290 semantic_error("Tailing with invalid str '%s'.\n", range);
1291 goto err;
1292 }
1293 }
1294
1295 file = strchr(name, '@');
1296 if (file) {
1297 *file = '\0';
1298 lr->file = strdup(++file);
1299 if (lr->file == NULL) {
1300 err = -ENOMEM;
1301 goto err;
1302 }
1303 lr->function = name;
1304 } else if (strchr(name, '/') || strchr(name, '.'))
1305 lr->file = name;
1306 else if (is_c_func_name(name))/* We reuse it for checking funcname */
1307 lr->function = name;
1308 else { /* Invalid name */
1309 semantic_error("'%s' is not a valid function name.\n", name);
1310 err = -EINVAL;
1311 goto err;
1312 }
1313
1314 return 0;
1315err:
1316 free(name);
1317 return err;
1318}
1319
1320static int parse_perf_probe_event_name(char **arg, struct perf_probe_event *pev)
1321{
1322 char *ptr;
1323
1324 ptr = strpbrk_esc(*arg, ":");
1325 if (ptr) {
1326 *ptr = '\0';
1327 if (!pev->sdt && !is_c_func_name(*arg))
1328 goto ng_name;
1329 pev->group = strdup_esc(*arg);
1330 if (!pev->group)
1331 return -ENOMEM;
1332 *arg = ptr + 1;
1333 } else
1334 pev->group = NULL;
1335
1336 pev->event = strdup_esc(*arg);
1337 if (pev->event == NULL)
1338 return -ENOMEM;
1339
1340 if (!pev->sdt && !is_c_func_name(pev->event)) {
1341 zfree(&pev->event);
1342ng_name:
1343 zfree(&pev->group);
1344 semantic_error("%s is bad for event name -it must "
1345 "follow C symbol-naming rule.\n", *arg);
1346 return -EINVAL;
1347 }
1348 return 0;
1349}
1350
1351/* Parse probepoint definition. */
1352static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1353{
1354 struct perf_probe_point *pp = &pev->point;
1355 char *ptr, *tmp;
1356 char c, nc = 0;
1357 bool file_spec = false;
1358 int ret;
1359
1360 /*
1361 * <Syntax>
1362 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN]
1363 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1364 * perf probe %[GRP:]SDT_EVENT
1365 */
1366 if (!arg)
1367 return -EINVAL;
1368
1369 if (is_sdt_event(arg)) {
1370 pev->sdt = true;
1371 if (arg[0] == '%')
1372 arg++;
1373 }
1374
1375 ptr = strpbrk_esc(arg, ";=@+%");
1376 if (pev->sdt) {
1377 if (ptr) {
1378 if (*ptr != '@') {
1379 semantic_error("%s must be an SDT name.\n",
1380 arg);
1381 return -EINVAL;
1382 }
1383 /* This must be a target file name or build id */
1384 tmp = build_id_cache__complement(ptr + 1);
1385 if (tmp) {
1386 pev->target = build_id_cache__origname(tmp);
1387 free(tmp);
1388 } else
1389 pev->target = strdup_esc(ptr + 1);
1390 if (!pev->target)
1391 return -ENOMEM;
1392 *ptr = '\0';
1393 }
1394 ret = parse_perf_probe_event_name(&arg, pev);
1395 if (ret == 0) {
1396 if (asprintf(&pev->point.function, "%%%s", pev->event) < 0)
1397 ret = -errno;
1398 }
1399 return ret;
1400 }
1401
1402 if (ptr && *ptr == '=') { /* Event name */
1403 *ptr = '\0';
1404 tmp = ptr + 1;
1405 ret = parse_perf_probe_event_name(&arg, pev);
1406 if (ret < 0)
1407 return ret;
1408
1409 arg = tmp;
1410 }
1411
1412 /*
1413 * Check arg is function or file name and copy it.
1414 *
1415 * We consider arg to be a file spec if and only if it satisfies
1416 * all of the below criteria::
1417 * - it does not include any of "+@%",
1418 * - it includes one of ":;", and
1419 * - it has a period '.' in the name.
1420 *
1421 * Otherwise, we consider arg to be a function specification.
1422 */
1423 if (!strpbrk_esc(arg, "+@%")) {
1424 ptr = strpbrk_esc(arg, ";:");
1425 /* This is a file spec if it includes a '.' before ; or : */
1426 if (ptr && memchr(arg, '.', ptr - arg))
1427 file_spec = true;
1428 }
1429
1430 ptr = strpbrk_esc(arg, ";:+@%");
1431 if (ptr) {
1432 nc = *ptr;
1433 *ptr++ = '\0';
1434 }
1435
1436 if (arg[0] == '\0')
1437 tmp = NULL;
1438 else {
1439 tmp = strdup_esc(arg);
1440 if (tmp == NULL)
1441 return -ENOMEM;
1442 }
1443
1444 if (file_spec)
1445 pp->file = tmp;
1446 else {
1447 pp->function = tmp;
1448
1449 /*
1450 * Keep pp->function even if this is absolute address,
1451 * so it can mark whether abs_address is valid.
1452 * Which make 'perf probe lib.bin 0x0' possible.
1453 *
1454 * Note that checking length of tmp is not needed
1455 * because when we access tmp[1] we know tmp[0] is '0',
1456 * so tmp[1] should always valid (but could be '\0').
1457 */
1458 if (tmp && !strncmp(tmp, "0x", 2)) {
1459 pp->abs_address = strtoul(pp->function, &tmp, 0);
1460 if (*tmp != '\0') {
1461 semantic_error("Invalid absolute address.\n");
1462 return -EINVAL;
1463 }
1464 }
1465 }
1466
1467 /* Parse other options */
1468 while (ptr) {
1469 arg = ptr;
1470 c = nc;
1471 if (c == ';') { /* Lazy pattern must be the last part */
1472 pp->lazy_line = strdup(arg); /* let leave escapes */
1473 if (pp->lazy_line == NULL)
1474 return -ENOMEM;
1475 break;
1476 }
1477 ptr = strpbrk_esc(arg, ";:+@%");
1478 if (ptr) {
1479 nc = *ptr;
1480 *ptr++ = '\0';
1481 }
1482 switch (c) {
1483 case ':': /* Line number */
1484 pp->line = strtoul(arg, &tmp, 0);
1485 if (*tmp != '\0') {
1486 semantic_error("There is non-digit char"
1487 " in line number.\n");
1488 return -EINVAL;
1489 }
1490 break;
1491 case '+': /* Byte offset from a symbol */
1492 pp->offset = strtoul(arg, &tmp, 0);
1493 if (*tmp != '\0') {
1494 semantic_error("There is non-digit character"
1495 " in offset.\n");
1496 return -EINVAL;
1497 }
1498 break;
1499 case '@': /* File name */
1500 if (pp->file) {
1501 semantic_error("SRC@SRC is not allowed.\n");
1502 return -EINVAL;
1503 }
1504 pp->file = strdup_esc(arg);
1505 if (pp->file == NULL)
1506 return -ENOMEM;
1507 break;
1508 case '%': /* Probe places */
1509 if (strcmp(arg, "return") == 0) {
1510 pp->retprobe = 1;
1511 } else { /* Others not supported yet */
1512 semantic_error("%%%s is not supported.\n", arg);
1513 return -ENOTSUP;
1514 }
1515 break;
1516 default: /* Buggy case */
1517 pr_err("This program has a bug at %s:%d.\n",
1518 __FILE__, __LINE__);
1519 return -ENOTSUP;
1520 break;
1521 }
1522 }
1523
1524 /* Exclusion check */
1525 if (pp->lazy_line && pp->line) {
1526 semantic_error("Lazy pattern can't be used with"
1527 " line number.\n");
1528 return -EINVAL;
1529 }
1530
1531 if (pp->lazy_line && pp->offset) {
1532 semantic_error("Lazy pattern can't be used with offset.\n");
1533 return -EINVAL;
1534 }
1535
1536 if (pp->line && pp->offset) {
1537 semantic_error("Offset can't be used with line number.\n");
1538 return -EINVAL;
1539 }
1540
1541 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1542 semantic_error("File always requires line number or "
1543 "lazy pattern.\n");
1544 return -EINVAL;
1545 }
1546
1547 if (pp->offset && !pp->function) {
1548 semantic_error("Offset requires an entry function.\n");
1549 return -EINVAL;
1550 }
1551
1552 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1553 semantic_error("Offset/Line/Lazy pattern can't be used with "
1554 "return probe.\n");
1555 return -EINVAL;
1556 }
1557
1558 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1559 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1560 pp->lazy_line);
1561 return 0;
1562}
1563
1564/* Parse perf-probe event argument */
1565static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1566{
1567 char *tmp, *goodname;
1568 struct perf_probe_arg_field **fieldp;
1569
1570 pr_debug("parsing arg: %s into ", str);
1571
1572 tmp = strchr(str, '=');
1573 if (tmp) {
1574 arg->name = strndup(str, tmp - str);
1575 if (arg->name == NULL)
1576 return -ENOMEM;
1577 pr_debug("name:%s ", arg->name);
1578 str = tmp + 1;
1579 }
1580
1581 tmp = strchr(str, '@');
1582 if (tmp && tmp != str && !strcmp(tmp + 1, "user")) { /* user attr */
1583 if (!user_access_is_supported()) {
1584 semantic_error("ftrace does not support user access\n");
1585 return -EINVAL;
1586 }
1587 *tmp = '\0';
1588 arg->user_access = true;
1589 pr_debug("user_access ");
1590 }
1591
1592 tmp = strchr(str, ':');
1593 if (tmp) { /* Type setting */
1594 *tmp = '\0';
1595 arg->type = strdup(tmp + 1);
1596 if (arg->type == NULL)
1597 return -ENOMEM;
1598 pr_debug("type:%s ", arg->type);
1599 }
1600
1601 tmp = strpbrk(str, "-.[");
1602 if (!is_c_varname(str) || !tmp) {
1603 /* A variable, register, symbol or special value */
1604 arg->var = strdup(str);
1605 if (arg->var == NULL)
1606 return -ENOMEM;
1607 pr_debug("%s\n", arg->var);
1608 return 0;
1609 }
1610
1611 /* Structure fields or array element */
1612 arg->var = strndup(str, tmp - str);
1613 if (arg->var == NULL)
1614 return -ENOMEM;
1615 goodname = arg->var;
1616 pr_debug("%s, ", arg->var);
1617 fieldp = &arg->field;
1618
1619 do {
1620 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1621 if (*fieldp == NULL)
1622 return -ENOMEM;
1623 if (*tmp == '[') { /* Array */
1624 str = tmp;
1625 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1626 (*fieldp)->ref = true;
1627 if (*tmp != ']' || tmp == str + 1) {
1628 semantic_error("Array index must be a"
1629 " number.\n");
1630 return -EINVAL;
1631 }
1632 tmp++;
1633 if (*tmp == '\0')
1634 tmp = NULL;
1635 } else { /* Structure */
1636 if (*tmp == '.') {
1637 str = tmp + 1;
1638 (*fieldp)->ref = false;
1639 } else if (tmp[1] == '>') {
1640 str = tmp + 2;
1641 (*fieldp)->ref = true;
1642 } else {
1643 semantic_error("Argument parse error: %s\n",
1644 str);
1645 return -EINVAL;
1646 }
1647 tmp = strpbrk(str, "-.[");
1648 }
1649 if (tmp) {
1650 (*fieldp)->name = strndup(str, tmp - str);
1651 if ((*fieldp)->name == NULL)
1652 return -ENOMEM;
1653 if (*str != '[')
1654 goodname = (*fieldp)->name;
1655 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1656 fieldp = &(*fieldp)->next;
1657 }
1658 } while (tmp);
1659 (*fieldp)->name = strdup(str);
1660 if ((*fieldp)->name == NULL)
1661 return -ENOMEM;
1662 if (*str != '[')
1663 goodname = (*fieldp)->name;
1664 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1665
1666 /* If no name is specified, set the last field name (not array index)*/
1667 if (!arg->name) {
1668 arg->name = strdup(goodname);
1669 if (arg->name == NULL)
1670 return -ENOMEM;
1671 }
1672 return 0;
1673}
1674
1675/* Parse perf-probe event command */
1676int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1677{
1678 char **argv;
1679 int argc, i, ret = 0;
1680
1681 argv = argv_split(cmd, &argc);
1682 if (!argv) {
1683 pr_debug("Failed to split arguments.\n");
1684 return -ENOMEM;
1685 }
1686 if (argc - 1 > MAX_PROBE_ARGS) {
1687 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1688 ret = -ERANGE;
1689 goto out;
1690 }
1691 /* Parse probe point */
1692 ret = parse_perf_probe_point(argv[0], pev);
1693 if (ret < 0)
1694 goto out;
1695
1696 /* Generate event name if needed */
1697 if (!pev->event && pev->point.function && pev->point.line
1698 && !pev->point.lazy_line && !pev->point.offset) {
1699 if (asprintf(&pev->event, "%s_L%d", pev->point.function,
1700 pev->point.line) < 0)
1701 return -ENOMEM;
1702 }
1703
1704 /* Copy arguments and ensure return probe has no C argument */
1705 pev->nargs = argc - 1;
1706 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1707 if (pev->args == NULL) {
1708 ret = -ENOMEM;
1709 goto out;
1710 }
1711 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1712 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1713 if (ret >= 0 &&
1714 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1715 semantic_error("You can't specify local variable for"
1716 " kretprobe.\n");
1717 ret = -EINVAL;
1718 }
1719 }
1720out:
1721 argv_free(argv);
1722
1723 return ret;
1724}
1725
1726/* Returns true if *any* ARG is either C variable, $params or $vars. */
1727bool perf_probe_with_var(struct perf_probe_event *pev)
1728{
1729 int i = 0;
1730
1731 for (i = 0; i < pev->nargs; i++)
1732 if (is_c_varname(pev->args[i].var) ||
1733 !strcmp(pev->args[i].var, PROBE_ARG_PARAMS) ||
1734 !strcmp(pev->args[i].var, PROBE_ARG_VARS))
1735 return true;
1736 return false;
1737}
1738
1739/* Return true if this perf_probe_event requires debuginfo */
1740bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1741{
1742 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1743 return true;
1744
1745 if (perf_probe_with_var(pev))
1746 return true;
1747
1748 return false;
1749}
1750
1751/* Parse probe_events event into struct probe_point */
1752int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1753{
1754 struct probe_trace_point *tp = &tev->point;
1755 char pr;
1756 char *p;
1757 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1758 int ret, i, argc;
1759 char **argv;
1760
1761 pr_debug("Parsing probe_events: %s\n", cmd);
1762 argv = argv_split(cmd, &argc);
1763 if (!argv) {
1764 pr_debug("Failed to split arguments.\n");
1765 return -ENOMEM;
1766 }
1767 if (argc < 2) {
1768 semantic_error("Too few probe arguments.\n");
1769 ret = -ERANGE;
1770 goto out;
1771 }
1772
1773 /* Scan event and group name. */
1774 argv0_str = strdup(argv[0]);
1775 if (argv0_str == NULL) {
1776 ret = -ENOMEM;
1777 goto out;
1778 }
1779 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1780 fmt2_str = strtok_r(NULL, "/", &fmt);
1781 fmt3_str = strtok_r(NULL, " \t", &fmt);
1782 if (fmt1_str == NULL || fmt2_str == NULL || fmt3_str == NULL) {
1783 semantic_error("Failed to parse event name: %s\n", argv[0]);
1784 ret = -EINVAL;
1785 goto out;
1786 }
1787 pr = fmt1_str[0];
1788 tev->group = strdup(fmt2_str);
1789 tev->event = strdup(fmt3_str);
1790 if (tev->group == NULL || tev->event == NULL) {
1791 ret = -ENOMEM;
1792 goto out;
1793 }
1794 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1795
1796 tp->retprobe = (pr == 'r');
1797
1798 /* Scan module name(if there), function name and offset */
1799 p = strchr(argv[1], ':');
1800 if (p) {
1801 tp->module = strndup(argv[1], p - argv[1]);
1802 if (!tp->module) {
1803 ret = -ENOMEM;
1804 goto out;
1805 }
1806 tev->uprobes = (tp->module[0] == '/');
1807 p++;
1808 } else
1809 p = argv[1];
1810 fmt1_str = strtok_r(p, "+", &fmt);
1811 /* only the address started with 0x */
1812 if (fmt1_str[0] == '0') {
1813 /*
1814 * Fix a special case:
1815 * if address == 0, kernel reports something like:
1816 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1817 * Newer kernel may fix that, but we want to
1818 * support old kernel also.
1819 */
1820 if (strcmp(fmt1_str, "0x") == 0) {
1821 if (!argv[2] || strcmp(argv[2], "(null)")) {
1822 ret = -EINVAL;
1823 goto out;
1824 }
1825 tp->address = 0;
1826
1827 free(argv[2]);
1828 for (i = 2; argv[i + 1] != NULL; i++)
1829 argv[i] = argv[i + 1];
1830
1831 argv[i] = NULL;
1832 argc -= 1;
1833 } else
1834 tp->address = strtoul(fmt1_str, NULL, 0);
1835 } else {
1836 /* Only the symbol-based probe has offset */
1837 tp->symbol = strdup(fmt1_str);
1838 if (tp->symbol == NULL) {
1839 ret = -ENOMEM;
1840 goto out;
1841 }
1842 fmt2_str = strtok_r(NULL, "", &fmt);
1843 if (fmt2_str == NULL)
1844 tp->offset = 0;
1845 else
1846 tp->offset = strtoul(fmt2_str, NULL, 10);
1847 }
1848
1849 if (tev->uprobes) {
1850 fmt2_str = strchr(p, '(');
1851 if (fmt2_str)
1852 tp->ref_ctr_offset = strtoul(fmt2_str + 1, NULL, 0);
1853 }
1854
1855 tev->nargs = argc - 2;
1856 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1857 if (tev->args == NULL) {
1858 ret = -ENOMEM;
1859 goto out;
1860 }
1861 for (i = 0; i < tev->nargs; i++) {
1862 p = strchr(argv[i + 2], '=');
1863 if (p) /* We don't need which register is assigned. */
1864 *p++ = '\0';
1865 else
1866 p = argv[i + 2];
1867 tev->args[i].name = strdup(argv[i + 2]);
1868 /* TODO: parse regs and offset */
1869 tev->args[i].value = strdup(p);
1870 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1871 ret = -ENOMEM;
1872 goto out;
1873 }
1874 }
1875 ret = 0;
1876out:
1877 free(argv0_str);
1878 argv_free(argv);
1879 return ret;
1880}
1881
1882/* Compose only probe arg */
1883char *synthesize_perf_probe_arg(struct perf_probe_arg *pa)
1884{
1885 struct perf_probe_arg_field *field = pa->field;
1886 struct strbuf buf;
1887 char *ret = NULL;
1888 int err;
1889
1890 if (strbuf_init(&buf, 64) < 0)
1891 return NULL;
1892
1893 if (pa->name && pa->var)
1894 err = strbuf_addf(&buf, "%s=%s", pa->name, pa->var);
1895 else
1896 err = strbuf_addstr(&buf, pa->name ?: pa->var);
1897 if (err)
1898 goto out;
1899
1900 while (field) {
1901 if (field->name[0] == '[')
1902 err = strbuf_addstr(&buf, field->name);
1903 else
1904 err = strbuf_addf(&buf, "%s%s", field->ref ? "->" : ".",
1905 field->name);
1906 field = field->next;
1907 if (err)
1908 goto out;
1909 }
1910
1911 if (pa->type)
1912 if (strbuf_addf(&buf, ":%s", pa->type) < 0)
1913 goto out;
1914
1915 ret = strbuf_detach(&buf, NULL);
1916out:
1917 strbuf_release(&buf);
1918 return ret;
1919}
1920
1921/* Compose only probe point (not argument) */
1922char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1923{
1924 struct strbuf buf;
1925 char *tmp, *ret = NULL;
1926 int len, err = 0;
1927
1928 if (strbuf_init(&buf, 64) < 0)
1929 return NULL;
1930
1931 if (pp->function) {
1932 if (strbuf_addstr(&buf, pp->function) < 0)
1933 goto out;
1934 if (pp->offset)
1935 err = strbuf_addf(&buf, "+%lu", pp->offset);
1936 else if (pp->line)
1937 err = strbuf_addf(&buf, ":%d", pp->line);
1938 else if (pp->retprobe)
1939 err = strbuf_addstr(&buf, "%return");
1940 if (err)
1941 goto out;
1942 }
1943 if (pp->file) {
1944 tmp = pp->file;
1945 len = strlen(tmp);
1946 if (len > 30) {
1947 tmp = strchr(pp->file + len - 30, '/');
1948 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1949 }
1950 err = strbuf_addf(&buf, "@%s", tmp);
1951 if (!err && !pp->function && pp->line)
1952 err = strbuf_addf(&buf, ":%d", pp->line);
1953 }
1954 if (!err)
1955 ret = strbuf_detach(&buf, NULL);
1956out:
1957 strbuf_release(&buf);
1958 return ret;
1959}
1960
1961char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1962{
1963 struct strbuf buf;
1964 char *tmp, *ret = NULL;
1965 int i;
1966
1967 if (strbuf_init(&buf, 64))
1968 return NULL;
1969 if (pev->event)
1970 if (strbuf_addf(&buf, "%s:%s=", pev->group ?: PERFPROBE_GROUP,
1971 pev->event) < 0)
1972 goto out;
1973
1974 tmp = synthesize_perf_probe_point(&pev->point);
1975 if (!tmp || strbuf_addstr(&buf, tmp) < 0)
1976 goto out;
1977 free(tmp);
1978
1979 for (i = 0; i < pev->nargs; i++) {
1980 tmp = synthesize_perf_probe_arg(pev->args + i);
1981 if (!tmp || strbuf_addf(&buf, " %s", tmp) < 0)
1982 goto out;
1983 free(tmp);
1984 }
1985
1986 ret = strbuf_detach(&buf, NULL);
1987out:
1988 strbuf_release(&buf);
1989 return ret;
1990}
1991
1992static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1993 struct strbuf *buf, int depth)
1994{
1995 int err;
1996 if (ref->next) {
1997 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1998 depth + 1);
1999 if (depth < 0)
2000 return depth;
2001 }
2002 if (ref->user_access)
2003 err = strbuf_addf(buf, "%s%ld(", "+u", ref->offset);
2004 else
2005 err = strbuf_addf(buf, "%+ld(", ref->offset);
2006 return (err < 0) ? err : depth;
2007}
2008
2009static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
2010 struct strbuf *buf)
2011{
2012 struct probe_trace_arg_ref *ref = arg->ref;
2013 int depth = 0, err;
2014
2015 /* Argument name or separator */
2016 if (arg->name)
2017 err = strbuf_addf(buf, " %s=", arg->name);
2018 else
2019 err = strbuf_addch(buf, ' ');
2020 if (err)
2021 return err;
2022
2023 /* Special case: @XXX */
2024 if (arg->value[0] == '@' && arg->ref)
2025 ref = ref->next;
2026
2027 /* Dereferencing arguments */
2028 if (ref) {
2029 depth = __synthesize_probe_trace_arg_ref(ref, buf, 1);
2030 if (depth < 0)
2031 return depth;
2032 }
2033
2034 /* Print argument value */
2035 if (arg->value[0] == '@' && arg->ref)
2036 err = strbuf_addf(buf, "%s%+ld", arg->value, arg->ref->offset);
2037 else
2038 err = strbuf_addstr(buf, arg->value);
2039
2040 /* Closing */
2041 while (!err && depth--)
2042 err = strbuf_addch(buf, ')');
2043
2044 /* Print argument type */
2045 if (!err && arg->type)
2046 err = strbuf_addf(buf, ":%s", arg->type);
2047
2048 return err;
2049}
2050
2051static int
2052synthesize_uprobe_trace_def(struct probe_trace_event *tev, struct strbuf *buf)
2053{
2054 struct probe_trace_point *tp = &tev->point;
2055 int err;
2056
2057 err = strbuf_addf(buf, "%s:0x%lx", tp->module, tp->address);
2058
2059 if (err >= 0 && tp->ref_ctr_offset) {
2060 if (!uprobe_ref_ctr_is_supported())
2061 return -1;
2062 err = strbuf_addf(buf, "(0x%lx)", tp->ref_ctr_offset);
2063 }
2064 return err >= 0 ? 0 : -1;
2065}
2066
2067char *synthesize_probe_trace_command(struct probe_trace_event *tev)
2068{
2069 struct probe_trace_point *tp = &tev->point;
2070 struct strbuf buf;
2071 char *ret = NULL;
2072 int i, err;
2073
2074 /* Uprobes must have tp->module */
2075 if (tev->uprobes && !tp->module)
2076 return NULL;
2077
2078 if (strbuf_init(&buf, 32) < 0)
2079 return NULL;
2080
2081 if (strbuf_addf(&buf, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
2082 tev->group, tev->event) < 0)
2083 goto error;
2084 /*
2085 * If tp->address == 0, then this point must be a
2086 * absolute address uprobe.
2087 * try_to_find_absolute_address() should have made
2088 * tp->symbol to "0x0".
2089 */
2090 if (tev->uprobes && !tp->address) {
2091 if (!tp->symbol || strcmp(tp->symbol, "0x0"))
2092 goto error;
2093 }
2094
2095 /* Use the tp->address for uprobes */
2096 if (tev->uprobes) {
2097 err = synthesize_uprobe_trace_def(tev, &buf);
2098 } else if (!strncmp(tp->symbol, "0x", 2)) {
2099 /* Absolute address. See try_to_find_absolute_address() */
2100 err = strbuf_addf(&buf, "%s%s0x%lx", tp->module ?: "",
2101 tp->module ? ":" : "", tp->address);
2102 } else {
2103 err = strbuf_addf(&buf, "%s%s%s+%lu", tp->module ?: "",
2104 tp->module ? ":" : "", tp->symbol, tp->offset);
2105 }
2106
2107 if (err)
2108 goto error;
2109
2110 for (i = 0; i < tev->nargs; i++)
2111 if (synthesize_probe_trace_arg(&tev->args[i], &buf) < 0)
2112 goto error;
2113
2114 ret = strbuf_detach(&buf, NULL);
2115error:
2116 strbuf_release(&buf);
2117 return ret;
2118}
2119
2120static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
2121 struct perf_probe_point *pp,
2122 bool is_kprobe)
2123{
2124 struct symbol *sym = NULL;
2125 struct map *map = NULL;
2126 u64 addr = tp->address;
2127 int ret = -ENOENT;
2128
2129 if (!is_kprobe) {
2130 map = dso__new_map(tp->module);
2131 if (!map)
2132 goto out;
2133 sym = map__find_symbol(map, addr);
2134 } else {
2135 if (tp->symbol && !addr) {
2136 if (kernel_get_symbol_address_by_name(tp->symbol,
2137 &addr, true, false) < 0)
2138 goto out;
2139 }
2140 if (addr) {
2141 addr += tp->offset;
2142 sym = machine__find_kernel_symbol(host_machine, addr, &map);
2143 }
2144 }
2145
2146 if (!sym)
2147 goto out;
2148
2149 pp->retprobe = tp->retprobe;
2150 pp->offset = addr - map->unmap_ip(map, sym->start);
2151 pp->function = strdup(sym->name);
2152 ret = pp->function ? 0 : -ENOMEM;
2153
2154out:
2155 if (map && !is_kprobe) {
2156 map__put(map);
2157 }
2158
2159 return ret;
2160}
2161
2162static int convert_to_perf_probe_point(struct probe_trace_point *tp,
2163 struct perf_probe_point *pp,
2164 bool is_kprobe)
2165{
2166 char buf[128];
2167 int ret;
2168
2169 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
2170 if (!ret)
2171 return 0;
2172 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
2173 if (!ret)
2174 return 0;
2175
2176 pr_debug("Failed to find probe point from both of dwarf and map.\n");
2177
2178 if (tp->symbol) {
2179 pp->function = strdup(tp->symbol);
2180 pp->offset = tp->offset;
2181 } else {
2182 ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address);
2183 if (ret < 0)
2184 return ret;
2185 pp->function = strdup(buf);
2186 pp->offset = 0;
2187 }
2188 if (pp->function == NULL)
2189 return -ENOMEM;
2190
2191 pp->retprobe = tp->retprobe;
2192
2193 return 0;
2194}
2195
2196static int convert_to_perf_probe_event(struct probe_trace_event *tev,
2197 struct perf_probe_event *pev, bool is_kprobe)
2198{
2199 struct strbuf buf = STRBUF_INIT;
2200 int i, ret;
2201
2202 /* Convert event/group name */
2203 pev->event = strdup(tev->event);
2204 pev->group = strdup(tev->group);
2205 if (pev->event == NULL || pev->group == NULL)
2206 return -ENOMEM;
2207
2208 /* Convert trace_point to probe_point */
2209 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
2210 if (ret < 0)
2211 return ret;
2212
2213 /* Convert trace_arg to probe_arg */
2214 pev->nargs = tev->nargs;
2215 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
2216 if (pev->args == NULL)
2217 return -ENOMEM;
2218 for (i = 0; i < tev->nargs && ret >= 0; i++) {
2219 if (tev->args[i].name)
2220 pev->args[i].name = strdup(tev->args[i].name);
2221 else {
2222 if ((ret = strbuf_init(&buf, 32)) < 0)
2223 goto error;
2224 ret = synthesize_probe_trace_arg(&tev->args[i], &buf);
2225 pev->args[i].name = strbuf_detach(&buf, NULL);
2226 }
2227 if (pev->args[i].name == NULL && ret >= 0)
2228 ret = -ENOMEM;
2229 }
2230error:
2231 if (ret < 0)
2232 clear_perf_probe_event(pev);
2233
2234 return ret;
2235}
2236
2237void clear_perf_probe_event(struct perf_probe_event *pev)
2238{
2239 struct perf_probe_arg_field *field, *next;
2240 int i;
2241
2242 zfree(&pev->event);
2243 zfree(&pev->group);
2244 zfree(&pev->target);
2245 clear_perf_probe_point(&pev->point);
2246
2247 for (i = 0; i < pev->nargs; i++) {
2248 zfree(&pev->args[i].name);
2249 zfree(&pev->args[i].var);
2250 zfree(&pev->args[i].type);
2251 field = pev->args[i].field;
2252 while (field) {
2253 next = field->next;
2254 zfree(&field->name);
2255 free(field);
2256 field = next;
2257 }
2258 }
2259 pev->nargs = 0;
2260 zfree(&pev->args);
2261}
2262
2263#define strdup_or_goto(str, label) \
2264({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; })
2265
2266static int perf_probe_point__copy(struct perf_probe_point *dst,
2267 struct perf_probe_point *src)
2268{
2269 dst->file = strdup_or_goto(src->file, out_err);
2270 dst->function = strdup_or_goto(src->function, out_err);
2271 dst->lazy_line = strdup_or_goto(src->lazy_line, out_err);
2272 dst->line = src->line;
2273 dst->retprobe = src->retprobe;
2274 dst->offset = src->offset;
2275 return 0;
2276
2277out_err:
2278 clear_perf_probe_point(dst);
2279 return -ENOMEM;
2280}
2281
2282static int perf_probe_arg__copy(struct perf_probe_arg *dst,
2283 struct perf_probe_arg *src)
2284{
2285 struct perf_probe_arg_field *field, **ppfield;
2286
2287 dst->name = strdup_or_goto(src->name, out_err);
2288 dst->var = strdup_or_goto(src->var, out_err);
2289 dst->type = strdup_or_goto(src->type, out_err);
2290
2291 field = src->field;
2292 ppfield = &(dst->field);
2293 while (field) {
2294 *ppfield = zalloc(sizeof(*field));
2295 if (!*ppfield)
2296 goto out_err;
2297 (*ppfield)->name = strdup_or_goto(field->name, out_err);
2298 (*ppfield)->index = field->index;
2299 (*ppfield)->ref = field->ref;
2300 field = field->next;
2301 ppfield = &((*ppfield)->next);
2302 }
2303 return 0;
2304out_err:
2305 return -ENOMEM;
2306}
2307
2308int perf_probe_event__copy(struct perf_probe_event *dst,
2309 struct perf_probe_event *src)
2310{
2311 int i;
2312
2313 dst->event = strdup_or_goto(src->event, out_err);
2314 dst->group = strdup_or_goto(src->group, out_err);
2315 dst->target = strdup_or_goto(src->target, out_err);
2316 dst->uprobes = src->uprobes;
2317
2318 if (perf_probe_point__copy(&dst->point, &src->point) < 0)
2319 goto out_err;
2320
2321 dst->args = zalloc(sizeof(struct perf_probe_arg) * src->nargs);
2322 if (!dst->args)
2323 goto out_err;
2324 dst->nargs = src->nargs;
2325
2326 for (i = 0; i < src->nargs; i++)
2327 if (perf_probe_arg__copy(&dst->args[i], &src->args[i]) < 0)
2328 goto out_err;
2329 return 0;
2330
2331out_err:
2332 clear_perf_probe_event(dst);
2333 return -ENOMEM;
2334}
2335
2336void clear_probe_trace_event(struct probe_trace_event *tev)
2337{
2338 struct probe_trace_arg_ref *ref, *next;
2339 int i;
2340
2341 zfree(&tev->event);
2342 zfree(&tev->group);
2343 zfree(&tev->point.symbol);
2344 zfree(&tev->point.realname);
2345 zfree(&tev->point.module);
2346 for (i = 0; i < tev->nargs; i++) {
2347 zfree(&tev->args[i].name);
2348 zfree(&tev->args[i].value);
2349 zfree(&tev->args[i].type);
2350 ref = tev->args[i].ref;
2351 while (ref) {
2352 next = ref->next;
2353 free(ref);
2354 ref = next;
2355 }
2356 }
2357 zfree(&tev->args);
2358 tev->nargs = 0;
2359}
2360
2361struct kprobe_blacklist_node {
2362 struct list_head list;
2363 unsigned long start;
2364 unsigned long end;
2365 char *symbol;
2366};
2367
2368static void kprobe_blacklist__delete(struct list_head *blacklist)
2369{
2370 struct kprobe_blacklist_node *node;
2371
2372 while (!list_empty(blacklist)) {
2373 node = list_first_entry(blacklist,
2374 struct kprobe_blacklist_node, list);
2375 list_del_init(&node->list);
2376 zfree(&node->symbol);
2377 free(node);
2378 }
2379}
2380
2381static int kprobe_blacklist__load(struct list_head *blacklist)
2382{
2383 struct kprobe_blacklist_node *node;
2384 const char *__debugfs = debugfs__mountpoint();
2385 char buf[PATH_MAX], *p;
2386 FILE *fp;
2387 int ret;
2388
2389 if (__debugfs == NULL)
2390 return -ENOTSUP;
2391
2392 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
2393 if (ret < 0)
2394 return ret;
2395
2396 fp = fopen(buf, "r");
2397 if (!fp)
2398 return -errno;
2399
2400 ret = 0;
2401 while (fgets(buf, PATH_MAX, fp)) {
2402 node = zalloc(sizeof(*node));
2403 if (!node) {
2404 ret = -ENOMEM;
2405 break;
2406 }
2407 INIT_LIST_HEAD(&node->list);
2408 list_add_tail(&node->list, blacklist);
2409 if (sscanf(buf, "0x%lx-0x%lx", &node->start, &node->end) != 2) {
2410 ret = -EINVAL;
2411 break;
2412 }
2413 p = strchr(buf, '\t');
2414 if (p) {
2415 p++;
2416 if (p[strlen(p) - 1] == '\n')
2417 p[strlen(p) - 1] = '\0';
2418 } else
2419 p = (char *)"unknown";
2420 node->symbol = strdup(p);
2421 if (!node->symbol) {
2422 ret = -ENOMEM;
2423 break;
2424 }
2425 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
2426 node->start, node->end, node->symbol);
2427 ret++;
2428 }
2429 if (ret < 0)
2430 kprobe_blacklist__delete(blacklist);
2431 fclose(fp);
2432
2433 return ret;
2434}
2435
2436static struct kprobe_blacklist_node *
2437kprobe_blacklist__find_by_address(struct list_head *blacklist,
2438 unsigned long address)
2439{
2440 struct kprobe_blacklist_node *node;
2441
2442 list_for_each_entry(node, blacklist, list) {
2443 if (node->start <= address && address < node->end)
2444 return node;
2445 }
2446
2447 return NULL;
2448}
2449
2450static LIST_HEAD(kprobe_blacklist);
2451
2452static void kprobe_blacklist__init(void)
2453{
2454 if (!list_empty(&kprobe_blacklist))
2455 return;
2456
2457 if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
2458 pr_debug("No kprobe blacklist support, ignored\n");
2459}
2460
2461static void kprobe_blacklist__release(void)
2462{
2463 kprobe_blacklist__delete(&kprobe_blacklist);
2464}
2465
2466static bool kprobe_blacklist__listed(unsigned long address)
2467{
2468 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
2469}
2470
2471static int perf_probe_event__sprintf(const char *group, const char *event,
2472 struct perf_probe_event *pev,
2473 const char *module,
2474 struct strbuf *result)
2475{
2476 int i, ret;
2477 char *buf;
2478
2479 if (asprintf(&buf, "%s:%s", group, event) < 0)
2480 return -errno;
2481 ret = strbuf_addf(result, " %-20s (on ", buf);
2482 free(buf);
2483 if (ret)
2484 return ret;
2485
2486 /* Synthesize only event probe point */
2487 buf = synthesize_perf_probe_point(&pev->point);
2488 if (!buf)
2489 return -ENOMEM;
2490 ret = strbuf_addstr(result, buf);
2491 free(buf);
2492
2493 if (!ret && module)
2494 ret = strbuf_addf(result, " in %s", module);
2495
2496 if (!ret && pev->nargs > 0) {
2497 ret = strbuf_add(result, " with", 5);
2498 for (i = 0; !ret && i < pev->nargs; i++) {
2499 buf = synthesize_perf_probe_arg(&pev->args[i]);
2500 if (!buf)
2501 return -ENOMEM;
2502 ret = strbuf_addf(result, " %s", buf);
2503 free(buf);
2504 }
2505 }
2506 if (!ret)
2507 ret = strbuf_addch(result, ')');
2508
2509 return ret;
2510}
2511
2512/* Show an event */
2513int show_perf_probe_event(const char *group, const char *event,
2514 struct perf_probe_event *pev,
2515 const char *module, bool use_stdout)
2516{
2517 struct strbuf buf = STRBUF_INIT;
2518 int ret;
2519
2520 ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2521 if (ret >= 0) {
2522 if (use_stdout)
2523 printf("%s\n", buf.buf);
2524 else
2525 pr_info("%s\n", buf.buf);
2526 }
2527 strbuf_release(&buf);
2528
2529 return ret;
2530}
2531
2532static bool filter_probe_trace_event(struct probe_trace_event *tev,
2533 struct strfilter *filter)
2534{
2535 char tmp[128];
2536
2537 /* At first, check the event name itself */
2538 if (strfilter__compare(filter, tev->event))
2539 return true;
2540
2541 /* Next, check the combination of name and group */
2542 if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0)
2543 return false;
2544 return strfilter__compare(filter, tmp);
2545}
2546
2547static int __show_perf_probe_events(int fd, bool is_kprobe,
2548 struct strfilter *filter)
2549{
2550 int ret = 0;
2551 struct probe_trace_event tev;
2552 struct perf_probe_event pev;
2553 struct strlist *rawlist;
2554 struct str_node *ent;
2555
2556 memset(&tev, 0, sizeof(tev));
2557 memset(&pev, 0, sizeof(pev));
2558
2559 rawlist = probe_file__get_rawlist(fd);
2560 if (!rawlist)
2561 return -ENOMEM;
2562
2563 strlist__for_each_entry(ent, rawlist) {
2564 ret = parse_probe_trace_command(ent->s, &tev);
2565 if (ret >= 0) {
2566 if (!filter_probe_trace_event(&tev, filter))
2567 goto next;
2568 ret = convert_to_perf_probe_event(&tev, &pev,
2569 is_kprobe);
2570 if (ret < 0)
2571 goto next;
2572 ret = show_perf_probe_event(pev.group, pev.event,
2573 &pev, tev.point.module,
2574 true);
2575 }
2576next:
2577 clear_perf_probe_event(&pev);
2578 clear_probe_trace_event(&tev);
2579 if (ret < 0)
2580 break;
2581 }
2582 strlist__delete(rawlist);
2583 /* Cleanup cached debuginfo if needed */
2584 debuginfo_cache__exit();
2585
2586 return ret;
2587}
2588
2589/* List up current perf-probe events */
2590int show_perf_probe_events(struct strfilter *filter)
2591{
2592 int kp_fd, up_fd, ret;
2593
2594 setup_pager();
2595
2596 if (probe_conf.cache)
2597 return probe_cache__show_all_caches(filter);
2598
2599 ret = init_probe_symbol_maps(false);
2600 if (ret < 0)
2601 return ret;
2602
2603 ret = probe_file__open_both(&kp_fd, &up_fd, 0);
2604 if (ret < 0)
2605 return ret;
2606
2607 if (kp_fd >= 0)
2608 ret = __show_perf_probe_events(kp_fd, true, filter);
2609 if (up_fd >= 0 && ret >= 0)
2610 ret = __show_perf_probe_events(up_fd, false, filter);
2611 if (kp_fd > 0)
2612 close(kp_fd);
2613 if (up_fd > 0)
2614 close(up_fd);
2615 exit_probe_symbol_maps();
2616
2617 return ret;
2618}
2619
2620static int get_new_event_name(char *buf, size_t len, const char *base,
2621 struct strlist *namelist, bool ret_event,
2622 bool allow_suffix)
2623{
2624 int i, ret;
2625 char *p, *nbase;
2626
2627 if (*base == '.')
2628 base++;
2629 nbase = strdup(base);
2630 if (!nbase)
2631 return -ENOMEM;
2632
2633 /* Cut off the dot suffixes (e.g. .const, .isra) and version suffixes */
2634 p = strpbrk(nbase, ".@");
2635 if (p && p != nbase)
2636 *p = '\0';
2637
2638 /* Try no suffix number */
2639 ret = e_snprintf(buf, len, "%s%s", nbase, ret_event ? "__return" : "");
2640 if (ret < 0) {
2641 pr_debug("snprintf() failed: %d\n", ret);
2642 goto out;
2643 }
2644 if (!strlist__has_entry(namelist, buf))
2645 goto out;
2646
2647 if (!allow_suffix) {
2648 pr_warning("Error: event \"%s\" already exists.\n"
2649 " Hint: Remove existing event by 'perf probe -d'\n"
2650 " or force duplicates by 'perf probe -f'\n"
2651 " or set 'force=yes' in BPF source.\n",
2652 buf);
2653 ret = -EEXIST;
2654 goto out;
2655 }
2656
2657 /* Try to add suffix */
2658 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2659 ret = e_snprintf(buf, len, "%s_%d", nbase, i);
2660 if (ret < 0) {
2661 pr_debug("snprintf() failed: %d\n", ret);
2662 goto out;
2663 }
2664 if (!strlist__has_entry(namelist, buf))
2665 break;
2666 }
2667 if (i == MAX_EVENT_INDEX) {
2668 pr_warning("Too many events are on the same function.\n");
2669 ret = -ERANGE;
2670 }
2671
2672out:
2673 free(nbase);
2674
2675 /* Final validation */
2676 if (ret >= 0 && !is_c_func_name(buf)) {
2677 pr_warning("Internal error: \"%s\" is an invalid event name.\n",
2678 buf);
2679 ret = -EINVAL;
2680 }
2681
2682 return ret;
2683}
2684
2685/* Warn if the current kernel's uprobe implementation is old */
2686static void warn_uprobe_event_compat(struct probe_trace_event *tev)
2687{
2688 int i;
2689 char *buf = synthesize_probe_trace_command(tev);
2690 struct probe_trace_point *tp = &tev->point;
2691
2692 if (tp->ref_ctr_offset && !uprobe_ref_ctr_is_supported()) {
2693 pr_warning("A semaphore is associated with %s:%s and "
2694 "seems your kernel doesn't support it.\n",
2695 tev->group, tev->event);
2696 }
2697
2698 /* Old uprobe event doesn't support memory dereference */
2699 if (!tev->uprobes || tev->nargs == 0 || !buf)
2700 goto out;
2701
2702 for (i = 0; i < tev->nargs; i++)
2703 if (strglobmatch(tev->args[i].value, "[$@+-]*")) {
2704 pr_warning("Please upgrade your kernel to at least "
2705 "3.14 to have access to feature %s\n",
2706 tev->args[i].value);
2707 break;
2708 }
2709out:
2710 free(buf);
2711}
2712
2713/* Set new name from original perf_probe_event and namelist */
2714static int probe_trace_event__set_name(struct probe_trace_event *tev,
2715 struct perf_probe_event *pev,
2716 struct strlist *namelist,
2717 bool allow_suffix)
2718{
2719 const char *event, *group;
2720 char buf[64];
2721 int ret;
2722
2723 /* If probe_event or trace_event already have the name, reuse it */
2724 if (pev->event && !pev->sdt)
2725 event = pev->event;
2726 else if (tev->event)
2727 event = tev->event;
2728 else {
2729 /* Or generate new one from probe point */
2730 if (pev->point.function &&
2731 (strncmp(pev->point.function, "0x", 2) != 0) &&
2732 !strisglob(pev->point.function))
2733 event = pev->point.function;
2734 else
2735 event = tev->point.realname;
2736 }
2737 if (pev->group && !pev->sdt)
2738 group = pev->group;
2739 else if (tev->group)
2740 group = tev->group;
2741 else
2742 group = PERFPROBE_GROUP;
2743
2744 /* Get an unused new event name */
2745 ret = get_new_event_name(buf, 64, event, namelist,
2746 tev->point.retprobe, allow_suffix);
2747 if (ret < 0)
2748 return ret;
2749
2750 event = buf;
2751
2752 tev->event = strdup(event);
2753 tev->group = strdup(group);
2754 if (tev->event == NULL || tev->group == NULL)
2755 return -ENOMEM;
2756
2757 /*
2758 * Add new event name to namelist if multiprobe event is NOT
2759 * supported, since we have to use new event name for following
2760 * probes in that case.
2761 */
2762 if (!multiprobe_event_is_supported())
2763 strlist__add(namelist, event);
2764 return 0;
2765}
2766
2767static int __open_probe_file_and_namelist(bool uprobe,
2768 struct strlist **namelist)
2769{
2770 int fd;
2771
2772 fd = probe_file__open(PF_FL_RW | (uprobe ? PF_FL_UPROBE : 0));
2773 if (fd < 0)
2774 return fd;
2775
2776 /* Get current event names */
2777 *namelist = probe_file__get_namelist(fd);
2778 if (!(*namelist)) {
2779 pr_debug("Failed to get current event list.\n");
2780 close(fd);
2781 return -ENOMEM;
2782 }
2783 return fd;
2784}
2785
2786static int __add_probe_trace_events(struct perf_probe_event *pev,
2787 struct probe_trace_event *tevs,
2788 int ntevs, bool allow_suffix)
2789{
2790 int i, fd[2] = {-1, -1}, up, ret;
2791 struct probe_trace_event *tev = NULL;
2792 struct probe_cache *cache = NULL;
2793 struct strlist *namelist[2] = {NULL, NULL};
2794 struct nscookie nsc;
2795
2796 up = pev->uprobes ? 1 : 0;
2797 fd[up] = __open_probe_file_and_namelist(up, &namelist[up]);
2798 if (fd[up] < 0)
2799 return fd[up];
2800
2801 ret = 0;
2802 for (i = 0; i < ntevs; i++) {
2803 tev = &tevs[i];
2804 up = tev->uprobes ? 1 : 0;
2805 if (fd[up] == -1) { /* Open the kprobe/uprobe_events */
2806 fd[up] = __open_probe_file_and_namelist(up,
2807 &namelist[up]);
2808 if (fd[up] < 0)
2809 goto close_out;
2810 }
2811 /* Skip if the symbol is out of .text or blacklisted */
2812 if (!tev->point.symbol && !pev->uprobes)
2813 continue;
2814
2815 /* Set new name for tev (and update namelist) */
2816 ret = probe_trace_event__set_name(tev, pev, namelist[up],
2817 allow_suffix);
2818 if (ret < 0)
2819 break;
2820
2821 nsinfo__mountns_enter(pev->nsi, &nsc);
2822 ret = probe_file__add_event(fd[up], tev);
2823 nsinfo__mountns_exit(&nsc);
2824 if (ret < 0)
2825 break;
2826
2827 /*
2828 * Probes after the first probe which comes from same
2829 * user input are always allowed to add suffix, because
2830 * there might be several addresses corresponding to
2831 * one code line.
2832 */
2833 allow_suffix = true;
2834 }
2835 if (ret == -EINVAL && pev->uprobes)
2836 warn_uprobe_event_compat(tev);
2837 if (ret == 0 && probe_conf.cache) {
2838 cache = probe_cache__new(pev->target, pev->nsi);
2839 if (!cache ||
2840 probe_cache__add_entry(cache, pev, tevs, ntevs) < 0 ||
2841 probe_cache__commit(cache) < 0)
2842 pr_warning("Failed to add event to probe cache\n");
2843 probe_cache__delete(cache);
2844 }
2845
2846close_out:
2847 for (up = 0; up < 2; up++) {
2848 strlist__delete(namelist[up]);
2849 if (fd[up] >= 0)
2850 close(fd[up]);
2851 }
2852 return ret;
2853}
2854
2855static int find_probe_functions(struct map *map, char *name,
2856 struct symbol **syms)
2857{
2858 int found = 0;
2859 struct symbol *sym;
2860 struct rb_node *tmp;
2861 const char *norm, *ver;
2862 char *buf = NULL;
2863 bool cut_version = true;
2864
2865 if (map__load(map) < 0)
2866 return 0;
2867
2868 /* If user gives a version, don't cut off the version from symbols */
2869 if (strchr(name, '@'))
2870 cut_version = false;
2871
2872 map__for_each_symbol(map, sym, tmp) {
2873 norm = arch__normalize_symbol_name(sym->name);
2874 if (!norm)
2875 continue;
2876
2877 if (cut_version) {
2878 /* We don't care about default symbol or not */
2879 ver = strchr(norm, '@');
2880 if (ver) {
2881 buf = strndup(norm, ver - norm);
2882 if (!buf)
2883 return -ENOMEM;
2884 norm = buf;
2885 }
2886 }
2887
2888 if (strglobmatch(norm, name)) {
2889 found++;
2890 if (syms && found < probe_conf.max_probes)
2891 syms[found - 1] = sym;
2892 }
2893 if (buf)
2894 zfree(&buf);
2895 }
2896
2897 return found;
2898}
2899
2900void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
2901 struct probe_trace_event *tev __maybe_unused,
2902 struct map *map __maybe_unused,
2903 struct symbol *sym __maybe_unused) { }
2904
2905/*
2906 * Find probe function addresses from map.
2907 * Return an error or the number of found probe_trace_event
2908 */
2909static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
2910 struct probe_trace_event **tevs)
2911{
2912 struct map *map = NULL;
2913 struct ref_reloc_sym *reloc_sym = NULL;
2914 struct symbol *sym;
2915 struct symbol **syms = NULL;
2916 struct probe_trace_event *tev;
2917 struct perf_probe_point *pp = &pev->point;
2918 struct probe_trace_point *tp;
2919 int num_matched_functions;
2920 int ret, i, j, skipped = 0;
2921 char *mod_name;
2922
2923 map = get_target_map(pev->target, pev->nsi, pev->uprobes);
2924 if (!map) {
2925 ret = -EINVAL;
2926 goto out;
2927 }
2928
2929 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
2930 if (!syms) {
2931 ret = -ENOMEM;
2932 goto out;
2933 }
2934
2935 /*
2936 * Load matched symbols: Since the different local symbols may have
2937 * same name but different addresses, this lists all the symbols.
2938 */
2939 num_matched_functions = find_probe_functions(map, pp->function, syms);
2940 if (num_matched_functions <= 0) {
2941 pr_err("Failed to find symbol %s in %s\n", pp->function,
2942 pev->target ? : "kernel");
2943 ret = -ENOENT;
2944 goto out;
2945 } else if (num_matched_functions > probe_conf.max_probes) {
2946 pr_err("Too many functions matched in %s\n",
2947 pev->target ? : "kernel");
2948 ret = -E2BIG;
2949 goto out;
2950 }
2951
2952 /* Note that the symbols in the kmodule are not relocated */
2953 if (!pev->uprobes && !pev->target &&
2954 (!pp->retprobe || kretprobe_offset_is_supported())) {
2955 reloc_sym = kernel_get_ref_reloc_sym(NULL);
2956 if (!reloc_sym) {
2957 pr_warning("Relocated base symbol is not found!\n");
2958 ret = -EINVAL;
2959 goto out;
2960 }
2961 }
2962
2963 /* Setup result trace-probe-events */
2964 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
2965 if (!*tevs) {
2966 ret = -ENOMEM;
2967 goto out;
2968 }
2969
2970 ret = 0;
2971
2972 for (j = 0; j < num_matched_functions; j++) {
2973 sym = syms[j];
2974
2975 /* There can be duplicated symbols in the map */
2976 for (i = 0; i < j; i++)
2977 if (sym->start == syms[i]->start) {
2978 pr_debug("Found duplicated symbol %s @ %" PRIx64 "\n",
2979 sym->name, sym->start);
2980 break;
2981 }
2982 if (i != j)
2983 continue;
2984
2985 tev = (*tevs) + ret;
2986 tp = &tev->point;
2987 if (ret == num_matched_functions) {
2988 pr_warning("Too many symbols are listed. Skip it.\n");
2989 break;
2990 }
2991 ret++;
2992
2993 if (pp->offset > sym->end - sym->start) {
2994 pr_warning("Offset %ld is bigger than the size of %s\n",
2995 pp->offset, sym->name);
2996 ret = -ENOENT;
2997 goto err_out;
2998 }
2999 /* Add one probe point */
3000 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
3001
3002 /* Check the kprobe (not in module) is within .text */
3003 if (!pev->uprobes && !pev->target &&
3004 kprobe_warn_out_range(sym->name, tp->address)) {
3005 tp->symbol = NULL; /* Skip it */
3006 skipped++;
3007 } else if (reloc_sym) {
3008 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
3009 tp->offset = tp->address - reloc_sym->addr;
3010 } else {
3011 tp->symbol = strdup_or_goto(sym->name, nomem_out);
3012 tp->offset = pp->offset;
3013 }
3014 tp->realname = strdup_or_goto(sym->name, nomem_out);
3015
3016 tp->retprobe = pp->retprobe;
3017 if (pev->target) {
3018 if (pev->uprobes) {
3019 tev->point.module = strdup_or_goto(pev->target,
3020 nomem_out);
3021 } else {
3022 mod_name = find_module_name(pev->target);
3023 tev->point.module =
3024 strdup(mod_name ? mod_name : pev->target);
3025 free(mod_name);
3026 if (!tev->point.module)
3027 goto nomem_out;
3028 }
3029 }
3030 tev->uprobes = pev->uprobes;
3031 tev->nargs = pev->nargs;
3032 if (tev->nargs) {
3033 tev->args = zalloc(sizeof(struct probe_trace_arg) *
3034 tev->nargs);
3035 if (tev->args == NULL)
3036 goto nomem_out;
3037 }
3038 for (i = 0; i < tev->nargs; i++) {
3039 if (pev->args[i].name)
3040 tev->args[i].name =
3041 strdup_or_goto(pev->args[i].name,
3042 nomem_out);
3043
3044 tev->args[i].value = strdup_or_goto(pev->args[i].var,
3045 nomem_out);
3046 if (pev->args[i].type)
3047 tev->args[i].type =
3048 strdup_or_goto(pev->args[i].type,
3049 nomem_out);
3050 }
3051 arch__fix_tev_from_maps(pev, tev, map, sym);
3052 }
3053 if (ret == skipped) {
3054 ret = -ENOENT;
3055 goto err_out;
3056 }
3057
3058out:
3059 map__put(map);
3060 free(syms);
3061 return ret;
3062
3063nomem_out:
3064 ret = -ENOMEM;
3065err_out:
3066 clear_probe_trace_events(*tevs, num_matched_functions);
3067 zfree(tevs);
3068 goto out;
3069}
3070
3071static int try_to_find_absolute_address(struct perf_probe_event *pev,
3072 struct probe_trace_event **tevs)
3073{
3074 struct perf_probe_point *pp = &pev->point;
3075 struct probe_trace_event *tev;
3076 struct probe_trace_point *tp;
3077 int i, err;
3078
3079 if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2)))
3080 return -EINVAL;
3081 if (perf_probe_event_need_dwarf(pev))
3082 return -EINVAL;
3083
3084 /*
3085 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
3086 * absolute address.
3087 *
3088 * Only one tev can be generated by this.
3089 */
3090 *tevs = zalloc(sizeof(*tev));
3091 if (!*tevs)
3092 return -ENOMEM;
3093
3094 tev = *tevs;
3095 tp = &tev->point;
3096
3097 /*
3098 * Don't use tp->offset, use address directly, because
3099 * in synthesize_probe_trace_command() address cannot be
3100 * zero.
3101 */
3102 tp->address = pev->point.abs_address;
3103 tp->retprobe = pp->retprobe;
3104 tev->uprobes = pev->uprobes;
3105
3106 err = -ENOMEM;
3107 /*
3108 * Give it a '0x' leading symbol name.
3109 * In __add_probe_trace_events, a NULL symbol is interpreted as
3110 * invalid.
3111 */
3112 if (asprintf(&tp->symbol, "0x%lx", tp->address) < 0)
3113 goto errout;
3114
3115 /* For kprobe, check range */
3116 if ((!tev->uprobes) &&
3117 (kprobe_warn_out_range(tev->point.symbol,
3118 tev->point.address))) {
3119 err = -EACCES;
3120 goto errout;
3121 }
3122
3123 if (asprintf(&tp->realname, "abs_%lx", tp->address) < 0)
3124 goto errout;
3125
3126 if (pev->target) {
3127 tp->module = strdup(pev->target);
3128 if (!tp->module)
3129 goto errout;
3130 }
3131
3132 if (tev->group) {
3133 tev->group = strdup(pev->group);
3134 if (!tev->group)
3135 goto errout;
3136 }
3137
3138 if (pev->event) {
3139 tev->event = strdup(pev->event);
3140 if (!tev->event)
3141 goto errout;
3142 }
3143
3144 tev->nargs = pev->nargs;
3145 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
3146 if (!tev->args)
3147 goto errout;
3148
3149 for (i = 0; i < tev->nargs; i++)
3150 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);
3151
3152 return 1;
3153
3154errout:
3155 clear_probe_trace_events(*tevs, 1);
3156 *tevs = NULL;
3157 return err;
3158}
3159
3160/* Concatinate two arrays */
3161static void *memcat(void *a, size_t sz_a, void *b, size_t sz_b)
3162{
3163 void *ret;
3164
3165 ret = malloc(sz_a + sz_b);
3166 if (ret) {
3167 memcpy(ret, a, sz_a);
3168 memcpy(ret + sz_a, b, sz_b);
3169 }
3170 return ret;
3171}
3172
3173static int
3174concat_probe_trace_events(struct probe_trace_event **tevs, int *ntevs,
3175 struct probe_trace_event **tevs2, int ntevs2)
3176{
3177 struct probe_trace_event *new_tevs;
3178 int ret = 0;
3179
3180 if (*ntevs == 0) {
3181 *tevs = *tevs2;
3182 *ntevs = ntevs2;
3183 *tevs2 = NULL;
3184 return 0;
3185 }
3186
3187 if (*ntevs + ntevs2 > probe_conf.max_probes)
3188 ret = -E2BIG;
3189 else {
3190 /* Concatinate the array of probe_trace_event */
3191 new_tevs = memcat(*tevs, (*ntevs) * sizeof(**tevs),
3192 *tevs2, ntevs2 * sizeof(**tevs2));
3193 if (!new_tevs)
3194 ret = -ENOMEM;
3195 else {
3196 free(*tevs);
3197 *tevs = new_tevs;
3198 *ntevs += ntevs2;
3199 }
3200 }
3201 if (ret < 0)
3202 clear_probe_trace_events(*tevs2, ntevs2);
3203 zfree(tevs2);
3204
3205 return ret;
3206}
3207
3208/*
3209 * Try to find probe_trace_event from given probe caches. Return the number
3210 * of cached events found, if an error occurs return the error.
3211 */
3212static int find_cached_events(struct perf_probe_event *pev,
3213 struct probe_trace_event **tevs,
3214 const char *target)
3215{
3216 struct probe_cache *cache;
3217 struct probe_cache_entry *entry;
3218 struct probe_trace_event *tmp_tevs = NULL;
3219 int ntevs = 0;
3220 int ret = 0;
3221
3222 cache = probe_cache__new(target, pev->nsi);
3223 /* Return 0 ("not found") if the target has no probe cache. */
3224 if (!cache)
3225 return 0;
3226
3227 for_each_probe_cache_entry(entry, cache) {
3228 /* Skip the cache entry which has no name */
3229 if (!entry->pev.event || !entry->pev.group)
3230 continue;
3231 if ((!pev->group || strglobmatch(entry->pev.group, pev->group)) &&
3232 strglobmatch(entry->pev.event, pev->event)) {
3233 ret = probe_cache_entry__get_event(entry, &tmp_tevs);
3234 if (ret > 0)
3235 ret = concat_probe_trace_events(tevs, &ntevs,
3236 &tmp_tevs, ret);
3237 if (ret < 0)
3238 break;
3239 }
3240 }
3241 probe_cache__delete(cache);
3242 if (ret < 0) {
3243 clear_probe_trace_events(*tevs, ntevs);
3244 zfree(tevs);
3245 } else {
3246 ret = ntevs;
3247 if (ntevs > 0 && target && target[0] == '/')
3248 pev->uprobes = true;
3249 }
3250
3251 return ret;
3252}
3253
3254/* Try to find probe_trace_event from all probe caches */
3255static int find_cached_events_all(struct perf_probe_event *pev,
3256 struct probe_trace_event **tevs)
3257{
3258 struct probe_trace_event *tmp_tevs = NULL;
3259 struct strlist *bidlist;
3260 struct str_node *nd;
3261 char *pathname;
3262 int ntevs = 0;
3263 int ret;
3264
3265 /* Get the buildid list of all valid caches */
3266 bidlist = build_id_cache__list_all(true);
3267 if (!bidlist) {
3268 ret = -errno;
3269 pr_debug("Failed to get buildids: %d\n", ret);
3270 return ret;
3271 }
3272
3273 ret = 0;
3274 strlist__for_each_entry(nd, bidlist) {
3275 pathname = build_id_cache__origname(nd->s);
3276 ret = find_cached_events(pev, &tmp_tevs, pathname);
3277 /* In the case of cnt == 0, we just skip it */
3278 if (ret > 0)
3279 ret = concat_probe_trace_events(tevs, &ntevs,
3280 &tmp_tevs, ret);
3281 free(pathname);
3282 if (ret < 0)
3283 break;
3284 }
3285 strlist__delete(bidlist);
3286
3287 if (ret < 0) {
3288 clear_probe_trace_events(*tevs, ntevs);
3289 zfree(tevs);
3290 } else
3291 ret = ntevs;
3292
3293 return ret;
3294}
3295
3296static int find_probe_trace_events_from_cache(struct perf_probe_event *pev,
3297 struct probe_trace_event **tevs)
3298{
3299 struct probe_cache *cache;
3300 struct probe_cache_entry *entry;
3301 struct probe_trace_event *tev;
3302 struct str_node *node;
3303 int ret, i;
3304
3305 if (pev->sdt) {
3306 /* For SDT/cached events, we use special search functions */
3307 if (!pev->target)
3308 return find_cached_events_all(pev, tevs);
3309 else
3310 return find_cached_events(pev, tevs, pev->target);
3311 }
3312 cache = probe_cache__new(pev->target, pev->nsi);
3313 if (!cache)
3314 return 0;
3315
3316 entry = probe_cache__find(cache, pev);
3317 if (!entry) {
3318 /* SDT must be in the cache */
3319 ret = pev->sdt ? -ENOENT : 0;
3320 goto out;
3321 }
3322
3323 ret = strlist__nr_entries(entry->tevlist);
3324 if (ret > probe_conf.max_probes) {
3325 pr_debug("Too many entries matched in the cache of %s\n",
3326 pev->target ? : "kernel");
3327 ret = -E2BIG;
3328 goto out;
3329 }
3330
3331 *tevs = zalloc(ret * sizeof(*tev));
3332 if (!*tevs) {
3333 ret = -ENOMEM;
3334 goto out;
3335 }
3336
3337 i = 0;
3338 strlist__for_each_entry(node, entry->tevlist) {
3339 tev = &(*tevs)[i++];
3340 ret = parse_probe_trace_command(node->s, tev);
3341 if (ret < 0)
3342 goto out;
3343 /* Set the uprobes attribute as same as original */
3344 tev->uprobes = pev->uprobes;
3345 }
3346 ret = i;
3347
3348out:
3349 probe_cache__delete(cache);
3350 return ret;
3351}
3352
3353static int convert_to_probe_trace_events(struct perf_probe_event *pev,
3354 struct probe_trace_event **tevs)
3355{
3356 int ret;
3357
3358 if (!pev->group && !pev->sdt) {
3359 /* Set group name if not given */
3360 if (!pev->uprobes) {
3361 pev->group = strdup(PERFPROBE_GROUP);
3362 ret = pev->group ? 0 : -ENOMEM;
3363 } else
3364 ret = convert_exec_to_group(pev->target, &pev->group);
3365 if (ret != 0) {
3366 pr_warning("Failed to make a group name.\n");
3367 return ret;
3368 }
3369 }
3370
3371 ret = try_to_find_absolute_address(pev, tevs);
3372 if (ret > 0)
3373 return ret;
3374
3375 /* At first, we need to lookup cache entry */
3376 ret = find_probe_trace_events_from_cache(pev, tevs);
3377 if (ret > 0 || pev->sdt) /* SDT can be found only in the cache */
3378 return ret == 0 ? -ENOENT : ret; /* Found in probe cache */
3379
3380 /* Convert perf_probe_event with debuginfo */
3381 ret = try_to_find_probe_trace_events(pev, tevs);
3382 if (ret != 0)
3383 return ret; /* Found in debuginfo or got an error */
3384
3385 return find_probe_trace_events_from_map(pev, tevs);
3386}
3387
3388int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3389{
3390 int i, ret;
3391
3392 /* Loop 1: convert all events */
3393 for (i = 0; i < npevs; i++) {
3394 /* Init kprobe blacklist if needed */
3395 if (!pevs[i].uprobes)
3396 kprobe_blacklist__init();
3397 /* Convert with or without debuginfo */
3398 ret = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
3399 if (ret < 0)
3400 return ret;
3401 pevs[i].ntevs = ret;
3402 }
3403 /* This just release blacklist only if allocated */
3404 kprobe_blacklist__release();
3405
3406 return 0;
3407}
3408
3409static int show_probe_trace_event(struct probe_trace_event *tev)
3410{
3411 char *buf = synthesize_probe_trace_command(tev);
3412
3413 if (!buf) {
3414 pr_debug("Failed to synthesize probe trace event.\n");
3415 return -EINVAL;
3416 }
3417
3418 /* Showing definition always go stdout */
3419 printf("%s\n", buf);
3420 free(buf);
3421
3422 return 0;
3423}
3424
3425int show_probe_trace_events(struct perf_probe_event *pevs, int npevs)
3426{
3427 struct strlist *namelist = strlist__new(NULL, NULL);
3428 struct probe_trace_event *tev;
3429 struct perf_probe_event *pev;
3430 int i, j, ret = 0;
3431
3432 if (!namelist)
3433 return -ENOMEM;
3434
3435 for (j = 0; j < npevs && !ret; j++) {
3436 pev = &pevs[j];
3437 for (i = 0; i < pev->ntevs && !ret; i++) {
3438 tev = &pev->tevs[i];
3439 /* Skip if the symbol is out of .text or blacklisted */
3440 if (!tev->point.symbol && !pev->uprobes)
3441 continue;
3442
3443 /* Set new name for tev (and update namelist) */
3444 ret = probe_trace_event__set_name(tev, pev,
3445 namelist, true);
3446 if (!ret)
3447 ret = show_probe_trace_event(tev);
3448 }
3449 }
3450 strlist__delete(namelist);
3451
3452 return ret;
3453}
3454
3455int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3456{
3457 int i, ret = 0;
3458
3459 /* Loop 2: add all events */
3460 for (i = 0; i < npevs; i++) {
3461 ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
3462 pevs[i].ntevs,
3463 probe_conf.force_add);
3464 if (ret < 0)
3465 break;
3466 }
3467 return ret;
3468}
3469
3470void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3471{
3472 int i, j;
3473 struct perf_probe_event *pev;
3474
3475 /* Loop 3: cleanup and free trace events */
3476 for (i = 0; i < npevs; i++) {
3477 pev = &pevs[i];
3478 for (j = 0; j < pevs[i].ntevs; j++)
3479 clear_probe_trace_event(&pevs[i].tevs[j]);
3480 zfree(&pevs[i].tevs);
3481 pevs[i].ntevs = 0;
3482 nsinfo__zput(pev->nsi);
3483 clear_perf_probe_event(&pevs[i]);
3484 }
3485}
3486
3487int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3488{
3489 int ret;
3490
3491 ret = init_probe_symbol_maps(pevs->uprobes);
3492 if (ret < 0)
3493 return ret;
3494
3495 ret = convert_perf_probe_events(pevs, npevs);
3496 if (ret == 0)
3497 ret = apply_perf_probe_events(pevs, npevs);
3498
3499 cleanup_perf_probe_events(pevs, npevs);
3500
3501 exit_probe_symbol_maps();
3502 return ret;
3503}
3504
3505int del_perf_probe_events(struct strfilter *filter)
3506{
3507 int ret, ret2, ufd = -1, kfd = -1;
3508 char *str = strfilter__string(filter);
3509
3510 if (!str)
3511 return -EINVAL;
3512
3513 /* Get current event names */
3514 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
3515 if (ret < 0)
3516 goto out;
3517
3518 ret = probe_file__del_events(kfd, filter);
3519 if (ret < 0 && ret != -ENOENT)
3520 goto error;
3521
3522 ret2 = probe_file__del_events(ufd, filter);
3523 if (ret2 < 0 && ret2 != -ENOENT) {
3524 ret = ret2;
3525 goto error;
3526 }
3527 ret = 0;
3528
3529error:
3530 if (kfd >= 0)
3531 close(kfd);
3532 if (ufd >= 0)
3533 close(ufd);
3534out:
3535 free(str);
3536
3537 return ret;
3538}
3539
3540int show_available_funcs(const char *target, struct nsinfo *nsi,
3541 struct strfilter *_filter, bool user)
3542{
3543 struct rb_node *nd;
3544 struct map *map;
3545 int ret;
3546
3547 ret = init_probe_symbol_maps(user);
3548 if (ret < 0)
3549 return ret;
3550
3551 /* Get a symbol map */
3552 map = get_target_map(target, nsi, user);
3553 if (!map) {
3554 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
3555 return -EINVAL;
3556 }
3557
3558 ret = map__load(map);
3559 if (ret) {
3560 if (ret == -2) {
3561 char *str = strfilter__string(_filter);
3562 pr_err("Failed to find symbols matched to \"%s\"\n",
3563 str);
3564 free(str);
3565 } else
3566 pr_err("Failed to load symbols in %s\n",
3567 (target) ? : "kernel");
3568 goto end;
3569 }
3570 if (!dso__sorted_by_name(map->dso))
3571 dso__sort_by_name(map->dso);
3572
3573 /* Show all (filtered) symbols */
3574 setup_pager();
3575
3576 for (nd = rb_first_cached(&map->dso->symbol_names); nd;
3577 nd = rb_next(nd)) {
3578 struct symbol_name_rb_node *pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
3579
3580 if (strfilter__compare(_filter, pos->sym.name))
3581 printf("%s\n", pos->sym.name);
3582 }
3583end:
3584 map__put(map);
3585 exit_probe_symbol_maps();
3586
3587 return ret;
3588}
3589
3590int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
3591 struct perf_probe_arg *pvar)
3592{
3593 tvar->value = strdup(pvar->var);
3594 if (tvar->value == NULL)
3595 return -ENOMEM;
3596 if (pvar->type) {
3597 tvar->type = strdup(pvar->type);
3598 if (tvar->type == NULL)
3599 return -ENOMEM;
3600 }
3601 if (pvar->name) {
3602 tvar->name = strdup(pvar->name);
3603 if (tvar->name == NULL)
3604 return -ENOMEM;
3605 } else
3606 tvar->name = NULL;
3607 return 0;
3608}
1/*
2 * probe-event.c : perf-probe definition to probe_events format converter
3 *
4 * Written by Masami Hiramatsu <mhiramat@redhat.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 *
20 */
21
22#include <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>
35
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"
52
53#include "sane_ctype.h"
54
55#define PERFPROBE_GROUP "probe"
56
57bool probe_event_dry_run; /* Dry run flag */
58struct probe_conf probe_conf;
59
60#define semantic_error(msg ...) pr_err("Semantic error :" msg)
61
62int e_snprintf(char *str, size_t size, const char *format, ...)
63{
64 int ret;
65 va_list ap;
66 va_start(ap, format);
67 ret = vsnprintf(str, size, format, ap);
68 va_end(ap);
69 if (ret >= (int)size)
70 ret = -E2BIG;
71 return ret;
72}
73
74static struct machine *host_machine;
75
76/* Initialize symbol maps and path of vmlinux/modules */
77int init_probe_symbol_maps(bool user_only)
78{
79 int ret;
80
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;
87 }
88
89 if (host_machine || user_only) /* already initialized */
90 return 0;
91
92 if (symbol_conf.vmlinux_name)
93 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
94
95 host_machine = machine__new_host();
96 if (!host_machine) {
97 pr_debug("machine__new_host() failed.\n");
98 symbol__exit();
99 ret = -1;
100 }
101out:
102 if (ret < 0)
103 pr_warning("Failed to init vmlinux path.\n");
104 return ret;
105}
106
107void exit_probe_symbol_maps(void)
108{
109 machine__delete(host_machine);
110 host_machine = NULL;
111 symbol__exit();
112}
113
114static struct symbol *__find_kernel_function_by_name(const char *name,
115 struct map **mapp)
116{
117 return machine__find_kernel_function_by_name(host_machine, name, mapp);
118}
119
120static struct symbol *__find_kernel_function(u64 addr, struct map **mapp)
121{
122 return machine__find_kernel_function(host_machine, addr, mapp);
123}
124
125static struct ref_reloc_sym *kernel_get_ref_reloc_sym(void)
126{
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);
130
131 if (map__load(map) < 0)
132 return NULL;
133
134 kmap = map__kmap(map);
135 if (!kmap)
136 return NULL;
137 return kmap->ref_reloc_sym;
138}
139
140static int kernel_get_symbol_address_by_name(const char *name, u64 *addr,
141 bool reloc, bool reladdr)
142{
143 struct ref_reloc_sym *reloc_sym;
144 struct symbol *sym;
145 struct map *map;
146
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);
158 }
159 return 0;
160}
161
162static struct map *kernel_get_module_map(const char *module)
163{
164 struct map_groups *grp = &host_machine->kmaps;
165 struct maps *maps = &grp->maps[MAP__FUNCTION];
166 struct map *pos;
167
168 /* A file path -- this is an offline module */
169 if (module && strchr(module, '/'))
170 return dso__new_map(module);
171
172 if (!module)
173 module = "kernel";
174
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;
182 }
183 }
184 return NULL;
185}
186
187struct map *get_target_map(const char *target, struct nsinfo *nsi, bool user)
188{
189 /* Init maps of given executable or kernel */
190 if (user) {
191 struct map *map;
192
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);
199 }
200}
201
202static int convert_exec_to_group(const char *exec, char **result)
203{
204 char *ptr1, *ptr2, *exec_copy;
205 char buf[64];
206 int ret;
207
208 exec_copy = strdup(exec);
209 if (!exec_copy)
210 return -ENOMEM;
211
212 ptr1 = basename(exec_copy);
213 if (!ptr1) {
214 ret = -EINVAL;
215 goto out;
216 }
217
218 for (ptr2 = ptr1; *ptr2 != '\0'; ptr2++) {
219 if (!isalnum(*ptr2) && *ptr2 != '_') {
220 *ptr2 = '\0';
221 break;
222 }
223 }
224
225 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
226 if (ret < 0)
227 goto out;
228
229 *result = strdup(buf);
230 ret = *result ? 0 : -ENOMEM;
231
232out:
233 free(exec_copy);
234 return ret;
235}
236
237static void clear_perf_probe_point(struct perf_probe_point *pp)
238{
239 free(pp->file);
240 free(pp->function);
241 free(pp->lazy_line);
242}
243
244static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
245{
246 int i;
247
248 for (i = 0; i < ntevs; i++)
249 clear_probe_trace_event(tevs + i);
250}
251
252static bool kprobe_blacklist__listed(unsigned long address);
253static bool kprobe_warn_out_range(const char *symbol, unsigned long address)
254{
255 u64 etext_addr = 0;
256 int ret;
257
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);
261
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;
268
269 return true;
270}
271
272/*
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.
276 */
277static char *find_module_name(const char *module)
278{
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;
287
288 fd = open(module, O_RDONLY);
289 if (fd < 0)
290 return NULL;
291
292 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
293 if (elf == NULL)
294 goto elf_err;
295
296 if (gelf_getehdr(elf, &ehdr) == NULL)
297 goto ret_err;
298
299 sec = elf_section_by_name(elf, &ehdr, &shdr,
300 ".gnu.linkonce.this_module", NULL);
301 if (!sec)
302 goto ret_err;
303
304 data = elf_getdata(sec, NULL);
305 if (!data || !data->d_buf)
306 goto ret_err;
307
308 /*
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.
316 */
317 if (ehdr.e_ident[EI_CLASS] == ELFCLASS32)
318 name_offset = 12;
319 else /* expect ELFCLASS64 by default */
320 name_offset = 24;
321
322 mod_name = strdup((char *)data->d_buf + name_offset);
323
324ret_err:
325 elf_end(elf);
326elf_err:
327 close(fd);
328 return mod_name;
329}
330
331#ifdef HAVE_DWARF_SUPPORT
332
333static int kernel_get_module_dso(const char *module, struct dso **pdso)
334{
335 struct dso *dso;
336 struct map *map;
337 const char *vmlinux_name;
338 int ret = 0;
339
340 if (module) {
341 char module_name[128];
342
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;
348 }
349 pr_debug("Failed to find module %s.\n", module);
350 return -ENOENT;
351 }
352
353 map = machine__kernel_map(host_machine);
354 dso = map->dso;
355
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);
362found:
363 *pdso = dso;
364 return ret;
365}
366
367/*
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.
371 */
372static 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)
377{
378 struct map *map = NULL;
379 struct symbol *sym;
380 u64 address = 0;
381 int ret = -ENOENT;
382
383 /* This can work only for function-name based one */
384 if (!pp->function || pp->file)
385 return -ENOTSUP;
386
387 map = get_target_map(target, nsi, uprobes);
388 if (!map)
389 return -EINVAL;
390
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;
398 }
399 if (!address) {
400 ret = -ENOENT;
401 goto out;
402 }
403 pr_debug("Symbol %s address found : %" PRIx64 "\n",
404 pp->function, address);
405
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;
415 }
416
417out:
418 map__put(map);
419 return ret;
420
421}
422
423static int get_alternative_probe_event(struct debuginfo *dinfo,
424 struct perf_probe_event *pev,
425 struct perf_probe_point *tmp)
426{
427 int ret;
428
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));
435
436 return ret;
437}
438
439static int get_alternative_line_range(struct debuginfo *dinfo,
440 struct line_range *lr,
441 const char *target, bool user)
442{
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;
448
449 memset(&result, 0, sizeof(result));
450
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);
462 }
463 return ret;
464}
465
466/* Open new debuginfo of given module */
467static struct debuginfo *open_debuginfo(const char *module, struct nsinfo *nsi,
468 bool silent)
469{
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;
476
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;
489 }
490 path = dso->long_name;
491 }
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");
501 }
502 nsinfo__mountns_exit(&nsc);
503 return ret;
504}
505
506/* For caching the last debuginfo */
507static struct debuginfo *debuginfo_cache;
508static char *debuginfo_cache_path;
509
510static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
511{
512 const char *path = module;
513
514 /* If the module is NULL, it should be the kernel. */
515 if (!module)
516 path = "kernel";
517
518 if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path))
519 goto out;
520
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;
528 }
529
530 debuginfo_cache = open_debuginfo(module, NULL, silent);
531 if (!debuginfo_cache)
532 zfree(&debuginfo_cache_path);
533out:
534 return debuginfo_cache;
535}
536
537static void debuginfo_cache__exit(void)
538{
539 debuginfo__delete(debuginfo_cache);
540 debuginfo_cache = NULL;
541 zfree(&debuginfo_cache_path);
542}
543
544
545static int get_text_start_address(const char *exec, unsigned long *address,
546 struct nsinfo *nsi)
547{
548 Elf *elf;
549 GElf_Ehdr ehdr;
550 GElf_Shdr shdr;
551 int fd, ret = -ENOENT;
552 struct nscookie nsc;
553
554 nsinfo__mountns_enter(nsi, &nsc);
555 fd = open(exec, O_RDONLY);
556 nsinfo__mountns_exit(&nsc);
557 if (fd < 0)
558 return -errno;
559
560 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
561 if (elf == NULL) {
562 ret = -EINVAL;
563 goto out_close;
564 }
565
566 if (gelf_getehdr(elf, &ehdr) == NULL)
567 goto out;
568
569 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
570 goto out;
571
572 *address = shdr.sh_addr - shdr.sh_offset;
573 ret = 0;
574out:
575 elf_end(elf);
576out_close:
577 close(fd);
578
579 return ret;
580}
581
582/*
583 * Convert trace point to probe point with debuginfo
584 */
585static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
586 struct perf_probe_point *pp,
587 bool is_kprobe)
588{
589 struct debuginfo *dinfo = NULL;
590 unsigned long stext = 0;
591 u64 addr = tp->address;
592 int ret = -ENOENT;
593
594 /* convert the address to dwarf address */
595 if (!is_kprobe) {
596 if (!addr) {
597 ret = -EINVAL;
598 goto error;
599 }
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;
611 }
612
613 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
614 tp->module ? : "kernel");
615
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;
622
623 if (ret > 0) {
624 pp->retprobe = tp->retprobe;
625 return 0;
626 }
627error:
628 pr_debug("Failed to find corresponding probes from debuginfo.\n");
629 return ret ? : -ENOENT;
630}
631
632/* Adjust symbol name and address */
633static int post_process_probe_trace_point(struct probe_trace_point *tp,
634 struct map *map, unsigned long offs)
635{
636 struct symbol *sym;
637 u64 addr = tp->address - offs;
638
639 sym = map__find_symbol(map, addr);
640 if (!sym)
641 return -ENOENT;
642
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;
652 }
653 tp->offset = addr - sym->start;
654 tp->address -= offs;
655
656 return 0;
657}
658
659/*
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.
666 */
667static int
668post_process_offline_probe_trace_events(struct probe_trace_event *tevs,
669 int ntevs, const char *pathname)
670{
671 struct map *map;
672 unsigned long stext = 0;
673 int i, ret = 0;
674
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;
680 }
681
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;
687 }
688 map__put(map);
689
690 return ret;
691}
692
693static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
694 int ntevs, const char *exec,
695 struct nsinfo *nsi)
696{
697 int i, ret = 0;
698 unsigned long stext = 0;
699
700 if (!exec)
701 return 0;
702
703 ret = get_text_start_address(exec, &stext, nsi);
704 if (ret < 0)
705 return ret;
706
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;
714 }
715 tevs[i].uprobes = true;
716 }
717
718 return ret;
719}
720
721static int
722post_process_module_probe_trace_events(struct probe_trace_event *tevs,
723 int ntevs, const char *module,
724 struct debuginfo *dinfo)
725{
726 Dwarf_Addr text_offs = 0;
727 int i, ret = 0;
728 char *mod_name = NULL;
729 struct map *map;
730
731 if (!module)
732 return 0;
733
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;
738 }
739
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;
751 }
752 }
753
754 free(mod_name);
755 map__put(map);
756
757 return ret;
758}
759
760static int
761post_process_kernel_probe_trace_events(struct probe_trace_event *tevs,
762 int ntevs)
763{
764 struct ref_reloc_sym *reloc_sym;
765 char *tmp;
766 int i, skipped = 0;
767
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);
772
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;
777 }
778
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;
793 }
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;
802 }
803 return skipped;
804}
805
806void __weak
807arch__post_process_probe_trace_events(struct perf_probe_event *pev __maybe_unused,
808 int ntevs __maybe_unused)
809{
810}
811
812/* Post processing the probe events */
813static 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)
817{
818 int ret;
819
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);
829
830 if (ret >= 0)
831 arch__post_process_probe_trace_events(pev, ntevs);
832
833 return ret;
834}
835
836/* Try to find perf_probe_event with debuginfo */
837static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
838 struct probe_trace_event **tevs)
839{
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;
844
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;
851 }
852
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);
856
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);
861 /*
862 * Write back to the original probe_event for
863 * setting appropriate (user given) event name
864 */
865 clear_perf_probe_point(&pev->point);
866 memcpy(&pev->point, &tmp, sizeof(tmp));
867 }
868 }
869
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;
879 }
880 }
881
882 debuginfo__delete(dinfo);
883
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;
897 }
898 }
899 return ntevs;
900}
901
902#define LINEBUF_SIZE 256
903#define NR_ADDITIONAL_LINES 2
904
905static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
906{
907 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
908 const char *color = show_num ? "" : PERF_COLOR_BLUE;
909 const char *prefix = NULL;
910
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);
919 }
920 color_fprintf(stdout, color, "%s", buf);
921
922 } while (strchr(buf, '\n') == NULL);
923
924 return 1;
925error:
926 if (ferror(fp)) {
927 pr_warning("File read error: %s\n",
928 str_error_r(errno, sbuf, sizeof(sbuf)));
929 return -1;
930 }
931 return 0;
932}
933
934static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
935{
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;
940 }
941 return rv;
942}
943
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)
948
949/*
950 * Show line-range always requires debuginfo to find source file and
951 * line number.
952 */
953static int __show_line_range(struct line_range *lr, const char *module,
954 bool user)
955{
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];
963
964 /* Search a line range */
965 dinfo = open_debuginfo(module, NULL, false);
966 if (!dinfo)
967 return -ENOENT;
968
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);
974 }
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;
982 }
983
984 /* Convert source file path */
985 tmp = lr->path;
986 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
987
988 /* Free old path when new path is assigned */
989 if (tmp != lr->path)
990 free(tmp);
991
992 if (ret < 0) {
993 pr_warning("Failed to find source file path.\n");
994 return ret;
995 }
996
997 setup_pager();
998
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);
1004
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;
1010 }
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;
1016 }
1017
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;
1023 }
1024 ret = show_one_line_with_num(fp, l++ - lr->offset);
1025 if (ret < 0)
1026 goto end;
1027 }
1028
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;
1035 }
1036end:
1037 fclose(fp);
1038 return ret;
1039}
1040
1041int show_line_range(struct line_range *lr, const char *module,
1042 struct nsinfo *nsi, bool user)
1043{
1044 int ret;
1045 struct nscookie nsc;
1046
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();
1054
1055 return ret;
1056}
1057
1058static int show_available_vars_at(struct debuginfo *dinfo,
1059 struct perf_probe_event *pev,
1060 struct strfilter *_filter)
1061{
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;
1068
1069 buf = synthesize_perf_probe_point(&pev->point);
1070 if (!buf)
1071 return -EINVAL;
1072 pr_debug("Searching variables at %s\n", buf);
1073
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);
1082 }
1083 }
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;
1091 }
1092
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];
1097 /*
1098 * A probe point might be converted to
1099 * several trace points.
1100 */
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++;
1111 }
1112 }
1113 strlist__delete(vl->vars);
1114 }
1115 if (nvars == 0)
1116 fprintf(stdout, "\t\t(No matched variables)\n");
1117 }
1118 free(vls);
1119end:
1120 free(buf);
1121 return ret;
1122}
1123
1124/* Show available variables on given probe point */
1125int show_available_vars(struct perf_probe_event *pevs, int npevs,
1126 struct strfilter *_filter)
1127{
1128 int i, ret = 0;
1129 struct debuginfo *dinfo;
1130
1131 ret = init_probe_symbol_maps(pevs->uprobes);
1132 if (ret < 0)
1133 return ret;
1134
1135 dinfo = open_debuginfo(pevs->target, pevs->nsi, false);
1136 if (!dinfo) {
1137 ret = -ENOENT;
1138 goto out;
1139 }
1140
1141 setup_pager();
1142
1143 for (i = 0; i < npevs && ret >= 0; i++)
1144 ret = show_available_vars_at(dinfo, &pevs[i], _filter);
1145
1146 debuginfo__delete(dinfo);
1147out:
1148 exit_probe_symbol_maps();
1149 return ret;
1150}
1151
1152#else /* !HAVE_DWARF_SUPPORT */
1153
1154static void debuginfo_cache__exit(void)
1155{
1156}
1157
1158static int
1159find_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)
1162{
1163 return -ENOSYS;
1164}
1165
1166static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
1167 struct probe_trace_event **tevs __maybe_unused)
1168{
1169 if (perf_probe_event_need_dwarf(pev)) {
1170 pr_warning("Debuginfo-analysis is not supported.\n");
1171 return -ENOSYS;
1172 }
1173
1174 return 0;
1175}
1176
1177int 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)
1181{
1182 pr_warning("Debuginfo-analysis is not supported.\n");
1183 return -ENOSYS;
1184}
1185
1186int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1187 int npevs __maybe_unused,
1188 struct strfilter *filter __maybe_unused)
1189{
1190 pr_warning("Debuginfo-analysis is not supported.\n");
1191 return -ENOSYS;
1192}
1193#endif
1194
1195void line_range__clear(struct line_range *lr)
1196{
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));
1203}
1204
1205int line_range__init(struct line_range *lr)
1206{
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;
1213}
1214
1215static int parse_line_num(char **ptr, int *val, const char *what)
1216{
1217 const char *start = *ptr;
1218
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;
1224 }
1225 return 0;
1226}
1227
1228/* Check the name is good for event, group or function */
1229static bool is_c_func_name(const char *name)
1230{
1231 if (!isalpha(*name) && *name != '_')
1232 return false;
1233 while (*++name != '\0') {
1234 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1235 return false;
1236 }
1237 return true;
1238}
1239
1240/*
1241 * Stuff 'lr' according to the line range described by 'arg'.
1242 * The line range syntax is described by:
1243 *
1244 * SRC[:SLN[+NUM|-ELN]]
1245 * FNC[@SRC][:SLN[+NUM|-ELN]]
1246 */
1247int parse_line_range_desc(const char *arg, struct line_range *lr)
1248{
1249 char *range, *file, *name = strdup(arg);
1250 int err;
1251
1252 if (!name)
1253 return -ENOMEM;
1254
1255 lr->start = 0;
1256 lr->end = INT_MAX;
1257
1258 range = strchr(name, ':');
1259 if (range) {
1260 *range++ = '\0';
1261
1262 err = parse_line_num(&range, &lr->start, "start line");
1263 if (err)
1264 goto err;
1265
1266 if (*range == '+' || *range == '-') {
1267 const char c = *range++;
1268
1269 err = parse_line_num(&range, &lr->end, "end line");
1270 if (err)
1271 goto err;
1272
1273 if (c == '+') {
1274 lr->end += lr->start;
1275 /*
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.
1280 */
1281 lr->end--;
1282 }
1283 }
1284
1285 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1286
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;
1292 }
1293 if (*range != '\0') {
1294 semantic_error("Tailing with invalid str '%s'.\n", range);
1295 goto err;
1296 }
1297 }
1298
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;
1306 }
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;
1316 }
1317
1318 return 0;
1319err:
1320 free(name);
1321 return err;
1322}
1323
1324static int parse_perf_probe_event_name(char **arg, struct perf_probe_event *pev)
1325{
1326 char *ptr;
1327
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;
1339
1340 pev->event = strdup_esc(*arg);
1341 if (pev->event == NULL)
1342 return -ENOMEM;
1343
1344 if (!pev->sdt && !is_c_func_name(pev->event)) {
1345 zfree(&pev->event);
1346ng_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;
1351 }
1352 return 0;
1353}
1354
1355/* Parse probepoint definition. */
1356static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1357{
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;
1363
1364 /*
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
1369 */
1370 if (!arg)
1371 return -EINVAL;
1372
1373 if (is_sdt_event(arg)) {
1374 pev->sdt = true;
1375 if (arg[0] == '%')
1376 arg++;
1377 }
1378
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;
1386 }
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';
1397 }
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;
1402 }
1403 return ret;
1404 }
1405
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;
1412
1413 arg = tmp;
1414 }
1415
1416 /*
1417 * Check arg is function or file name and copy it.
1418 *
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.
1424 *
1425 * Otherwise, we consider arg to be a function specification.
1426 */
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;
1432 }
1433
1434 ptr = strpbrk_esc(arg, ";:+@%");
1435 if (ptr) {
1436 nc = *ptr;
1437 *ptr++ = '\0';
1438 }
1439
1440 if (arg[0] == '\0')
1441 tmp = NULL;
1442 else {
1443 tmp = strdup_esc(arg);
1444 if (tmp == NULL)
1445 return -ENOMEM;
1446 }
1447
1448 if (file_spec)
1449 pp->file = tmp;
1450 else {
1451 pp->function = tmp;
1452
1453 /*
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.
1457 *
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').
1461 */
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;
1467 }
1468 }
1469 }
1470
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;
1480 }
1481 ptr = strpbrk_esc(arg, ";:+@%");
1482 if (ptr) {
1483 nc = *ptr;
1484 *ptr++ = '\0';
1485 }
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;
1493 }
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;
1501 }
1502 break;
1503 case '@': /* File name */
1504 if (pp->file) {
1505 semantic_error("SRC@SRC is not allowed.\n");
1506 return -EINVAL;
1507 }
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;
1518 }
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;
1525 }
1526 }
1527
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;
1533 }
1534
1535 if (pp->lazy_line && pp->offset) {
1536 semantic_error("Lazy pattern can't be used with offset.\n");
1537 return -EINVAL;
1538 }
1539
1540 if (pp->line && pp->offset) {
1541 semantic_error("Offset can't be used with line number.\n");
1542 return -EINVAL;
1543 }
1544
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;
1549 }
1550
1551 if (pp->offset && !pp->function) {
1552 semantic_error("Offset requires an entry function.\n");
1553 return -EINVAL;
1554 }
1555
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;
1560 }
1561
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;
1566}
1567
1568/* Parse perf-probe event argument */
1569static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1570{
1571 char *tmp, *goodname;
1572 struct perf_probe_arg_field **fieldp;
1573
1574 pr_debug("parsing arg: %s into ", str);
1575
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;
1583 }
1584
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);
1592 }
1593
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;
1602 }
1603
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;
1611
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;
1624 }
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;
1639 }
1640 tmp = strpbrk(str, "-.[");
1641 }
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;
1650 }
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);
1658
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;
1664 }
1665 return 0;
1666}
1667
1668/* Parse perf-probe event command */
1669int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1670{
1671 char **argv;
1672 int argc, i, ret = 0;
1673
1674 argv = argv_split(cmd, &argc);
1675 if (!argv) {
1676 pr_debug("Failed to split arguments.\n");
1677 return -ENOMEM;
1678 }
1679 if (argc - 1 > MAX_PROBE_ARGS) {
1680 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1681 ret = -ERANGE;
1682 goto out;
1683 }
1684 /* Parse probe point */
1685 ret = parse_perf_probe_point(argv[0], pev);
1686 if (ret < 0)
1687 goto out;
1688
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;
1695 }
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;
1703 }
1704 }
1705out:
1706 argv_free(argv);
1707
1708 return ret;
1709}
1710
1711/* Returns true if *any* ARG is either C variable, $params or $vars. */
1712bool perf_probe_with_var(struct perf_probe_event *pev)
1713{
1714 int i = 0;
1715
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;
1722}
1723
1724/* Return true if this perf_probe_event requires debuginfo */
1725bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1726{
1727 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1728 return true;
1729
1730 if (perf_probe_with_var(pev))
1731 return true;
1732
1733 return false;
1734}
1735
1736/* Parse probe_events event into struct probe_point */
1737int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1738{
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;
1745
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;
1751 }
1752 if (argc < 2) {
1753 semantic_error("Too few probe arguments.\n");
1754 ret = -ERANGE;
1755 goto out;
1756 }
1757
1758 /* Scan event and group name. */
1759 argv0_str = strdup(argv[0]);
1760 if (argv0_str == NULL) {
1761 ret = -ENOMEM;
1762 goto out;
1763 }
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;
1772 }
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;
1779 }
1780 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1781
1782 tp->retprobe = (pr == 'r');
1783
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;
1791 }
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') {
1799 /*
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.
1805 */
1806 if (strcmp(fmt1_str, "0x") == 0) {
1807 if (!argv[2] || strcmp(argv[2], "(null)")) {
1808 ret = -EINVAL;
1809 goto out;
1810 }
1811 tp->address = 0;
1812
1813 free(argv[2]);
1814 for (i = 2; argv[i + 1] != NULL; i++)
1815 argv[i] = argv[i + 1];
1816
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;
1827 }
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);
1833 }
1834
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;
1840 }
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;
1853 }
1854 }
1855 ret = 0;
1856out:
1857 free(argv0_str);
1858 argv_free(argv);
1859 return ret;
1860}
1861
1862/* Compose only probe arg */
1863char *synthesize_perf_probe_arg(struct perf_probe_arg *pa)
1864{
1865 struct perf_probe_arg_field *field = pa->field;
1866 struct strbuf buf;
1867 char *ret = NULL;
1868 int err;
1869
1870 if (strbuf_init(&buf, 64) < 0)
1871 return NULL;
1872
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;
1879
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;
1889 }
1890
1891 if (pa->type)
1892 if (strbuf_addf(&buf, ":%s", pa->type) < 0)
1893 goto out;
1894
1895 ret = strbuf_detach(&buf, NULL);
1896out:
1897 strbuf_release(&buf);
1898 return ret;
1899}
1900
1901/* Compose only probe point (not argument) */
1902char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1903{
1904 struct strbuf buf;
1905 char *tmp, *ret = NULL;
1906 int len, err = 0;
1907
1908 if (strbuf_init(&buf, 64) < 0)
1909 return NULL;
1910
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;
1922 }
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;
1929 }
1930 err = strbuf_addf(&buf, "@%s", tmp);
1931 if (!err && !pp->function && pp->line)
1932 err = strbuf_addf(&buf, ":%d", pp->line);
1933 }
1934 if (!err)
1935 ret = strbuf_detach(&buf, NULL);
1936out:
1937 strbuf_release(&buf);
1938 return ret;
1939}
1940
1941char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1942{
1943 struct strbuf buf;
1944 char *tmp, *ret = NULL;
1945 int i;
1946
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;
1953
1954 tmp = synthesize_perf_probe_point(&pev->point);
1955 if (!tmp || strbuf_addstr(&buf, tmp) < 0)
1956 goto out;
1957 free(tmp);
1958
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);
1964 }
1965
1966 ret = strbuf_detach(&buf, NULL);
1967out:
1968 strbuf_release(&buf);
1969 return ret;
1970}
1971
1972static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1973 struct strbuf *buf, int depth)
1974{
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;
1981 }
1982 err = strbuf_addf(buf, "%+ld(", ref->offset);
1983 return (err < 0) ? err : depth;
1984}
1985
1986static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1987 struct strbuf *buf)
1988{
1989 struct probe_trace_arg_ref *ref = arg->ref;
1990 int depth = 0, err;
1991
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;
1999
2000 /* Special case: @XXX */
2001 if (arg->value[0] == '@' && arg->ref)
2002 ref = ref->next;
2003
2004 /* Dereferencing arguments */
2005 if (ref) {
2006 depth = __synthesize_probe_trace_arg_ref(ref, buf, 1);
2007 if (depth < 0)
2008 return depth;
2009 }
2010
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);
2016
2017 /* Closing */
2018 while (!err && depth--)
2019 err = strbuf_addch(buf, ')');
2020
2021 /* Print argument type */
2022 if (!err && arg->type)
2023 err = strbuf_addf(buf, ":%s", arg->type);
2024
2025 return err;
2026}
2027
2028char *synthesize_probe_trace_command(struct probe_trace_event *tev)
2029{
2030 struct probe_trace_point *tp = &tev->point;
2031 struct strbuf buf;
2032 char *ret = NULL;
2033 int i, err;
2034
2035 /* Uprobes must have tp->module */
2036 if (tev->uprobes && !tp->module)
2037 return NULL;
2038
2039 if (strbuf_init(&buf, 32) < 0)
2040 return NULL;
2041
2042 if (strbuf_addf(&buf, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
2043 tev->group, tev->event) < 0)
2044 goto error;
2045 /*
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".
2050 */
2051 if (tev->uprobes && !tp->address) {
2052 if (!tp->symbol || strcmp(tp->symbol, "0x0"))
2053 goto error;
2054 }
2055
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;
2068
2069 for (i = 0; i < tev->nargs; i++)
2070 if (synthesize_probe_trace_arg(&tev->args[i], &buf) < 0)
2071 goto error;
2072
2073 ret = strbuf_detach(&buf, NULL);
2074error:
2075 strbuf_release(&buf);
2076 return ret;
2077}
2078
2079static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
2080 struct perf_probe_point *pp,
2081 bool is_kprobe)
2082{
2083 struct symbol *sym = NULL;
2084 struct map *map = NULL;
2085 u64 addr = tp->address;
2086 int ret = -ENOENT;
2087
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;
2098 }
2099 if (addr) {
2100 addr += tp->offset;
2101 sym = __find_kernel_function(addr, &map);
2102 }
2103 }
2104
2105 if (!sym)
2106 goto out;
2107
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;
2112
2113out:
2114 if (map && !is_kprobe) {
2115 map__put(map);
2116 }
2117
2118 return ret;
2119}
2120
2121static int convert_to_perf_probe_point(struct probe_trace_point *tp,
2122 struct perf_probe_point *pp,
2123 bool is_kprobe)
2124{
2125 char buf[128];
2126 int ret;
2127
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;
2134
2135 pr_debug("Failed to find probe point from both of dwarf and map.\n");
2136
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;
2146 }
2147 if (pp->function == NULL)
2148 return -ENOMEM;
2149
2150 pp->retprobe = tp->retprobe;
2151
2152 return 0;
2153}
2154
2155static int convert_to_perf_probe_event(struct probe_trace_event *tev,
2156 struct perf_probe_event *pev, bool is_kprobe)
2157{
2158 struct strbuf buf = STRBUF_INIT;
2159 int i, ret;
2160
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;
2166
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;
2171
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);
2185 }
2186 if (pev->args[i].name == NULL && ret >= 0)
2187 ret = -ENOMEM;
2188 }
2189error:
2190 if (ret < 0)
2191 clear_perf_probe_event(pev);
2192
2193 return ret;
2194}
2195
2196void clear_perf_probe_event(struct perf_probe_event *pev)
2197{
2198 struct perf_probe_arg_field *field, *next;
2199 int i;
2200
2201 free(pev->event);
2202 free(pev->group);
2203 free(pev->target);
2204 clear_perf_probe_point(&pev->point);
2205
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;
2216 }
2217 }
2218 free(pev->args);
2219 memset(pev, 0, sizeof(*pev));
2220}
2221
2222#define strdup_or_goto(str, label) \
2223({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; })
2224
2225static int perf_probe_point__copy(struct perf_probe_point *dst,
2226 struct perf_probe_point *src)
2227{
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;
2235
2236out_err:
2237 clear_perf_probe_point(dst);
2238 return -ENOMEM;
2239}
2240
2241static int perf_probe_arg__copy(struct perf_probe_arg *dst,
2242 struct perf_probe_arg *src)
2243{
2244 struct perf_probe_arg_field *field, **ppfield;
2245
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);
2249
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);
2261 }
2262 return 0;
2263out_err:
2264 return -ENOMEM;
2265}
2266
2267int perf_probe_event__copy(struct perf_probe_event *dst,
2268 struct perf_probe_event *src)
2269{
2270 int i;
2271
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;
2276
2277 if (perf_probe_point__copy(&dst->point, &src->point) < 0)
2278 goto out_err;
2279
2280 dst->args = zalloc(sizeof(struct perf_probe_arg) * src->nargs);
2281 if (!dst->args)
2282 goto out_err;
2283 dst->nargs = src->nargs;
2284
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;
2289
2290out_err:
2291 clear_perf_probe_event(dst);
2292 return -ENOMEM;
2293}
2294
2295void clear_probe_trace_event(struct probe_trace_event *tev)
2296{
2297 struct probe_trace_arg_ref *ref, *next;
2298 int i;
2299
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;
2314 }
2315 }
2316 free(tev->args);
2317 memset(tev, 0, sizeof(*tev));
2318}
2319
2320struct kprobe_blacklist_node {
2321 struct list_head list;
2322 unsigned long start;
2323 unsigned long end;
2324 char *symbol;
2325};
2326
2327static void kprobe_blacklist__delete(struct list_head *blacklist)
2328{
2329 struct kprobe_blacklist_node *node;
2330
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);
2337 }
2338}
2339
2340static int kprobe_blacklist__load(struct list_head *blacklist)
2341{
2342 struct kprobe_blacklist_node *node;
2343 const char *__debugfs = debugfs__mountpoint();
2344 char buf[PATH_MAX], *p;
2345 FILE *fp;
2346 int ret;
2347
2348 if (__debugfs == NULL)
2349 return -ENOTSUP;
2350
2351 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
2352 if (ret < 0)
2353 return ret;
2354
2355 fp = fopen(buf, "r");
2356 if (!fp)
2357 return -errno;
2358
2359 ret = 0;
2360 while (fgets(buf, PATH_MAX, fp)) {
2361 node = zalloc(sizeof(*node));
2362 if (!node) {
2363 ret = -ENOMEM;
2364 break;
2365 }
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;
2371 }
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;
2383 }
2384 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
2385 node->start, node->end, node->symbol);
2386 ret++;
2387 }
2388 if (ret < 0)
2389 kprobe_blacklist__delete(blacklist);
2390 fclose(fp);
2391
2392 return ret;
2393}
2394
2395static struct kprobe_blacklist_node *
2396kprobe_blacklist__find_by_address(struct list_head *blacklist,
2397 unsigned long address)
2398{
2399 struct kprobe_blacklist_node *node;
2400
2401 list_for_each_entry(node, blacklist, list) {
2402 if (node->start <= address && address < node->end)
2403 return node;
2404 }
2405
2406 return NULL;
2407}
2408
2409static LIST_HEAD(kprobe_blacklist);
2410
2411static void kprobe_blacklist__init(void)
2412{
2413 if (!list_empty(&kprobe_blacklist))
2414 return;
2415
2416 if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
2417 pr_debug("No kprobe blacklist support, ignored\n");
2418}
2419
2420static void kprobe_blacklist__release(void)
2421{
2422 kprobe_blacklist__delete(&kprobe_blacklist);
2423}
2424
2425static bool kprobe_blacklist__listed(unsigned long address)
2426{
2427 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
2428}
2429
2430static 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)
2434{
2435 int i, ret;
2436 char *buf;
2437
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;
2444
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);
2451
2452 if (!ret && module)
2453 ret = strbuf_addf(result, " in %s", module);
2454
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);
2463 }
2464 }
2465 if (!ret)
2466 ret = strbuf_addch(result, ')');
2467
2468 return ret;
2469}
2470
2471/* Show an event */
2472int show_perf_probe_event(const char *group, const char *event,
2473 struct perf_probe_event *pev,
2474 const char *module, bool use_stdout)
2475{
2476 struct strbuf buf = STRBUF_INIT;
2477 int ret;
2478
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);
2485 }
2486 strbuf_release(&buf);
2487
2488 return ret;
2489}
2490
2491static bool filter_probe_trace_event(struct probe_trace_event *tev,
2492 struct strfilter *filter)
2493{
2494 char tmp[128];
2495
2496 /* At first, check the event name itself */
2497 if (strfilter__compare(filter, tev->event))
2498 return true;
2499
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);
2504}
2505
2506static int __show_perf_probe_events(int fd, bool is_kprobe,
2507 struct strfilter *filter)
2508{
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;
2514
2515 memset(&tev, 0, sizeof(tev));
2516 memset(&pev, 0, sizeof(pev));
2517
2518 rawlist = probe_file__get_rawlist(fd);
2519 if (!rawlist)
2520 return -ENOMEM;
2521
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);
2534 }
2535next:
2536 clear_perf_probe_event(&pev);
2537 clear_probe_trace_event(&tev);
2538 if (ret < 0)
2539 break;
2540 }
2541 strlist__delete(rawlist);
2542 /* Cleanup cached debuginfo if needed */
2543 debuginfo_cache__exit();
2544
2545 return ret;
2546}
2547
2548/* List up current perf-probe events */
2549int show_perf_probe_events(struct strfilter *filter)
2550{
2551 int kp_fd, up_fd, ret;
2552
2553 setup_pager();
2554
2555 if (probe_conf.cache)
2556 return probe_cache__show_all_caches(filter);
2557
2558 ret = init_probe_symbol_maps(false);
2559 if (ret < 0)
2560 return ret;
2561
2562 ret = probe_file__open_both(&kp_fd, &up_fd, 0);
2563 if (ret < 0)
2564 return ret;
2565
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();
2575
2576 return ret;
2577}
2578
2579static int get_new_event_name(char *buf, size_t len, const char *base,
2580 struct strlist *namelist, bool ret_event,
2581 bool allow_suffix)
2582{
2583 int i, ret;
2584 char *p, *nbase;
2585
2586 if (*base == '.')
2587 base++;
2588 nbase = strdup(base);
2589 if (!nbase)
2590 return -ENOMEM;
2591
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';
2596
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;
2602 }
2603 if (!strlist__has_entry(namelist, buf))
2604 goto out;
2605
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;
2614 }
2615
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;
2622 }
2623 if (!strlist__has_entry(namelist, buf))
2624 break;
2625 }
2626 if (i == MAX_EVENT_INDEX) {
2627 pr_warning("Too many events are on the same function.\n");
2628 ret = -ERANGE;
2629 }
2630
2631out:
2632 free(nbase);
2633
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;
2639 }
2640
2641 return ret;
2642}
2643
2644/* Warn if the current kernel's uprobe implementation is old */
2645static void warn_uprobe_event_compat(struct probe_trace_event *tev)
2646{
2647 int i;
2648 char *buf = synthesize_probe_trace_command(tev);
2649
2650 /* Old uprobe event doesn't support memory dereference */
2651 if (!tev->uprobes || tev->nargs == 0 || !buf)
2652 goto out;
2653
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;
2660 }
2661out:
2662 free(buf);
2663}
2664
2665/* Set new name from original perf_probe_event and namelist */
2666static 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)
2670{
2671 const char *event, *group;
2672 char buf[64];
2673 int ret;
2674
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;
2688 }
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;
2695
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;
2701
2702 event = buf;
2703
2704 tev->event = strdup(event);
2705 tev->group = strdup(group);
2706 if (tev->event == NULL || tev->group == NULL)
2707 return -ENOMEM;
2708
2709 /* Add added event name to namelist */
2710 strlist__add(namelist, event);
2711 return 0;
2712}
2713
2714static int __open_probe_file_and_namelist(bool uprobe,
2715 struct strlist **namelist)
2716{
2717 int fd;
2718
2719 fd = probe_file__open(PF_FL_RW | (uprobe ? PF_FL_UPROBE : 0));
2720 if (fd < 0)
2721 return fd;
2722
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;
2729 }
2730 return fd;
2731}
2732
2733static int __add_probe_trace_events(struct perf_probe_event *pev,
2734 struct probe_trace_event *tevs,
2735 int ntevs, bool allow_suffix)
2736{
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;
2742
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];
2747
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;
2757 }
2758 /* Skip if the symbol is out of .text or blacklisted */
2759 if (!tev->point.symbol && !pev->uprobes)
2760 continue;
2761
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;
2767
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;
2773
2774 /*
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.
2779 */
2780 allow_suffix = true;
2781 }
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);
2791 }
2792
2793close_out:
2794 for (up = 0; up < 2; up++) {
2795 strlist__delete(namelist[up]);
2796 if (fd[up] >= 0)
2797 close(fd[up]);
2798 }
2799 return ret;
2800}
2801
2802static int find_probe_functions(struct map *map, char *name,
2803 struct symbol **syms)
2804{
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;
2811
2812 if (map__load(map) < 0)
2813 return 0;
2814
2815 /* If user gives a version, don't cut off the version from symbols */
2816 if (strchr(name, '@'))
2817 cut_version = false;
2818
2819 map__for_each_symbol(map, sym, tmp) {
2820 norm = arch__normalize_symbol_name(sym->name);
2821 if (!norm)
2822 continue;
2823
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;
2832 }
2833 }
2834
2835 if (strglobmatch(norm, name)) {
2836 found++;
2837 if (syms && found < probe_conf.max_probes)
2838 syms[found - 1] = sym;
2839 }
2840 if (buf)
2841 zfree(&buf);
2842 }
2843
2844 return found;
2845}
2846
2847void __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) { }
2851
2852/*
2853 * Find probe function addresses from map.
2854 * Return an error or the number of found probe_trace_event
2855 */
2856static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
2857 struct probe_trace_event **tevs)
2858{
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;
2869
2870 map = get_target_map(pev->target, pev->nsi, pev->uprobes);
2871 if (!map) {
2872 ret = -EINVAL;
2873 goto out;
2874 }
2875
2876 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
2877 if (!syms) {
2878 ret = -ENOMEM;
2879 goto out;
2880 }
2881
2882 /*
2883 * Load matched symbols: Since the different local symbols may have
2884 * same name but different addresses, this lists all the symbols.
2885 */
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;
2897 }
2898
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;
2907 }
2908 }
2909
2910 /* Setup result trace-probe-events */
2911 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
2912 if (!*tevs) {
2913 ret = -ENOMEM;
2914 goto out;
2915 }
2916
2917 ret = 0;
2918
2919 for (j = 0; j < num_matched_functions; j++) {
2920 sym = syms[j];
2921
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;
2927 }
2928 ret++;
2929
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;
2935 }
2936 /* Add one probe point */
2937 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
2938
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;
2950 }
2951 tp->realname = strdup_or_goto(sym->name, nomem_out);
2952
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;
2965 }
2966 }
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;
2974 }
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);
2980
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);
2987 }
2988 arch__fix_tev_from_maps(pev, tev, map, sym);
2989 }
2990 if (ret == skipped) {
2991 ret = -ENOENT;
2992 goto err_out;
2993 }
2994
2995out:
2996 map__put(map);
2997 free(syms);
2998 return ret;
2999
3000nomem_out:
3001 ret = -ENOMEM;
3002err_out:
3003 clear_probe_trace_events(*tevs, num_matched_functions);
3004 zfree(tevs);
3005 goto out;
3006}
3007
3008static int try_to_find_absolute_address(struct perf_probe_event *pev,
3009 struct probe_trace_event **tevs)
3010{
3011 struct perf_probe_point *pp = &pev->point;
3012 struct probe_trace_event *tev;
3013 struct probe_trace_point *tp;
3014 int i, err;
3015
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;
3020
3021 /*
3022 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
3023 * absolute address.
3024 *
3025 * Only one tev can be generated by this.
3026 */
3027 *tevs = zalloc(sizeof(*tev));
3028 if (!*tevs)
3029 return -ENOMEM;
3030
3031 tev = *tevs;
3032 tp = &tev->point;
3033
3034 /*
3035 * Don't use tp->offset, use address directly, because
3036 * in synthesize_probe_trace_command() address cannot be
3037 * zero.
3038 */
3039 tp->address = pev->point.abs_address;
3040 tp->retprobe = pp->retprobe;
3041 tev->uprobes = pev->uprobes;
3042
3043 err = -ENOMEM;
3044 /*
3045 * Give it a '0x' leading symbol name.
3046 * In __add_probe_trace_events, a NULL symbol is interpreted as
3047 * invalud.
3048 */
3049 if (asprintf(&tp->symbol, "0x%lx", tp->address) < 0)
3050 goto errout;
3051
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;
3058 }
3059
3060 if (asprintf(&tp->realname, "abs_%lx", tp->address) < 0)
3061 goto errout;
3062
3063 if (pev->target) {
3064 tp->module = strdup(pev->target);
3065 if (!tp->module)
3066 goto errout;
3067 }
3068
3069 if (tev->group) {
3070 tev->group = strdup(pev->group);
3071 if (!tev->group)
3072 goto errout;
3073 }
3074
3075 if (pev->event) {
3076 tev->event = strdup(pev->event);
3077 if (!tev->event)
3078 goto errout;
3079 }
3080
3081 tev->nargs = pev->nargs;
3082 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
3083 if (!tev->args)
3084 goto errout;
3085
3086 for (i = 0; i < tev->nargs; i++)
3087 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);
3088
3089 return 1;
3090
3091errout:
3092 clear_probe_trace_events(*tevs, 1);
3093 *tevs = NULL;
3094 return err;
3095}
3096
3097/* Concatinate two arrays */
3098static void *memcat(void *a, size_t sz_a, void *b, size_t sz_b)
3099{
3100 void *ret;
3101
3102 ret = malloc(sz_a + sz_b);
3103 if (ret) {
3104 memcpy(ret, a, sz_a);
3105 memcpy(ret + sz_a, b, sz_b);
3106 }
3107 return ret;
3108}
3109
3110static int
3111concat_probe_trace_events(struct probe_trace_event **tevs, int *ntevs,
3112 struct probe_trace_event **tevs2, int ntevs2)
3113{
3114 struct probe_trace_event *new_tevs;
3115 int ret = 0;
3116
3117 if (*ntevs == 0) {
3118 *tevs = *tevs2;
3119 *ntevs = ntevs2;
3120 *tevs2 = NULL;
3121 return 0;
3122 }
3123
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;
3136 }
3137 }
3138 if (ret < 0)
3139 clear_probe_trace_events(*tevs2, ntevs2);
3140 zfree(tevs2);
3141
3142 return ret;
3143}
3144
3145/*
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.
3148 */
3149static int find_cached_events(struct perf_probe_event *pev,
3150 struct probe_trace_event **tevs,
3151 const char *target)
3152{
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;
3158
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;
3163
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;
3176 }
3177 }
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;
3186 }
3187
3188 return ret;
3189}
3190
3191/* Try to find probe_trace_event from all probe caches */
3192static int find_cached_events_all(struct perf_probe_event *pev,
3193 struct probe_trace_event **tevs)
3194{
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;
3201
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;
3208 }
3209
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;
3221 }
3222 strlist__delete(bidlist);
3223
3224 if (ret < 0) {
3225 clear_probe_trace_events(*tevs, ntevs);
3226 zfree(tevs);
3227 } else
3228 ret = ntevs;
3229
3230 return ret;
3231}
3232
3233static int find_probe_trace_events_from_cache(struct perf_probe_event *pev,
3234 struct probe_trace_event **tevs)
3235{
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;
3241
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);
3248 }
3249 cache = probe_cache__new(pev->target, pev->nsi);
3250 if (!cache)
3251 return 0;
3252
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;
3258 }
3259
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;
3266 }
3267
3268 *tevs = zalloc(ret * sizeof(*tev));
3269 if (!*tevs) {
3270 ret = -ENOMEM;
3271 goto out;
3272 }
3273
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;
3282 }
3283 ret = i;
3284
3285out:
3286 probe_cache__delete(cache);
3287 return ret;
3288}
3289
3290static int convert_to_probe_trace_events(struct perf_probe_event *pev,
3291 struct probe_trace_event **tevs)
3292{
3293 int ret;
3294
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;
3305 }
3306 }
3307
3308 ret = try_to_find_absolute_address(pev, tevs);
3309 if (ret > 0)
3310 return ret;
3311
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 */
3316
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 */
3321
3322 return find_probe_trace_events_from_map(pev, tevs);
3323}
3324
3325int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3326{
3327 int i, ret;
3328
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;
3339 }
3340 /* This just release blacklist only if allocated */
3341 kprobe_blacklist__release();
3342
3343 return 0;
3344}
3345
3346static int show_probe_trace_event(struct probe_trace_event *tev)
3347{
3348 char *buf = synthesize_probe_trace_command(tev);
3349
3350 if (!buf) {
3351 pr_debug("Failed to synthesize probe trace event.\n");
3352 return -EINVAL;
3353 }
3354
3355 /* Showing definition always go stdout */
3356 printf("%s\n", buf);
3357 free(buf);
3358
3359 return 0;
3360}
3361
3362int show_probe_trace_events(struct perf_probe_event *pevs, int npevs)
3363{
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;
3368
3369 if (!namelist)
3370 return -ENOMEM;
3371
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;
3379
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);
3385 }
3386 }
3387 strlist__delete(namelist);
3388
3389 return ret;
3390}
3391
3392int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3393{
3394 int i, ret = 0;
3395
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;
3403 }
3404 return ret;
3405}
3406
3407void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3408{
3409 int i, j;
3410 struct perf_probe_event *pev;
3411
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]);
3421 }
3422}
3423
3424int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3425{
3426 int ret;
3427
3428 ret = init_probe_symbol_maps(pevs->uprobes);
3429 if (ret < 0)
3430 return ret;
3431
3432 ret = convert_perf_probe_events(pevs, npevs);
3433 if (ret == 0)
3434 ret = apply_perf_probe_events(pevs, npevs);
3435
3436 cleanup_perf_probe_events(pevs, npevs);
3437
3438 exit_probe_symbol_maps();
3439 return ret;
3440}
3441
3442int del_perf_probe_events(struct strfilter *filter)
3443{
3444 int ret, ret2, ufd = -1, kfd = -1;
3445 char *str = strfilter__string(filter);
3446
3447 if (!str)
3448 return -EINVAL;
3449
3450 /* Get current event names */
3451 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
3452 if (ret < 0)
3453 goto out;
3454
3455 ret = probe_file__del_events(kfd, filter);
3456 if (ret < 0 && ret != -ENOENT)
3457 goto error;
3458
3459 ret2 = probe_file__del_events(ufd, filter);
3460 if (ret2 < 0 && ret2 != -ENOENT) {
3461 ret = ret2;
3462 goto error;
3463 }
3464 ret = 0;
3465
3466error:
3467 if (kfd >= 0)
3468 close(kfd);
3469 if (ufd >= 0)
3470 close(ufd);
3471out:
3472 free(str);
3473
3474 return ret;
3475}
3476
3477int show_available_funcs(const char *target, struct nsinfo *nsi,
3478 struct strfilter *_filter, bool user)
3479{
3480 struct rb_node *nd;
3481 struct map *map;
3482 int ret;
3483
3484 ret = init_probe_symbol_maps(user);
3485 if (ret < 0)
3486 return ret;
3487
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;
3493 }
3494
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;
3506 }
3507 if (!dso__sorted_by_name(map->dso, map->type))
3508 dso__sort_by_name(map->dso, map->type);
3509
3510 /* Show all (filtered) symbols */
3511 setup_pager();
3512
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);
3515
3516 if (strfilter__compare(_filter, pos->sym.name))
3517 printf("%s\n", pos->sym.name);
3518 }
3519
3520end:
3521 map__put(map);
3522 exit_probe_symbol_maps();
3523
3524 return ret;
3525}
3526
3527int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
3528 struct perf_probe_arg *pvar)
3529{
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;
3537 }
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;
3545}