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#define _GNU_SOURCE
23#include <sys/utsname.h>
24#include <sys/types.h>
25#include <sys/stat.h>
26#include <fcntl.h>
27#include <errno.h>
28#include <stdio.h>
29#include <unistd.h>
30#include <stdlib.h>
31#include <string.h>
32#include <stdarg.h>
33#include <limits.h>
34#include <elf.h>
35
36#undef _GNU_SOURCE
37#include "util.h"
38#include "event.h"
39#include "string.h"
40#include "strlist.h"
41#include "debug.h"
42#include "cache.h"
43#include "color.h"
44#include "symbol.h"
45#include "thread.h"
46#include "debugfs.h"
47#include "trace-event.h" /* For __unused */
48#include "probe-event.h"
49#include "probe-finder.h"
50
51#define MAX_CMDLEN 256
52#define MAX_PROBE_ARGS 128
53#define PERFPROBE_GROUP "probe"
54
55bool probe_event_dry_run; /* Dry run flag */
56
57#define semantic_error(msg ...) pr_err("Semantic error :" msg)
58
59/* If there is no space to write, returns -E2BIG. */
60static int e_snprintf(char *str, size_t size, const char *format, ...)
61 __attribute__((format(printf, 3, 4)));
62
63static int e_snprintf(char *str, size_t size, const char *format, ...)
64{
65 int ret;
66 va_list ap;
67 va_start(ap, format);
68 ret = vsnprintf(str, size, format, ap);
69 va_end(ap);
70 if (ret >= (int)size)
71 ret = -E2BIG;
72 return ret;
73}
74
75static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
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
176#ifdef DWARF_SUPPORT
177/* Open new debuginfo of given module */
178static struct debuginfo *open_debuginfo(const char *module)
179{
180 const char *path;
181
182 /* A file path -- this is an offline module */
183 if (module && strchr(module, '/'))
184 path = module;
185 else {
186 path = kernel_get_module_path(module);
187
188 if (!path) {
189 pr_err("Failed to find path of %s module.\n",
190 module ?: "kernel");
191 return NULL;
192 }
193 }
194 return debuginfo__new(path);
195}
196
197/*
198 * Convert trace point to probe point with debuginfo
199 * Currently only handles kprobes.
200 */
201static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
202 struct perf_probe_point *pp)
203{
204 struct symbol *sym;
205 struct map *map;
206 u64 addr;
207 int ret = -ENOENT;
208 struct debuginfo *dinfo;
209
210 sym = __find_kernel_function_by_name(tp->symbol, &map);
211 if (sym) {
212 addr = map->unmap_ip(map, sym->start + tp->offset);
213 pr_debug("try to find %s+%ld@%" PRIx64 "\n", tp->symbol,
214 tp->offset, addr);
215
216 dinfo = debuginfo__new_online_kernel(addr);
217 if (dinfo) {
218 ret = debuginfo__find_probe_point(dinfo,
219 (unsigned long)addr, pp);
220 debuginfo__delete(dinfo);
221 } else {
222 pr_debug("Failed to open debuginfo at 0x%" PRIx64 "\n",
223 addr);
224 ret = -ENOENT;
225 }
226 }
227 if (ret <= 0) {
228 pr_debug("Failed to find corresponding probes from "
229 "debuginfo. Use kprobe event information.\n");
230 pp->function = strdup(tp->symbol);
231 if (pp->function == NULL)
232 return -ENOMEM;
233 pp->offset = tp->offset;
234 }
235 pp->retprobe = tp->retprobe;
236
237 return 0;
238}
239
240static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
241 int ntevs, const char *module)
242{
243 int i, ret = 0;
244 char *tmp;
245
246 if (!module)
247 return 0;
248
249 tmp = strrchr(module, '/');
250 if (tmp) {
251 /* This is a module path -- get the module name */
252 module = strdup(tmp + 1);
253 if (!module)
254 return -ENOMEM;
255 tmp = strchr(module, '.');
256 if (tmp)
257 *tmp = '\0';
258 tmp = (char *)module; /* For free() */
259 }
260
261 for (i = 0; i < ntevs; i++) {
262 tevs[i].point.module = strdup(module);
263 if (!tevs[i].point.module) {
264 ret = -ENOMEM;
265 break;
266 }
267 }
268
269 if (tmp)
270 free(tmp);
271
272 return ret;
273}
274
275/* Try to find perf_probe_event with debuginfo */
276static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
277 struct probe_trace_event **tevs,
278 int max_tevs, const char *module)
279{
280 bool need_dwarf = perf_probe_event_need_dwarf(pev);
281 struct debuginfo *dinfo = open_debuginfo(module);
282 int ntevs, ret = 0;
283
284 if (!dinfo) {
285 if (need_dwarf) {
286 pr_warning("Failed to open debuginfo file.\n");
287 return -ENOENT;
288 }
289 pr_debug("Could not open debuginfo. Try to use symbols.\n");
290 return 0;
291 }
292
293 /* Searching trace events corresponding to a probe event */
294 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);
295
296 debuginfo__delete(dinfo);
297
298 if (ntevs > 0) { /* Succeeded to find trace events */
299 pr_debug("find %d probe_trace_events.\n", ntevs);
300 if (module)
301 ret = add_module_to_probe_trace_events(*tevs, ntevs,
302 module);
303 return ret < 0 ? ret : ntevs;
304 }
305
306 if (ntevs == 0) { /* No error but failed to find probe point. */
307 pr_warning("Probe point '%s' not found.\n",
308 synthesize_perf_probe_point(&pev->point));
309 return -ENOENT;
310 }
311 /* Error path : ntevs < 0 */
312 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
313 if (ntevs == -EBADF) {
314 pr_warning("Warning: No dwarf info found in the vmlinux - "
315 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
316 if (!need_dwarf) {
317 pr_debug("Trying to use symbols.\n");
318 return 0;
319 }
320 }
321 return ntevs;
322}
323
324/*
325 * Find a src file from a DWARF tag path. Prepend optional source path prefix
326 * and chop off leading directories that do not exist. Result is passed back as
327 * a newly allocated path on success.
328 * Return 0 if file was found and readable, -errno otherwise.
329 */
330static int get_real_path(const char *raw_path, const char *comp_dir,
331 char **new_path)
332{
333 const char *prefix = symbol_conf.source_prefix;
334
335 if (!prefix) {
336 if (raw_path[0] != '/' && comp_dir)
337 /* If not an absolute path, try to use comp_dir */
338 prefix = comp_dir;
339 else {
340 if (access(raw_path, R_OK) == 0) {
341 *new_path = strdup(raw_path);
342 return 0;
343 } else
344 return -errno;
345 }
346 }
347
348 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
349 if (!*new_path)
350 return -ENOMEM;
351
352 for (;;) {
353 sprintf(*new_path, "%s/%s", prefix, raw_path);
354
355 if (access(*new_path, R_OK) == 0)
356 return 0;
357
358 if (!symbol_conf.source_prefix)
359 /* In case of searching comp_dir, don't retry */
360 return -errno;
361
362 switch (errno) {
363 case ENAMETOOLONG:
364 case ENOENT:
365 case EROFS:
366 case EFAULT:
367 raw_path = strchr(++raw_path, '/');
368 if (!raw_path) {
369 free(*new_path);
370 *new_path = NULL;
371 return -ENOENT;
372 }
373 continue;
374
375 default:
376 free(*new_path);
377 *new_path = NULL;
378 return -errno;
379 }
380 }
381}
382
383#define LINEBUF_SIZE 256
384#define NR_ADDITIONAL_LINES 2
385
386static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
387{
388 char buf[LINEBUF_SIZE];
389 const char *color = show_num ? "" : PERF_COLOR_BLUE;
390 const char *prefix = NULL;
391
392 do {
393 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
394 goto error;
395 if (skip)
396 continue;
397 if (!prefix) {
398 prefix = show_num ? "%7d " : " ";
399 color_fprintf(stdout, color, prefix, l);
400 }
401 color_fprintf(stdout, color, "%s", buf);
402
403 } while (strchr(buf, '\n') == NULL);
404
405 return 1;
406error:
407 if (ferror(fp)) {
408 pr_warning("File read error: %s\n", strerror(errno));
409 return -1;
410 }
411 return 0;
412}
413
414static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
415{
416 int rv = __show_one_line(fp, l, skip, show_num);
417 if (rv == 0) {
418 pr_warning("Source file is shorter than expected.\n");
419 rv = -1;
420 }
421 return rv;
422}
423
424#define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
425#define show_one_line(f,l) _show_one_line(f,l,false,false)
426#define skip_one_line(f,l) _show_one_line(f,l,true,false)
427#define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
428
429/*
430 * Show line-range always requires debuginfo to find source file and
431 * line number.
432 */
433int show_line_range(struct line_range *lr, const char *module)
434{
435 int l = 1;
436 struct line_node *ln;
437 struct debuginfo *dinfo;
438 FILE *fp;
439 int ret;
440 char *tmp;
441
442 /* Search a line range */
443 ret = init_vmlinux();
444 if (ret < 0)
445 return ret;
446
447 dinfo = open_debuginfo(module);
448 if (!dinfo) {
449 pr_warning("Failed to open debuginfo file.\n");
450 return -ENOENT;
451 }
452
453 ret = debuginfo__find_line_range(dinfo, lr);
454 debuginfo__delete(dinfo);
455 if (ret == 0) {
456 pr_warning("Specified source line is not found.\n");
457 return -ENOENT;
458 } else if (ret < 0) {
459 pr_warning("Debuginfo analysis failed. (%d)\n", ret);
460 return ret;
461 }
462
463 /* Convert source file path */
464 tmp = lr->path;
465 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
466 free(tmp); /* Free old path */
467 if (ret < 0) {
468 pr_warning("Failed to find source file. (%d)\n", ret);
469 return ret;
470 }
471
472 setup_pager();
473
474 if (lr->function)
475 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
476 lr->start - lr->offset);
477 else
478 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
479
480 fp = fopen(lr->path, "r");
481 if (fp == NULL) {
482 pr_warning("Failed to open %s: %s\n", lr->path,
483 strerror(errno));
484 return -errno;
485 }
486 /* Skip to starting line number */
487 while (l < lr->start) {
488 ret = skip_one_line(fp, l++);
489 if (ret < 0)
490 goto end;
491 }
492
493 list_for_each_entry(ln, &lr->line_list, list) {
494 for (; ln->line > l; l++) {
495 ret = show_one_line(fp, l - lr->offset);
496 if (ret < 0)
497 goto end;
498 }
499 ret = show_one_line_with_num(fp, l++ - lr->offset);
500 if (ret < 0)
501 goto end;
502 }
503
504 if (lr->end == INT_MAX)
505 lr->end = l + NR_ADDITIONAL_LINES;
506 while (l <= lr->end) {
507 ret = show_one_line_or_eof(fp, l++ - lr->offset);
508 if (ret <= 0)
509 break;
510 }
511end:
512 fclose(fp);
513 return ret;
514}
515
516static int show_available_vars_at(struct debuginfo *dinfo,
517 struct perf_probe_event *pev,
518 int max_vls, struct strfilter *_filter,
519 bool externs)
520{
521 char *buf;
522 int ret, i, nvars;
523 struct str_node *node;
524 struct variable_list *vls = NULL, *vl;
525 const char *var;
526
527 buf = synthesize_perf_probe_point(&pev->point);
528 if (!buf)
529 return -EINVAL;
530 pr_debug("Searching variables at %s\n", buf);
531
532 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
533 max_vls, externs);
534 if (ret <= 0) {
535 pr_err("Failed to find variables at %s (%d)\n", buf, ret);
536 goto end;
537 }
538 /* Some variables are found */
539 fprintf(stdout, "Available variables at %s\n", buf);
540 for (i = 0; i < ret; i++) {
541 vl = &vls[i];
542 /*
543 * A probe point might be converted to
544 * several trace points.
545 */
546 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
547 vl->point.offset);
548 free(vl->point.symbol);
549 nvars = 0;
550 if (vl->vars) {
551 strlist__for_each(node, vl->vars) {
552 var = strchr(node->s, '\t') + 1;
553 if (strfilter__compare(_filter, var)) {
554 fprintf(stdout, "\t\t%s\n", node->s);
555 nvars++;
556 }
557 }
558 strlist__delete(vl->vars);
559 }
560 if (nvars == 0)
561 fprintf(stdout, "\t\t(No matched variables)\n");
562 }
563 free(vls);
564end:
565 free(buf);
566 return ret;
567}
568
569/* Show available variables on given probe point */
570int show_available_vars(struct perf_probe_event *pevs, int npevs,
571 int max_vls, const char *module,
572 struct strfilter *_filter, bool externs)
573{
574 int i, ret = 0;
575 struct debuginfo *dinfo;
576
577 ret = init_vmlinux();
578 if (ret < 0)
579 return ret;
580
581 dinfo = open_debuginfo(module);
582 if (!dinfo) {
583 pr_warning("Failed to open debuginfo file.\n");
584 return -ENOENT;
585 }
586
587 setup_pager();
588
589 for (i = 0; i < npevs && ret >= 0; i++)
590 ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
591 externs);
592
593 debuginfo__delete(dinfo);
594 return ret;
595}
596
597#else /* !DWARF_SUPPORT */
598
599static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
600 struct perf_probe_point *pp)
601{
602 struct symbol *sym;
603
604 sym = __find_kernel_function_by_name(tp->symbol, NULL);
605 if (!sym) {
606 pr_err("Failed to find symbol %s in kernel.\n", tp->symbol);
607 return -ENOENT;
608 }
609 pp->function = strdup(tp->symbol);
610 if (pp->function == NULL)
611 return -ENOMEM;
612 pp->offset = tp->offset;
613 pp->retprobe = tp->retprobe;
614
615 return 0;
616}
617
618static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
619 struct probe_trace_event **tevs __unused,
620 int max_tevs __unused, const char *mod __unused)
621{
622 if (perf_probe_event_need_dwarf(pev)) {
623 pr_warning("Debuginfo-analysis is not supported.\n");
624 return -ENOSYS;
625 }
626 return 0;
627}
628
629int show_line_range(struct line_range *lr __unused, const char *module __unused)
630{
631 pr_warning("Debuginfo-analysis is not supported.\n");
632 return -ENOSYS;
633}
634
635int show_available_vars(struct perf_probe_event *pevs __unused,
636 int npevs __unused, int max_vls __unused,
637 const char *module __unused,
638 struct strfilter *filter __unused,
639 bool externs __unused)
640{
641 pr_warning("Debuginfo-analysis is not supported.\n");
642 return -ENOSYS;
643}
644#endif
645
646static int parse_line_num(char **ptr, int *val, const char *what)
647{
648 const char *start = *ptr;
649
650 errno = 0;
651 *val = strtol(*ptr, ptr, 0);
652 if (errno || *ptr == start) {
653 semantic_error("'%s' is not a valid number.\n", what);
654 return -EINVAL;
655 }
656 return 0;
657}
658
659/*
660 * Stuff 'lr' according to the line range described by 'arg'.
661 * The line range syntax is described by:
662 *
663 * SRC[:SLN[+NUM|-ELN]]
664 * FNC[@SRC][:SLN[+NUM|-ELN]]
665 */
666int parse_line_range_desc(const char *arg, struct line_range *lr)
667{
668 char *range, *file, *name = strdup(arg);
669 int err;
670
671 if (!name)
672 return -ENOMEM;
673
674 lr->start = 0;
675 lr->end = INT_MAX;
676
677 range = strchr(name, ':');
678 if (range) {
679 *range++ = '\0';
680
681 err = parse_line_num(&range, &lr->start, "start line");
682 if (err)
683 goto err;
684
685 if (*range == '+' || *range == '-') {
686 const char c = *range++;
687
688 err = parse_line_num(&range, &lr->end, "end line");
689 if (err)
690 goto err;
691
692 if (c == '+') {
693 lr->end += lr->start;
694 /*
695 * Adjust the number of lines here.
696 * If the number of lines == 1, the
697 * the end of line should be equal to
698 * the start of line.
699 */
700 lr->end--;
701 }
702 }
703
704 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
705
706 err = -EINVAL;
707 if (lr->start > lr->end) {
708 semantic_error("Start line must be smaller"
709 " than end line.\n");
710 goto err;
711 }
712 if (*range != '\0') {
713 semantic_error("Tailing with invalid str '%s'.\n", range);
714 goto err;
715 }
716 }
717
718 file = strchr(name, '@');
719 if (file) {
720 *file = '\0';
721 lr->file = strdup(++file);
722 if (lr->file == NULL) {
723 err = -ENOMEM;
724 goto err;
725 }
726 lr->function = name;
727 } else if (strchr(name, '.'))
728 lr->file = name;
729 else
730 lr->function = name;
731
732 return 0;
733err:
734 free(name);
735 return err;
736}
737
738/* Check the name is good for event/group */
739static bool check_event_name(const char *name)
740{
741 if (!isalpha(*name) && *name != '_')
742 return false;
743 while (*++name != '\0') {
744 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
745 return false;
746 }
747 return true;
748}
749
750/* Parse probepoint definition. */
751static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
752{
753 struct perf_probe_point *pp = &pev->point;
754 char *ptr, *tmp;
755 char c, nc = 0;
756 /*
757 * <Syntax>
758 * perf probe [EVENT=]SRC[:LN|;PTN]
759 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
760 *
761 * TODO:Group name support
762 */
763
764 ptr = strpbrk(arg, ";=@+%");
765 if (ptr && *ptr == '=') { /* Event name */
766 *ptr = '\0';
767 tmp = ptr + 1;
768 if (strchr(arg, ':')) {
769 semantic_error("Group name is not supported yet.\n");
770 return -ENOTSUP;
771 }
772 if (!check_event_name(arg)) {
773 semantic_error("%s is bad for event name -it must "
774 "follow C symbol-naming rule.\n", arg);
775 return -EINVAL;
776 }
777 pev->event = strdup(arg);
778 if (pev->event == NULL)
779 return -ENOMEM;
780 pev->group = NULL;
781 arg = tmp;
782 }
783
784 ptr = strpbrk(arg, ";:+@%");
785 if (ptr) {
786 nc = *ptr;
787 *ptr++ = '\0';
788 }
789
790 tmp = strdup(arg);
791 if (tmp == NULL)
792 return -ENOMEM;
793
794 /* Check arg is function or file and copy it */
795 if (strchr(tmp, '.')) /* File */
796 pp->file = tmp;
797 else /* Function */
798 pp->function = tmp;
799
800 /* Parse other options */
801 while (ptr) {
802 arg = ptr;
803 c = nc;
804 if (c == ';') { /* Lazy pattern must be the last part */
805 pp->lazy_line = strdup(arg);
806 if (pp->lazy_line == NULL)
807 return -ENOMEM;
808 break;
809 }
810 ptr = strpbrk(arg, ";:+@%");
811 if (ptr) {
812 nc = *ptr;
813 *ptr++ = '\0';
814 }
815 switch (c) {
816 case ':': /* Line number */
817 pp->line = strtoul(arg, &tmp, 0);
818 if (*tmp != '\0') {
819 semantic_error("There is non-digit char"
820 " in line number.\n");
821 return -EINVAL;
822 }
823 break;
824 case '+': /* Byte offset from a symbol */
825 pp->offset = strtoul(arg, &tmp, 0);
826 if (*tmp != '\0') {
827 semantic_error("There is non-digit character"
828 " in offset.\n");
829 return -EINVAL;
830 }
831 break;
832 case '@': /* File name */
833 if (pp->file) {
834 semantic_error("SRC@SRC is not allowed.\n");
835 return -EINVAL;
836 }
837 pp->file = strdup(arg);
838 if (pp->file == NULL)
839 return -ENOMEM;
840 break;
841 case '%': /* Probe places */
842 if (strcmp(arg, "return") == 0) {
843 pp->retprobe = 1;
844 } else { /* Others not supported yet */
845 semantic_error("%%%s is not supported.\n", arg);
846 return -ENOTSUP;
847 }
848 break;
849 default: /* Buggy case */
850 pr_err("This program has a bug at %s:%d.\n",
851 __FILE__, __LINE__);
852 return -ENOTSUP;
853 break;
854 }
855 }
856
857 /* Exclusion check */
858 if (pp->lazy_line && pp->line) {
859 semantic_error("Lazy pattern can't be used with"
860 " line number.\n");
861 return -EINVAL;
862 }
863
864 if (pp->lazy_line && pp->offset) {
865 semantic_error("Lazy pattern can't be used with offset.\n");
866 return -EINVAL;
867 }
868
869 if (pp->line && pp->offset) {
870 semantic_error("Offset can't be used with line number.\n");
871 return -EINVAL;
872 }
873
874 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
875 semantic_error("File always requires line number or "
876 "lazy pattern.\n");
877 return -EINVAL;
878 }
879
880 if (pp->offset && !pp->function) {
881 semantic_error("Offset requires an entry function.\n");
882 return -EINVAL;
883 }
884
885 if (pp->retprobe && !pp->function) {
886 semantic_error("Return probe requires an entry function.\n");
887 return -EINVAL;
888 }
889
890 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
891 semantic_error("Offset/Line/Lazy pattern can't be used with "
892 "return probe.\n");
893 return -EINVAL;
894 }
895
896 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
897 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
898 pp->lazy_line);
899 return 0;
900}
901
902/* Parse perf-probe event argument */
903static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
904{
905 char *tmp, *goodname;
906 struct perf_probe_arg_field **fieldp;
907
908 pr_debug("parsing arg: %s into ", str);
909
910 tmp = strchr(str, '=');
911 if (tmp) {
912 arg->name = strndup(str, tmp - str);
913 if (arg->name == NULL)
914 return -ENOMEM;
915 pr_debug("name:%s ", arg->name);
916 str = tmp + 1;
917 }
918
919 tmp = strchr(str, ':');
920 if (tmp) { /* Type setting */
921 *tmp = '\0';
922 arg->type = strdup(tmp + 1);
923 if (arg->type == NULL)
924 return -ENOMEM;
925 pr_debug("type:%s ", arg->type);
926 }
927
928 tmp = strpbrk(str, "-.[");
929 if (!is_c_varname(str) || !tmp) {
930 /* A variable, register, symbol or special value */
931 arg->var = strdup(str);
932 if (arg->var == NULL)
933 return -ENOMEM;
934 pr_debug("%s\n", arg->var);
935 return 0;
936 }
937
938 /* Structure fields or array element */
939 arg->var = strndup(str, tmp - str);
940 if (arg->var == NULL)
941 return -ENOMEM;
942 goodname = arg->var;
943 pr_debug("%s, ", arg->var);
944 fieldp = &arg->field;
945
946 do {
947 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
948 if (*fieldp == NULL)
949 return -ENOMEM;
950 if (*tmp == '[') { /* Array */
951 str = tmp;
952 (*fieldp)->index = strtol(str + 1, &tmp, 0);
953 (*fieldp)->ref = true;
954 if (*tmp != ']' || tmp == str + 1) {
955 semantic_error("Array index must be a"
956 " number.\n");
957 return -EINVAL;
958 }
959 tmp++;
960 if (*tmp == '\0')
961 tmp = NULL;
962 } else { /* Structure */
963 if (*tmp == '.') {
964 str = tmp + 1;
965 (*fieldp)->ref = false;
966 } else if (tmp[1] == '>') {
967 str = tmp + 2;
968 (*fieldp)->ref = true;
969 } else {
970 semantic_error("Argument parse error: %s\n",
971 str);
972 return -EINVAL;
973 }
974 tmp = strpbrk(str, "-.[");
975 }
976 if (tmp) {
977 (*fieldp)->name = strndup(str, tmp - str);
978 if ((*fieldp)->name == NULL)
979 return -ENOMEM;
980 if (*str != '[')
981 goodname = (*fieldp)->name;
982 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
983 fieldp = &(*fieldp)->next;
984 }
985 } while (tmp);
986 (*fieldp)->name = strdup(str);
987 if ((*fieldp)->name == NULL)
988 return -ENOMEM;
989 if (*str != '[')
990 goodname = (*fieldp)->name;
991 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
992
993 /* If no name is specified, set the last field name (not array index)*/
994 if (!arg->name) {
995 arg->name = strdup(goodname);
996 if (arg->name == NULL)
997 return -ENOMEM;
998 }
999 return 0;
1000}
1001
1002/* Parse perf-probe event command */
1003int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1004{
1005 char **argv;
1006 int argc, i, ret = 0;
1007
1008 argv = argv_split(cmd, &argc);
1009 if (!argv) {
1010 pr_debug("Failed to split arguments.\n");
1011 return -ENOMEM;
1012 }
1013 if (argc - 1 > MAX_PROBE_ARGS) {
1014 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1015 ret = -ERANGE;
1016 goto out;
1017 }
1018 /* Parse probe point */
1019 ret = parse_perf_probe_point(argv[0], pev);
1020 if (ret < 0)
1021 goto out;
1022
1023 /* Copy arguments and ensure return probe has no C argument */
1024 pev->nargs = argc - 1;
1025 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1026 if (pev->args == NULL) {
1027 ret = -ENOMEM;
1028 goto out;
1029 }
1030 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1031 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1032 if (ret >= 0 &&
1033 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1034 semantic_error("You can't specify local variable for"
1035 " kretprobe.\n");
1036 ret = -EINVAL;
1037 }
1038 }
1039out:
1040 argv_free(argv);
1041
1042 return ret;
1043}
1044
1045/* Return true if this perf_probe_event requires debuginfo */
1046bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1047{
1048 int i;
1049
1050 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1051 return true;
1052
1053 for (i = 0; i < pev->nargs; i++)
1054 if (is_c_varname(pev->args[i].var))
1055 return true;
1056
1057 return false;
1058}
1059
1060/* Parse probe_events event into struct probe_point */
1061static int parse_probe_trace_command(const char *cmd,
1062 struct probe_trace_event *tev)
1063{
1064 struct probe_trace_point *tp = &tev->point;
1065 char pr;
1066 char *p;
1067 int ret, i, argc;
1068 char **argv;
1069
1070 pr_debug("Parsing probe_events: %s\n", cmd);
1071 argv = argv_split(cmd, &argc);
1072 if (!argv) {
1073 pr_debug("Failed to split arguments.\n");
1074 return -ENOMEM;
1075 }
1076 if (argc < 2) {
1077 semantic_error("Too few probe arguments.\n");
1078 ret = -ERANGE;
1079 goto out;
1080 }
1081
1082 /* Scan event and group name. */
1083 ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
1084 &pr, (float *)(void *)&tev->group,
1085 (float *)(void *)&tev->event);
1086 if (ret != 3) {
1087 semantic_error("Failed to parse event name: %s\n", argv[0]);
1088 ret = -EINVAL;
1089 goto out;
1090 }
1091 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1092
1093 tp->retprobe = (pr == 'r');
1094
1095 /* Scan module name(if there), function name and offset */
1096 p = strchr(argv[1], ':');
1097 if (p) {
1098 tp->module = strndup(argv[1], p - argv[1]);
1099 p++;
1100 } else
1101 p = argv[1];
1102 ret = sscanf(p, "%a[^+]+%lu", (float *)(void *)&tp->symbol,
1103 &tp->offset);
1104 if (ret == 1)
1105 tp->offset = 0;
1106
1107 tev->nargs = argc - 2;
1108 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1109 if (tev->args == NULL) {
1110 ret = -ENOMEM;
1111 goto out;
1112 }
1113 for (i = 0; i < tev->nargs; i++) {
1114 p = strchr(argv[i + 2], '=');
1115 if (p) /* We don't need which register is assigned. */
1116 *p++ = '\0';
1117 else
1118 p = argv[i + 2];
1119 tev->args[i].name = strdup(argv[i + 2]);
1120 /* TODO: parse regs and offset */
1121 tev->args[i].value = strdup(p);
1122 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1123 ret = -ENOMEM;
1124 goto out;
1125 }
1126 }
1127 ret = 0;
1128out:
1129 argv_free(argv);
1130 return ret;
1131}
1132
1133/* Compose only probe arg */
1134int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1135{
1136 struct perf_probe_arg_field *field = pa->field;
1137 int ret;
1138 char *tmp = buf;
1139
1140 if (pa->name && pa->var)
1141 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1142 else
1143 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1144 if (ret <= 0)
1145 goto error;
1146 tmp += ret;
1147 len -= ret;
1148
1149 while (field) {
1150 if (field->name[0] == '[')
1151 ret = e_snprintf(tmp, len, "%s", field->name);
1152 else
1153 ret = e_snprintf(tmp, len, "%s%s",
1154 field->ref ? "->" : ".", field->name);
1155 if (ret <= 0)
1156 goto error;
1157 tmp += ret;
1158 len -= ret;
1159 field = field->next;
1160 }
1161
1162 if (pa->type) {
1163 ret = e_snprintf(tmp, len, ":%s", pa->type);
1164 if (ret <= 0)
1165 goto error;
1166 tmp += ret;
1167 len -= ret;
1168 }
1169
1170 return tmp - buf;
1171error:
1172 pr_debug("Failed to synthesize perf probe argument: %s\n",
1173 strerror(-ret));
1174 return ret;
1175}
1176
1177/* Compose only probe point (not argument) */
1178static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1179{
1180 char *buf, *tmp;
1181 char offs[32] = "", line[32] = "", file[32] = "";
1182 int ret, len;
1183
1184 buf = zalloc(MAX_CMDLEN);
1185 if (buf == NULL) {
1186 ret = -ENOMEM;
1187 goto error;
1188 }
1189 if (pp->offset) {
1190 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1191 if (ret <= 0)
1192 goto error;
1193 }
1194 if (pp->line) {
1195 ret = e_snprintf(line, 32, ":%d", pp->line);
1196 if (ret <= 0)
1197 goto error;
1198 }
1199 if (pp->file) {
1200 tmp = pp->file;
1201 len = strlen(tmp);
1202 if (len > 30) {
1203 tmp = strchr(pp->file + len - 30, '/');
1204 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1205 }
1206 ret = e_snprintf(file, 32, "@%s", tmp);
1207 if (ret <= 0)
1208 goto error;
1209 }
1210
1211 if (pp->function)
1212 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1213 offs, pp->retprobe ? "%return" : "", line,
1214 file);
1215 else
1216 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1217 if (ret <= 0)
1218 goto error;
1219
1220 return buf;
1221error:
1222 pr_debug("Failed to synthesize perf probe point: %s\n",
1223 strerror(-ret));
1224 if (buf)
1225 free(buf);
1226 return NULL;
1227}
1228
1229#if 0
1230char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1231{
1232 char *buf;
1233 int i, len, ret;
1234
1235 buf = synthesize_perf_probe_point(&pev->point);
1236 if (!buf)
1237 return NULL;
1238
1239 len = strlen(buf);
1240 for (i = 0; i < pev->nargs; i++) {
1241 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1242 pev->args[i].name);
1243 if (ret <= 0) {
1244 free(buf);
1245 return NULL;
1246 }
1247 len += ret;
1248 }
1249
1250 return buf;
1251}
1252#endif
1253
1254static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1255 char **buf, size_t *buflen,
1256 int depth)
1257{
1258 int ret;
1259 if (ref->next) {
1260 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1261 buflen, depth + 1);
1262 if (depth < 0)
1263 goto out;
1264 }
1265
1266 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1267 if (ret < 0)
1268 depth = ret;
1269 else {
1270 *buf += ret;
1271 *buflen -= ret;
1272 }
1273out:
1274 return depth;
1275
1276}
1277
1278static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1279 char *buf, size_t buflen)
1280{
1281 struct probe_trace_arg_ref *ref = arg->ref;
1282 int ret, depth = 0;
1283 char *tmp = buf;
1284
1285 /* Argument name or separator */
1286 if (arg->name)
1287 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1288 else
1289 ret = e_snprintf(buf, buflen, " ");
1290 if (ret < 0)
1291 return ret;
1292 buf += ret;
1293 buflen -= ret;
1294
1295 /* Special case: @XXX */
1296 if (arg->value[0] == '@' && arg->ref)
1297 ref = ref->next;
1298
1299 /* Dereferencing arguments */
1300 if (ref) {
1301 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1302 &buflen, 1);
1303 if (depth < 0)
1304 return depth;
1305 }
1306
1307 /* Print argument value */
1308 if (arg->value[0] == '@' && arg->ref)
1309 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1310 arg->ref->offset);
1311 else
1312 ret = e_snprintf(buf, buflen, "%s", arg->value);
1313 if (ret < 0)
1314 return ret;
1315 buf += ret;
1316 buflen -= ret;
1317
1318 /* Closing */
1319 while (depth--) {
1320 ret = e_snprintf(buf, buflen, ")");
1321 if (ret < 0)
1322 return ret;
1323 buf += ret;
1324 buflen -= ret;
1325 }
1326 /* Print argument type */
1327 if (arg->type) {
1328 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1329 if (ret <= 0)
1330 return ret;
1331 buf += ret;
1332 }
1333
1334 return buf - tmp;
1335}
1336
1337char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1338{
1339 struct probe_trace_point *tp = &tev->point;
1340 char *buf;
1341 int i, len, ret;
1342
1343 buf = zalloc(MAX_CMDLEN);
1344 if (buf == NULL)
1345 return NULL;
1346
1347 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s%s%s+%lu",
1348 tp->retprobe ? 'r' : 'p',
1349 tev->group, tev->event,
1350 tp->module ?: "", tp->module ? ":" : "",
1351 tp->symbol, tp->offset);
1352 if (len <= 0)
1353 goto error;
1354
1355 for (i = 0; i < tev->nargs; i++) {
1356 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1357 MAX_CMDLEN - len);
1358 if (ret <= 0)
1359 goto error;
1360 len += ret;
1361 }
1362
1363 return buf;
1364error:
1365 free(buf);
1366 return NULL;
1367}
1368
1369static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1370 struct perf_probe_event *pev)
1371{
1372 char buf[64] = "";
1373 int i, ret;
1374
1375 /* Convert event/group name */
1376 pev->event = strdup(tev->event);
1377 pev->group = strdup(tev->group);
1378 if (pev->event == NULL || pev->group == NULL)
1379 return -ENOMEM;
1380
1381 /* Convert trace_point to probe_point */
1382 ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
1383 if (ret < 0)
1384 return ret;
1385
1386 /* Convert trace_arg to probe_arg */
1387 pev->nargs = tev->nargs;
1388 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1389 if (pev->args == NULL)
1390 return -ENOMEM;
1391 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1392 if (tev->args[i].name)
1393 pev->args[i].name = strdup(tev->args[i].name);
1394 else {
1395 ret = synthesize_probe_trace_arg(&tev->args[i],
1396 buf, 64);
1397 pev->args[i].name = strdup(buf);
1398 }
1399 if (pev->args[i].name == NULL && ret >= 0)
1400 ret = -ENOMEM;
1401 }
1402
1403 if (ret < 0)
1404 clear_perf_probe_event(pev);
1405
1406 return ret;
1407}
1408
1409void clear_perf_probe_event(struct perf_probe_event *pev)
1410{
1411 struct perf_probe_point *pp = &pev->point;
1412 struct perf_probe_arg_field *field, *next;
1413 int i;
1414
1415 if (pev->event)
1416 free(pev->event);
1417 if (pev->group)
1418 free(pev->group);
1419 if (pp->file)
1420 free(pp->file);
1421 if (pp->function)
1422 free(pp->function);
1423 if (pp->lazy_line)
1424 free(pp->lazy_line);
1425 for (i = 0; i < pev->nargs; i++) {
1426 if (pev->args[i].name)
1427 free(pev->args[i].name);
1428 if (pev->args[i].var)
1429 free(pev->args[i].var);
1430 if (pev->args[i].type)
1431 free(pev->args[i].type);
1432 field = pev->args[i].field;
1433 while (field) {
1434 next = field->next;
1435 if (field->name)
1436 free(field->name);
1437 free(field);
1438 field = next;
1439 }
1440 }
1441 if (pev->args)
1442 free(pev->args);
1443 memset(pev, 0, sizeof(*pev));
1444}
1445
1446static void clear_probe_trace_event(struct probe_trace_event *tev)
1447{
1448 struct probe_trace_arg_ref *ref, *next;
1449 int i;
1450
1451 if (tev->event)
1452 free(tev->event);
1453 if (tev->group)
1454 free(tev->group);
1455 if (tev->point.symbol)
1456 free(tev->point.symbol);
1457 if (tev->point.module)
1458 free(tev->point.module);
1459 for (i = 0; i < tev->nargs; i++) {
1460 if (tev->args[i].name)
1461 free(tev->args[i].name);
1462 if (tev->args[i].value)
1463 free(tev->args[i].value);
1464 if (tev->args[i].type)
1465 free(tev->args[i].type);
1466 ref = tev->args[i].ref;
1467 while (ref) {
1468 next = ref->next;
1469 free(ref);
1470 ref = next;
1471 }
1472 }
1473 if (tev->args)
1474 free(tev->args);
1475 memset(tev, 0, sizeof(*tev));
1476}
1477
1478static int open_kprobe_events(bool readwrite)
1479{
1480 char buf[PATH_MAX];
1481 const char *__debugfs;
1482 int ret;
1483
1484 __debugfs = debugfs_find_mountpoint();
1485 if (__debugfs == NULL) {
1486 pr_warning("Debugfs is not mounted.\n");
1487 return -ENOENT;
1488 }
1489
1490 ret = e_snprintf(buf, PATH_MAX, "%stracing/kprobe_events", __debugfs);
1491 if (ret >= 0) {
1492 pr_debug("Opening %s write=%d\n", buf, readwrite);
1493 if (readwrite && !probe_event_dry_run)
1494 ret = open(buf, O_RDWR, O_APPEND);
1495 else
1496 ret = open(buf, O_RDONLY, 0);
1497 }
1498
1499 if (ret < 0) {
1500 if (errno == ENOENT)
1501 pr_warning("kprobe_events file does not exist - please"
1502 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
1503 else
1504 pr_warning("Failed to open kprobe_events file: %s\n",
1505 strerror(errno));
1506 }
1507 return ret;
1508}
1509
1510/* Get raw string list of current kprobe_events */
1511static struct strlist *get_probe_trace_command_rawlist(int fd)
1512{
1513 int ret, idx;
1514 FILE *fp;
1515 char buf[MAX_CMDLEN];
1516 char *p;
1517 struct strlist *sl;
1518
1519 sl = strlist__new(true, NULL);
1520
1521 fp = fdopen(dup(fd), "r");
1522 while (!feof(fp)) {
1523 p = fgets(buf, MAX_CMDLEN, fp);
1524 if (!p)
1525 break;
1526
1527 idx = strlen(p) - 1;
1528 if (p[idx] == '\n')
1529 p[idx] = '\0';
1530 ret = strlist__add(sl, buf);
1531 if (ret < 0) {
1532 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1533 strlist__delete(sl);
1534 return NULL;
1535 }
1536 }
1537 fclose(fp);
1538
1539 return sl;
1540}
1541
1542/* Show an event */
1543static int show_perf_probe_event(struct perf_probe_event *pev)
1544{
1545 int i, ret;
1546 char buf[128];
1547 char *place;
1548
1549 /* Synthesize only event probe point */
1550 place = synthesize_perf_probe_point(&pev->point);
1551 if (!place)
1552 return -EINVAL;
1553
1554 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1555 if (ret < 0)
1556 return ret;
1557
1558 printf(" %-20s (on %s", buf, place);
1559
1560 if (pev->nargs > 0) {
1561 printf(" with");
1562 for (i = 0; i < pev->nargs; i++) {
1563 ret = synthesize_perf_probe_arg(&pev->args[i],
1564 buf, 128);
1565 if (ret < 0)
1566 break;
1567 printf(" %s", buf);
1568 }
1569 }
1570 printf(")\n");
1571 free(place);
1572 return ret;
1573}
1574
1575/* List up current perf-probe events */
1576int show_perf_probe_events(void)
1577{
1578 int fd, ret;
1579 struct probe_trace_event tev;
1580 struct perf_probe_event pev;
1581 struct strlist *rawlist;
1582 struct str_node *ent;
1583
1584 setup_pager();
1585 ret = init_vmlinux();
1586 if (ret < 0)
1587 return ret;
1588
1589 memset(&tev, 0, sizeof(tev));
1590 memset(&pev, 0, sizeof(pev));
1591
1592 fd = open_kprobe_events(false);
1593 if (fd < 0)
1594 return fd;
1595
1596 rawlist = get_probe_trace_command_rawlist(fd);
1597 close(fd);
1598 if (!rawlist)
1599 return -ENOENT;
1600
1601 strlist__for_each(ent, rawlist) {
1602 ret = parse_probe_trace_command(ent->s, &tev);
1603 if (ret >= 0) {
1604 ret = convert_to_perf_probe_event(&tev, &pev);
1605 if (ret >= 0)
1606 ret = show_perf_probe_event(&pev);
1607 }
1608 clear_perf_probe_event(&pev);
1609 clear_probe_trace_event(&tev);
1610 if (ret < 0)
1611 break;
1612 }
1613 strlist__delete(rawlist);
1614
1615 return ret;
1616}
1617
1618/* Get current perf-probe event names */
1619static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
1620{
1621 char buf[128];
1622 struct strlist *sl, *rawlist;
1623 struct str_node *ent;
1624 struct probe_trace_event tev;
1625 int ret = 0;
1626
1627 memset(&tev, 0, sizeof(tev));
1628 rawlist = get_probe_trace_command_rawlist(fd);
1629 sl = strlist__new(true, NULL);
1630 strlist__for_each(ent, rawlist) {
1631 ret = parse_probe_trace_command(ent->s, &tev);
1632 if (ret < 0)
1633 break;
1634 if (include_group) {
1635 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1636 tev.event);
1637 if (ret >= 0)
1638 ret = strlist__add(sl, buf);
1639 } else
1640 ret = strlist__add(sl, tev.event);
1641 clear_probe_trace_event(&tev);
1642 if (ret < 0)
1643 break;
1644 }
1645 strlist__delete(rawlist);
1646
1647 if (ret < 0) {
1648 strlist__delete(sl);
1649 return NULL;
1650 }
1651 return sl;
1652}
1653
1654static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
1655{
1656 int ret = 0;
1657 char *buf = synthesize_probe_trace_command(tev);
1658
1659 if (!buf) {
1660 pr_debug("Failed to synthesize probe trace event.\n");
1661 return -EINVAL;
1662 }
1663
1664 pr_debug("Writing event: %s\n", buf);
1665 if (!probe_event_dry_run) {
1666 ret = write(fd, buf, strlen(buf));
1667 if (ret <= 0)
1668 pr_warning("Failed to write event: %s\n",
1669 strerror(errno));
1670 }
1671 free(buf);
1672 return ret;
1673}
1674
1675static int get_new_event_name(char *buf, size_t len, const char *base,
1676 struct strlist *namelist, bool allow_suffix)
1677{
1678 int i, ret;
1679
1680 /* Try no suffix */
1681 ret = e_snprintf(buf, len, "%s", base);
1682 if (ret < 0) {
1683 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1684 return ret;
1685 }
1686 if (!strlist__has_entry(namelist, buf))
1687 return 0;
1688
1689 if (!allow_suffix) {
1690 pr_warning("Error: event \"%s\" already exists. "
1691 "(Use -f to force duplicates.)\n", base);
1692 return -EEXIST;
1693 }
1694
1695 /* Try to add suffix */
1696 for (i = 1; i < MAX_EVENT_INDEX; i++) {
1697 ret = e_snprintf(buf, len, "%s_%d", base, i);
1698 if (ret < 0) {
1699 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1700 return ret;
1701 }
1702 if (!strlist__has_entry(namelist, buf))
1703 break;
1704 }
1705 if (i == MAX_EVENT_INDEX) {
1706 pr_warning("Too many events are on the same function.\n");
1707 ret = -ERANGE;
1708 }
1709
1710 return ret;
1711}
1712
1713static int __add_probe_trace_events(struct perf_probe_event *pev,
1714 struct probe_trace_event *tevs,
1715 int ntevs, bool allow_suffix)
1716{
1717 int i, fd, ret;
1718 struct probe_trace_event *tev = NULL;
1719 char buf[64];
1720 const char *event, *group;
1721 struct strlist *namelist;
1722
1723 fd = open_kprobe_events(true);
1724 if (fd < 0)
1725 return fd;
1726 /* Get current event names */
1727 namelist = get_probe_trace_event_names(fd, false);
1728 if (!namelist) {
1729 pr_debug("Failed to get current event list.\n");
1730 return -EIO;
1731 }
1732
1733 ret = 0;
1734 printf("Add new event%s\n", (ntevs > 1) ? "s:" : ":");
1735 for (i = 0; i < ntevs; i++) {
1736 tev = &tevs[i];
1737 if (pev->event)
1738 event = pev->event;
1739 else
1740 if (pev->point.function)
1741 event = pev->point.function;
1742 else
1743 event = tev->point.symbol;
1744 if (pev->group)
1745 group = pev->group;
1746 else
1747 group = PERFPROBE_GROUP;
1748
1749 /* Get an unused new event name */
1750 ret = get_new_event_name(buf, 64, event,
1751 namelist, allow_suffix);
1752 if (ret < 0)
1753 break;
1754 event = buf;
1755
1756 tev->event = strdup(event);
1757 tev->group = strdup(group);
1758 if (tev->event == NULL || tev->group == NULL) {
1759 ret = -ENOMEM;
1760 break;
1761 }
1762 ret = write_probe_trace_event(fd, tev);
1763 if (ret < 0)
1764 break;
1765 /* Add added event name to namelist */
1766 strlist__add(namelist, event);
1767
1768 /* Trick here - save current event/group */
1769 event = pev->event;
1770 group = pev->group;
1771 pev->event = tev->event;
1772 pev->group = tev->group;
1773 show_perf_probe_event(pev);
1774 /* Trick here - restore current event/group */
1775 pev->event = (char *)event;
1776 pev->group = (char *)group;
1777
1778 /*
1779 * Probes after the first probe which comes from same
1780 * user input are always allowed to add suffix, because
1781 * there might be several addresses corresponding to
1782 * one code line.
1783 */
1784 allow_suffix = true;
1785 }
1786
1787 if (ret >= 0) {
1788 /* Show how to use the event. */
1789 printf("\nYou can now use it on all perf tools, such as:\n\n");
1790 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
1791 tev->event);
1792 }
1793
1794 strlist__delete(namelist);
1795 close(fd);
1796 return ret;
1797}
1798
1799static int convert_to_probe_trace_events(struct perf_probe_event *pev,
1800 struct probe_trace_event **tevs,
1801 int max_tevs, const char *module)
1802{
1803 struct symbol *sym;
1804 int ret = 0, i;
1805 struct probe_trace_event *tev;
1806
1807 /* Convert perf_probe_event with debuginfo */
1808 ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, module);
1809 if (ret != 0)
1810 return ret; /* Found in debuginfo or got an error */
1811
1812 /* Allocate trace event buffer */
1813 tev = *tevs = zalloc(sizeof(struct probe_trace_event));
1814 if (tev == NULL)
1815 return -ENOMEM;
1816
1817 /* Copy parameters */
1818 tev->point.symbol = strdup(pev->point.function);
1819 if (tev->point.symbol == NULL) {
1820 ret = -ENOMEM;
1821 goto error;
1822 }
1823
1824 if (module) {
1825 tev->point.module = strdup(module);
1826 if (tev->point.module == NULL) {
1827 ret = -ENOMEM;
1828 goto error;
1829 }
1830 }
1831
1832 tev->point.offset = pev->point.offset;
1833 tev->point.retprobe = pev->point.retprobe;
1834 tev->nargs = pev->nargs;
1835 if (tev->nargs) {
1836 tev->args = zalloc(sizeof(struct probe_trace_arg)
1837 * tev->nargs);
1838 if (tev->args == NULL) {
1839 ret = -ENOMEM;
1840 goto error;
1841 }
1842 for (i = 0; i < tev->nargs; i++) {
1843 if (pev->args[i].name) {
1844 tev->args[i].name = strdup(pev->args[i].name);
1845 if (tev->args[i].name == NULL) {
1846 ret = -ENOMEM;
1847 goto error;
1848 }
1849 }
1850 tev->args[i].value = strdup(pev->args[i].var);
1851 if (tev->args[i].value == NULL) {
1852 ret = -ENOMEM;
1853 goto error;
1854 }
1855 if (pev->args[i].type) {
1856 tev->args[i].type = strdup(pev->args[i].type);
1857 if (tev->args[i].type == NULL) {
1858 ret = -ENOMEM;
1859 goto error;
1860 }
1861 }
1862 }
1863 }
1864
1865 /* Currently just checking function name from symbol map */
1866 sym = __find_kernel_function_by_name(tev->point.symbol, NULL);
1867 if (!sym) {
1868 pr_warning("Kernel symbol \'%s\' not found.\n",
1869 tev->point.symbol);
1870 ret = -ENOENT;
1871 goto error;
1872 }
1873
1874 return 1;
1875error:
1876 clear_probe_trace_event(tev);
1877 free(tev);
1878 *tevs = NULL;
1879 return ret;
1880}
1881
1882struct __event_package {
1883 struct perf_probe_event *pev;
1884 struct probe_trace_event *tevs;
1885 int ntevs;
1886};
1887
1888int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
1889 int max_tevs, const char *module, bool force_add)
1890{
1891 int i, j, ret;
1892 struct __event_package *pkgs;
1893
1894 pkgs = zalloc(sizeof(struct __event_package) * npevs);
1895 if (pkgs == NULL)
1896 return -ENOMEM;
1897
1898 /* Init vmlinux path */
1899 ret = init_vmlinux();
1900 if (ret < 0) {
1901 free(pkgs);
1902 return ret;
1903 }
1904
1905 /* Loop 1: convert all events */
1906 for (i = 0; i < npevs; i++) {
1907 pkgs[i].pev = &pevs[i];
1908 /* Convert with or without debuginfo */
1909 ret = convert_to_probe_trace_events(pkgs[i].pev,
1910 &pkgs[i].tevs,
1911 max_tevs,
1912 module);
1913 if (ret < 0)
1914 goto end;
1915 pkgs[i].ntevs = ret;
1916 }
1917
1918 /* Loop 2: add all events */
1919 for (i = 0; i < npevs; i++) {
1920 ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
1921 pkgs[i].ntevs, force_add);
1922 if (ret < 0)
1923 break;
1924 }
1925end:
1926 /* Loop 3: cleanup and free trace events */
1927 for (i = 0; i < npevs; i++) {
1928 for (j = 0; j < pkgs[i].ntevs; j++)
1929 clear_probe_trace_event(&pkgs[i].tevs[j]);
1930 free(pkgs[i].tevs);
1931 }
1932 free(pkgs);
1933
1934 return ret;
1935}
1936
1937static int __del_trace_probe_event(int fd, struct str_node *ent)
1938{
1939 char *p;
1940 char buf[128];
1941 int ret;
1942
1943 /* Convert from perf-probe event to trace-probe event */
1944 ret = e_snprintf(buf, 128, "-:%s", ent->s);
1945 if (ret < 0)
1946 goto error;
1947
1948 p = strchr(buf + 2, ':');
1949 if (!p) {
1950 pr_debug("Internal error: %s should have ':' but not.\n",
1951 ent->s);
1952 ret = -ENOTSUP;
1953 goto error;
1954 }
1955 *p = '/';
1956
1957 pr_debug("Writing event: %s\n", buf);
1958 ret = write(fd, buf, strlen(buf));
1959 if (ret < 0)
1960 goto error;
1961
1962 printf("Remove event: %s\n", ent->s);
1963 return 0;
1964error:
1965 pr_warning("Failed to delete event: %s\n", strerror(-ret));
1966 return ret;
1967}
1968
1969static int del_trace_probe_event(int fd, const char *group,
1970 const char *event, struct strlist *namelist)
1971{
1972 char buf[128];
1973 struct str_node *ent, *n;
1974 int found = 0, ret = 0;
1975
1976 ret = e_snprintf(buf, 128, "%s:%s", group, event);
1977 if (ret < 0) {
1978 pr_err("Failed to copy event.\n");
1979 return ret;
1980 }
1981
1982 if (strpbrk(buf, "*?")) { /* Glob-exp */
1983 strlist__for_each_safe(ent, n, namelist)
1984 if (strglobmatch(ent->s, buf)) {
1985 found++;
1986 ret = __del_trace_probe_event(fd, ent);
1987 if (ret < 0)
1988 break;
1989 strlist__remove(namelist, ent);
1990 }
1991 } else {
1992 ent = strlist__find(namelist, buf);
1993 if (ent) {
1994 found++;
1995 ret = __del_trace_probe_event(fd, ent);
1996 if (ret >= 0)
1997 strlist__remove(namelist, ent);
1998 }
1999 }
2000 if (found == 0 && ret >= 0)
2001 pr_info("Info: Event \"%s\" does not exist.\n", buf);
2002
2003 return ret;
2004}
2005
2006int del_perf_probe_events(struct strlist *dellist)
2007{
2008 int fd, ret = 0;
2009 const char *group, *event;
2010 char *p, *str;
2011 struct str_node *ent;
2012 struct strlist *namelist;
2013
2014 fd = open_kprobe_events(true);
2015 if (fd < 0)
2016 return fd;
2017
2018 /* Get current event names */
2019 namelist = get_probe_trace_event_names(fd, true);
2020 if (namelist == NULL)
2021 return -EINVAL;
2022
2023 strlist__for_each(ent, dellist) {
2024 str = strdup(ent->s);
2025 if (str == NULL) {
2026 ret = -ENOMEM;
2027 break;
2028 }
2029 pr_debug("Parsing: %s\n", str);
2030 p = strchr(str, ':');
2031 if (p) {
2032 group = str;
2033 *p = '\0';
2034 event = p + 1;
2035 } else {
2036 group = "*";
2037 event = str;
2038 }
2039 pr_debug("Group: %s, Event: %s\n", group, event);
2040 ret = del_trace_probe_event(fd, group, event, namelist);
2041 free(str);
2042 if (ret < 0)
2043 break;
2044 }
2045 strlist__delete(namelist);
2046 close(fd);
2047
2048 return ret;
2049}
2050/* TODO: don't use a global variable for filter ... */
2051static struct strfilter *available_func_filter;
2052
2053/*
2054 * If a symbol corresponds to a function with global binding and
2055 * matches filter return 0. For all others return 1.
2056 */
2057static int filter_available_functions(struct map *map __unused,
2058 struct symbol *sym)
2059{
2060 if (sym->binding == STB_GLOBAL &&
2061 strfilter__compare(available_func_filter, sym->name))
2062 return 0;
2063 return 1;
2064}
2065
2066int show_available_funcs(const char *module, struct strfilter *_filter)
2067{
2068 struct map *map;
2069 int ret;
2070
2071 setup_pager();
2072
2073 ret = init_vmlinux();
2074 if (ret < 0)
2075 return ret;
2076
2077 map = kernel_get_module_map(module);
2078 if (!map) {
2079 pr_err("Failed to find %s map.\n", (module) ? : "kernel");
2080 return -EINVAL;
2081 }
2082 available_func_filter = _filter;
2083 if (map__load(map, filter_available_functions)) {
2084 pr_err("Failed to load map.\n");
2085 return -EINVAL;
2086 }
2087 if (!dso__sorted_by_name(map->dso, map->type))
2088 dso__sort_by_name(map->dso, map->type);
2089
2090 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2091 return 0;
2092}