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/*
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 <sys/utsname.h>
23#include <sys/types.h>
24#include <sys/stat.h>
25#include <fcntl.h>
26#include <errno.h>
27#include <stdio.h>
28#include <unistd.h>
29#include <stdlib.h>
30#include <string.h>
31#include <stdarg.h>
32#include <limits.h>
33#include <elf.h>
34
35#include "util.h"
36#include "event.h"
37#include "strlist.h"
38#include "debug.h"
39#include "cache.h"
40#include "color.h"
41#include "symbol.h"
42#include "thread.h"
43#include <api/fs/debugfs.h>
44#include "trace-event.h" /* For __maybe_unused */
45#include "probe-event.h"
46#include "probe-finder.h"
47#include "session.h"
48
49#define MAX_CMDLEN 256
50#define PERFPROBE_GROUP "probe"
51
52bool probe_event_dry_run; /* Dry run flag */
53
54#define semantic_error(msg ...) pr_err("Semantic error :" msg)
55
56/* If there is no space to write, returns -E2BIG. */
57static int e_snprintf(char *str, size_t size, const char *format, ...)
58 __attribute__((format(printf, 3, 4)));
59
60static int e_snprintf(char *str, size_t size, const char *format, ...)
61{
62 int ret;
63 va_list ap;
64 va_start(ap, format);
65 ret = vsnprintf(str, size, format, ap);
66 va_end(ap);
67 if (ret >= (int)size)
68 ret = -E2BIG;
69 return ret;
70}
71
72static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
73static void clear_probe_trace_event(struct probe_trace_event *tev);
74static struct machine *host_machine;
75
76/* Initialize symbol maps and path of vmlinux/modules */
77static int init_symbol_maps(bool user_only)
78{
79 int ret;
80
81 symbol_conf.sort_by_name = true;
82 ret = symbol__init();
83 if (ret < 0) {
84 pr_debug("Failed to init symbol map.\n");
85 goto out;
86 }
87
88 if (host_machine || user_only) /* already initialized */
89 return 0;
90
91 if (symbol_conf.vmlinux_name)
92 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
93
94 host_machine = machine__new_host();
95 if (!host_machine) {
96 pr_debug("machine__new_host() failed.\n");
97 symbol__exit();
98 ret = -1;
99 }
100out:
101 if (ret < 0)
102 pr_warning("Failed to init vmlinux path.\n");
103 return ret;
104}
105
106static void exit_symbol_maps(void)
107{
108 if (host_machine) {
109 machine__delete(host_machine);
110 host_machine = NULL;
111 }
112 symbol__exit();
113}
114
115static struct symbol *__find_kernel_function_by_name(const char *name,
116 struct map **mapp)
117{
118 return machine__find_kernel_function_by_name(host_machine, name, mapp,
119 NULL);
120}
121
122static struct symbol *__find_kernel_function(u64 addr, struct map **mapp)
123{
124 return machine__find_kernel_function(host_machine, addr, mapp, NULL);
125}
126
127static struct ref_reloc_sym *kernel_get_ref_reloc_sym(void)
128{
129 /* kmap->ref_reloc_sym should be set if host_machine is initialized */
130 struct kmap *kmap;
131
132 if (map__load(host_machine->vmlinux_maps[MAP__FUNCTION], NULL) < 0)
133 return NULL;
134
135 kmap = map__kmap(host_machine->vmlinux_maps[MAP__FUNCTION]);
136 return kmap->ref_reloc_sym;
137}
138
139static u64 kernel_get_symbol_address_by_name(const char *name, bool reloc)
140{
141 struct ref_reloc_sym *reloc_sym;
142 struct symbol *sym;
143 struct map *map;
144
145 /* ref_reloc_sym is just a label. Need a special fix*/
146 reloc_sym = kernel_get_ref_reloc_sym();
147 if (reloc_sym && strcmp(name, reloc_sym->name) == 0)
148 return (reloc) ? reloc_sym->addr : reloc_sym->unrelocated_addr;
149 else {
150 sym = __find_kernel_function_by_name(name, &map);
151 if (sym)
152 return map->unmap_ip(map, sym->start) -
153 (reloc) ? 0 : map->reloc;
154 }
155 return 0;
156}
157
158static struct map *kernel_get_module_map(const char *module)
159{
160 struct rb_node *nd;
161 struct map_groups *grp = &host_machine->kmaps;
162
163 /* A file path -- this is an offline module */
164 if (module && strchr(module, '/'))
165 return machine__new_module(host_machine, 0, module);
166
167 if (!module)
168 module = "kernel";
169
170 for (nd = rb_first(&grp->maps[MAP__FUNCTION]); nd; nd = rb_next(nd)) {
171 struct map *pos = rb_entry(nd, struct map, rb_node);
172 if (strncmp(pos->dso->short_name + 1, module,
173 pos->dso->short_name_len - 2) == 0) {
174 return pos;
175 }
176 }
177 return NULL;
178}
179
180static struct dso *kernel_get_module_dso(const char *module)
181{
182 struct dso *dso;
183 struct map *map;
184 const char *vmlinux_name;
185
186 if (module) {
187 list_for_each_entry(dso, &host_machine->kernel_dsos, node) {
188 if (strncmp(dso->short_name + 1, module,
189 dso->short_name_len - 2) == 0)
190 goto found;
191 }
192 pr_debug("Failed to find module %s.\n", module);
193 return NULL;
194 }
195
196 map = host_machine->vmlinux_maps[MAP__FUNCTION];
197 dso = map->dso;
198
199 vmlinux_name = symbol_conf.vmlinux_name;
200 if (vmlinux_name) {
201 if (dso__load_vmlinux(dso, map, vmlinux_name, false, NULL) <= 0)
202 return NULL;
203 } else {
204 if (dso__load_vmlinux_path(dso, map, NULL) <= 0) {
205 pr_debug("Failed to load kernel map.\n");
206 return NULL;
207 }
208 }
209found:
210 return dso;
211}
212
213const char *kernel_get_module_path(const char *module)
214{
215 struct dso *dso = kernel_get_module_dso(module);
216 return (dso) ? dso->long_name : NULL;
217}
218
219static int convert_exec_to_group(const char *exec, char **result)
220{
221 char *ptr1, *ptr2, *exec_copy;
222 char buf[64];
223 int ret;
224
225 exec_copy = strdup(exec);
226 if (!exec_copy)
227 return -ENOMEM;
228
229 ptr1 = basename(exec_copy);
230 if (!ptr1) {
231 ret = -EINVAL;
232 goto out;
233 }
234
235 ptr2 = strpbrk(ptr1, "-._");
236 if (ptr2)
237 *ptr2 = '\0';
238 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
239 if (ret < 0)
240 goto out;
241
242 *result = strdup(buf);
243 ret = *result ? 0 : -ENOMEM;
244
245out:
246 free(exec_copy);
247 return ret;
248}
249
250static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
251{
252 int i;
253
254 for (i = 0; i < ntevs; i++)
255 clear_probe_trace_event(tevs + i);
256}
257
258#ifdef HAVE_DWARF_SUPPORT
259
260/* Open new debuginfo of given module */
261static struct debuginfo *open_debuginfo(const char *module)
262{
263 const char *path = module;
264
265 if (!module || !strchr(module, '/')) {
266 path = kernel_get_module_path(module);
267 if (!path) {
268 pr_err("Failed to find path of %s module.\n",
269 module ?: "kernel");
270 return NULL;
271 }
272 }
273 return debuginfo__new(path);
274}
275
276static int get_text_start_address(const char *exec, unsigned long *address)
277{
278 Elf *elf;
279 GElf_Ehdr ehdr;
280 GElf_Shdr shdr;
281 int fd, ret = -ENOENT;
282
283 fd = open(exec, O_RDONLY);
284 if (fd < 0)
285 return -errno;
286
287 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
288 if (elf == NULL)
289 return -EINVAL;
290
291 if (gelf_getehdr(elf, &ehdr) == NULL)
292 goto out;
293
294 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
295 goto out;
296
297 *address = shdr.sh_addr - shdr.sh_offset;
298 ret = 0;
299out:
300 elf_end(elf);
301 return ret;
302}
303
304/*
305 * Convert trace point to probe point with debuginfo
306 */
307static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
308 struct perf_probe_point *pp,
309 bool is_kprobe)
310{
311 struct debuginfo *dinfo = NULL;
312 unsigned long stext = 0;
313 u64 addr = tp->address;
314 int ret = -ENOENT;
315
316 /* convert the address to dwarf address */
317 if (!is_kprobe) {
318 if (!addr) {
319 ret = -EINVAL;
320 goto error;
321 }
322 ret = get_text_start_address(tp->module, &stext);
323 if (ret < 0)
324 goto error;
325 addr += stext;
326 } else {
327 addr = kernel_get_symbol_address_by_name(tp->symbol, false);
328 if (addr == 0)
329 goto error;
330 addr += tp->offset;
331 }
332
333 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
334 tp->module ? : "kernel");
335
336 dinfo = open_debuginfo(tp->module);
337 if (dinfo) {
338 ret = debuginfo__find_probe_point(dinfo,
339 (unsigned long)addr, pp);
340 debuginfo__delete(dinfo);
341 } else {
342 pr_debug("Failed to open debuginfo at 0x%" PRIx64 "\n", addr);
343 ret = -ENOENT;
344 }
345
346 if (ret > 0) {
347 pp->retprobe = tp->retprobe;
348 return 0;
349 }
350error:
351 pr_debug("Failed to find corresponding probes from debuginfo.\n");
352 return ret ? : -ENOENT;
353}
354
355static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
356 int ntevs, const char *exec)
357{
358 int i, ret = 0;
359 unsigned long stext = 0;
360
361 if (!exec)
362 return 0;
363
364 ret = get_text_start_address(exec, &stext);
365 if (ret < 0)
366 return ret;
367
368 for (i = 0; i < ntevs && ret >= 0; i++) {
369 /* point.address is the addres of point.symbol + point.offset */
370 tevs[i].point.address -= stext;
371 tevs[i].point.module = strdup(exec);
372 if (!tevs[i].point.module) {
373 ret = -ENOMEM;
374 break;
375 }
376 tevs[i].uprobes = true;
377 }
378
379 return ret;
380}
381
382static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
383 int ntevs, const char *module)
384{
385 int i, ret = 0;
386 char *tmp;
387
388 if (!module)
389 return 0;
390
391 tmp = strrchr(module, '/');
392 if (tmp) {
393 /* This is a module path -- get the module name */
394 module = strdup(tmp + 1);
395 if (!module)
396 return -ENOMEM;
397 tmp = strchr(module, '.');
398 if (tmp)
399 *tmp = '\0';
400 tmp = (char *)module; /* For free() */
401 }
402
403 for (i = 0; i < ntevs; i++) {
404 tevs[i].point.module = strdup(module);
405 if (!tevs[i].point.module) {
406 ret = -ENOMEM;
407 break;
408 }
409 }
410
411 free(tmp);
412 return ret;
413}
414
415/* Post processing the probe events */
416static int post_process_probe_trace_events(struct probe_trace_event *tevs,
417 int ntevs, const char *module,
418 bool uprobe)
419{
420 struct ref_reloc_sym *reloc_sym;
421 char *tmp;
422 int i;
423
424 if (uprobe)
425 return add_exec_to_probe_trace_events(tevs, ntevs, module);
426
427 /* Note that currently ref_reloc_sym based probe is not for drivers */
428 if (module)
429 return add_module_to_probe_trace_events(tevs, ntevs, module);
430
431 reloc_sym = kernel_get_ref_reloc_sym();
432 if (!reloc_sym) {
433 pr_warning("Relocated base symbol is not found!\n");
434 return -EINVAL;
435 }
436
437 for (i = 0; i < ntevs; i++) {
438 if (tevs[i].point.address) {
439 tmp = strdup(reloc_sym->name);
440 if (!tmp)
441 return -ENOMEM;
442 free(tevs[i].point.symbol);
443 tevs[i].point.symbol = tmp;
444 tevs[i].point.offset = tevs[i].point.address -
445 reloc_sym->unrelocated_addr;
446 }
447 }
448 return 0;
449}
450
451/* Try to find perf_probe_event with debuginfo */
452static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
453 struct probe_trace_event **tevs,
454 int max_tevs, const char *target)
455{
456 bool need_dwarf = perf_probe_event_need_dwarf(pev);
457 struct debuginfo *dinfo;
458 int ntevs, ret = 0;
459
460 dinfo = open_debuginfo(target);
461
462 if (!dinfo) {
463 if (need_dwarf) {
464 pr_warning("Failed to open debuginfo file.\n");
465 return -ENOENT;
466 }
467 pr_debug("Could not open debuginfo. Try to use symbols.\n");
468 return 0;
469 }
470
471 pr_debug("Try to find probe point from debuginfo.\n");
472 /* Searching trace events corresponding to a probe event */
473 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);
474
475 debuginfo__delete(dinfo);
476
477 if (ntevs > 0) { /* Succeeded to find trace events */
478 pr_debug("Found %d probe_trace_events.\n", ntevs);
479 ret = post_process_probe_trace_events(*tevs, ntevs,
480 target, pev->uprobes);
481 if (ret < 0) {
482 clear_probe_trace_events(*tevs, ntevs);
483 zfree(tevs);
484 }
485 return ret < 0 ? ret : ntevs;
486 }
487
488 if (ntevs == 0) { /* No error but failed to find probe point. */
489 pr_warning("Probe point '%s' not found.\n",
490 synthesize_perf_probe_point(&pev->point));
491 return -ENOENT;
492 }
493 /* Error path : ntevs < 0 */
494 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
495 if (ntevs == -EBADF) {
496 pr_warning("Warning: No dwarf info found in the vmlinux - "
497 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
498 if (!need_dwarf) {
499 pr_debug("Trying to use symbols.\n");
500 return 0;
501 }
502 }
503 return ntevs;
504}
505
506/*
507 * Find a src file from a DWARF tag path. Prepend optional source path prefix
508 * and chop off leading directories that do not exist. Result is passed back as
509 * a newly allocated path on success.
510 * Return 0 if file was found and readable, -errno otherwise.
511 */
512static int get_real_path(const char *raw_path, const char *comp_dir,
513 char **new_path)
514{
515 const char *prefix = symbol_conf.source_prefix;
516
517 if (!prefix) {
518 if (raw_path[0] != '/' && comp_dir)
519 /* If not an absolute path, try to use comp_dir */
520 prefix = comp_dir;
521 else {
522 if (access(raw_path, R_OK) == 0) {
523 *new_path = strdup(raw_path);
524 return 0;
525 } else
526 return -errno;
527 }
528 }
529
530 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
531 if (!*new_path)
532 return -ENOMEM;
533
534 for (;;) {
535 sprintf(*new_path, "%s/%s", prefix, raw_path);
536
537 if (access(*new_path, R_OK) == 0)
538 return 0;
539
540 if (!symbol_conf.source_prefix)
541 /* In case of searching comp_dir, don't retry */
542 return -errno;
543
544 switch (errno) {
545 case ENAMETOOLONG:
546 case ENOENT:
547 case EROFS:
548 case EFAULT:
549 raw_path = strchr(++raw_path, '/');
550 if (!raw_path) {
551 zfree(new_path);
552 return -ENOENT;
553 }
554 continue;
555
556 default:
557 zfree(new_path);
558 return -errno;
559 }
560 }
561}
562
563#define LINEBUF_SIZE 256
564#define NR_ADDITIONAL_LINES 2
565
566static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
567{
568 char buf[LINEBUF_SIZE];
569 const char *color = show_num ? "" : PERF_COLOR_BLUE;
570 const char *prefix = NULL;
571
572 do {
573 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
574 goto error;
575 if (skip)
576 continue;
577 if (!prefix) {
578 prefix = show_num ? "%7d " : " ";
579 color_fprintf(stdout, color, prefix, l);
580 }
581 color_fprintf(stdout, color, "%s", buf);
582
583 } while (strchr(buf, '\n') == NULL);
584
585 return 1;
586error:
587 if (ferror(fp)) {
588 pr_warning("File read error: %s\n", strerror(errno));
589 return -1;
590 }
591 return 0;
592}
593
594static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
595{
596 int rv = __show_one_line(fp, l, skip, show_num);
597 if (rv == 0) {
598 pr_warning("Source file is shorter than expected.\n");
599 rv = -1;
600 }
601 return rv;
602}
603
604#define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
605#define show_one_line(f,l) _show_one_line(f,l,false,false)
606#define skip_one_line(f,l) _show_one_line(f,l,true,false)
607#define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
608
609/*
610 * Show line-range always requires debuginfo to find source file and
611 * line number.
612 */
613static int __show_line_range(struct line_range *lr, const char *module)
614{
615 int l = 1;
616 struct int_node *ln;
617 struct debuginfo *dinfo;
618 FILE *fp;
619 int ret;
620 char *tmp;
621
622 /* Search a line range */
623 dinfo = open_debuginfo(module);
624 if (!dinfo) {
625 pr_warning("Failed to open debuginfo file.\n");
626 return -ENOENT;
627 }
628
629 ret = debuginfo__find_line_range(dinfo, lr);
630 debuginfo__delete(dinfo);
631 if (ret == 0) {
632 pr_warning("Specified source line is not found.\n");
633 return -ENOENT;
634 } else if (ret < 0) {
635 pr_warning("Debuginfo analysis failed. (%d)\n", ret);
636 return ret;
637 }
638
639 /* Convert source file path */
640 tmp = lr->path;
641 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
642 free(tmp); /* Free old path */
643 if (ret < 0) {
644 pr_warning("Failed to find source file. (%d)\n", ret);
645 return ret;
646 }
647
648 setup_pager();
649
650 if (lr->function)
651 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
652 lr->start - lr->offset);
653 else
654 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
655
656 fp = fopen(lr->path, "r");
657 if (fp == NULL) {
658 pr_warning("Failed to open %s: %s\n", lr->path,
659 strerror(errno));
660 return -errno;
661 }
662 /* Skip to starting line number */
663 while (l < lr->start) {
664 ret = skip_one_line(fp, l++);
665 if (ret < 0)
666 goto end;
667 }
668
669 intlist__for_each(ln, lr->line_list) {
670 for (; ln->i > l; l++) {
671 ret = show_one_line(fp, l - lr->offset);
672 if (ret < 0)
673 goto end;
674 }
675 ret = show_one_line_with_num(fp, l++ - lr->offset);
676 if (ret < 0)
677 goto end;
678 }
679
680 if (lr->end == INT_MAX)
681 lr->end = l + NR_ADDITIONAL_LINES;
682 while (l <= lr->end) {
683 ret = show_one_line_or_eof(fp, l++ - lr->offset);
684 if (ret <= 0)
685 break;
686 }
687end:
688 fclose(fp);
689 return ret;
690}
691
692int show_line_range(struct line_range *lr, const char *module)
693{
694 int ret;
695
696 ret = init_symbol_maps(false);
697 if (ret < 0)
698 return ret;
699 ret = __show_line_range(lr, module);
700 exit_symbol_maps();
701
702 return ret;
703}
704
705static int show_available_vars_at(struct debuginfo *dinfo,
706 struct perf_probe_event *pev,
707 int max_vls, struct strfilter *_filter,
708 bool externs)
709{
710 char *buf;
711 int ret, i, nvars;
712 struct str_node *node;
713 struct variable_list *vls = NULL, *vl;
714 const char *var;
715
716 buf = synthesize_perf_probe_point(&pev->point);
717 if (!buf)
718 return -EINVAL;
719 pr_debug("Searching variables at %s\n", buf);
720
721 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
722 max_vls, externs);
723 if (ret <= 0) {
724 pr_err("Failed to find variables at %s (%d)\n", buf, ret);
725 goto end;
726 }
727 /* Some variables are found */
728 fprintf(stdout, "Available variables at %s\n", buf);
729 for (i = 0; i < ret; i++) {
730 vl = &vls[i];
731 /*
732 * A probe point might be converted to
733 * several trace points.
734 */
735 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
736 vl->point.offset);
737 zfree(&vl->point.symbol);
738 nvars = 0;
739 if (vl->vars) {
740 strlist__for_each(node, vl->vars) {
741 var = strchr(node->s, '\t') + 1;
742 if (strfilter__compare(_filter, var)) {
743 fprintf(stdout, "\t\t%s\n", node->s);
744 nvars++;
745 }
746 }
747 strlist__delete(vl->vars);
748 }
749 if (nvars == 0)
750 fprintf(stdout, "\t\t(No matched variables)\n");
751 }
752 free(vls);
753end:
754 free(buf);
755 return ret;
756}
757
758/* Show available variables on given probe point */
759int show_available_vars(struct perf_probe_event *pevs, int npevs,
760 int max_vls, const char *module,
761 struct strfilter *_filter, bool externs)
762{
763 int i, ret = 0;
764 struct debuginfo *dinfo;
765
766 ret = init_symbol_maps(false);
767 if (ret < 0)
768 return ret;
769
770 dinfo = open_debuginfo(module);
771 if (!dinfo) {
772 pr_warning("Failed to open debuginfo file.\n");
773 ret = -ENOENT;
774 goto out;
775 }
776
777 setup_pager();
778
779 for (i = 0; i < npevs && ret >= 0; i++)
780 ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
781 externs);
782
783 debuginfo__delete(dinfo);
784out:
785 exit_symbol_maps();
786 return ret;
787}
788
789#else /* !HAVE_DWARF_SUPPORT */
790
791static int
792find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
793 struct perf_probe_point *pp __maybe_unused,
794 bool is_kprobe __maybe_unused)
795{
796 return -ENOSYS;
797}
798
799static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
800 struct probe_trace_event **tevs __maybe_unused,
801 int max_tevs __maybe_unused,
802 const char *target __maybe_unused)
803{
804 if (perf_probe_event_need_dwarf(pev)) {
805 pr_warning("Debuginfo-analysis is not supported.\n");
806 return -ENOSYS;
807 }
808
809 return 0;
810}
811
812int show_line_range(struct line_range *lr __maybe_unused,
813 const char *module __maybe_unused)
814{
815 pr_warning("Debuginfo-analysis is not supported.\n");
816 return -ENOSYS;
817}
818
819int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
820 int npevs __maybe_unused, int max_vls __maybe_unused,
821 const char *module __maybe_unused,
822 struct strfilter *filter __maybe_unused,
823 bool externs __maybe_unused)
824{
825 pr_warning("Debuginfo-analysis is not supported.\n");
826 return -ENOSYS;
827}
828#endif
829
830void line_range__clear(struct line_range *lr)
831{
832 free(lr->function);
833 free(lr->file);
834 free(lr->path);
835 free(lr->comp_dir);
836 intlist__delete(lr->line_list);
837 memset(lr, 0, sizeof(*lr));
838}
839
840int line_range__init(struct line_range *lr)
841{
842 memset(lr, 0, sizeof(*lr));
843 lr->line_list = intlist__new(NULL);
844 if (!lr->line_list)
845 return -ENOMEM;
846 else
847 return 0;
848}
849
850static int parse_line_num(char **ptr, int *val, const char *what)
851{
852 const char *start = *ptr;
853
854 errno = 0;
855 *val = strtol(*ptr, ptr, 0);
856 if (errno || *ptr == start) {
857 semantic_error("'%s' is not a valid number.\n", what);
858 return -EINVAL;
859 }
860 return 0;
861}
862
863/*
864 * Stuff 'lr' according to the line range described by 'arg'.
865 * The line range syntax is described by:
866 *
867 * SRC[:SLN[+NUM|-ELN]]
868 * FNC[@SRC][:SLN[+NUM|-ELN]]
869 */
870int parse_line_range_desc(const char *arg, struct line_range *lr)
871{
872 char *range, *file, *name = strdup(arg);
873 int err;
874
875 if (!name)
876 return -ENOMEM;
877
878 lr->start = 0;
879 lr->end = INT_MAX;
880
881 range = strchr(name, ':');
882 if (range) {
883 *range++ = '\0';
884
885 err = parse_line_num(&range, &lr->start, "start line");
886 if (err)
887 goto err;
888
889 if (*range == '+' || *range == '-') {
890 const char c = *range++;
891
892 err = parse_line_num(&range, &lr->end, "end line");
893 if (err)
894 goto err;
895
896 if (c == '+') {
897 lr->end += lr->start;
898 /*
899 * Adjust the number of lines here.
900 * If the number of lines == 1, the
901 * the end of line should be equal to
902 * the start of line.
903 */
904 lr->end--;
905 }
906 }
907
908 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
909
910 err = -EINVAL;
911 if (lr->start > lr->end) {
912 semantic_error("Start line must be smaller"
913 " than end line.\n");
914 goto err;
915 }
916 if (*range != '\0') {
917 semantic_error("Tailing with invalid str '%s'.\n", range);
918 goto err;
919 }
920 }
921
922 file = strchr(name, '@');
923 if (file) {
924 *file = '\0';
925 lr->file = strdup(++file);
926 if (lr->file == NULL) {
927 err = -ENOMEM;
928 goto err;
929 }
930 lr->function = name;
931 } else if (strchr(name, '.'))
932 lr->file = name;
933 else
934 lr->function = name;
935
936 return 0;
937err:
938 free(name);
939 return err;
940}
941
942/* Check the name is good for event/group */
943static bool check_event_name(const char *name)
944{
945 if (!isalpha(*name) && *name != '_')
946 return false;
947 while (*++name != '\0') {
948 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
949 return false;
950 }
951 return true;
952}
953
954/* Parse probepoint definition. */
955static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
956{
957 struct perf_probe_point *pp = &pev->point;
958 char *ptr, *tmp;
959 char c, nc = 0;
960 /*
961 * <Syntax>
962 * perf probe [EVENT=]SRC[:LN|;PTN]
963 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
964 *
965 * TODO:Group name support
966 */
967
968 ptr = strpbrk(arg, ";=@+%");
969 if (ptr && *ptr == '=') { /* Event name */
970 *ptr = '\0';
971 tmp = ptr + 1;
972 if (strchr(arg, ':')) {
973 semantic_error("Group name is not supported yet.\n");
974 return -ENOTSUP;
975 }
976 if (!check_event_name(arg)) {
977 semantic_error("%s is bad for event name -it must "
978 "follow C symbol-naming rule.\n", arg);
979 return -EINVAL;
980 }
981 pev->event = strdup(arg);
982 if (pev->event == NULL)
983 return -ENOMEM;
984 pev->group = NULL;
985 arg = tmp;
986 }
987
988 ptr = strpbrk(arg, ";:+@%");
989 if (ptr) {
990 nc = *ptr;
991 *ptr++ = '\0';
992 }
993
994 tmp = strdup(arg);
995 if (tmp == NULL)
996 return -ENOMEM;
997
998 /* Check arg is function or file and copy it */
999 if (strchr(tmp, '.')) /* File */
1000 pp->file = tmp;
1001 else /* Function */
1002 pp->function = tmp;
1003
1004 /* Parse other options */
1005 while (ptr) {
1006 arg = ptr;
1007 c = nc;
1008 if (c == ';') { /* Lazy pattern must be the last part */
1009 pp->lazy_line = strdup(arg);
1010 if (pp->lazy_line == NULL)
1011 return -ENOMEM;
1012 break;
1013 }
1014 ptr = strpbrk(arg, ";:+@%");
1015 if (ptr) {
1016 nc = *ptr;
1017 *ptr++ = '\0';
1018 }
1019 switch (c) {
1020 case ':': /* Line number */
1021 pp->line = strtoul(arg, &tmp, 0);
1022 if (*tmp != '\0') {
1023 semantic_error("There is non-digit char"
1024 " in line number.\n");
1025 return -EINVAL;
1026 }
1027 break;
1028 case '+': /* Byte offset from a symbol */
1029 pp->offset = strtoul(arg, &tmp, 0);
1030 if (*tmp != '\0') {
1031 semantic_error("There is non-digit character"
1032 " in offset.\n");
1033 return -EINVAL;
1034 }
1035 break;
1036 case '@': /* File name */
1037 if (pp->file) {
1038 semantic_error("SRC@SRC is not allowed.\n");
1039 return -EINVAL;
1040 }
1041 pp->file = strdup(arg);
1042 if (pp->file == NULL)
1043 return -ENOMEM;
1044 break;
1045 case '%': /* Probe places */
1046 if (strcmp(arg, "return") == 0) {
1047 pp->retprobe = 1;
1048 } else { /* Others not supported yet */
1049 semantic_error("%%%s is not supported.\n", arg);
1050 return -ENOTSUP;
1051 }
1052 break;
1053 default: /* Buggy case */
1054 pr_err("This program has a bug at %s:%d.\n",
1055 __FILE__, __LINE__);
1056 return -ENOTSUP;
1057 break;
1058 }
1059 }
1060
1061 /* Exclusion check */
1062 if (pp->lazy_line && pp->line) {
1063 semantic_error("Lazy pattern can't be used with"
1064 " line number.\n");
1065 return -EINVAL;
1066 }
1067
1068 if (pp->lazy_line && pp->offset) {
1069 semantic_error("Lazy pattern can't be used with offset.\n");
1070 return -EINVAL;
1071 }
1072
1073 if (pp->line && pp->offset) {
1074 semantic_error("Offset can't be used with line number.\n");
1075 return -EINVAL;
1076 }
1077
1078 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1079 semantic_error("File always requires line number or "
1080 "lazy pattern.\n");
1081 return -EINVAL;
1082 }
1083
1084 if (pp->offset && !pp->function) {
1085 semantic_error("Offset requires an entry function.\n");
1086 return -EINVAL;
1087 }
1088
1089 if (pp->retprobe && !pp->function) {
1090 semantic_error("Return probe requires an entry function.\n");
1091 return -EINVAL;
1092 }
1093
1094 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1095 semantic_error("Offset/Line/Lazy pattern can't be used with "
1096 "return probe.\n");
1097 return -EINVAL;
1098 }
1099
1100 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1101 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1102 pp->lazy_line);
1103 return 0;
1104}
1105
1106/* Parse perf-probe event argument */
1107static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1108{
1109 char *tmp, *goodname;
1110 struct perf_probe_arg_field **fieldp;
1111
1112 pr_debug("parsing arg: %s into ", str);
1113
1114 tmp = strchr(str, '=');
1115 if (tmp) {
1116 arg->name = strndup(str, tmp - str);
1117 if (arg->name == NULL)
1118 return -ENOMEM;
1119 pr_debug("name:%s ", arg->name);
1120 str = tmp + 1;
1121 }
1122
1123 tmp = strchr(str, ':');
1124 if (tmp) { /* Type setting */
1125 *tmp = '\0';
1126 arg->type = strdup(tmp + 1);
1127 if (arg->type == NULL)
1128 return -ENOMEM;
1129 pr_debug("type:%s ", arg->type);
1130 }
1131
1132 tmp = strpbrk(str, "-.[");
1133 if (!is_c_varname(str) || !tmp) {
1134 /* A variable, register, symbol or special value */
1135 arg->var = strdup(str);
1136 if (arg->var == NULL)
1137 return -ENOMEM;
1138 pr_debug("%s\n", arg->var);
1139 return 0;
1140 }
1141
1142 /* Structure fields or array element */
1143 arg->var = strndup(str, tmp - str);
1144 if (arg->var == NULL)
1145 return -ENOMEM;
1146 goodname = arg->var;
1147 pr_debug("%s, ", arg->var);
1148 fieldp = &arg->field;
1149
1150 do {
1151 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1152 if (*fieldp == NULL)
1153 return -ENOMEM;
1154 if (*tmp == '[') { /* Array */
1155 str = tmp;
1156 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1157 (*fieldp)->ref = true;
1158 if (*tmp != ']' || tmp == str + 1) {
1159 semantic_error("Array index must be a"
1160 " number.\n");
1161 return -EINVAL;
1162 }
1163 tmp++;
1164 if (*tmp == '\0')
1165 tmp = NULL;
1166 } else { /* Structure */
1167 if (*tmp == '.') {
1168 str = tmp + 1;
1169 (*fieldp)->ref = false;
1170 } else if (tmp[1] == '>') {
1171 str = tmp + 2;
1172 (*fieldp)->ref = true;
1173 } else {
1174 semantic_error("Argument parse error: %s\n",
1175 str);
1176 return -EINVAL;
1177 }
1178 tmp = strpbrk(str, "-.[");
1179 }
1180 if (tmp) {
1181 (*fieldp)->name = strndup(str, tmp - str);
1182 if ((*fieldp)->name == NULL)
1183 return -ENOMEM;
1184 if (*str != '[')
1185 goodname = (*fieldp)->name;
1186 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1187 fieldp = &(*fieldp)->next;
1188 }
1189 } while (tmp);
1190 (*fieldp)->name = strdup(str);
1191 if ((*fieldp)->name == NULL)
1192 return -ENOMEM;
1193 if (*str != '[')
1194 goodname = (*fieldp)->name;
1195 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1196
1197 /* If no name is specified, set the last field name (not array index)*/
1198 if (!arg->name) {
1199 arg->name = strdup(goodname);
1200 if (arg->name == NULL)
1201 return -ENOMEM;
1202 }
1203 return 0;
1204}
1205
1206/* Parse perf-probe event command */
1207int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1208{
1209 char **argv;
1210 int argc, i, ret = 0;
1211
1212 argv = argv_split(cmd, &argc);
1213 if (!argv) {
1214 pr_debug("Failed to split arguments.\n");
1215 return -ENOMEM;
1216 }
1217 if (argc - 1 > MAX_PROBE_ARGS) {
1218 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1219 ret = -ERANGE;
1220 goto out;
1221 }
1222 /* Parse probe point */
1223 ret = parse_perf_probe_point(argv[0], pev);
1224 if (ret < 0)
1225 goto out;
1226
1227 /* Copy arguments and ensure return probe has no C argument */
1228 pev->nargs = argc - 1;
1229 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1230 if (pev->args == NULL) {
1231 ret = -ENOMEM;
1232 goto out;
1233 }
1234 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1235 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1236 if (ret >= 0 &&
1237 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1238 semantic_error("You can't specify local variable for"
1239 " kretprobe.\n");
1240 ret = -EINVAL;
1241 }
1242 }
1243out:
1244 argv_free(argv);
1245
1246 return ret;
1247}
1248
1249/* Return true if this perf_probe_event requires debuginfo */
1250bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1251{
1252 int i;
1253
1254 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1255 return true;
1256
1257 for (i = 0; i < pev->nargs; i++)
1258 if (is_c_varname(pev->args[i].var))
1259 return true;
1260
1261 return false;
1262}
1263
1264/* Parse probe_events event into struct probe_point */
1265static int parse_probe_trace_command(const char *cmd,
1266 struct probe_trace_event *tev)
1267{
1268 struct probe_trace_point *tp = &tev->point;
1269 char pr;
1270 char *p;
1271 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1272 int ret, i, argc;
1273 char **argv;
1274
1275 pr_debug("Parsing probe_events: %s\n", cmd);
1276 argv = argv_split(cmd, &argc);
1277 if (!argv) {
1278 pr_debug("Failed to split arguments.\n");
1279 return -ENOMEM;
1280 }
1281 if (argc < 2) {
1282 semantic_error("Too few probe arguments.\n");
1283 ret = -ERANGE;
1284 goto out;
1285 }
1286
1287 /* Scan event and group name. */
1288 argv0_str = strdup(argv[0]);
1289 if (argv0_str == NULL) {
1290 ret = -ENOMEM;
1291 goto out;
1292 }
1293 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1294 fmt2_str = strtok_r(NULL, "/", &fmt);
1295 fmt3_str = strtok_r(NULL, " \t", &fmt);
1296 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
1297 || fmt3_str == NULL) {
1298 semantic_error("Failed to parse event name: %s\n", argv[0]);
1299 ret = -EINVAL;
1300 goto out;
1301 }
1302 pr = fmt1_str[0];
1303 tev->group = strdup(fmt2_str);
1304 tev->event = strdup(fmt3_str);
1305 if (tev->group == NULL || tev->event == NULL) {
1306 ret = -ENOMEM;
1307 goto out;
1308 }
1309 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1310
1311 tp->retprobe = (pr == 'r');
1312
1313 /* Scan module name(if there), function name and offset */
1314 p = strchr(argv[1], ':');
1315 if (p) {
1316 tp->module = strndup(argv[1], p - argv[1]);
1317 p++;
1318 } else
1319 p = argv[1];
1320 fmt1_str = strtok_r(p, "+", &fmt);
1321 if (fmt1_str[0] == '0') /* only the address started with 0x */
1322 tp->address = strtoul(fmt1_str, NULL, 0);
1323 else {
1324 /* Only the symbol-based probe has offset */
1325 tp->symbol = strdup(fmt1_str);
1326 if (tp->symbol == NULL) {
1327 ret = -ENOMEM;
1328 goto out;
1329 }
1330 fmt2_str = strtok_r(NULL, "", &fmt);
1331 if (fmt2_str == NULL)
1332 tp->offset = 0;
1333 else
1334 tp->offset = strtoul(fmt2_str, NULL, 10);
1335 }
1336
1337 tev->nargs = argc - 2;
1338 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1339 if (tev->args == NULL) {
1340 ret = -ENOMEM;
1341 goto out;
1342 }
1343 for (i = 0; i < tev->nargs; i++) {
1344 p = strchr(argv[i + 2], '=');
1345 if (p) /* We don't need which register is assigned. */
1346 *p++ = '\0';
1347 else
1348 p = argv[i + 2];
1349 tev->args[i].name = strdup(argv[i + 2]);
1350 /* TODO: parse regs and offset */
1351 tev->args[i].value = strdup(p);
1352 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1353 ret = -ENOMEM;
1354 goto out;
1355 }
1356 }
1357 ret = 0;
1358out:
1359 free(argv0_str);
1360 argv_free(argv);
1361 return ret;
1362}
1363
1364/* Compose only probe arg */
1365int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1366{
1367 struct perf_probe_arg_field *field = pa->field;
1368 int ret;
1369 char *tmp = buf;
1370
1371 if (pa->name && pa->var)
1372 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1373 else
1374 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1375 if (ret <= 0)
1376 goto error;
1377 tmp += ret;
1378 len -= ret;
1379
1380 while (field) {
1381 if (field->name[0] == '[')
1382 ret = e_snprintf(tmp, len, "%s", field->name);
1383 else
1384 ret = e_snprintf(tmp, len, "%s%s",
1385 field->ref ? "->" : ".", field->name);
1386 if (ret <= 0)
1387 goto error;
1388 tmp += ret;
1389 len -= ret;
1390 field = field->next;
1391 }
1392
1393 if (pa->type) {
1394 ret = e_snprintf(tmp, len, ":%s", pa->type);
1395 if (ret <= 0)
1396 goto error;
1397 tmp += ret;
1398 len -= ret;
1399 }
1400
1401 return tmp - buf;
1402error:
1403 pr_debug("Failed to synthesize perf probe argument: %s\n",
1404 strerror(-ret));
1405 return ret;
1406}
1407
1408/* Compose only probe point (not argument) */
1409static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1410{
1411 char *buf, *tmp;
1412 char offs[32] = "", line[32] = "", file[32] = "";
1413 int ret, len;
1414
1415 buf = zalloc(MAX_CMDLEN);
1416 if (buf == NULL) {
1417 ret = -ENOMEM;
1418 goto error;
1419 }
1420 if (pp->offset) {
1421 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1422 if (ret <= 0)
1423 goto error;
1424 }
1425 if (pp->line) {
1426 ret = e_snprintf(line, 32, ":%d", pp->line);
1427 if (ret <= 0)
1428 goto error;
1429 }
1430 if (pp->file) {
1431 tmp = pp->file;
1432 len = strlen(tmp);
1433 if (len > 30) {
1434 tmp = strchr(pp->file + len - 30, '/');
1435 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1436 }
1437 ret = e_snprintf(file, 32, "@%s", tmp);
1438 if (ret <= 0)
1439 goto error;
1440 }
1441
1442 if (pp->function)
1443 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1444 offs, pp->retprobe ? "%return" : "", line,
1445 file);
1446 else
1447 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1448 if (ret <= 0)
1449 goto error;
1450
1451 return buf;
1452error:
1453 pr_debug("Failed to synthesize perf probe point: %s\n",
1454 strerror(-ret));
1455 free(buf);
1456 return NULL;
1457}
1458
1459#if 0
1460char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1461{
1462 char *buf;
1463 int i, len, ret;
1464
1465 buf = synthesize_perf_probe_point(&pev->point);
1466 if (!buf)
1467 return NULL;
1468
1469 len = strlen(buf);
1470 for (i = 0; i < pev->nargs; i++) {
1471 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1472 pev->args[i].name);
1473 if (ret <= 0) {
1474 free(buf);
1475 return NULL;
1476 }
1477 len += ret;
1478 }
1479
1480 return buf;
1481}
1482#endif
1483
1484static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1485 char **buf, size_t *buflen,
1486 int depth)
1487{
1488 int ret;
1489 if (ref->next) {
1490 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1491 buflen, depth + 1);
1492 if (depth < 0)
1493 goto out;
1494 }
1495
1496 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1497 if (ret < 0)
1498 depth = ret;
1499 else {
1500 *buf += ret;
1501 *buflen -= ret;
1502 }
1503out:
1504 return depth;
1505
1506}
1507
1508static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1509 char *buf, size_t buflen)
1510{
1511 struct probe_trace_arg_ref *ref = arg->ref;
1512 int ret, depth = 0;
1513 char *tmp = buf;
1514
1515 /* Argument name or separator */
1516 if (arg->name)
1517 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1518 else
1519 ret = e_snprintf(buf, buflen, " ");
1520 if (ret < 0)
1521 return ret;
1522 buf += ret;
1523 buflen -= ret;
1524
1525 /* Special case: @XXX */
1526 if (arg->value[0] == '@' && arg->ref)
1527 ref = ref->next;
1528
1529 /* Dereferencing arguments */
1530 if (ref) {
1531 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1532 &buflen, 1);
1533 if (depth < 0)
1534 return depth;
1535 }
1536
1537 /* Print argument value */
1538 if (arg->value[0] == '@' && arg->ref)
1539 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1540 arg->ref->offset);
1541 else
1542 ret = e_snprintf(buf, buflen, "%s", arg->value);
1543 if (ret < 0)
1544 return ret;
1545 buf += ret;
1546 buflen -= ret;
1547
1548 /* Closing */
1549 while (depth--) {
1550 ret = e_snprintf(buf, buflen, ")");
1551 if (ret < 0)
1552 return ret;
1553 buf += ret;
1554 buflen -= ret;
1555 }
1556 /* Print argument type */
1557 if (arg->type) {
1558 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1559 if (ret <= 0)
1560 return ret;
1561 buf += ret;
1562 }
1563
1564 return buf - tmp;
1565}
1566
1567char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1568{
1569 struct probe_trace_point *tp = &tev->point;
1570 char *buf;
1571 int i, len, ret;
1572
1573 buf = zalloc(MAX_CMDLEN);
1574 if (buf == NULL)
1575 return NULL;
1576
1577 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
1578 tev->group, tev->event);
1579 if (len <= 0)
1580 goto error;
1581
1582 /* Uprobes must have tp->address and tp->module */
1583 if (tev->uprobes && (!tp->address || !tp->module))
1584 goto error;
1585
1586 /* Use the tp->address for uprobes */
1587 if (tev->uprobes)
1588 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s:0x%lx",
1589 tp->module, tp->address);
1590 else
1591 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s%s+%lu",
1592 tp->module ?: "", tp->module ? ":" : "",
1593 tp->symbol, tp->offset);
1594
1595 if (ret <= 0)
1596 goto error;
1597 len += ret;
1598
1599 for (i = 0; i < tev->nargs; i++) {
1600 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1601 MAX_CMDLEN - len);
1602 if (ret <= 0)
1603 goto error;
1604 len += ret;
1605 }
1606
1607 return buf;
1608error:
1609 free(buf);
1610 return NULL;
1611}
1612
1613static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
1614 struct perf_probe_point *pp,
1615 bool is_kprobe)
1616{
1617 struct symbol *sym = NULL;
1618 struct map *map;
1619 u64 addr;
1620 int ret = -ENOENT;
1621
1622 if (!is_kprobe) {
1623 map = dso__new_map(tp->module);
1624 if (!map)
1625 goto out;
1626 addr = tp->address;
1627 sym = map__find_symbol(map, addr, NULL);
1628 } else {
1629 addr = kernel_get_symbol_address_by_name(tp->symbol, true);
1630 if (addr) {
1631 addr += tp->offset;
1632 sym = __find_kernel_function(addr, &map);
1633 }
1634 }
1635 if (!sym)
1636 goto out;
1637
1638 pp->retprobe = tp->retprobe;
1639 pp->offset = addr - map->unmap_ip(map, sym->start);
1640 pp->function = strdup(sym->name);
1641 ret = pp->function ? 0 : -ENOMEM;
1642
1643out:
1644 if (map && !is_kprobe) {
1645 dso__delete(map->dso);
1646 map__delete(map);
1647 }
1648
1649 return ret;
1650}
1651
1652static int convert_to_perf_probe_point(struct probe_trace_point *tp,
1653 struct perf_probe_point *pp,
1654 bool is_kprobe)
1655{
1656 char buf[128];
1657 int ret;
1658
1659 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
1660 if (!ret)
1661 return 0;
1662 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
1663 if (!ret)
1664 return 0;
1665
1666 pr_debug("Failed to find probe point from both of dwarf and map.\n");
1667
1668 if (tp->symbol) {
1669 pp->function = strdup(tp->symbol);
1670 pp->offset = tp->offset;
1671 } else if (!tp->module && !is_kprobe) {
1672 ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address);
1673 if (ret < 0)
1674 return ret;
1675 pp->function = strdup(buf);
1676 pp->offset = 0;
1677 }
1678 if (pp->function == NULL)
1679 return -ENOMEM;
1680
1681 pp->retprobe = tp->retprobe;
1682
1683 return 0;
1684}
1685
1686static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1687 struct perf_probe_event *pev, bool is_kprobe)
1688{
1689 char buf[64] = "";
1690 int i, ret;
1691
1692 /* Convert event/group name */
1693 pev->event = strdup(tev->event);
1694 pev->group = strdup(tev->group);
1695 if (pev->event == NULL || pev->group == NULL)
1696 return -ENOMEM;
1697
1698 /* Convert trace_point to probe_point */
1699 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1700 if (ret < 0)
1701 return ret;
1702
1703 /* Convert trace_arg to probe_arg */
1704 pev->nargs = tev->nargs;
1705 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1706 if (pev->args == NULL)
1707 return -ENOMEM;
1708 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1709 if (tev->args[i].name)
1710 pev->args[i].name = strdup(tev->args[i].name);
1711 else {
1712 ret = synthesize_probe_trace_arg(&tev->args[i],
1713 buf, 64);
1714 pev->args[i].name = strdup(buf);
1715 }
1716 if (pev->args[i].name == NULL && ret >= 0)
1717 ret = -ENOMEM;
1718 }
1719
1720 if (ret < 0)
1721 clear_perf_probe_event(pev);
1722
1723 return ret;
1724}
1725
1726void clear_perf_probe_event(struct perf_probe_event *pev)
1727{
1728 struct perf_probe_point *pp = &pev->point;
1729 struct perf_probe_arg_field *field, *next;
1730 int i;
1731
1732 free(pev->event);
1733 free(pev->group);
1734 free(pp->file);
1735 free(pp->function);
1736 free(pp->lazy_line);
1737
1738 for (i = 0; i < pev->nargs; i++) {
1739 free(pev->args[i].name);
1740 free(pev->args[i].var);
1741 free(pev->args[i].type);
1742 field = pev->args[i].field;
1743 while (field) {
1744 next = field->next;
1745 zfree(&field->name);
1746 free(field);
1747 field = next;
1748 }
1749 }
1750 free(pev->args);
1751 memset(pev, 0, sizeof(*pev));
1752}
1753
1754static void clear_probe_trace_event(struct probe_trace_event *tev)
1755{
1756 struct probe_trace_arg_ref *ref, *next;
1757 int i;
1758
1759 free(tev->event);
1760 free(tev->group);
1761 free(tev->point.symbol);
1762 free(tev->point.module);
1763 for (i = 0; i < tev->nargs; i++) {
1764 free(tev->args[i].name);
1765 free(tev->args[i].value);
1766 free(tev->args[i].type);
1767 ref = tev->args[i].ref;
1768 while (ref) {
1769 next = ref->next;
1770 free(ref);
1771 ref = next;
1772 }
1773 }
1774 free(tev->args);
1775 memset(tev, 0, sizeof(*tev));
1776}
1777
1778static void print_warn_msg(const char *file, bool is_kprobe)
1779{
1780
1781 if (errno == ENOENT) {
1782 const char *config;
1783
1784 if (!is_kprobe)
1785 config = "CONFIG_UPROBE_EVENTS";
1786 else
1787 config = "CONFIG_KPROBE_EVENTS";
1788
1789 pr_warning("%s file does not exist - please rebuild kernel"
1790 " with %s.\n", file, config);
1791 } else
1792 pr_warning("Failed to open %s file: %s\n", file,
1793 strerror(errno));
1794}
1795
1796static int open_probe_events(const char *trace_file, bool readwrite,
1797 bool is_kprobe)
1798{
1799 char buf[PATH_MAX];
1800 const char *__debugfs;
1801 int ret;
1802
1803 __debugfs = debugfs_find_mountpoint();
1804 if (__debugfs == NULL) {
1805 pr_warning("Debugfs is not mounted.\n");
1806 return -ENOENT;
1807 }
1808
1809 ret = e_snprintf(buf, PATH_MAX, "%s/%s", __debugfs, trace_file);
1810 if (ret >= 0) {
1811 pr_debug("Opening %s write=%d\n", buf, readwrite);
1812 if (readwrite && !probe_event_dry_run)
1813 ret = open(buf, O_RDWR, O_APPEND);
1814 else
1815 ret = open(buf, O_RDONLY, 0);
1816
1817 if (ret < 0)
1818 print_warn_msg(buf, is_kprobe);
1819 }
1820 return ret;
1821}
1822
1823static int open_kprobe_events(bool readwrite)
1824{
1825 return open_probe_events("tracing/kprobe_events", readwrite, true);
1826}
1827
1828static int open_uprobe_events(bool readwrite)
1829{
1830 return open_probe_events("tracing/uprobe_events", readwrite, false);
1831}
1832
1833/* Get raw string list of current kprobe_events or uprobe_events */
1834static struct strlist *get_probe_trace_command_rawlist(int fd)
1835{
1836 int ret, idx;
1837 FILE *fp;
1838 char buf[MAX_CMDLEN];
1839 char *p;
1840 struct strlist *sl;
1841
1842 sl = strlist__new(true, NULL);
1843
1844 fp = fdopen(dup(fd), "r");
1845 while (!feof(fp)) {
1846 p = fgets(buf, MAX_CMDLEN, fp);
1847 if (!p)
1848 break;
1849
1850 idx = strlen(p) - 1;
1851 if (p[idx] == '\n')
1852 p[idx] = '\0';
1853 ret = strlist__add(sl, buf);
1854 if (ret < 0) {
1855 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1856 strlist__delete(sl);
1857 return NULL;
1858 }
1859 }
1860 fclose(fp);
1861
1862 return sl;
1863}
1864
1865/* Show an event */
1866static int show_perf_probe_event(struct perf_probe_event *pev,
1867 const char *module)
1868{
1869 int i, ret;
1870 char buf[128];
1871 char *place;
1872
1873 /* Synthesize only event probe point */
1874 place = synthesize_perf_probe_point(&pev->point);
1875 if (!place)
1876 return -EINVAL;
1877
1878 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1879 if (ret < 0)
1880 return ret;
1881
1882 printf(" %-20s (on %s", buf, place);
1883 if (module)
1884 printf(" in %s", module);
1885
1886 if (pev->nargs > 0) {
1887 printf(" with");
1888 for (i = 0; i < pev->nargs; i++) {
1889 ret = synthesize_perf_probe_arg(&pev->args[i],
1890 buf, 128);
1891 if (ret < 0)
1892 break;
1893 printf(" %s", buf);
1894 }
1895 }
1896 printf(")\n");
1897 free(place);
1898 return ret;
1899}
1900
1901static int __show_perf_probe_events(int fd, bool is_kprobe)
1902{
1903 int ret = 0;
1904 struct probe_trace_event tev;
1905 struct perf_probe_event pev;
1906 struct strlist *rawlist;
1907 struct str_node *ent;
1908
1909 memset(&tev, 0, sizeof(tev));
1910 memset(&pev, 0, sizeof(pev));
1911
1912 rawlist = get_probe_trace_command_rawlist(fd);
1913 if (!rawlist)
1914 return -ENOENT;
1915
1916 strlist__for_each(ent, rawlist) {
1917 ret = parse_probe_trace_command(ent->s, &tev);
1918 if (ret >= 0) {
1919 ret = convert_to_perf_probe_event(&tev, &pev,
1920 is_kprobe);
1921 if (ret >= 0)
1922 ret = show_perf_probe_event(&pev,
1923 tev.point.module);
1924 }
1925 clear_perf_probe_event(&pev);
1926 clear_probe_trace_event(&tev);
1927 if (ret < 0)
1928 break;
1929 }
1930 strlist__delete(rawlist);
1931
1932 return ret;
1933}
1934
1935/* List up current perf-probe events */
1936int show_perf_probe_events(void)
1937{
1938 int fd, ret;
1939
1940 setup_pager();
1941 fd = open_kprobe_events(false);
1942
1943 if (fd < 0)
1944 return fd;
1945
1946 ret = init_symbol_maps(false);
1947 if (ret < 0)
1948 return ret;
1949
1950 ret = __show_perf_probe_events(fd, true);
1951 close(fd);
1952
1953 fd = open_uprobe_events(false);
1954 if (fd >= 0) {
1955 ret = __show_perf_probe_events(fd, false);
1956 close(fd);
1957 }
1958
1959 exit_symbol_maps();
1960 return ret;
1961}
1962
1963/* Get current perf-probe event names */
1964static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
1965{
1966 char buf[128];
1967 struct strlist *sl, *rawlist;
1968 struct str_node *ent;
1969 struct probe_trace_event tev;
1970 int ret = 0;
1971
1972 memset(&tev, 0, sizeof(tev));
1973 rawlist = get_probe_trace_command_rawlist(fd);
1974 sl = strlist__new(true, NULL);
1975 strlist__for_each(ent, rawlist) {
1976 ret = parse_probe_trace_command(ent->s, &tev);
1977 if (ret < 0)
1978 break;
1979 if (include_group) {
1980 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1981 tev.event);
1982 if (ret >= 0)
1983 ret = strlist__add(sl, buf);
1984 } else
1985 ret = strlist__add(sl, tev.event);
1986 clear_probe_trace_event(&tev);
1987 if (ret < 0)
1988 break;
1989 }
1990 strlist__delete(rawlist);
1991
1992 if (ret < 0) {
1993 strlist__delete(sl);
1994 return NULL;
1995 }
1996 return sl;
1997}
1998
1999static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
2000{
2001 int ret = 0;
2002 char *buf = synthesize_probe_trace_command(tev);
2003
2004 if (!buf) {
2005 pr_debug("Failed to synthesize probe trace event.\n");
2006 return -EINVAL;
2007 }
2008
2009 pr_debug("Writing event: %s\n", buf);
2010 if (!probe_event_dry_run) {
2011 ret = write(fd, buf, strlen(buf));
2012 if (ret <= 0)
2013 pr_warning("Failed to write event: %s\n",
2014 strerror(errno));
2015 }
2016 free(buf);
2017 return ret;
2018}
2019
2020static int get_new_event_name(char *buf, size_t len, const char *base,
2021 struct strlist *namelist, bool allow_suffix)
2022{
2023 int i, ret;
2024
2025 /* Try no suffix */
2026 ret = e_snprintf(buf, len, "%s", base);
2027 if (ret < 0) {
2028 pr_debug("snprintf() failed: %s\n", strerror(-ret));
2029 return ret;
2030 }
2031 if (!strlist__has_entry(namelist, buf))
2032 return 0;
2033
2034 if (!allow_suffix) {
2035 pr_warning("Error: event \"%s\" already exists. "
2036 "(Use -f to force duplicates.)\n", base);
2037 return -EEXIST;
2038 }
2039
2040 /* Try to add suffix */
2041 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2042 ret = e_snprintf(buf, len, "%s_%d", base, i);
2043 if (ret < 0) {
2044 pr_debug("snprintf() failed: %s\n", strerror(-ret));
2045 return ret;
2046 }
2047 if (!strlist__has_entry(namelist, buf))
2048 break;
2049 }
2050 if (i == MAX_EVENT_INDEX) {
2051 pr_warning("Too many events are on the same function.\n");
2052 ret = -ERANGE;
2053 }
2054
2055 return ret;
2056}
2057
2058static int __add_probe_trace_events(struct perf_probe_event *pev,
2059 struct probe_trace_event *tevs,
2060 int ntevs, bool allow_suffix)
2061{
2062 int i, fd, ret;
2063 struct probe_trace_event *tev = NULL;
2064 char buf[64];
2065 const char *event, *group;
2066 struct strlist *namelist;
2067
2068 if (pev->uprobes)
2069 fd = open_uprobe_events(true);
2070 else
2071 fd = open_kprobe_events(true);
2072
2073 if (fd < 0)
2074 return fd;
2075 /* Get current event names */
2076 namelist = get_probe_trace_event_names(fd, false);
2077 if (!namelist) {
2078 pr_debug("Failed to get current event list.\n");
2079 return -EIO;
2080 }
2081
2082 ret = 0;
2083 printf("Added new event%s\n", (ntevs > 1) ? "s:" : ":");
2084 for (i = 0; i < ntevs; i++) {
2085 tev = &tevs[i];
2086 if (pev->event)
2087 event = pev->event;
2088 else
2089 if (pev->point.function)
2090 event = pev->point.function;
2091 else
2092 event = tev->point.symbol;
2093 if (pev->group)
2094 group = pev->group;
2095 else
2096 group = PERFPROBE_GROUP;
2097
2098 /* Get an unused new event name */
2099 ret = get_new_event_name(buf, 64, event,
2100 namelist, allow_suffix);
2101 if (ret < 0)
2102 break;
2103 event = buf;
2104
2105 tev->event = strdup(event);
2106 tev->group = strdup(group);
2107 if (tev->event == NULL || tev->group == NULL) {
2108 ret = -ENOMEM;
2109 break;
2110 }
2111 ret = write_probe_trace_event(fd, tev);
2112 if (ret < 0)
2113 break;
2114 /* Add added event name to namelist */
2115 strlist__add(namelist, event);
2116
2117 /* Trick here - save current event/group */
2118 event = pev->event;
2119 group = pev->group;
2120 pev->event = tev->event;
2121 pev->group = tev->group;
2122 show_perf_probe_event(pev, tev->point.module);
2123 /* Trick here - restore current event/group */
2124 pev->event = (char *)event;
2125 pev->group = (char *)group;
2126
2127 /*
2128 * Probes after the first probe which comes from same
2129 * user input are always allowed to add suffix, because
2130 * there might be several addresses corresponding to
2131 * one code line.
2132 */
2133 allow_suffix = true;
2134 }
2135
2136 if (ret >= 0) {
2137 /* Show how to use the event. */
2138 printf("\nYou can now use it in all perf tools, such as:\n\n");
2139 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
2140 tev->event);
2141 }
2142
2143 strlist__delete(namelist);
2144 close(fd);
2145 return ret;
2146}
2147
2148static char *looking_function_name;
2149static int num_matched_functions;
2150
2151static int probe_function_filter(struct map *map __maybe_unused,
2152 struct symbol *sym)
2153{
2154 if ((sym->binding == STB_GLOBAL || sym->binding == STB_LOCAL) &&
2155 strcmp(looking_function_name, sym->name) == 0) {
2156 num_matched_functions++;
2157 return 0;
2158 }
2159 return 1;
2160}
2161
2162#define strdup_or_goto(str, label) \
2163 ({ char *__p = strdup(str); if (!__p) goto label; __p; })
2164
2165/*
2166 * Find probe function addresses from map.
2167 * Return an error or the number of found probe_trace_event
2168 */
2169static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
2170 struct probe_trace_event **tevs,
2171 int max_tevs, const char *target)
2172{
2173 struct map *map = NULL;
2174 struct kmap *kmap = NULL;
2175 struct ref_reloc_sym *reloc_sym = NULL;
2176 struct symbol *sym;
2177 struct rb_node *nd;
2178 struct probe_trace_event *tev;
2179 struct perf_probe_point *pp = &pev->point;
2180 struct probe_trace_point *tp;
2181 int ret, i;
2182
2183 /* Init maps of given executable or kernel */
2184 if (pev->uprobes)
2185 map = dso__new_map(target);
2186 else
2187 map = kernel_get_module_map(target);
2188 if (!map) {
2189 ret = -EINVAL;
2190 goto out;
2191 }
2192
2193 /*
2194 * Load matched symbols: Since the different local symbols may have
2195 * same name but different addresses, this lists all the symbols.
2196 */
2197 num_matched_functions = 0;
2198 looking_function_name = pp->function;
2199 ret = map__load(map, probe_function_filter);
2200 if (ret || num_matched_functions == 0) {
2201 pr_err("Failed to find symbol %s in %s\n", pp->function,
2202 target ? : "kernel");
2203 ret = -ENOENT;
2204 goto out;
2205 } else if (num_matched_functions > max_tevs) {
2206 pr_err("Too many functions matched in %s\n",
2207 target ? : "kernel");
2208 ret = -E2BIG;
2209 goto out;
2210 }
2211
2212 if (!pev->uprobes) {
2213 kmap = map__kmap(map);
2214 reloc_sym = kmap->ref_reloc_sym;
2215 if (!reloc_sym) {
2216 pr_warning("Relocated base symbol is not found!\n");
2217 ret = -EINVAL;
2218 goto out;
2219 }
2220 }
2221
2222 /* Setup result trace-probe-events */
2223 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
2224 if (!*tevs) {
2225 ret = -ENOMEM;
2226 goto out;
2227 }
2228
2229 ret = 0;
2230 map__for_each_symbol(map, sym, nd) {
2231 tev = (*tevs) + ret;
2232 tp = &tev->point;
2233 if (ret == num_matched_functions) {
2234 pr_warning("Too many symbols are listed. Skip it.\n");
2235 break;
2236 }
2237 ret++;
2238
2239 if (pp->offset > sym->end - sym->start) {
2240 pr_warning("Offset %ld is bigger than the size of %s\n",
2241 pp->offset, sym->name);
2242 ret = -ENOENT;
2243 goto err_out;
2244 }
2245 /* Add one probe point */
2246 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
2247 if (reloc_sym) {
2248 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
2249 tp->offset = tp->address - reloc_sym->addr;
2250 } else {
2251 tp->symbol = strdup_or_goto(sym->name, nomem_out);
2252 tp->offset = pp->offset;
2253 }
2254 tp->retprobe = pp->retprobe;
2255 if (target)
2256 tev->point.module = strdup_or_goto(target, nomem_out);
2257 tev->uprobes = pev->uprobes;
2258 tev->nargs = pev->nargs;
2259 if (tev->nargs) {
2260 tev->args = zalloc(sizeof(struct probe_trace_arg) *
2261 tev->nargs);
2262 if (tev->args == NULL)
2263 goto nomem_out;
2264 }
2265 for (i = 0; i < tev->nargs; i++) {
2266 if (pev->args[i].name)
2267 tev->args[i].name =
2268 strdup_or_goto(pev->args[i].name,
2269 nomem_out);
2270
2271 tev->args[i].value = strdup_or_goto(pev->args[i].var,
2272 nomem_out);
2273 if (pev->args[i].type)
2274 tev->args[i].type =
2275 strdup_or_goto(pev->args[i].type,
2276 nomem_out);
2277 }
2278 }
2279
2280out:
2281 if (map && pev->uprobes) {
2282 /* Only when using uprobe(exec) map needs to be released */
2283 dso__delete(map->dso);
2284 map__delete(map);
2285 }
2286 return ret;
2287
2288nomem_out:
2289 ret = -ENOMEM;
2290err_out:
2291 clear_probe_trace_events(*tevs, num_matched_functions);
2292 zfree(tevs);
2293 goto out;
2294}
2295
2296static int convert_to_probe_trace_events(struct perf_probe_event *pev,
2297 struct probe_trace_event **tevs,
2298 int max_tevs, const char *target)
2299{
2300 int ret;
2301
2302 if (pev->uprobes && !pev->group) {
2303 /* Replace group name if not given */
2304 ret = convert_exec_to_group(target, &pev->group);
2305 if (ret != 0) {
2306 pr_warning("Failed to make a group name.\n");
2307 return ret;
2308 }
2309 }
2310
2311 /* Convert perf_probe_event with debuginfo */
2312 ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, target);
2313 if (ret != 0)
2314 return ret; /* Found in debuginfo or got an error */
2315
2316 return find_probe_trace_events_from_map(pev, tevs, max_tevs, target);
2317}
2318
2319struct __event_package {
2320 struct perf_probe_event *pev;
2321 struct probe_trace_event *tevs;
2322 int ntevs;
2323};
2324
2325int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
2326 int max_tevs, const char *target, bool force_add)
2327{
2328 int i, j, ret;
2329 struct __event_package *pkgs;
2330
2331 ret = 0;
2332 pkgs = zalloc(sizeof(struct __event_package) * npevs);
2333
2334 if (pkgs == NULL)
2335 return -ENOMEM;
2336
2337 ret = init_symbol_maps(pevs->uprobes);
2338 if (ret < 0) {
2339 free(pkgs);
2340 return ret;
2341 }
2342
2343 /* Loop 1: convert all events */
2344 for (i = 0; i < npevs; i++) {
2345 pkgs[i].pev = &pevs[i];
2346 /* Convert with or without debuginfo */
2347 ret = convert_to_probe_trace_events(pkgs[i].pev,
2348 &pkgs[i].tevs,
2349 max_tevs,
2350 target);
2351 if (ret < 0)
2352 goto end;
2353 pkgs[i].ntevs = ret;
2354 }
2355
2356 /* Loop 2: add all events */
2357 for (i = 0; i < npevs; i++) {
2358 ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
2359 pkgs[i].ntevs, force_add);
2360 if (ret < 0)
2361 break;
2362 }
2363end:
2364 /* Loop 3: cleanup and free trace events */
2365 for (i = 0; i < npevs; i++) {
2366 for (j = 0; j < pkgs[i].ntevs; j++)
2367 clear_probe_trace_event(&pkgs[i].tevs[j]);
2368 zfree(&pkgs[i].tevs);
2369 }
2370 free(pkgs);
2371 exit_symbol_maps();
2372
2373 return ret;
2374}
2375
2376static int __del_trace_probe_event(int fd, struct str_node *ent)
2377{
2378 char *p;
2379 char buf[128];
2380 int ret;
2381
2382 /* Convert from perf-probe event to trace-probe event */
2383 ret = e_snprintf(buf, 128, "-:%s", ent->s);
2384 if (ret < 0)
2385 goto error;
2386
2387 p = strchr(buf + 2, ':');
2388 if (!p) {
2389 pr_debug("Internal error: %s should have ':' but not.\n",
2390 ent->s);
2391 ret = -ENOTSUP;
2392 goto error;
2393 }
2394 *p = '/';
2395
2396 pr_debug("Writing event: %s\n", buf);
2397 ret = write(fd, buf, strlen(buf));
2398 if (ret < 0) {
2399 ret = -errno;
2400 goto error;
2401 }
2402
2403 printf("Removed event: %s\n", ent->s);
2404 return 0;
2405error:
2406 pr_warning("Failed to delete event: %s\n", strerror(-ret));
2407 return ret;
2408}
2409
2410static int del_trace_probe_event(int fd, const char *buf,
2411 struct strlist *namelist)
2412{
2413 struct str_node *ent, *n;
2414 int ret = -1;
2415
2416 if (strpbrk(buf, "*?")) { /* Glob-exp */
2417 strlist__for_each_safe(ent, n, namelist)
2418 if (strglobmatch(ent->s, buf)) {
2419 ret = __del_trace_probe_event(fd, ent);
2420 if (ret < 0)
2421 break;
2422 strlist__remove(namelist, ent);
2423 }
2424 } else {
2425 ent = strlist__find(namelist, buf);
2426 if (ent) {
2427 ret = __del_trace_probe_event(fd, ent);
2428 if (ret >= 0)
2429 strlist__remove(namelist, ent);
2430 }
2431 }
2432
2433 return ret;
2434}
2435
2436int del_perf_probe_events(struct strlist *dellist)
2437{
2438 int ret = -1, ufd = -1, kfd = -1;
2439 char buf[128];
2440 const char *group, *event;
2441 char *p, *str;
2442 struct str_node *ent;
2443 struct strlist *namelist = NULL, *unamelist = NULL;
2444
2445 /* Get current event names */
2446 kfd = open_kprobe_events(true);
2447 if (kfd < 0)
2448 return kfd;
2449
2450 namelist = get_probe_trace_event_names(kfd, true);
2451 ufd = open_uprobe_events(true);
2452
2453 if (ufd >= 0)
2454 unamelist = get_probe_trace_event_names(ufd, true);
2455
2456 if (namelist == NULL && unamelist == NULL)
2457 goto error;
2458
2459 strlist__for_each(ent, dellist) {
2460 str = strdup(ent->s);
2461 if (str == NULL) {
2462 ret = -ENOMEM;
2463 goto error;
2464 }
2465 pr_debug("Parsing: %s\n", str);
2466 p = strchr(str, ':');
2467 if (p) {
2468 group = str;
2469 *p = '\0';
2470 event = p + 1;
2471 } else {
2472 group = "*";
2473 event = str;
2474 }
2475
2476 ret = e_snprintf(buf, 128, "%s:%s", group, event);
2477 if (ret < 0) {
2478 pr_err("Failed to copy event.");
2479 free(str);
2480 goto error;
2481 }
2482
2483 pr_debug("Group: %s, Event: %s\n", group, event);
2484
2485 if (namelist)
2486 ret = del_trace_probe_event(kfd, buf, namelist);
2487
2488 if (unamelist && ret != 0)
2489 ret = del_trace_probe_event(ufd, buf, unamelist);
2490
2491 if (ret != 0)
2492 pr_info("Info: Event \"%s\" does not exist.\n", buf);
2493
2494 free(str);
2495 }
2496
2497error:
2498 if (kfd >= 0) {
2499 strlist__delete(namelist);
2500 close(kfd);
2501 }
2502
2503 if (ufd >= 0) {
2504 strlist__delete(unamelist);
2505 close(ufd);
2506 }
2507
2508 return ret;
2509}
2510
2511/* TODO: don't use a global variable for filter ... */
2512static struct strfilter *available_func_filter;
2513
2514/*
2515 * If a symbol corresponds to a function with global binding and
2516 * matches filter return 0. For all others return 1.
2517 */
2518static int filter_available_functions(struct map *map __maybe_unused,
2519 struct symbol *sym)
2520{
2521 if ((sym->binding == STB_GLOBAL || sym->binding == STB_LOCAL) &&
2522 strfilter__compare(available_func_filter, sym->name))
2523 return 0;
2524 return 1;
2525}
2526
2527int show_available_funcs(const char *target, struct strfilter *_filter,
2528 bool user)
2529{
2530 struct map *map;
2531 int ret;
2532
2533 ret = init_symbol_maps(user);
2534 if (ret < 0)
2535 return ret;
2536
2537 /* Get a symbol map */
2538 if (user)
2539 map = dso__new_map(target);
2540 else
2541 map = kernel_get_module_map(target);
2542 if (!map) {
2543 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
2544 return -EINVAL;
2545 }
2546
2547 /* Load symbols with given filter */
2548 available_func_filter = _filter;
2549 if (map__load(map, filter_available_functions)) {
2550 pr_err("Failed to load symbols in %s\n", (target) ? : "kernel");
2551 goto end;
2552 }
2553 if (!dso__sorted_by_name(map->dso, map->type))
2554 dso__sort_by_name(map->dso, map->type);
2555
2556 /* Show all (filtered) symbols */
2557 setup_pager();
2558 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2559end:
2560 if (user) {
2561 dso__delete(map->dso);
2562 map__delete(map);
2563 }
2564 exit_symbol_maps();
2565
2566 return ret;
2567}
2568