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