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