perf top: Improve the autosizing of column lenghts
[safe/jmp/linux-2.6] / tools / perf / builtin-probe.c
index a2f6daf..152d6c9 100644 (file)
 #include "perf.h"
 #include "builtin.h"
 #include "util/util.h"
+#include "util/strlist.h"
 #include "util/event.h"
 #include "util/debug.h"
+#include "util/debugfs.h"
+#include "util/symbol.h"
+#include "util/thread.h"
 #include "util/parse-options.h"
 #include "util/parse-events.h" /* For debugfs_path */
 #include "util/probe-finder.h"
-
-/* Default vmlinux search paths */
-#define NR_SEARCH_PATH 3
-const char *default_search_path[NR_SEARCH_PATH] = {
-"/lib/modules/%s/build/vmlinux",               /* Custom build kernel */
-"/usr/lib/debug/lib/modules/%s/vmlinux",       /* Red Hat debuginfo */
-"/boot/vmlinux-debug-%s",                      /* Ubuntu */
-};
+#include "util/probe-event.h"
 
 #define MAX_PATH_LEN 256
-#define MAX_PROBES 128
-#define MAX_PROBE_ARGS 128
-#define PERFPROBE_GROUP "probe"
 
 /* Session management structure */
 static struct {
-       char *vmlinux;
-       char *release;
-       int need_dwarf;
+       bool need_dwarf;
+       bool list_events;
+       bool force_add;
+       bool show_lines;
        int nr_probe;
        struct probe_point probes[MAX_PROBES];
+       struct strlist *dellist;
+       struct map_groups kmap_groups;
+       struct map *kmaps[MAP__NR_TYPES];
+       struct line_range line_range;
 } session;
 
-#define semantic_error(msg ...) die("Semantic error :" msg)
-
-/* Parse probe point. Return 1 if return probe */
-static void parse_probe_point(char *arg, struct probe_point *pp)
-{
-       char *ptr, *tmp;
-       char c, nc = 0;
-       /*
-        * <Syntax>
-        * perf probe SRC:LN
-        * perf probe FUNC[+OFFS|%return][@SRC]
-        */
-
-       ptr = strpbrk(arg, ":+@%");
-       if (ptr) {
-               nc = *ptr;
-               *ptr++ = '\0';
-       }
-
-       /* Check arg is function or file and copy it */
-       if (strchr(arg, '.'))   /* File */
-               pp->file = strdup(arg);
-       else                    /* Function */
-               pp->function = strdup(arg);
-       DIE_IF(pp->file == NULL && pp->function == NULL);
-
-       /* Parse other options */
-       while (ptr) {
-               arg = ptr;
-               c = nc;
-               ptr = strpbrk(arg, ":+@%");
-               if (ptr) {
-                       nc = *ptr;
-                       *ptr++ = '\0';
-               }
-               switch (c) {
-               case ':':       /* Line number */
-                       pp->line = strtoul(arg, &tmp, 0);
-                       if (*tmp != '\0')
-                               semantic_error("There is non-digit charactor"
-                                               " in line number.");
-                       break;
-               case '+':       /* Byte offset from a symbol */
-                       pp->offset = strtoul(arg, &tmp, 0);
-                       if (*tmp != '\0')
-                               semantic_error("There is non-digit charactor"
-                                               " in offset.");
-                       break;
-               case '@':       /* File name */
-                       if (pp->file)
-                               semantic_error("SRC@SRC is not allowed.");
-                       pp->file = strdup(arg);
-                       DIE_IF(pp->file == NULL);
-                       if (ptr)
-                               semantic_error("@SRC must be the last "
-                                              "option.");
-                       break;
-               case '%':       /* Probe places */
-                       if (strcmp(arg, "return") == 0) {
-                               pp->retprobe = 1;
-                       } else  /* Others not supported yet */
-                               semantic_error("%%%s is not supported.", arg);
-                       break;
-               default:
-                       DIE_IF("Program has a bug.");
-                       break;
-               }
-       }
-
-       /* Exclusion check */
-       if (pp->line && pp->offset)
-               semantic_error("Offset can't be used with line number.");
-       if (!pp->line && pp->file && !pp->function)
-               semantic_error("File always requires line number.");
-       if (pp->offset && !pp->function)
-               semantic_error("Offset requires an entry function.");
-       if (pp->retprobe && !pp->function)
-               semantic_error("Return probe requires an entry function.");
-       if ((pp->offset || pp->line) && pp->retprobe)
-               semantic_error("Offset/Line can't be used with return probe.");
-
-       pr_debug("symbol:%s file:%s line:%d offset:%d, return:%d\n",
-                pp->function, pp->file, pp->line, pp->offset, pp->retprobe);
-}
 
 /* Parse an event definition. Note that any error must die. */
 static void parse_probe_event(const char *str)
 {
-       char *argv[MAX_PROBE_ARGS + 2]; /* Event + probe + args */
-       int argc, i;
        struct probe_point *pp = &session.probes[session.nr_probe];
 
        pr_debug("probe-definition(%d): %s\n", session.nr_probe, str);
        if (++session.nr_probe == MAX_PROBES)
-               semantic_error("Too many probes");
-
-       /* Separate arguments, similar to argv_split */
-       argc = 0;
-       do {
-               /* Skip separators */
-               while (isspace(*str))
-                       str++;
-
-               /* Add an argument */
-               if (*str != '\0') {
-                       const char *s = str;
-
-                       /* Skip the argument */
-                       while (!isspace(*str) && *str != '\0')
-                               str++;
-
-                       /* Duplicate the argument */
-                       argv[argc] = strndup(s, str - s);
-                       if (argv[argc] == NULL)
-                               die("strndup");
-                       if (++argc == MAX_PROBE_ARGS)
-                               semantic_error("Too many arguments");
-                       pr_debug("argv[%d]=%s\n", argc, argv[argc - 1]);
-               }
-       } while (*str != '\0');
-       if (!argc)
-               semantic_error("An empty argument.");
-
-       /* Parse probe point */
-       parse_probe_point(argv[0], pp);
-       free(argv[0]);
-       if (pp->file || pp->line)
-               session.need_dwarf = 1;
-
-       /* Copy arguments */
-       pp->nr_args = argc - 1;
-       if (pp->nr_args > 0) {
-               pp->args = (char **)malloc(sizeof(char *) * pp->nr_args);
-               if (!pp->args)
-                       die("malloc");
-               memcpy(pp->args, &argv[1], sizeof(char *) * pp->nr_args);
-       }
+               die("Too many probes (> %d) are specified.", MAX_PROBES);
 
-       /* Ensure return probe has no C argument */
-       for (i = 0; i < pp->nr_args; i++)
-               if (is_c_varname(pp->args[i])) {
-                       if (pp->retprobe)
-                               semantic_error("You can't specify local"
-                                               " variable for kretprobe");
-                       session.need_dwarf = 1;
-               }
+       /* Parse perf-probe event into probe_point */
+       parse_perf_probe_event(str, pp, &session.need_dwarf);
 
        pr_debug("%d arguments\n", pp->nr_args);
 }
 
