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