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