+static void parse_probe_event_argv(int argc, const char **argv)
+{
+       int i, len;
+       char *buf;
+
+       /* Bind up rest arguments */
+       len = 0;
+       for (i = 0; i < argc; i++)
+               len += strlen(argv[i]) + 1;
+       buf = zalloc(len + 1);
+       if (!buf)
+               die("Failed to allocate memory for binding arguments.");
+       len = 0;
+       for (i = 0; i < argc; i++)
+               len += sprintf(&buf[len], "%s ", argv[i]);
+       parse_probe_event(buf);
+       free(buf);
+}
+
 static int opt_add_probe_event(const struct option *opt __used,
                              const char *str, int unset __used)
 {
@@ -221,215 +105,256 @@ static int opt_add_probe_event(const struct option *opt __used,
        return 0;
 }
 
-#ifndef NO_LIBDWARF
-static int open_default_vmlinux(void)
+static int opt_del_probe_event(const struct option *opt __used,
+                              const char *str, int unset __used)
 {
-       struct utsname uts;
-       char fname[MAX_PATH_LEN];
-       int fd, ret, i;
-
-       ret = uname(&uts);
-       if (ret) {
-               pr_debug("uname() failed.\n");
-               return -errno;
+       if (str) {
+               if (!session.dellist)
+                       session.dellist = strlist__new(true, NULL);
+               strlist__add(session.dellist, str);
        }
-       session.release = uts.release;
-       for (i = 0; i < NR_SEARCH_PATH; i++) {
-               ret = snprintf(fname, MAX_PATH_LEN,
-                              default_search_path[i], session.release);
-               if (ret >= MAX_PATH_LEN || ret < 0) {
-                       pr_debug("Filename(%d,%s) is too long.\n", i,
-                               uts.release);
-                       errno = E2BIG;
-                       return -E2BIG;
-               }
-               pr_debug("try to open %s\n", fname);
-               fd = open(fname, O_RDONLY);
-               if (fd >= 0)
-                       break;
+       return 0;
+}
+
+/* Currently just checking function name from symbol map */
+static void evaluate_probe_point(struct probe_point *pp)
+{
+       struct symbol *sym;
+       sym = map__find_symbol_by_name(session.kmaps[MAP__FUNCTION],
+                                      pp->function, NULL);
+       if (!sym)
+               die("Kernel symbol \'%s\' not found - probe not added.",
+                   pp->function);
+}
+
+#ifndef NO_DWARF_SUPPORT
+static int open_vmlinux(void)
+{
+       if (map__load(session.kmaps[MAP__FUNCTION], NULL) < 0) {
+               pr_debug("Failed to load kernel map.\n");
+               return -EINVAL;
        }
-       return fd;
+       pr_debug("Try to open %s\n",
+                session.kmaps[MAP__FUNCTION]->dso->long_name);
+       return open(session.kmaps[MAP__FUNCTION]->dso->long_name, O_RDONLY);
+}
+
+static int opt_show_lines(const struct option *opt __used,
+                         const char *str, int unset __used)
+{
+       if (str)
+               parse_line_range_desc(str, &session.line_range);
+       INIT_LIST_HEAD(&session.line_range.line_list);
+       session.show_lines = true;
+       return 0;
 }
 #endif
 
 static const char * const probe_usage[] = {
        "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
        "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
+       "perf probe [<options>] --del '[GROUP:]EVENT' ...",
+       "perf probe --list",
+#ifndef NO_DWARF_SUPPORT
+       "perf probe --line 'LINEDESC'",
+#endif
        NULL
 };
 
 static const struct option options[] = {
        OPT_BOOLEAN('v', "verbose", &verbose,
                    "be more verbose (show parsed arguments, etc)"),
-#ifndef NO_LIBDWARF
-       OPT_STRING('k', "vmlinux", &session.vmlinux, "file",
-               "vmlinux/module pathname"),
+#ifndef NO_DWARF_SUPPORT
+       OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
+                  "file", "vmlinux pathname"),
 #endif
+       OPT_BOOLEAN('l', "list", &session.list_events,
+                   "list up current probe events"),
+       OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
+               opt_del_probe_event),
        OPT_CALLBACK('a', "add", NULL,
-#ifdef NO_LIBDWARF
-               "FUNC[+OFFS|%return] [ARG ...]",
+#ifdef NO_DWARF_SUPPORT
+               "[EVENT=]FUNC[+OFF|%return] [ARG ...]",
 #else
-               "FUNC[+OFFS|%return|:RLN][@SRC]|SRC:ALN [ARG ...]",
+               "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
+               " [ARG ...]",
 #endif
                "probe point definition, where\n"
-               "\t\tGRP:\tGroup name (optional)\n"
-               "\t\tNAME:\tEvent name\n"
+               "\t\tGROUP:\tGroup name (optional)\n"
+               "\t\tEVENT:\tEvent name\n"
                "\t\tFUNC:\tFunction name\n"
-               "\t\tOFFS:\tOffset from function entry (in byte)\n"
+               "\t\tOFF:\tOffset from function entry (in byte)\n"
                "\t\t%return:\tPut the probe at function return\n"
-#ifdef NO_LIBDWARF
+#ifdef NO_DWARF_SUPPORT
                "\t\tARG:\tProbe argument (only \n"
 #else
                "\t\tSRC:\tSource code path\n"
-               "\t\tRLN:\tRelative line number from function entry.\n"
-               "\t\tALN:\tAbsolute line number in file.\n"
+               "\t\tRL:\tRelative line number from function entry.\n"
+               "\t\tAL:\tAbsolute line number in file.\n"
+               "\t\tPT:\tLazy expression of line code.\n"
                "\t\tARG:\tProbe argument (local variable name or\n"
 #endif
-               "\t\t\tkprobe-tracer argument format is supported.)\n",
+               "\t\t\tkprobe-tracer argument format.)\n",
                opt_add_probe_event),
+       OPT_BOOLEAN('f', "force", &session.force_add, "forcibly add events"
+                   " with existing name"),
+#ifndef NO_DWARF_SUPPORT
+       OPT_CALLBACK('L', "line", NULL,
+                    "FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]",
+                    "Show source code lines.", opt_show_lines),
+#endif
        OPT_END()
 };
 
-static int write_new_event(int fd, const char *buf)
+/* Initialize symbol maps for vmlinux */
+static void init_vmlinux(void)
 {
-       int ret;
-
-       ret = write(fd, buf, strlen(buf));
-       if (ret <= 0)
-               die("Failed to create event.");
+       symbol_conf.sort_by_name = true;
+       if (symbol_conf.vmlinux_name == NULL)
+               symbol_conf.try_vmlinux_path = true;
        else
-               printf("Added new event: %s\n", buf);
-
-       return ret;
-}
-
-#define MAX_CMDLEN 256
-
-static int synthesize_probe_event(struct probe_point *pp)
-{
-       char *buf;
-       int i, len, ret;
-       pp->probes[0] = buf = zalloc(MAX_CMDLEN);
-       if (!buf)
-               die("Failed to allocate memory by zalloc.");
-       ret = snprintf(buf, MAX_CMDLEN, "%s+%d", pp->function, pp->offset);
-       if (ret <= 0 || ret >= MAX_CMDLEN)
-               goto error;
-       len = ret;
-
-       for (i = 0; i < pp->nr_args; i++) {
-               ret = snprintf(&buf[len], MAX_CMDLEN - len, " %s",
-                              pp->args[i]);
-               if (ret <= 0 || ret >= MAX_CMDLEN - len)
-                       goto error;
-               len += ret;
-       }
-       pp->found = 1;
-       return pp->found;
-error:
-       free(pp->probes[0]);
-       if (ret > 0)
-               ret = -E2BIG;
-       return ret;
+               pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
+       if (symbol__init() < 0)
+               die("Failed to init symbol map.");
+
+       map_groups__init(&session.kmap_groups);
+       if (map_groups__create_kernel_maps(&session.kmap_groups,
+                                          session.kmaps) < 0)
+               die("Failed to create kernel maps.");
 }
 
 int cmd_probe(int argc, const char **argv, const char *prefix __used)
 {
-       int i, j, fd, ret;
+       int i, ret;
+#ifndef NO_DWARF_SUPPORT
+       int fd;
+#endif
        struct probe_point *pp;
-       char buf[MAX_CMDLEN];
 
        argc = parse_options(argc, argv, options, probe_usage,
                             PARSE_OPT_STOP_AT_NON_OPTION);
-       for (i = 0; i < argc; i++)
-               parse_probe_event(argv[i]);
+       if (argc > 0) {
+               if (strcmp(argv[0], "-") == 0) {
+                       pr_warning("  Error: '-' is not supported.\n");
+                       usage_with_options(probe_usage, options);
+               }
+               parse_probe_event_argv(argc, argv);
+       }
 
-       if (session.nr_probe == 0)
+       if ((!session.nr_probe && !session.dellist && !session.list_events &&
+            !session.show_lines))
                usage_with_options(probe_usage, options);
 
+       if (debugfs_valid_mountpoint(debugfs_path) < 0)
+               die("Failed to find debugfs path.");
+
+       if (session.list_events) {
+               if (session.nr_probe != 0 || session.dellist) {
+                       pr_warning("  Error: Don't use --list with"
+                                  " --add/--del.\n");
+                       usage_with_options(probe_usage, options);
+               }
+               if (session.show_lines) {
+                       pr_warning("  Error: Don't use --list with --line.\n");
+                       usage_with_options(probe_usage, options);
+               }
+               show_perf_probe_events();
+               return 0;
+       }
+
+#ifndef NO_DWARF_SUPPORT
+       if (session.show_lines) {
+               if (session.nr_probe != 0 || session.dellist) {
+                       pr_warning("  Error: Don't use --line with"
+                                  " --add/--del.\n");
+                       usage_with_options(probe_usage, options);
+               }
+               init_vmlinux();
+               fd = open_vmlinux();
+               if (fd < 0)
+                       die("Could not open debuginfo file.");
+               ret = find_line_range(fd, &session.line_range);
+               if (ret <= 0)
+                       die("Source line is not found.\n");
+               close(fd);
+               show_line_range(&session.line_range);
+               return 0;
+       }
+#endif
+
+       if (session.dellist) {
+               del_trace_kprobe_events(session.dellist);
+               strlist__delete(session.dellist);
+               if (session.nr_probe == 0)
+                       return 0;
+       }
+
+       /* Add probes */
+       init_vmlinux();
+
        if (session.need_dwarf)
-#ifdef NO_LIBDWARF
-               semantic_error("Debuginfo-analysis is not supported");
-#else  /* !NO_LIBDWARF */
-               pr_info("Some probes require debuginfo.\n");
+#ifdef NO_DWARF_SUPPORT
+               die("Debuginfo-analysis is not supported");
+#else  /* !NO_DWARF_SUPPORT */
+               pr_debug("Some probes require debuginfo.\n");
 
-       if (session.vmlinux)
-               fd = open(session.vmlinux, O_RDONLY);
-       else
-               fd = open_default_vmlinux();
+       fd = open_vmlinux();
        if (fd < 0) {
                if (session.need_dwarf)
-                       die("Could not open vmlinux/module file.");
+                       die("Could not open debuginfo file.");
 
-               pr_warning("Could not open vmlinux/module file."
-                          " Try to use symbols.\n");
+               pr_debug("Could not open vmlinux/module file."
+                        " Try to use symbols.\n");
                goto end_dwarf;
        }
 
        /* Searching probe points */
-       for (j = 0; j < session.nr_probe; j++) {
-               pp = &session.probes[j];
+       for (i = 0; i < session.nr_probe; i++) {
+               pp = &session.probes[i];
                if (pp->found)
                        continue;
 
                lseek(fd, SEEK_SET, 0);
-               ret = find_probepoint(fd, pp);
-               if (ret < 0) {
-                       if (session.need_dwarf)
-                               die("Could not analyze debuginfo.");
-
-                       pr_warning("An error occurred in debuginfo analysis. Try to use symbols.\n");
-                       break;
+               ret = find_probe_point(fd, pp);
+               if (ret > 0)
+                       continue;
+               if (ret == 0) { /* No error but failed to find probe point. */
+                       synthesize_perf_probe_point(pp);
+                       die("Probe point '%s' not found. - probe not added.",
+                           pp->probes[0]);
+               }
+               /* Error path */
+               if (session.need_dwarf) {
+                       if (ret == -ENOENT)
+                               pr_warning("No dwarf info found in the vmlinux - please rebuild with CONFIG_DEBUG_INFO=y.\n");
+                       die("Could not analyze debuginfo.");
                }
-               if (ret == 0)   /* No error but failed to find probe point. */
-                       die("No probe point found.");
+               pr_debug("An error occurred in debuginfo analysis."
+                        " Try to use symbols.\n");
+               break;
        }
        close(fd);
 
 end_dwarf:
-#endif /* !NO_LIBDWARF */
+#endif /* !NO_DWARF_SUPPORT */
 
        /* Synthesize probes without dwarf */
-       for (j = 0; j < session.nr_probe; j++) {
-               pp = &session.probes[j];
+       for (i = 0; i < session.nr_probe; i++) {
+               pp = &session.probes[i];
                if (pp->found)  /* This probe is already found. */
                        continue;
 
-               ret = synthesize_probe_event(pp);
+               evaluate_probe_point(pp);
+               ret = synthesize_trace_kprobe_event(pp);
                if (ret == -E2BIG)
-                       semantic_error("probe point is too long.");
+                       die("probe point definition becomes too long.");
                else if (ret < 0)
                        die("Failed to synthesize a probe point.");
        }
 
        /* Settng up probe points */
-       snprintf(buf, MAX_CMDLEN, "%s/../kprobe_events", debugfs_path);
-       fd = open(buf, O_WRONLY, O_APPEND);
-       if (fd < 0) {
-               if (errno == ENOENT)
-                       die("kprobe_events file does not exist - please rebuild with CONFIG_KPROBE_TRACER.");
-               else
-                       die("Could not open kprobe_events file: %s",
-                           strerror(errno));
-       }
-       for (j = 0; j < session.nr_probe; j++) {
-               pp = &session.probes[j];
-               if (pp->found == 1) {
-                       snprintf(buf, MAX_CMDLEN, "%c:%s/%s_%x %s\n",
-                               pp->retprobe ? 'r' : 'p', PERFPROBE_GROUP,
-                               pp->function, pp->offset, pp->probes[0]);
-                       write_new_event(fd, buf);
-               } else
-                       for (i = 0; i < pp->found; i++) {
-                               snprintf(buf, MAX_CMDLEN, "%c:%s/%s_%x_%d %s\n",
-                                       pp->retprobe ? 'r' : 'p',
-                                       PERFPROBE_GROUP,
-                                       pp->function, pp->offset, i,
-                                       pp->probes[0]);
-                               write_new_event(fd, buf);
-                       }
-       }
-       close(fd);
+       add_trace_kprobe_events(session.probes, session.nr_probe,
+                               session.force_add);
        return 0;
 }