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 <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/fs.h>
44#include "trace-event.h" /* For __maybe_unused */
45#include "probe-event.h"
46#include "probe-finder.h"
47#include "probe-file.h"
48#include "session.h"
49
50#define MAX_CMDLEN 256
51#define PERFPROBE_GROUP "probe"
52
53bool probe_event_dry_run; /* Dry run flag */
54struct probe_conf probe_conf;
55
56#define semantic_error(msg ...) pr_err("Semantic error :" msg)
57
58int e_snprintf(char *str, size_t size, const char *format, ...)
59{
60 int ret;
61 va_list ap;
62 va_start(ap, format);
63 ret = vsnprintf(str, size, format, ap);
64 va_end(ap);
65 if (ret >= (int)size)
66 ret = -E2BIG;
67 return ret;
68}
69
70static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
71static struct machine *host_machine;
72
73/* Initialize symbol maps and path of vmlinux/modules */
74int init_probe_symbol_maps(bool user_only)
75{
76 int ret;
77
78 symbol_conf.sort_by_name = true;
79 symbol_conf.allow_aliases = true;
80 ret = symbol__init(NULL);
81 if (ret < 0) {
82 pr_debug("Failed to init symbol map.\n");
83 goto out;
84 }
85
86 if (host_machine || user_only) /* already initialized */
87 return 0;
88
89 if (symbol_conf.vmlinux_name)
90 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
91
92 host_machine = machine__new_host();
93 if (!host_machine) {
94 pr_debug("machine__new_host() failed.\n");
95 symbol__exit();
96 ret = -1;
97 }
98out:
99 if (ret < 0)
100 pr_warning("Failed to init vmlinux path.\n");
101 return ret;
102}
103
104void exit_probe_symbol_maps(void)
105{
106 if (host_machine) {
107 machine__delete(host_machine);
108 host_machine = NULL;
109 }
110 symbol__exit();
111}
112
113static struct symbol *__find_kernel_function_by_name(const char *name,
114 struct map **mapp)
115{
116 return machine__find_kernel_function_by_name(host_machine, name, mapp,
117 NULL);
118}
119
120static struct symbol *__find_kernel_function(u64 addr, struct map **mapp)
121{
122 return machine__find_kernel_function(host_machine, addr, mapp, NULL);
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, NULL) < 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 machine__findnew_module_map(host_machine, 0, module);
171
172 if (!module)
173 module = "kernel";
174
175 for (pos = maps__first(maps); pos; pos = map__next(pos)) {
176 if (strncmp(pos->dso->short_name + 1, module,
177 pos->dso->short_name_len - 2) == 0) {
178 return pos;
179 }
180 }
181 return NULL;
182}
183
184static struct map *get_target_map(const char *target, bool user)
185{
186 /* Init maps of given executable or kernel */
187 if (user)
188 return dso__new_map(target);
189 else
190 return kernel_get_module_map(target);
191}
192
193static void put_target_map(struct map *map, bool user)
194{
195 if (map && user) {
196 /* Only the user map needs to be released */
197 map__put(map);
198 }
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 ptr2 = strpbrk(ptr1, "-._");
219 if (ptr2)
220 *ptr2 = '\0';
221 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
222 if (ret < 0)
223 goto out;
224
225 *result = strdup(buf);
226 ret = *result ? 0 : -ENOMEM;
227
228out:
229 free(exec_copy);
230 return ret;
231}
232
233static void clear_perf_probe_point(struct perf_probe_point *pp)
234{
235 free(pp->file);
236 free(pp->function);
237 free(pp->lazy_line);
238}
239
240static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
241{
242 int i;
243
244 for (i = 0; i < ntevs; i++)
245 clear_probe_trace_event(tevs + i);
246}
247
248static bool kprobe_blacklist__listed(unsigned long address);
249static bool kprobe_warn_out_range(const char *symbol, unsigned long address)
250{
251 u64 etext_addr = 0;
252 int ret;
253
254 /* Get the address of _etext for checking non-probable text symbol */
255 ret = kernel_get_symbol_address_by_name("_etext", &etext_addr,
256 false, false);
257
258 if (ret == 0 && etext_addr < address)
259 pr_warning("%s is out of .text, skip it.\n", symbol);
260 else if (kprobe_blacklist__listed(address))
261 pr_warning("%s is blacklisted function, skip it.\n", symbol);
262 else
263 return false;
264
265 return true;
266}
267
268#ifdef HAVE_DWARF_SUPPORT
269
270static int kernel_get_module_dso(const char *module, struct dso **pdso)
271{
272 struct dso *dso;
273 struct map *map;
274 const char *vmlinux_name;
275 int ret = 0;
276
277 if (module) {
278 char module_name[128];
279
280 snprintf(module_name, sizeof(module_name), "[%s]", module);
281 map = map_groups__find_by_name(&host_machine->kmaps, MAP__FUNCTION, module_name);
282 if (map) {
283 dso = map->dso;
284 goto found;
285 }
286 pr_debug("Failed to find module %s.\n", module);
287 return -ENOENT;
288 }
289
290 map = machine__kernel_map(host_machine);
291 dso = map->dso;
292
293 vmlinux_name = symbol_conf.vmlinux_name;
294 dso->load_errno = 0;
295 if (vmlinux_name)
296 ret = dso__load_vmlinux(dso, map, vmlinux_name, false, NULL);
297 else
298 ret = dso__load_vmlinux_path(dso, map, NULL);
299found:
300 *pdso = dso;
301 return ret;
302}
303
304/*
305 * Some binaries like glibc have special symbols which are on the symbol
306 * table, but not in the debuginfo. If we can find the address of the
307 * symbol from map, we can translate the address back to the probe point.
308 */
309static int find_alternative_probe_point(struct debuginfo *dinfo,
310 struct perf_probe_point *pp,
311 struct perf_probe_point *result,
312 const char *target, bool uprobes)
313{
314 struct map *map = NULL;
315 struct symbol *sym;
316 u64 address = 0;
317 int ret = -ENOENT;
318
319 /* This can work only for function-name based one */
320 if (!pp->function || pp->file)
321 return -ENOTSUP;
322
323 map = get_target_map(target, uprobes);
324 if (!map)
325 return -EINVAL;
326
327 /* Find the address of given function */
328 map__for_each_symbol_by_name(map, pp->function, sym) {
329 if (uprobes)
330 address = sym->start;
331 else
332 address = map->unmap_ip(map, sym->start);
333 break;
334 }
335 if (!address) {
336 ret = -ENOENT;
337 goto out;
338 }
339 pr_debug("Symbol %s address found : %" PRIx64 "\n",
340 pp->function, address);
341
342 ret = debuginfo__find_probe_point(dinfo, (unsigned long)address,
343 result);
344 if (ret <= 0)
345 ret = (!ret) ? -ENOENT : ret;
346 else {
347 result->offset += pp->offset;
348 result->line += pp->line;
349 result->retprobe = pp->retprobe;
350 ret = 0;
351 }
352
353out:
354 put_target_map(map, uprobes);
355 return ret;
356
357}
358
359static int get_alternative_probe_event(struct debuginfo *dinfo,
360 struct perf_probe_event *pev,
361 struct perf_probe_point *tmp)
362{
363 int ret;
364
365 memcpy(tmp, &pev->point, sizeof(*tmp));
366 memset(&pev->point, 0, sizeof(pev->point));
367 ret = find_alternative_probe_point(dinfo, tmp, &pev->point,
368 pev->target, pev->uprobes);
369 if (ret < 0)
370 memcpy(&pev->point, tmp, sizeof(*tmp));
371
372 return ret;
373}
374
375static int get_alternative_line_range(struct debuginfo *dinfo,
376 struct line_range *lr,
377 const char *target, bool user)
378{
379 struct perf_probe_point pp = { .function = lr->function,
380 .file = lr->file,
381 .line = lr->start };
382 struct perf_probe_point result;
383 int ret, len = 0;
384
385 memset(&result, 0, sizeof(result));
386
387 if (lr->end != INT_MAX)
388 len = lr->end - lr->start;
389 ret = find_alternative_probe_point(dinfo, &pp, &result,
390 target, user);
391 if (!ret) {
392 lr->function = result.function;
393 lr->file = result.file;
394 lr->start = result.line;
395 if (lr->end != INT_MAX)
396 lr->end = lr->start + len;
397 clear_perf_probe_point(&pp);
398 }
399 return ret;
400}
401
402/* Open new debuginfo of given module */
403static struct debuginfo *open_debuginfo(const char *module, bool silent)
404{
405 const char *path = module;
406 char reason[STRERR_BUFSIZE];
407 struct debuginfo *ret = NULL;
408 struct dso *dso = NULL;
409 int err;
410
411 if (!module || !strchr(module, '/')) {
412 err = kernel_get_module_dso(module, &dso);
413 if (err < 0) {
414 if (!dso || dso->load_errno == 0) {
415 if (!strerror_r(-err, reason, STRERR_BUFSIZE))
416 strcpy(reason, "(unknown)");
417 } else
418 dso__strerror_load(dso, reason, STRERR_BUFSIZE);
419 if (!silent)
420 pr_err("Failed to find the path for %s: %s\n",
421 module ?: "kernel", reason);
422 return NULL;
423 }
424 path = dso->long_name;
425 }
426 ret = debuginfo__new(path);
427 if (!ret && !silent) {
428 pr_warning("The %s file has no debug information.\n", path);
429 if (!module || !strtailcmp(path, ".ko"))
430 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
431 else
432 pr_warning("Rebuild with -g, ");
433 pr_warning("or install an appropriate debuginfo package.\n");
434 }
435 return ret;
436}
437
438/* For caching the last debuginfo */
439static struct debuginfo *debuginfo_cache;
440static char *debuginfo_cache_path;
441
442static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
443{
444 const char *path = module;
445
446 /* If the module is NULL, it should be the kernel. */
447 if (!module)
448 path = "kernel";
449
450 if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path))
451 goto out;
452
453 /* Copy module path */
454 free(debuginfo_cache_path);
455 debuginfo_cache_path = strdup(path);
456 if (!debuginfo_cache_path) {
457 debuginfo__delete(debuginfo_cache);
458 debuginfo_cache = NULL;
459 goto out;
460 }
461
462 debuginfo_cache = open_debuginfo(module, silent);
463 if (!debuginfo_cache)
464 zfree(&debuginfo_cache_path);
465out:
466 return debuginfo_cache;
467}
468
469static void debuginfo_cache__exit(void)
470{
471 debuginfo__delete(debuginfo_cache);
472 debuginfo_cache = NULL;
473 zfree(&debuginfo_cache_path);
474}
475
476
477static int get_text_start_address(const char *exec, unsigned long *address)
478{
479 Elf *elf;
480 GElf_Ehdr ehdr;
481 GElf_Shdr shdr;
482 int fd, ret = -ENOENT;
483
484 fd = open(exec, O_RDONLY);
485 if (fd < 0)
486 return -errno;
487
488 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
489 if (elf == NULL)
490 return -EINVAL;
491
492 if (gelf_getehdr(elf, &ehdr) == NULL)
493 goto out;
494
495 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
496 goto out;
497
498 *address = shdr.sh_addr - shdr.sh_offset;
499 ret = 0;
500out:
501 elf_end(elf);
502 return ret;
503}
504
505/*
506 * Convert trace point to probe point with debuginfo
507 */
508static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
509 struct perf_probe_point *pp,
510 bool is_kprobe)
511{
512 struct debuginfo *dinfo = NULL;
513 unsigned long stext = 0;
514 u64 addr = tp->address;
515 int ret = -ENOENT;
516
517 /* convert the address to dwarf address */
518 if (!is_kprobe) {
519 if (!addr) {
520 ret = -EINVAL;
521 goto error;
522 }
523 ret = get_text_start_address(tp->module, &stext);
524 if (ret < 0)
525 goto error;
526 addr += stext;
527 } else if (tp->symbol) {
528 /* If the module is given, this returns relative address */
529 ret = kernel_get_symbol_address_by_name(tp->symbol, &addr,
530 false, !!tp->module);
531 if (ret != 0)
532 goto error;
533 addr += tp->offset;
534 }
535
536 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
537 tp->module ? : "kernel");
538
539 dinfo = debuginfo_cache__open(tp->module, verbose == 0);
540 if (dinfo)
541 ret = debuginfo__find_probe_point(dinfo,
542 (unsigned long)addr, pp);
543 else
544 ret = -ENOENT;
545
546 if (ret > 0) {
547 pp->retprobe = tp->retprobe;
548 return 0;
549 }
550error:
551 pr_debug("Failed to find corresponding probes from debuginfo.\n");
552 return ret ? : -ENOENT;
553}
554
555static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
556 int ntevs, const char *exec)
557{
558 int i, ret = 0;
559 unsigned long stext = 0;
560
561 if (!exec)
562 return 0;
563
564 ret = get_text_start_address(exec, &stext);
565 if (ret < 0)
566 return ret;
567
568 for (i = 0; i < ntevs && ret >= 0; i++) {
569 /* point.address is the addres of point.symbol + point.offset */
570 tevs[i].point.address -= stext;
571 tevs[i].point.module = strdup(exec);
572 if (!tevs[i].point.module) {
573 ret = -ENOMEM;
574 break;
575 }
576 tevs[i].uprobes = true;
577 }
578
579 return ret;
580}
581
582static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
583 int ntevs, const char *module)
584{
585 int i, ret = 0;
586 char *tmp;
587
588 if (!module)
589 return 0;
590
591 tmp = strrchr(module, '/');
592 if (tmp) {
593 /* This is a module path -- get the module name */
594 module = strdup(tmp + 1);
595 if (!module)
596 return -ENOMEM;
597 tmp = strchr(module, '.');
598 if (tmp)
599 *tmp = '\0';
600 tmp = (char *)module; /* For free() */
601 }
602
603 for (i = 0; i < ntevs; i++) {
604 tevs[i].point.module = strdup(module);
605 if (!tevs[i].point.module) {
606 ret = -ENOMEM;
607 break;
608 }
609 }
610
611 free(tmp);
612 return ret;
613}
614
615/* Post processing the probe events */
616static int post_process_probe_trace_events(struct probe_trace_event *tevs,
617 int ntevs, const char *module,
618 bool uprobe)
619{
620 struct ref_reloc_sym *reloc_sym;
621 char *tmp;
622 int i, skipped = 0;
623
624 if (uprobe)
625 return add_exec_to_probe_trace_events(tevs, ntevs, module);
626
627 /* Note that currently ref_reloc_sym based probe is not for drivers */
628 if (module)
629 return add_module_to_probe_trace_events(tevs, ntevs, module);
630
631 reloc_sym = kernel_get_ref_reloc_sym();
632 if (!reloc_sym) {
633 pr_warning("Relocated base symbol is not found!\n");
634 return -EINVAL;
635 }
636
637 for (i = 0; i < ntevs; i++) {
638 if (!tevs[i].point.address || tevs[i].point.retprobe)
639 continue;
640 /* If we found a wrong one, mark it by NULL symbol */
641 if (kprobe_warn_out_range(tevs[i].point.symbol,
642 tevs[i].point.address)) {
643 tmp = NULL;
644 skipped++;
645 } else {
646 tmp = strdup(reloc_sym->name);
647 if (!tmp)
648 return -ENOMEM;
649 }
650 /* If we have no realname, use symbol for it */
651 if (!tevs[i].point.realname)
652 tevs[i].point.realname = tevs[i].point.symbol;
653 else
654 free(tevs[i].point.symbol);
655 tevs[i].point.symbol = tmp;
656 tevs[i].point.offset = tevs[i].point.address -
657 reloc_sym->unrelocated_addr;
658 }
659 return skipped;
660}
661
662/* Try to find perf_probe_event with debuginfo */
663static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
664 struct probe_trace_event **tevs)
665{
666 bool need_dwarf = perf_probe_event_need_dwarf(pev);
667 struct perf_probe_point tmp;
668 struct debuginfo *dinfo;
669 int ntevs, ret = 0;
670
671 dinfo = open_debuginfo(pev->target, !need_dwarf);
672 if (!dinfo) {
673 if (need_dwarf)
674 return -ENOENT;
675 pr_debug("Could not open debuginfo. Try to use symbols.\n");
676 return 0;
677 }
678
679 pr_debug("Try to find probe point from debuginfo.\n");
680 /* Searching trace events corresponding to a probe event */
681 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
682
683 if (ntevs == 0) { /* Not found, retry with an alternative */
684 ret = get_alternative_probe_event(dinfo, pev, &tmp);
685 if (!ret) {
686 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
687 /*
688 * Write back to the original probe_event for
689 * setting appropriate (user given) event name
690 */
691 clear_perf_probe_point(&pev->point);
692 memcpy(&pev->point, &tmp, sizeof(tmp));
693 }
694 }
695
696 debuginfo__delete(dinfo);
697
698 if (ntevs > 0) { /* Succeeded to find trace events */
699 pr_debug("Found %d probe_trace_events.\n", ntevs);
700 ret = post_process_probe_trace_events(*tevs, ntevs,
701 pev->target, pev->uprobes);
702 if (ret < 0 || ret == ntevs) {
703 clear_probe_trace_events(*tevs, ntevs);
704 zfree(tevs);
705 }
706 if (ret != ntevs)
707 return ret < 0 ? ret : ntevs;
708 ntevs = 0;
709 /* Fall through */
710 }
711
712 if (ntevs == 0) { /* No error but failed to find probe point. */
713 pr_warning("Probe point '%s' not found.\n",
714 synthesize_perf_probe_point(&pev->point));
715 return -ENOENT;
716 }
717 /* Error path : ntevs < 0 */
718 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
719 if (ntevs < 0) {
720 if (ntevs == -EBADF)
721 pr_warning("Warning: No dwarf info found in the vmlinux - "
722 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
723 if (!need_dwarf) {
724 pr_debug("Trying to use symbols.\n");
725 return 0;
726 }
727 }
728 return ntevs;
729}
730
731#define LINEBUF_SIZE 256
732#define NR_ADDITIONAL_LINES 2
733
734static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
735{
736 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
737 const char *color = show_num ? "" : PERF_COLOR_BLUE;
738 const char *prefix = NULL;
739
740 do {
741 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
742 goto error;
743 if (skip)
744 continue;
745 if (!prefix) {
746 prefix = show_num ? "%7d " : " ";
747 color_fprintf(stdout, color, prefix, l);
748 }
749 color_fprintf(stdout, color, "%s", buf);
750
751 } while (strchr(buf, '\n') == NULL);
752
753 return 1;
754error:
755 if (ferror(fp)) {
756 pr_warning("File read error: %s\n",
757 strerror_r(errno, sbuf, sizeof(sbuf)));
758 return -1;
759 }
760 return 0;
761}
762
763static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
764{
765 int rv = __show_one_line(fp, l, skip, show_num);
766 if (rv == 0) {
767 pr_warning("Source file is shorter than expected.\n");
768 rv = -1;
769 }
770 return rv;
771}
772
773#define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
774#define show_one_line(f,l) _show_one_line(f,l,false,false)
775#define skip_one_line(f,l) _show_one_line(f,l,true,false)
776#define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
777
778/*
779 * Show line-range always requires debuginfo to find source file and
780 * line number.
781 */
782static int __show_line_range(struct line_range *lr, const char *module,
783 bool user)
784{
785 int l = 1;
786 struct int_node *ln;
787 struct debuginfo *dinfo;
788 FILE *fp;
789 int ret;
790 char *tmp;
791 char sbuf[STRERR_BUFSIZE];
792
793 /* Search a line range */
794 dinfo = open_debuginfo(module, false);
795 if (!dinfo)
796 return -ENOENT;
797
798 ret = debuginfo__find_line_range(dinfo, lr);
799 if (!ret) { /* Not found, retry with an alternative */
800 ret = get_alternative_line_range(dinfo, lr, module, user);
801 if (!ret)
802 ret = debuginfo__find_line_range(dinfo, lr);
803 }
804 debuginfo__delete(dinfo);
805 if (ret == 0 || ret == -ENOENT) {
806 pr_warning("Specified source line is not found.\n");
807 return -ENOENT;
808 } else if (ret < 0) {
809 pr_warning("Debuginfo analysis failed.\n");
810 return ret;
811 }
812
813 /* Convert source file path */
814 tmp = lr->path;
815 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
816
817 /* Free old path when new path is assigned */
818 if (tmp != lr->path)
819 free(tmp);
820
821 if (ret < 0) {
822 pr_warning("Failed to find source file path.\n");
823 return ret;
824 }
825
826 setup_pager();
827
828 if (lr->function)
829 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
830 lr->start - lr->offset);
831 else
832 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
833
834 fp = fopen(lr->path, "r");
835 if (fp == NULL) {
836 pr_warning("Failed to open %s: %s\n", lr->path,
837 strerror_r(errno, sbuf, sizeof(sbuf)));
838 return -errno;
839 }
840 /* Skip to starting line number */
841 while (l < lr->start) {
842 ret = skip_one_line(fp, l++);
843 if (ret < 0)
844 goto end;
845 }
846
847 intlist__for_each(ln, lr->line_list) {
848 for (; ln->i > l; l++) {
849 ret = show_one_line(fp, l - lr->offset);
850 if (ret < 0)
851 goto end;
852 }
853 ret = show_one_line_with_num(fp, l++ - lr->offset);
854 if (ret < 0)
855 goto end;
856 }
857
858 if (lr->end == INT_MAX)
859 lr->end = l + NR_ADDITIONAL_LINES;
860 while (l <= lr->end) {
861 ret = show_one_line_or_eof(fp, l++ - lr->offset);
862 if (ret <= 0)
863 break;
864 }
865end:
866 fclose(fp);
867 return ret;
868}
869
870int show_line_range(struct line_range *lr, const char *module, bool user)
871{
872 int ret;
873
874 ret = init_probe_symbol_maps(user);
875 if (ret < 0)
876 return ret;
877 ret = __show_line_range(lr, module, user);
878 exit_probe_symbol_maps();
879
880 return ret;
881}
882
883static int show_available_vars_at(struct debuginfo *dinfo,
884 struct perf_probe_event *pev,
885 struct strfilter *_filter)
886{
887 char *buf;
888 int ret, i, nvars;
889 struct str_node *node;
890 struct variable_list *vls = NULL, *vl;
891 struct perf_probe_point tmp;
892 const char *var;
893
894 buf = synthesize_perf_probe_point(&pev->point);
895 if (!buf)
896 return -EINVAL;
897 pr_debug("Searching variables at %s\n", buf);
898
899 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
900 if (!ret) { /* Not found, retry with an alternative */
901 ret = get_alternative_probe_event(dinfo, pev, &tmp);
902 if (!ret) {
903 ret = debuginfo__find_available_vars_at(dinfo, pev,
904 &vls);
905 /* Release the old probe_point */
906 clear_perf_probe_point(&tmp);
907 }
908 }
909 if (ret <= 0) {
910 if (ret == 0 || ret == -ENOENT) {
911 pr_err("Failed to find the address of %s\n", buf);
912 ret = -ENOENT;
913 } else
914 pr_warning("Debuginfo analysis failed.\n");
915 goto end;
916 }
917
918 /* Some variables are found */
919 fprintf(stdout, "Available variables at %s\n", buf);
920 for (i = 0; i < ret; i++) {
921 vl = &vls[i];
922 /*
923 * A probe point might be converted to
924 * several trace points.
925 */
926 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
927 vl->point.offset);
928 zfree(&vl->point.symbol);
929 nvars = 0;
930 if (vl->vars) {
931 strlist__for_each(node, vl->vars) {
932 var = strchr(node->s, '\t') + 1;
933 if (strfilter__compare(_filter, var)) {
934 fprintf(stdout, "\t\t%s\n", node->s);
935 nvars++;
936 }
937 }
938 strlist__delete(vl->vars);
939 }
940 if (nvars == 0)
941 fprintf(stdout, "\t\t(No matched variables)\n");
942 }
943 free(vls);
944end:
945 free(buf);
946 return ret;
947}
948
949/* Show available variables on given probe point */
950int show_available_vars(struct perf_probe_event *pevs, int npevs,
951 struct strfilter *_filter)
952{
953 int i, ret = 0;
954 struct debuginfo *dinfo;
955
956 ret = init_probe_symbol_maps(pevs->uprobes);
957 if (ret < 0)
958 return ret;
959
960 dinfo = open_debuginfo(pevs->target, false);
961 if (!dinfo) {
962 ret = -ENOENT;
963 goto out;
964 }
965
966 setup_pager();
967
968 for (i = 0; i < npevs && ret >= 0; i++)
969 ret = show_available_vars_at(dinfo, &pevs[i], _filter);
970
971 debuginfo__delete(dinfo);
972out:
973 exit_probe_symbol_maps();
974 return ret;
975}
976
977#else /* !HAVE_DWARF_SUPPORT */
978
979static void debuginfo_cache__exit(void)
980{
981}
982
983static int
984find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
985 struct perf_probe_point *pp __maybe_unused,
986 bool is_kprobe __maybe_unused)
987{
988 return -ENOSYS;
989}
990
991static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
992 struct probe_trace_event **tevs __maybe_unused)
993{
994 if (perf_probe_event_need_dwarf(pev)) {
995 pr_warning("Debuginfo-analysis is not supported.\n");
996 return -ENOSYS;
997 }
998
999 return 0;
1000}
1001
1002int show_line_range(struct line_range *lr __maybe_unused,
1003 const char *module __maybe_unused,
1004 bool user __maybe_unused)
1005{
1006 pr_warning("Debuginfo-analysis is not supported.\n");
1007 return -ENOSYS;
1008}
1009
1010int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1011 int npevs __maybe_unused,
1012 struct strfilter *filter __maybe_unused)
1013{
1014 pr_warning("Debuginfo-analysis is not supported.\n");
1015 return -ENOSYS;
1016}
1017#endif
1018
1019void line_range__clear(struct line_range *lr)
1020{
1021 free(lr->function);
1022 free(lr->file);
1023 free(lr->path);
1024 free(lr->comp_dir);
1025 intlist__delete(lr->line_list);
1026 memset(lr, 0, sizeof(*lr));
1027}
1028
1029int line_range__init(struct line_range *lr)
1030{
1031 memset(lr, 0, sizeof(*lr));
1032 lr->line_list = intlist__new(NULL);
1033 if (!lr->line_list)
1034 return -ENOMEM;
1035 else
1036 return 0;
1037}
1038
1039static int parse_line_num(char **ptr, int *val, const char *what)
1040{
1041 const char *start = *ptr;
1042
1043 errno = 0;
1044 *val = strtol(*ptr, ptr, 0);
1045 if (errno || *ptr == start) {
1046 semantic_error("'%s' is not a valid number.\n", what);
1047 return -EINVAL;
1048 }
1049 return 0;
1050}
1051
1052/* Check the name is good for event, group or function */
1053static bool is_c_func_name(const char *name)
1054{
1055 if (!isalpha(*name) && *name != '_')
1056 return false;
1057 while (*++name != '\0') {
1058 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1059 return false;
1060 }
1061 return true;
1062}
1063
1064/*
1065 * Stuff 'lr' according to the line range described by 'arg'.
1066 * The line range syntax is described by:
1067 *
1068 * SRC[:SLN[+NUM|-ELN]]
1069 * FNC[@SRC][:SLN[+NUM|-ELN]]
1070 */
1071int parse_line_range_desc(const char *arg, struct line_range *lr)
1072{
1073 char *range, *file, *name = strdup(arg);
1074 int err;
1075
1076 if (!name)
1077 return -ENOMEM;
1078
1079 lr->start = 0;
1080 lr->end = INT_MAX;
1081
1082 range = strchr(name, ':');
1083 if (range) {
1084 *range++ = '\0';
1085
1086 err = parse_line_num(&range, &lr->start, "start line");
1087 if (err)
1088 goto err;
1089
1090 if (*range == '+' || *range == '-') {
1091 const char c = *range++;
1092
1093 err = parse_line_num(&range, &lr->end, "end line");
1094 if (err)
1095 goto err;
1096
1097 if (c == '+') {
1098 lr->end += lr->start;
1099 /*
1100 * Adjust the number of lines here.
1101 * If the number of lines == 1, the
1102 * the end of line should be equal to
1103 * the start of line.
1104 */
1105 lr->end--;
1106 }
1107 }
1108
1109 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1110
1111 err = -EINVAL;
1112 if (lr->start > lr->end) {
1113 semantic_error("Start line must be smaller"
1114 " than end line.\n");
1115 goto err;
1116 }
1117 if (*range != '\0') {
1118 semantic_error("Tailing with invalid str '%s'.\n", range);
1119 goto err;
1120 }
1121 }
1122
1123 file = strchr(name, '@');
1124 if (file) {
1125 *file = '\0';
1126 lr->file = strdup(++file);
1127 if (lr->file == NULL) {
1128 err = -ENOMEM;
1129 goto err;
1130 }
1131 lr->function = name;
1132 } else if (strchr(name, '/') || strchr(name, '.'))
1133 lr->file = name;
1134 else if (is_c_func_name(name))/* We reuse it for checking funcname */
1135 lr->function = name;
1136 else { /* Invalid name */
1137 semantic_error("'%s' is not a valid function name.\n", name);
1138 err = -EINVAL;
1139 goto err;
1140 }
1141
1142 return 0;
1143err:
1144 free(name);
1145 return err;
1146}
1147
1148/* Parse probepoint definition. */
1149static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1150{
1151 struct perf_probe_point *pp = &pev->point;
1152 char *ptr, *tmp;
1153 char c, nc = 0;
1154 bool file_spec = false;
1155 /*
1156 * <Syntax>
1157 * perf probe [EVENT=]SRC[:LN|;PTN]
1158 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1159 *
1160 * TODO:Group name support
1161 */
1162 if (!arg)
1163 return -EINVAL;
1164
1165 ptr = strpbrk(arg, ";=@+%");
1166 if (ptr && *ptr == '=') { /* Event name */
1167 *ptr = '\0';
1168 tmp = ptr + 1;
1169 if (strchr(arg, ':')) {
1170 semantic_error("Group name is not supported yet.\n");
1171 return -ENOTSUP;
1172 }
1173 if (!is_c_func_name(arg)) {
1174 semantic_error("%s is bad for event name -it must "
1175 "follow C symbol-naming rule.\n", arg);
1176 return -EINVAL;
1177 }
1178 pev->event = strdup(arg);
1179 if (pev->event == NULL)
1180 return -ENOMEM;
1181 pev->group = NULL;
1182 arg = tmp;
1183 }
1184
1185 /*
1186 * Check arg is function or file name and copy it.
1187 *
1188 * We consider arg to be a file spec if and only if it satisfies
1189 * all of the below criteria::
1190 * - it does not include any of "+@%",
1191 * - it includes one of ":;", and
1192 * - it has a period '.' in the name.
1193 *
1194 * Otherwise, we consider arg to be a function specification.
1195 */
1196 if (!strpbrk(arg, "+@%") && (ptr = strpbrk(arg, ";:")) != NULL) {
1197 /* This is a file spec if it includes a '.' before ; or : */
1198 if (memchr(arg, '.', ptr - arg))
1199 file_spec = true;
1200 }
1201
1202 ptr = strpbrk(arg, ";:+@%");
1203 if (ptr) {
1204 nc = *ptr;
1205 *ptr++ = '\0';
1206 }
1207
1208 if (arg[0] == '\0')
1209 tmp = NULL;
1210 else {
1211 tmp = strdup(arg);
1212 if (tmp == NULL)
1213 return -ENOMEM;
1214 }
1215
1216 if (file_spec)
1217 pp->file = tmp;
1218 else {
1219 pp->function = tmp;
1220
1221 /*
1222 * Keep pp->function even if this is absolute address,
1223 * so it can mark whether abs_address is valid.
1224 * Which make 'perf probe lib.bin 0x0' possible.
1225 *
1226 * Note that checking length of tmp is not needed
1227 * because when we access tmp[1] we know tmp[0] is '0',
1228 * so tmp[1] should always valid (but could be '\0').
1229 */
1230 if (tmp && !strncmp(tmp, "0x", 2)) {
1231 pp->abs_address = strtoul(pp->function, &tmp, 0);
1232 if (*tmp != '\0') {
1233 semantic_error("Invalid absolute address.\n");
1234 return -EINVAL;
1235 }
1236 }
1237 }
1238
1239 /* Parse other options */
1240 while (ptr) {
1241 arg = ptr;
1242 c = nc;
1243 if (c == ';') { /* Lazy pattern must be the last part */
1244 pp->lazy_line = strdup(arg);
1245 if (pp->lazy_line == NULL)
1246 return -ENOMEM;
1247 break;
1248 }
1249 ptr = strpbrk(arg, ";:+@%");
1250 if (ptr) {
1251 nc = *ptr;
1252 *ptr++ = '\0';
1253 }
1254 switch (c) {
1255 case ':': /* Line number */
1256 pp->line = strtoul(arg, &tmp, 0);
1257 if (*tmp != '\0') {
1258 semantic_error("There is non-digit char"
1259 " in line number.\n");
1260 return -EINVAL;
1261 }
1262 break;
1263 case '+': /* Byte offset from a symbol */
1264 pp->offset = strtoul(arg, &tmp, 0);
1265 if (*tmp != '\0') {
1266 semantic_error("There is non-digit character"
1267 " in offset.\n");
1268 return -EINVAL;
1269 }
1270 break;
1271 case '@': /* File name */
1272 if (pp->file) {
1273 semantic_error("SRC@SRC is not allowed.\n");
1274 return -EINVAL;
1275 }
1276 pp->file = strdup(arg);
1277 if (pp->file == NULL)
1278 return -ENOMEM;
1279 break;
1280 case '%': /* Probe places */
1281 if (strcmp(arg, "return") == 0) {
1282 pp->retprobe = 1;
1283 } else { /* Others not supported yet */
1284 semantic_error("%%%s is not supported.\n", arg);
1285 return -ENOTSUP;
1286 }
1287 break;
1288 default: /* Buggy case */
1289 pr_err("This program has a bug at %s:%d.\n",
1290 __FILE__, __LINE__);
1291 return -ENOTSUP;
1292 break;
1293 }
1294 }
1295
1296 /* Exclusion check */
1297 if (pp->lazy_line && pp->line) {
1298 semantic_error("Lazy pattern can't be used with"
1299 " line number.\n");
1300 return -EINVAL;
1301 }
1302
1303 if (pp->lazy_line && pp->offset) {
1304 semantic_error("Lazy pattern can't be used with offset.\n");
1305 return -EINVAL;
1306 }
1307
1308 if (pp->line && pp->offset) {
1309 semantic_error("Offset can't be used with line number.\n");
1310 return -EINVAL;
1311 }
1312
1313 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1314 semantic_error("File always requires line number or "
1315 "lazy pattern.\n");
1316 return -EINVAL;
1317 }
1318
1319 if (pp->offset && !pp->function) {
1320 semantic_error("Offset requires an entry function.\n");
1321 return -EINVAL;
1322 }
1323
1324 if (pp->retprobe && !pp->function) {
1325 semantic_error("Return probe requires an entry function.\n");
1326 return -EINVAL;
1327 }
1328
1329 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1330 semantic_error("Offset/Line/Lazy pattern can't be used with "
1331 "return probe.\n");
1332 return -EINVAL;
1333 }
1334
1335 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1336 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1337 pp->lazy_line);
1338 return 0;
1339}
1340
1341/* Parse perf-probe event argument */
1342static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1343{
1344 char *tmp, *goodname;
1345 struct perf_probe_arg_field **fieldp;
1346
1347 pr_debug("parsing arg: %s into ", str);
1348
1349 tmp = strchr(str, '=');
1350 if (tmp) {
1351 arg->name = strndup(str, tmp - str);
1352 if (arg->name == NULL)
1353 return -ENOMEM;
1354 pr_debug("name:%s ", arg->name);
1355 str = tmp + 1;
1356 }
1357
1358 tmp = strchr(str, ':');
1359 if (tmp) { /* Type setting */
1360 *tmp = '\0';
1361 arg->type = strdup(tmp + 1);
1362 if (arg->type == NULL)
1363 return -ENOMEM;
1364 pr_debug("type:%s ", arg->type);
1365 }
1366
1367 tmp = strpbrk(str, "-.[");
1368 if (!is_c_varname(str) || !tmp) {
1369 /* A variable, register, symbol or special value */
1370 arg->var = strdup(str);
1371 if (arg->var == NULL)
1372 return -ENOMEM;
1373 pr_debug("%s\n", arg->var);
1374 return 0;
1375 }
1376
1377 /* Structure fields or array element */
1378 arg->var = strndup(str, tmp - str);
1379 if (arg->var == NULL)
1380 return -ENOMEM;
1381 goodname = arg->var;
1382 pr_debug("%s, ", arg->var);
1383 fieldp = &arg->field;
1384
1385 do {
1386 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1387 if (*fieldp == NULL)
1388 return -ENOMEM;
1389 if (*tmp == '[') { /* Array */
1390 str = tmp;
1391 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1392 (*fieldp)->ref = true;
1393 if (*tmp != ']' || tmp == str + 1) {
1394 semantic_error("Array index must be a"
1395 " number.\n");
1396 return -EINVAL;
1397 }
1398 tmp++;
1399 if (*tmp == '\0')
1400 tmp = NULL;
1401 } else { /* Structure */
1402 if (*tmp == '.') {
1403 str = tmp + 1;
1404 (*fieldp)->ref = false;
1405 } else if (tmp[1] == '>') {
1406 str = tmp + 2;
1407 (*fieldp)->ref = true;
1408 } else {
1409 semantic_error("Argument parse error: %s\n",
1410 str);
1411 return -EINVAL;
1412 }
1413 tmp = strpbrk(str, "-.[");
1414 }
1415 if (tmp) {
1416 (*fieldp)->name = strndup(str, tmp - str);
1417 if ((*fieldp)->name == NULL)
1418 return -ENOMEM;
1419 if (*str != '[')
1420 goodname = (*fieldp)->name;
1421 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1422 fieldp = &(*fieldp)->next;
1423 }
1424 } while (tmp);
1425 (*fieldp)->name = strdup(str);
1426 if ((*fieldp)->name == NULL)
1427 return -ENOMEM;
1428 if (*str != '[')
1429 goodname = (*fieldp)->name;
1430 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1431
1432 /* If no name is specified, set the last field name (not array index)*/
1433 if (!arg->name) {
1434 arg->name = strdup(goodname);
1435 if (arg->name == NULL)
1436 return -ENOMEM;
1437 }
1438 return 0;
1439}
1440
1441/* Parse perf-probe event command */
1442int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1443{
1444 char **argv;
1445 int argc, i, ret = 0;
1446
1447 argv = argv_split(cmd, &argc);
1448 if (!argv) {
1449 pr_debug("Failed to split arguments.\n");
1450 return -ENOMEM;
1451 }
1452 if (argc - 1 > MAX_PROBE_ARGS) {
1453 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1454 ret = -ERANGE;
1455 goto out;
1456 }
1457 /* Parse probe point */
1458 ret = parse_perf_probe_point(argv[0], pev);
1459 if (ret < 0)
1460 goto out;
1461
1462 /* Copy arguments and ensure return probe has no C argument */
1463 pev->nargs = argc - 1;
1464 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1465 if (pev->args == NULL) {
1466 ret = -ENOMEM;
1467 goto out;
1468 }
1469 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1470 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1471 if (ret >= 0 &&
1472 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1473 semantic_error("You can't specify local variable for"
1474 " kretprobe.\n");
1475 ret = -EINVAL;
1476 }
1477 }
1478out:
1479 argv_free(argv);
1480
1481 return ret;
1482}
1483
1484/* Return true if this perf_probe_event requires debuginfo */
1485bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1486{
1487 int i;
1488
1489 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1490 return true;
1491
1492 for (i = 0; i < pev->nargs; i++)
1493 if (is_c_varname(pev->args[i].var))
1494 return true;
1495
1496 return false;
1497}
1498
1499/* Parse probe_events event into struct probe_point */
1500int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1501{
1502 struct probe_trace_point *tp = &tev->point;
1503 char pr;
1504 char *p;
1505 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1506 int ret, i, argc;
1507 char **argv;
1508
1509 pr_debug("Parsing probe_events: %s\n", cmd);
1510 argv = argv_split(cmd, &argc);
1511 if (!argv) {
1512 pr_debug("Failed to split arguments.\n");
1513 return -ENOMEM;
1514 }
1515 if (argc < 2) {
1516 semantic_error("Too few probe arguments.\n");
1517 ret = -ERANGE;
1518 goto out;
1519 }
1520
1521 /* Scan event and group name. */
1522 argv0_str = strdup(argv[0]);
1523 if (argv0_str == NULL) {
1524 ret = -ENOMEM;
1525 goto out;
1526 }
1527 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1528 fmt2_str = strtok_r(NULL, "/", &fmt);
1529 fmt3_str = strtok_r(NULL, " \t", &fmt);
1530 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
1531 || fmt3_str == NULL) {
1532 semantic_error("Failed to parse event name: %s\n", argv[0]);
1533 ret = -EINVAL;
1534 goto out;
1535 }
1536 pr = fmt1_str[0];
1537 tev->group = strdup(fmt2_str);
1538 tev->event = strdup(fmt3_str);
1539 if (tev->group == NULL || tev->event == NULL) {
1540 ret = -ENOMEM;
1541 goto out;
1542 }
1543 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1544
1545 tp->retprobe = (pr == 'r');
1546
1547 /* Scan module name(if there), function name and offset */
1548 p = strchr(argv[1], ':');
1549 if (p) {
1550 tp->module = strndup(argv[1], p - argv[1]);
1551 p++;
1552 } else
1553 p = argv[1];
1554 fmt1_str = strtok_r(p, "+", &fmt);
1555 /* only the address started with 0x */
1556 if (fmt1_str[0] == '0') {
1557 /*
1558 * Fix a special case:
1559 * if address == 0, kernel reports something like:
1560 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1561 * Newer kernel may fix that, but we want to
1562 * support old kernel also.
1563 */
1564 if (strcmp(fmt1_str, "0x") == 0) {
1565 if (!argv[2] || strcmp(argv[2], "(null)")) {
1566 ret = -EINVAL;
1567 goto out;
1568 }
1569 tp->address = 0;
1570
1571 free(argv[2]);
1572 for (i = 2; argv[i + 1] != NULL; i++)
1573 argv[i] = argv[i + 1];
1574
1575 argv[i] = NULL;
1576 argc -= 1;
1577 } else
1578 tp->address = strtoul(fmt1_str, NULL, 0);
1579 } else {
1580 /* Only the symbol-based probe has offset */
1581 tp->symbol = strdup(fmt1_str);
1582 if (tp->symbol == NULL) {
1583 ret = -ENOMEM;
1584 goto out;
1585 }
1586 fmt2_str = strtok_r(NULL, "", &fmt);
1587 if (fmt2_str == NULL)
1588 tp->offset = 0;
1589 else
1590 tp->offset = strtoul(fmt2_str, NULL, 10);
1591 }
1592
1593 tev->nargs = argc - 2;
1594 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1595 if (tev->args == NULL) {
1596 ret = -ENOMEM;
1597 goto out;
1598 }
1599 for (i = 0; i < tev->nargs; i++) {
1600 p = strchr(argv[i + 2], '=');
1601 if (p) /* We don't need which register is assigned. */
1602 *p++ = '\0';
1603 else
1604 p = argv[i + 2];
1605 tev->args[i].name = strdup(argv[i + 2]);
1606 /* TODO: parse regs and offset */
1607 tev->args[i].value = strdup(p);
1608 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1609 ret = -ENOMEM;
1610 goto out;
1611 }
1612 }
1613 ret = 0;
1614out:
1615 free(argv0_str);
1616 argv_free(argv);
1617 return ret;
1618}
1619
1620/* Compose only probe arg */
1621int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1622{
1623 struct perf_probe_arg_field *field = pa->field;
1624 int ret;
1625 char *tmp = buf;
1626
1627 if (pa->name && pa->var)
1628 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1629 else
1630 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1631 if (ret <= 0)
1632 goto error;
1633 tmp += ret;
1634 len -= ret;
1635
1636 while (field) {
1637 if (field->name[0] == '[')
1638 ret = e_snprintf(tmp, len, "%s", field->name);
1639 else
1640 ret = e_snprintf(tmp, len, "%s%s",
1641 field->ref ? "->" : ".", field->name);
1642 if (ret <= 0)
1643 goto error;
1644 tmp += ret;
1645 len -= ret;
1646 field = field->next;
1647 }
1648
1649 if (pa->type) {
1650 ret = e_snprintf(tmp, len, ":%s", pa->type);
1651 if (ret <= 0)
1652 goto error;
1653 tmp += ret;
1654 len -= ret;
1655 }
1656
1657 return tmp - buf;
1658error:
1659 pr_debug("Failed to synthesize perf probe argument: %d\n", ret);
1660 return ret;
1661}
1662
1663/* Compose only probe point (not argument) */
1664static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1665{
1666 char *buf, *tmp;
1667 char offs[32] = "", line[32] = "", file[32] = "";
1668 int ret, len;
1669
1670 buf = zalloc(MAX_CMDLEN);
1671 if (buf == NULL) {
1672 ret = -ENOMEM;
1673 goto error;
1674 }
1675 if (pp->offset) {
1676 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1677 if (ret <= 0)
1678 goto error;
1679 }
1680 if (pp->line) {
1681 ret = e_snprintf(line, 32, ":%d", pp->line);
1682 if (ret <= 0)
1683 goto error;
1684 }
1685 if (pp->file) {
1686 tmp = pp->file;
1687 len = strlen(tmp);
1688 if (len > 30) {
1689 tmp = strchr(pp->file + len - 30, '/');
1690 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1691 }
1692 ret = e_snprintf(file, 32, "@%s", tmp);
1693 if (ret <= 0)
1694 goto error;
1695 }
1696
1697 if (pp->function)
1698 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1699 offs, pp->retprobe ? "%return" : "", line,
1700 file);
1701 else
1702 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1703 if (ret <= 0)
1704 goto error;
1705
1706 return buf;
1707error:
1708 pr_debug("Failed to synthesize perf probe point: %d\n", ret);
1709 free(buf);
1710 return NULL;
1711}
1712
1713#if 0
1714char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1715{
1716 char *buf;
1717 int i, len, ret;
1718
1719 buf = synthesize_perf_probe_point(&pev->point);
1720 if (!buf)
1721 return NULL;
1722
1723 len = strlen(buf);
1724 for (i = 0; i < pev->nargs; i++) {
1725 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1726 pev->args[i].name);
1727 if (ret <= 0) {
1728 free(buf);
1729 return NULL;
1730 }
1731 len += ret;
1732 }
1733
1734 return buf;
1735}
1736#endif
1737
1738static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1739 char **buf, size_t *buflen,
1740 int depth)
1741{
1742 int ret;
1743 if (ref->next) {
1744 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1745 buflen, depth + 1);
1746 if (depth < 0)
1747 goto out;
1748 }
1749
1750 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1751 if (ret < 0)
1752 depth = ret;
1753 else {
1754 *buf += ret;
1755 *buflen -= ret;
1756 }
1757out:
1758 return depth;
1759
1760}
1761
1762static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1763 char *buf, size_t buflen)
1764{
1765 struct probe_trace_arg_ref *ref = arg->ref;
1766 int ret, depth = 0;
1767 char *tmp = buf;
1768
1769 /* Argument name or separator */
1770 if (arg->name)
1771 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1772 else
1773 ret = e_snprintf(buf, buflen, " ");
1774 if (ret < 0)
1775 return ret;
1776 buf += ret;
1777 buflen -= ret;
1778
1779 /* Special case: @XXX */
1780 if (arg->value[0] == '@' && arg->ref)
1781 ref = ref->next;
1782
1783 /* Dereferencing arguments */
1784 if (ref) {
1785 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1786 &buflen, 1);
1787 if (depth < 0)
1788 return depth;
1789 }
1790
1791 /* Print argument value */
1792 if (arg->value[0] == '@' && arg->ref)
1793 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1794 arg->ref->offset);
1795 else
1796 ret = e_snprintf(buf, buflen, "%s", arg->value);
1797 if (ret < 0)
1798 return ret;
1799 buf += ret;
1800 buflen -= ret;
1801
1802 /* Closing */
1803 while (depth--) {
1804 ret = e_snprintf(buf, buflen, ")");
1805 if (ret < 0)
1806 return ret;
1807 buf += ret;
1808 buflen -= ret;
1809 }
1810 /* Print argument type */
1811 if (arg->type) {
1812 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1813 if (ret <= 0)
1814 return ret;
1815 buf += ret;
1816 }
1817
1818 return buf - tmp;
1819}
1820
1821char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1822{
1823 struct probe_trace_point *tp = &tev->point;
1824 char *buf;
1825 int i, len, ret;
1826
1827 buf = zalloc(MAX_CMDLEN);
1828 if (buf == NULL)
1829 return NULL;
1830
1831 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
1832 tev->group, tev->event);
1833 if (len <= 0)
1834 goto error;
1835
1836 /* Uprobes must have tp->module */
1837 if (tev->uprobes && !tp->module)
1838 goto error;
1839 /*
1840 * If tp->address == 0, then this point must be a
1841 * absolute address uprobe.
1842 * try_to_find_absolute_address() should have made
1843 * tp->symbol to "0x0".
1844 */
1845 if (tev->uprobes && !tp->address) {
1846 if (!tp->symbol || strcmp(tp->symbol, "0x0"))
1847 goto error;
1848 }
1849
1850 /* Use the tp->address for uprobes */
1851 if (tev->uprobes)
1852 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s:0x%lx",
1853 tp->module, tp->address);
1854 else if (!strncmp(tp->symbol, "0x", 2))
1855 /* Absolute address. See try_to_find_absolute_address() */
1856 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s0x%lx",
1857 tp->module ?: "", tp->module ? ":" : "",
1858 tp->address);
1859 else
1860 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s%s+%lu",
1861 tp->module ?: "", tp->module ? ":" : "",
1862 tp->symbol, tp->offset);
1863
1864 if (ret <= 0)
1865 goto error;
1866 len += ret;
1867
1868 for (i = 0; i < tev->nargs; i++) {
1869 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1870 MAX_CMDLEN - len);
1871 if (ret <= 0)
1872 goto error;
1873 len += ret;
1874 }
1875
1876 return buf;
1877error:
1878 free(buf);
1879 return NULL;
1880}
1881
1882static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
1883 struct perf_probe_point *pp,
1884 bool is_kprobe)
1885{
1886 struct symbol *sym = NULL;
1887 struct map *map;
1888 u64 addr = tp->address;
1889 int ret = -ENOENT;
1890
1891 if (!is_kprobe) {
1892 map = dso__new_map(tp->module);
1893 if (!map)
1894 goto out;
1895 sym = map__find_symbol(map, addr, NULL);
1896 } else {
1897 if (tp->symbol && !addr) {
1898 if (kernel_get_symbol_address_by_name(tp->symbol,
1899 &addr, true, false) < 0)
1900 goto out;
1901 }
1902 if (addr) {
1903 addr += tp->offset;
1904 sym = __find_kernel_function(addr, &map);
1905 }
1906 }
1907
1908 if (!sym)
1909 goto out;
1910
1911 pp->retprobe = tp->retprobe;
1912 pp->offset = addr - map->unmap_ip(map, sym->start);
1913 pp->function = strdup(sym->name);
1914 ret = pp->function ? 0 : -ENOMEM;
1915
1916out:
1917 if (map && !is_kprobe) {
1918 map__put(map);
1919 }
1920
1921 return ret;
1922}
1923
1924static int convert_to_perf_probe_point(struct probe_trace_point *tp,
1925 struct perf_probe_point *pp,
1926 bool is_kprobe)
1927{
1928 char buf[128];
1929 int ret;
1930
1931 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
1932 if (!ret)
1933 return 0;
1934 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
1935 if (!ret)
1936 return 0;
1937
1938 pr_debug("Failed to find probe point from both of dwarf and map.\n");
1939
1940 if (tp->symbol) {
1941 pp->function = strdup(tp->symbol);
1942 pp->offset = tp->offset;
1943 } else {
1944 ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address);
1945 if (ret < 0)
1946 return ret;
1947 pp->function = strdup(buf);
1948 pp->offset = 0;
1949 }
1950 if (pp->function == NULL)
1951 return -ENOMEM;
1952
1953 pp->retprobe = tp->retprobe;
1954
1955 return 0;
1956}
1957
1958static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1959 struct perf_probe_event *pev, bool is_kprobe)
1960{
1961 char buf[64] = "";
1962 int i, ret;
1963
1964 /* Convert event/group name */
1965 pev->event = strdup(tev->event);
1966 pev->group = strdup(tev->group);
1967 if (pev->event == NULL || pev->group == NULL)
1968 return -ENOMEM;
1969
1970 /* Convert trace_point to probe_point */
1971 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1972 if (ret < 0)
1973 return ret;
1974
1975 /* Convert trace_arg to probe_arg */
1976 pev->nargs = tev->nargs;
1977 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1978 if (pev->args == NULL)
1979 return -ENOMEM;
1980 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1981 if (tev->args[i].name)
1982 pev->args[i].name = strdup(tev->args[i].name);
1983 else {
1984 ret = synthesize_probe_trace_arg(&tev->args[i],
1985 buf, 64);
1986 pev->args[i].name = strdup(buf);
1987 }
1988 if (pev->args[i].name == NULL && ret >= 0)
1989 ret = -ENOMEM;
1990 }
1991
1992 if (ret < 0)
1993 clear_perf_probe_event(pev);
1994
1995 return ret;
1996}
1997
1998void clear_perf_probe_event(struct perf_probe_event *pev)
1999{
2000 struct perf_probe_arg_field *field, *next;
2001 int i;
2002
2003 free(pev->event);
2004 free(pev->group);
2005 free(pev->target);
2006 clear_perf_probe_point(&pev->point);
2007
2008 for (i = 0; i < pev->nargs; i++) {
2009 free(pev->args[i].name);
2010 free(pev->args[i].var);
2011 free(pev->args[i].type);
2012 field = pev->args[i].field;
2013 while (field) {
2014 next = field->next;
2015 zfree(&field->name);
2016 free(field);
2017 field = next;
2018 }
2019 }
2020 free(pev->args);
2021 memset(pev, 0, sizeof(*pev));
2022}
2023
2024void clear_probe_trace_event(struct probe_trace_event *tev)
2025{
2026 struct probe_trace_arg_ref *ref, *next;
2027 int i;
2028
2029 free(tev->event);
2030 free(tev->group);
2031 free(tev->point.symbol);
2032 free(tev->point.realname);
2033 free(tev->point.module);
2034 for (i = 0; i < tev->nargs; i++) {
2035 free(tev->args[i].name);
2036 free(tev->args[i].value);
2037 free(tev->args[i].type);
2038 ref = tev->args[i].ref;
2039 while (ref) {
2040 next = ref->next;
2041 free(ref);
2042 ref = next;
2043 }
2044 }
2045 free(tev->args);
2046 memset(tev, 0, sizeof(*tev));
2047}
2048
2049struct kprobe_blacklist_node {
2050 struct list_head list;
2051 unsigned long start;
2052 unsigned long end;
2053 char *symbol;
2054};
2055
2056static void kprobe_blacklist__delete(struct list_head *blacklist)
2057{
2058 struct kprobe_blacklist_node *node;
2059
2060 while (!list_empty(blacklist)) {
2061 node = list_first_entry(blacklist,
2062 struct kprobe_blacklist_node, list);
2063 list_del(&node->list);
2064 free(node->symbol);
2065 free(node);
2066 }
2067}
2068
2069static int kprobe_blacklist__load(struct list_head *blacklist)
2070{
2071 struct kprobe_blacklist_node *node;
2072 const char *__debugfs = debugfs__mountpoint();
2073 char buf[PATH_MAX], *p;
2074 FILE *fp;
2075 int ret;
2076
2077 if (__debugfs == NULL)
2078 return -ENOTSUP;
2079
2080 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
2081 if (ret < 0)
2082 return ret;
2083
2084 fp = fopen(buf, "r");
2085 if (!fp)
2086 return -errno;
2087
2088 ret = 0;
2089 while (fgets(buf, PATH_MAX, fp)) {
2090 node = zalloc(sizeof(*node));
2091 if (!node) {
2092 ret = -ENOMEM;
2093 break;
2094 }
2095 INIT_LIST_HEAD(&node->list);
2096 list_add_tail(&node->list, blacklist);
2097 if (sscanf(buf, "0x%lx-0x%lx", &node->start, &node->end) != 2) {
2098 ret = -EINVAL;
2099 break;
2100 }
2101 p = strchr(buf, '\t');
2102 if (p) {
2103 p++;
2104 if (p[strlen(p) - 1] == '\n')
2105 p[strlen(p) - 1] = '\0';
2106 } else
2107 p = (char *)"unknown";
2108 node->symbol = strdup(p);
2109 if (!node->symbol) {
2110 ret = -ENOMEM;
2111 break;
2112 }
2113 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
2114 node->start, node->end, node->symbol);
2115 ret++;
2116 }
2117 if (ret < 0)
2118 kprobe_blacklist__delete(blacklist);
2119 fclose(fp);
2120
2121 return ret;
2122}
2123
2124static struct kprobe_blacklist_node *
2125kprobe_blacklist__find_by_address(struct list_head *blacklist,
2126 unsigned long address)
2127{
2128 struct kprobe_blacklist_node *node;
2129
2130 list_for_each_entry(node, blacklist, list) {
2131 if (node->start <= address && address <= node->end)
2132 return node;
2133 }
2134
2135 return NULL;
2136}
2137
2138static LIST_HEAD(kprobe_blacklist);
2139
2140static void kprobe_blacklist__init(void)
2141{
2142 if (!list_empty(&kprobe_blacklist))
2143 return;
2144
2145 if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
2146 pr_debug("No kprobe blacklist support, ignored\n");
2147}
2148
2149static void kprobe_blacklist__release(void)
2150{
2151 kprobe_blacklist__delete(&kprobe_blacklist);
2152}
2153
2154static bool kprobe_blacklist__listed(unsigned long address)
2155{
2156 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
2157}
2158
2159static int perf_probe_event__sprintf(const char *group, const char *event,
2160 struct perf_probe_event *pev,
2161 const char *module,
2162 struct strbuf *result)
2163{
2164 int i, ret;
2165 char buf[128];
2166 char *place;
2167
2168 /* Synthesize only event probe point */
2169 place = synthesize_perf_probe_point(&pev->point);
2170 if (!place)
2171 return -EINVAL;
2172
2173 ret = e_snprintf(buf, 128, "%s:%s", group, event);
2174 if (ret < 0)
2175 goto out;
2176
2177 strbuf_addf(result, " %-20s (on %s", buf, place);
2178 if (module)
2179 strbuf_addf(result, " in %s", module);
2180
2181 if (pev->nargs > 0) {
2182 strbuf_add(result, " with", 5);
2183 for (i = 0; i < pev->nargs; i++) {
2184 ret = synthesize_perf_probe_arg(&pev->args[i],
2185 buf, 128);
2186 if (ret < 0)
2187 goto out;
2188 strbuf_addf(result, " %s", buf);
2189 }
2190 }
2191 strbuf_addch(result, ')');
2192out:
2193 free(place);
2194 return ret;
2195}
2196
2197/* Show an event */
2198int show_perf_probe_event(const char *group, const char *event,
2199 struct perf_probe_event *pev,
2200 const char *module, bool use_stdout)
2201{
2202 struct strbuf buf = STRBUF_INIT;
2203 int ret;
2204
2205 ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2206 if (ret >= 0) {
2207 if (use_stdout)
2208 printf("%s\n", buf.buf);
2209 else
2210 pr_info("%s\n", buf.buf);
2211 }
2212 strbuf_release(&buf);
2213
2214 return ret;
2215}
2216
2217static bool filter_probe_trace_event(struct probe_trace_event *tev,
2218 struct strfilter *filter)
2219{
2220 char tmp[128];
2221
2222 /* At first, check the event name itself */
2223 if (strfilter__compare(filter, tev->event))
2224 return true;
2225
2226 /* Next, check the combination of name and group */
2227 if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0)
2228 return false;
2229 return strfilter__compare(filter, tmp);
2230}
2231
2232static int __show_perf_probe_events(int fd, bool is_kprobe,
2233 struct strfilter *filter)
2234{
2235 int ret = 0;
2236 struct probe_trace_event tev;
2237 struct perf_probe_event pev;
2238 struct strlist *rawlist;
2239 struct str_node *ent;
2240
2241 memset(&tev, 0, sizeof(tev));
2242 memset(&pev, 0, sizeof(pev));
2243
2244 rawlist = probe_file__get_rawlist(fd);
2245 if (!rawlist)
2246 return -ENOMEM;
2247
2248 strlist__for_each(ent, rawlist) {
2249 ret = parse_probe_trace_command(ent->s, &tev);
2250 if (ret >= 0) {
2251 if (!filter_probe_trace_event(&tev, filter))
2252 goto next;
2253 ret = convert_to_perf_probe_event(&tev, &pev,
2254 is_kprobe);
2255 if (ret < 0)
2256 goto next;
2257 ret = show_perf_probe_event(pev.group, pev.event,
2258 &pev, tev.point.module,
2259 true);
2260 }
2261next:
2262 clear_perf_probe_event(&pev);
2263 clear_probe_trace_event(&tev);
2264 if (ret < 0)
2265 break;
2266 }
2267 strlist__delete(rawlist);
2268 /* Cleanup cached debuginfo if needed */
2269 debuginfo_cache__exit();
2270
2271 return ret;
2272}
2273
2274/* List up current perf-probe events */
2275int show_perf_probe_events(struct strfilter *filter)
2276{
2277 int kp_fd, up_fd, ret;
2278
2279 setup_pager();
2280
2281 ret = init_probe_symbol_maps(false);
2282 if (ret < 0)
2283 return ret;
2284
2285 ret = probe_file__open_both(&kp_fd, &up_fd, 0);
2286 if (ret < 0)
2287 return ret;
2288
2289 if (kp_fd >= 0)
2290 ret = __show_perf_probe_events(kp_fd, true, filter);
2291 if (up_fd >= 0 && ret >= 0)
2292 ret = __show_perf_probe_events(up_fd, false, filter);
2293 if (kp_fd > 0)
2294 close(kp_fd);
2295 if (up_fd > 0)
2296 close(up_fd);
2297 exit_probe_symbol_maps();
2298
2299 return ret;
2300}
2301
2302static int get_new_event_name(char *buf, size_t len, const char *base,
2303 struct strlist *namelist, bool allow_suffix)
2304{
2305 int i, ret;
2306 char *p, *nbase;
2307
2308 if (*base == '.')
2309 base++;
2310 nbase = strdup(base);
2311 if (!nbase)
2312 return -ENOMEM;
2313
2314 /* Cut off the dot suffixes (e.g. .const, .isra)*/
2315 p = strchr(nbase, '.');
2316 if (p && p != nbase)
2317 *p = '\0';
2318
2319 /* Try no suffix number */
2320 ret = e_snprintf(buf, len, "%s", nbase);
2321 if (ret < 0) {
2322 pr_debug("snprintf() failed: %d\n", ret);
2323 goto out;
2324 }
2325 if (!strlist__has_entry(namelist, buf))
2326 goto out;
2327
2328 if (!allow_suffix) {
2329 pr_warning("Error: event \"%s\" already exists.\n"
2330 " Hint: Remove existing event by 'perf probe -d'\n"
2331 " or force duplicates by 'perf probe -f'\n"
2332 " or set 'force=yes' in BPF source.\n",
2333 buf);
2334 ret = -EEXIST;
2335 goto out;
2336 }
2337
2338 /* Try to add suffix */
2339 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2340 ret = e_snprintf(buf, len, "%s_%d", nbase, i);
2341 if (ret < 0) {
2342 pr_debug("snprintf() failed: %d\n", ret);
2343 goto out;
2344 }
2345 if (!strlist__has_entry(namelist, buf))
2346 break;
2347 }
2348 if (i == MAX_EVENT_INDEX) {
2349 pr_warning("Too many events are on the same function.\n");
2350 ret = -ERANGE;
2351 }
2352
2353out:
2354 free(nbase);
2355 return ret;
2356}
2357
2358/* Warn if the current kernel's uprobe implementation is old */
2359static void warn_uprobe_event_compat(struct probe_trace_event *tev)
2360{
2361 int i;
2362 char *buf = synthesize_probe_trace_command(tev);
2363
2364 /* Old uprobe event doesn't support memory dereference */
2365 if (!tev->uprobes || tev->nargs == 0 || !buf)
2366 goto out;
2367
2368 for (i = 0; i < tev->nargs; i++)
2369 if (strglobmatch(tev->args[i].value, "[$@+-]*")) {
2370 pr_warning("Please upgrade your kernel to at least "
2371 "3.14 to have access to feature %s\n",
2372 tev->args[i].value);
2373 break;
2374 }
2375out:
2376 free(buf);
2377}
2378
2379/* Set new name from original perf_probe_event and namelist */
2380static int probe_trace_event__set_name(struct probe_trace_event *tev,
2381 struct perf_probe_event *pev,
2382 struct strlist *namelist,
2383 bool allow_suffix)
2384{
2385 const char *event, *group;
2386 char buf[64];
2387 int ret;
2388
2389 if (pev->event)
2390 event = pev->event;
2391 else
2392 if (pev->point.function &&
2393 (strncmp(pev->point.function, "0x", 2) != 0) &&
2394 !strisglob(pev->point.function))
2395 event = pev->point.function;
2396 else
2397 event = tev->point.realname;
2398 if (pev->group)
2399 group = pev->group;
2400 else
2401 group = PERFPROBE_GROUP;
2402
2403 /* Get an unused new event name */
2404 ret = get_new_event_name(buf, 64, event,
2405 namelist, allow_suffix);
2406 if (ret < 0)
2407 return ret;
2408
2409 event = buf;
2410
2411 tev->event = strdup(event);
2412 tev->group = strdup(group);
2413 if (tev->event == NULL || tev->group == NULL)
2414 return -ENOMEM;
2415
2416 /* Add added event name to namelist */
2417 strlist__add(namelist, event);
2418 return 0;
2419}
2420
2421static int __add_probe_trace_events(struct perf_probe_event *pev,
2422 struct probe_trace_event *tevs,
2423 int ntevs, bool allow_suffix)
2424{
2425 int i, fd, ret;
2426 struct probe_trace_event *tev = NULL;
2427 struct strlist *namelist;
2428
2429 fd = probe_file__open(PF_FL_RW | (pev->uprobes ? PF_FL_UPROBE : 0));
2430 if (fd < 0)
2431 return fd;
2432
2433 /* Get current event names */
2434 namelist = probe_file__get_namelist(fd);
2435 if (!namelist) {
2436 pr_debug("Failed to get current event list.\n");
2437 ret = -ENOMEM;
2438 goto close_out;
2439 }
2440
2441 ret = 0;
2442 for (i = 0; i < ntevs; i++) {
2443 tev = &tevs[i];
2444 /* Skip if the symbol is out of .text or blacklisted */
2445 if (!tev->point.symbol)
2446 continue;
2447
2448 /* Set new name for tev (and update namelist) */
2449 ret = probe_trace_event__set_name(tev, pev, namelist,
2450 allow_suffix);
2451 if (ret < 0)
2452 break;
2453
2454 ret = probe_file__add_event(fd, tev);
2455 if (ret < 0)
2456 break;
2457
2458 /*
2459 * Probes after the first probe which comes from same
2460 * user input are always allowed to add suffix, because
2461 * there might be several addresses corresponding to
2462 * one code line.
2463 */
2464 allow_suffix = true;
2465 }
2466 if (ret == -EINVAL && pev->uprobes)
2467 warn_uprobe_event_compat(tev);
2468
2469 strlist__delete(namelist);
2470close_out:
2471 close(fd);
2472 return ret;
2473}
2474
2475static int find_probe_functions(struct map *map, char *name,
2476 struct symbol **syms)
2477{
2478 int found = 0;
2479 struct symbol *sym;
2480 struct rb_node *tmp;
2481
2482 if (map__load(map, NULL) < 0)
2483 return 0;
2484
2485 map__for_each_symbol(map, sym, tmp) {
2486 if (strglobmatch(sym->name, name)) {
2487 found++;
2488 if (syms && found < probe_conf.max_probes)
2489 syms[found - 1] = sym;
2490 }
2491 }
2492
2493 return found;
2494}
2495
2496#define strdup_or_goto(str, label) \
2497 ({ char *__p = strdup(str); if (!__p) goto label; __p; })
2498
2499void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
2500 struct probe_trace_event *tev __maybe_unused,
2501 struct map *map __maybe_unused) { }
2502
2503/*
2504 * Find probe function addresses from map.
2505 * Return an error or the number of found probe_trace_event
2506 */
2507static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
2508 struct probe_trace_event **tevs)
2509{
2510 struct map *map = NULL;
2511 struct ref_reloc_sym *reloc_sym = NULL;
2512 struct symbol *sym;
2513 struct symbol **syms = NULL;
2514 struct probe_trace_event *tev;
2515 struct perf_probe_point *pp = &pev->point;
2516 struct probe_trace_point *tp;
2517 int num_matched_functions;
2518 int ret, i, j, skipped = 0;
2519
2520 map = get_target_map(pev->target, pev->uprobes);
2521 if (!map) {
2522 ret = -EINVAL;
2523 goto out;
2524 }
2525
2526 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
2527 if (!syms) {
2528 ret = -ENOMEM;
2529 goto out;
2530 }
2531
2532 /*
2533 * Load matched symbols: Since the different local symbols may have
2534 * same name but different addresses, this lists all the symbols.
2535 */
2536 num_matched_functions = find_probe_functions(map, pp->function, syms);
2537 if (num_matched_functions == 0) {
2538 pr_err("Failed to find symbol %s in %s\n", pp->function,
2539 pev->target ? : "kernel");
2540 ret = -ENOENT;
2541 goto out;
2542 } else if (num_matched_functions > probe_conf.max_probes) {
2543 pr_err("Too many functions matched in %s\n",
2544 pev->target ? : "kernel");
2545 ret = -E2BIG;
2546 goto out;
2547 }
2548
2549 /* Note that the symbols in the kmodule are not relocated */
2550 if (!pev->uprobes && !pp->retprobe && !pev->target) {
2551 reloc_sym = kernel_get_ref_reloc_sym();
2552 if (!reloc_sym) {
2553 pr_warning("Relocated base symbol is not found!\n");
2554 ret = -EINVAL;
2555 goto out;
2556 }
2557 }
2558
2559 /* Setup result trace-probe-events */
2560 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
2561 if (!*tevs) {
2562 ret = -ENOMEM;
2563 goto out;
2564 }
2565
2566 ret = 0;
2567
2568 for (j = 0; j < num_matched_functions; j++) {
2569 sym = syms[j];
2570
2571 tev = (*tevs) + ret;
2572 tp = &tev->point;
2573 if (ret == num_matched_functions) {
2574 pr_warning("Too many symbols are listed. Skip it.\n");
2575 break;
2576 }
2577 ret++;
2578
2579 if (pp->offset > sym->end - sym->start) {
2580 pr_warning("Offset %ld is bigger than the size of %s\n",
2581 pp->offset, sym->name);
2582 ret = -ENOENT;
2583 goto err_out;
2584 }
2585 /* Add one probe point */
2586 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
2587
2588 /* Check the kprobe (not in module) is within .text */
2589 if (!pev->uprobes && !pev->target &&
2590 kprobe_warn_out_range(sym->name, tp->address)) {
2591 tp->symbol = NULL; /* Skip it */
2592 skipped++;
2593 } else if (reloc_sym) {
2594 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
2595 tp->offset = tp->address - reloc_sym->addr;
2596 } else {
2597 tp->symbol = strdup_or_goto(sym->name, nomem_out);
2598 tp->offset = pp->offset;
2599 }
2600 tp->realname = strdup_or_goto(sym->name, nomem_out);
2601
2602 tp->retprobe = pp->retprobe;
2603 if (pev->target)
2604 tev->point.module = strdup_or_goto(pev->target,
2605 nomem_out);
2606 tev->uprobes = pev->uprobes;
2607 tev->nargs = pev->nargs;
2608 if (tev->nargs) {
2609 tev->args = zalloc(sizeof(struct probe_trace_arg) *
2610 tev->nargs);
2611 if (tev->args == NULL)
2612 goto nomem_out;
2613 }
2614 for (i = 0; i < tev->nargs; i++) {
2615 if (pev->args[i].name)
2616 tev->args[i].name =
2617 strdup_or_goto(pev->args[i].name,
2618 nomem_out);
2619
2620 tev->args[i].value = strdup_or_goto(pev->args[i].var,
2621 nomem_out);
2622 if (pev->args[i].type)
2623 tev->args[i].type =
2624 strdup_or_goto(pev->args[i].type,
2625 nomem_out);
2626 }
2627 arch__fix_tev_from_maps(pev, tev, map);
2628 }
2629 if (ret == skipped) {
2630 ret = -ENOENT;
2631 goto err_out;
2632 }
2633
2634out:
2635 put_target_map(map, pev->uprobes);
2636 free(syms);
2637 return ret;
2638
2639nomem_out:
2640 ret = -ENOMEM;
2641err_out:
2642 clear_probe_trace_events(*tevs, num_matched_functions);
2643 zfree(tevs);
2644 goto out;
2645}
2646
2647static int try_to_find_absolute_address(struct perf_probe_event *pev,
2648 struct probe_trace_event **tevs)
2649{
2650 struct perf_probe_point *pp = &pev->point;
2651 struct probe_trace_event *tev;
2652 struct probe_trace_point *tp;
2653 int i, err;
2654
2655 if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2)))
2656 return -EINVAL;
2657 if (perf_probe_event_need_dwarf(pev))
2658 return -EINVAL;
2659
2660 /*
2661 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
2662 * absolute address.
2663 *
2664 * Only one tev can be generated by this.
2665 */
2666 *tevs = zalloc(sizeof(*tev));
2667 if (!*tevs)
2668 return -ENOMEM;
2669
2670 tev = *tevs;
2671 tp = &tev->point;
2672
2673 /*
2674 * Don't use tp->offset, use address directly, because
2675 * in synthesize_probe_trace_command() address cannot be
2676 * zero.
2677 */
2678 tp->address = pev->point.abs_address;
2679 tp->retprobe = pp->retprobe;
2680 tev->uprobes = pev->uprobes;
2681
2682 err = -ENOMEM;
2683 /*
2684 * Give it a '0x' leading symbol name.
2685 * In __add_probe_trace_events, a NULL symbol is interpreted as
2686 * invalud.
2687 */
2688 if (asprintf(&tp->symbol, "0x%lx", tp->address) < 0)
2689 goto errout;
2690
2691 /* For kprobe, check range */
2692 if ((!tev->uprobes) &&
2693 (kprobe_warn_out_range(tev->point.symbol,
2694 tev->point.address))) {
2695 err = -EACCES;
2696 goto errout;
2697 }
2698
2699 if (asprintf(&tp->realname, "abs_%lx", tp->address) < 0)
2700 goto errout;
2701
2702 if (pev->target) {
2703 tp->module = strdup(pev->target);
2704 if (!tp->module)
2705 goto errout;
2706 }
2707
2708 if (tev->group) {
2709 tev->group = strdup(pev->group);
2710 if (!tev->group)
2711 goto errout;
2712 }
2713
2714 if (pev->event) {
2715 tev->event = strdup(pev->event);
2716 if (!tev->event)
2717 goto errout;
2718 }
2719
2720 tev->nargs = pev->nargs;
2721 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
2722 if (!tev->args) {
2723 err = -ENOMEM;
2724 goto errout;
2725 }
2726 for (i = 0; i < tev->nargs; i++)
2727 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);
2728
2729 return 1;
2730
2731errout:
2732 if (*tevs) {
2733 clear_probe_trace_events(*tevs, 1);
2734 *tevs = NULL;
2735 }
2736 return err;
2737}
2738
2739bool __weak arch__prefers_symtab(void) { return false; }
2740
2741static int convert_to_probe_trace_events(struct perf_probe_event *pev,
2742 struct probe_trace_event **tevs)
2743{
2744 int ret;
2745
2746 if (pev->uprobes && !pev->group) {
2747 /* Replace group name if not given */
2748 ret = convert_exec_to_group(pev->target, &pev->group);
2749 if (ret != 0) {
2750 pr_warning("Failed to make a group name.\n");
2751 return ret;
2752 }
2753 }
2754
2755 ret = try_to_find_absolute_address(pev, tevs);
2756 if (ret > 0)
2757 return ret;
2758
2759 if (arch__prefers_symtab() && !perf_probe_event_need_dwarf(pev)) {
2760 ret = find_probe_trace_events_from_map(pev, tevs);
2761 if (ret > 0)
2762 return ret; /* Found in symbol table */
2763 }
2764
2765 /* Convert perf_probe_event with debuginfo */
2766 ret = try_to_find_probe_trace_events(pev, tevs);
2767 if (ret != 0)
2768 return ret; /* Found in debuginfo or got an error */
2769
2770 return find_probe_trace_events_from_map(pev, tevs);
2771}
2772
2773int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2774{
2775 int i, ret;
2776
2777 /* Loop 1: convert all events */
2778 for (i = 0; i < npevs; i++) {
2779 /* Init kprobe blacklist if needed */
2780 if (!pevs[i].uprobes)
2781 kprobe_blacklist__init();
2782 /* Convert with or without debuginfo */
2783 ret = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
2784 if (ret < 0)
2785 return ret;
2786 pevs[i].ntevs = ret;
2787 }
2788 /* This just release blacklist only if allocated */
2789 kprobe_blacklist__release();
2790
2791 return 0;
2792}
2793
2794int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2795{
2796 int i, ret = 0;
2797
2798 /* Loop 2: add all events */
2799 for (i = 0; i < npevs; i++) {
2800 ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
2801 pevs[i].ntevs,
2802 probe_conf.force_add);
2803 if (ret < 0)
2804 break;
2805 }
2806 return ret;
2807}
2808
2809void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2810{
2811 int i, j;
2812
2813 /* Loop 3: cleanup and free trace events */
2814 for (i = 0; i < npevs; i++) {
2815 for (j = 0; j < pevs[i].ntevs; j++)
2816 clear_probe_trace_event(&pevs[i].tevs[j]);
2817 zfree(&pevs[i].tevs);
2818 pevs[i].ntevs = 0;
2819 clear_perf_probe_event(&pevs[i]);
2820 }
2821}
2822
2823int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2824{
2825 int ret;
2826
2827 ret = init_probe_symbol_maps(pevs->uprobes);
2828 if (ret < 0)
2829 return ret;
2830
2831 ret = convert_perf_probe_events(pevs, npevs);
2832 if (ret == 0)
2833 ret = apply_perf_probe_events(pevs, npevs);
2834
2835 cleanup_perf_probe_events(pevs, npevs);
2836
2837 exit_probe_symbol_maps();
2838 return ret;
2839}
2840
2841int del_perf_probe_events(struct strfilter *filter)
2842{
2843 int ret, ret2, ufd = -1, kfd = -1;
2844 char *str = strfilter__string(filter);
2845
2846 if (!str)
2847 return -EINVAL;
2848
2849 /* Get current event names */
2850 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
2851 if (ret < 0)
2852 goto out;
2853
2854 ret = probe_file__del_events(kfd, filter);
2855 if (ret < 0 && ret != -ENOENT)
2856 goto error;
2857
2858 ret2 = probe_file__del_events(ufd, filter);
2859 if (ret2 < 0 && ret2 != -ENOENT) {
2860 ret = ret2;
2861 goto error;
2862 }
2863 ret = 0;
2864
2865error:
2866 if (kfd >= 0)
2867 close(kfd);
2868 if (ufd >= 0)
2869 close(ufd);
2870out:
2871 free(str);
2872
2873 return ret;
2874}
2875
2876/* TODO: don't use a global variable for filter ... */
2877static struct strfilter *available_func_filter;
2878
2879/*
2880 * If a symbol corresponds to a function with global binding and
2881 * matches filter return 0. For all others return 1.
2882 */
2883static int filter_available_functions(struct map *map __maybe_unused,
2884 struct symbol *sym)
2885{
2886 if (strfilter__compare(available_func_filter, sym->name))
2887 return 0;
2888 return 1;
2889}
2890
2891int show_available_funcs(const char *target, struct strfilter *_filter,
2892 bool user)
2893{
2894 struct map *map;
2895 int ret;
2896
2897 ret = init_probe_symbol_maps(user);
2898 if (ret < 0)
2899 return ret;
2900
2901 /* Get a symbol map */
2902 if (user)
2903 map = dso__new_map(target);
2904 else
2905 map = kernel_get_module_map(target);
2906 if (!map) {
2907 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
2908 return -EINVAL;
2909 }
2910
2911 /* Load symbols with given filter */
2912 available_func_filter = _filter;
2913 if (map__load(map, filter_available_functions)) {
2914 pr_err("Failed to load symbols in %s\n", (target) ? : "kernel");
2915 goto end;
2916 }
2917 if (!dso__sorted_by_name(map->dso, map->type))
2918 dso__sort_by_name(map->dso, map->type);
2919
2920 /* Show all (filtered) symbols */
2921 setup_pager();
2922 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2923end:
2924 if (user) {
2925 map__put(map);
2926 }
2927 exit_probe_symbol_maps();
2928
2929 return ret;
2930}
2931
2932int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
2933 struct perf_probe_arg *pvar)
2934{
2935 tvar->value = strdup(pvar->var);
2936 if (tvar->value == NULL)
2937 return -ENOMEM;
2938 if (pvar->type) {
2939 tvar->type = strdup(pvar->type);
2940 if (tvar->type == NULL)
2941 return -ENOMEM;
2942 }
2943 if (pvar->name) {
2944 tvar->name = strdup(pvar->name);
2945 if (tvar->name == NULL)
2946 return -ENOMEM;
2947 } else
2948 tvar->name = NULL;
2949 return 0;
2950}
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