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