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