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