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