tools/perf/builtin-probe.c

   1 /*
   2  * builtin-probe.c
   3  *
   4  * Builtin probe command: Set up probe events by C expression
   5  *
   6  * Written by Masami Hiramatsu <mhiramat@redhat.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  21  *
  22  */
  23 #define _GNU_SOURCE
  24 #include <sys/utsname.h>
  25 #include <sys/types.h>
  26 #include <sys/stat.h>
  27 #include <fcntl.h>
  28 #include <errno.h>
  29 #include <stdio.h>
  30 #include <unistd.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33
  34 #undef _GNU_SOURCE
  35 #include "perf.h"
  36 #include "builtin.h"
  37 #include "util/util.h"
  38 #include "util/strlist.h"
  39 #include "util/event.h"
  40 #include "util/debug.h"
  41 #include "util/debugfs.h"
  42 #include "util/symbol.h"
  43 #include "util/thread.h"
  44 #include "util/session.h"
  45 #include "util/parse-options.h"
  46 #include "util/parse-events.h"  /* For debugfs_path */
  47 #include "util/probe-finder.h"
  48 #include "util/probe-event.h"
  49
  50 #define MAX_PATH_LEN 256
  51 #define MAX_PROBES 128
  52
  53 /* Session management structure */
  54 static struct {
  55         bool need_dwarf;
  56         bool list_events;
  57         bool force_add;
  58         bool show_lines;
  59         int nr_probe;
  60         struct probe_point probes[MAX_PROBES];
  61         struct strlist *dellist;
  62         struct perf_session *psession;
  63         struct map *kmap;
  64         struct line_range line_range;
  65 } session;
  66
  67
  68 /* Parse an event definition. Note that any error must die. */
  69 static void parse_probe_event(const char *str)
  70 {
  71         struct probe_point *pp = &session.probes[session.nr_probe];
  72
  73         pr_debug("probe-definition(%d): %s\n", session.nr_probe, str);
  74         if (++session.nr_probe == MAX_PROBES)
  75                 die("Too many probes (> %d) are specified.", MAX_PROBES);
  76
  77         /* Parse perf-probe event into probe_point */
  78         parse_perf_probe_event(str, pp, &session.need_dwarf);
  79
  80         pr_debug("%d arguments\n", pp->nr_args);
  81 }
  82
  83 static void parse_probe_event_argv(int argc, const char **argv)
  84 {
  85         int i, len;
  86         char *buf;
  87
  88         /* Bind up rest arguments */
  89         len = 0;
  90         for (i = 0; i < argc; i++)
  91                 len += strlen(argv[i]) + 1;
  92         buf = zalloc(len + 1);
  93         if (!buf)
  94                 die("Failed to allocate memory for binding arguments.");
  95         len = 0;
  96         for (i = 0; i < argc; i++)
  97                 len += sprintf(&buf[len], "%s ", argv[i]);
  98         parse_probe_event(buf);
  99         free(buf);
 100 }
 101
 102 static int opt_add_probe_event(const struct option *opt __used,
 103                               const char *str, int unset __used)
 104 {
 105         if (str)
 106                 parse_probe_event(str);
 107         return 0;
 108 }
 109
 110 static int opt_del_probe_event(const struct option *opt __used,
 111                                const char *str, int unset __used)
 112 {
 113         if (str) {
 114                 if (!session.dellist)
 115                         session.dellist = strlist__new(true, NULL);
 116                 strlist__add(session.dellist, str);
 117         }
 118         return 0;
 119 }
 120
 121 /* Currently just checking function name from symbol map */
 122 static void evaluate_probe_point(struct probe_point *pp)
 123 {
 124         struct symbol *sym;
 125         sym = map__find_symbol_by_name(session.kmap, pp->function,
 126                                        session.psession, NULL);
 127         if (!sym)
 128                 die("Kernel symbol \'%s\' not found - probe not added.",
 129                     pp->function);
 130 }
 131
 132 #ifndef NO_LIBDWARF
 133 static int open_vmlinux(void)
 134 {
 135         if (map__load(session.kmap, session.psession, NULL) < 0) {
 136                 pr_debug("Failed to load kernel map.\n");
 137                 return -EINVAL;
 138         }
 139         pr_debug("Try to open %s\n", session.kmap->dso->long_name);
 140         return open(session.kmap->dso->long_name, O_RDONLY);
 141 }
 142
 143 static int opt_show_lines(const struct option *opt __used,
 144                           const char *str, int unset __used)
 145 {
 146         if (str)
 147                 parse_line_range_desc(str, &session.line_range);
 148         INIT_LIST_HEAD(&session.line_range.line_list);
 149         session.show_lines = true;
 150         return 0;
 151 }
 152 #endif
 153
 154 static const char * const probe_usage[] = {
 155         "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
 156         "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
 157         "perf probe [<options>] --del '[GROUP:]EVENT' ...",
 158         "perf probe --list",
 159         "perf probe --line 'LINEDESC'",
 160         NULL
 161 };
 162
 163 static const struct option options[] = {
 164         OPT_BOOLEAN('v', "verbose", &verbose,
 165                     "be more verbose (show parsed arguments, etc)"),
 166 #ifndef NO_LIBDWARF
 167         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 168                    "file", "vmlinux pathname"),
 169 #endif
 170         OPT_BOOLEAN('l', "list", &session.list_events,
 171                     "list up current probe events"),
 172         OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
 173                 opt_del_probe_event),
 174         OPT_CALLBACK('a', "add", NULL,
 175 #ifdef NO_LIBDWARF
 176                 "[EVENT=]FUNC[+OFFS|%return] [ARG ...]",
 177 #else
 178                 "[EVENT=]FUNC[+OFFS|%return|:RLN][@SRC]|SRC:ALN [ARG ...]",
 179 #endif
 180                 "probe point definition, where\n"
 181                 "\t\tGROUP:\tGroup name (optional)\n"
 182                 "\t\tEVENT:\tEvent name\n"
 183                 "\t\tFUNC:\tFunction name\n"
 184                 "\t\tOFFS:\tOffset from function entry (in byte)\n"
 185                 "\t\t%return:\tPut the probe at function return\n"
 186 #ifdef NO_LIBDWARF
 187                 "\t\tARG:\tProbe argument (only \n"
 188 #else
 189                 "\t\tSRC:\tSource code path\n"
 190                 "\t\tRLN:\tRelative line number from function entry.\n"
 191                 "\t\tALN:\tAbsolute line number in file.\n"
 192                 "\t\tARG:\tProbe argument (local variable name or\n"
 193 #endif
 194                 "\t\t\tkprobe-tracer argument format.)\n",
 195                 opt_add_probe_event),
 196         OPT_BOOLEAN('f', "force", &session.force_add, "forcibly add events"
 197                     " with existing name"),
 198 #ifndef NO_LIBDWARF
 199         OPT_CALLBACK('L', "line", NULL,
 200                      "FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]",
 201                      "Show source code lines.", opt_show_lines),
 202 #endif
 203         OPT_END()
 204 };
 205
 206 /* Initialize symbol maps for vmlinux */
 207 static void init_vmlinux(void)
 208 {
 209         symbol_conf.sort_by_name = true;
 210         if (symbol_conf.vmlinux_name == NULL)
 211                 symbol_conf.try_vmlinux_path = true;
 212         else
 213                 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
 214         if (symbol__init() < 0)
 215                 die("Failed to init symbol map.");
 216         session.psession = perf_session__new(NULL, O_WRONLY, false);
 217         if (session.psession == NULL)
 218                 die("Failed to init perf_session.");
 219         session.kmap = session.psession->vmlinux_maps[MAP__FUNCTION];
 220         if (!session.kmap)
 221                 die("Could not find kernel map.\n");
 222 }
 223
 224 int cmd_probe(int argc, const char **argv, const char *prefix __used)
 225 {
 226         int i, ret;
 227 #ifndef NO_LIBDWARF
 228         int fd;
 229 #endif
 230         struct probe_point *pp;
 231
 232         argc = parse_options(argc, argv, options, probe_usage,
 233                              PARSE_OPT_STOP_AT_NON_OPTION);
 234         if (argc > 0) {
 235                 if (strcmp(argv[0], "-") == 0) {
 236                         pr_warning("  Error: '-' is not supported.\n");
 237                         usage_with_options(probe_usage, options);
 238                 }
 239                 parse_probe_event_argv(argc, argv);
 240         }
 241
 242         if ((!session.nr_probe && !session.dellist && !session.list_events &&
 243              !session.show_lines))
 244                 usage_with_options(probe_usage, options);
 245
 246         if (debugfs_valid_mountpoint(debugfs_path) < 0)
 247                 die("Failed to find debugfs path.");
 248
 249         if (session.list_events) {
 250                 if (session.nr_probe != 0 || session.dellist) {
 251                         pr_warning("  Error: Don't use --list with"
 252                                    " --add/--del.\n");
 253                         usage_with_options(probe_usage, options);
 254                 }
 255                 if (session.show_lines) {
 256                         pr_warning("  Error: Don't use --list with --line.\n");
 257                         usage_with_options(probe_usage, options);
 258                 }
 259                 show_perf_probe_events();
 260                 return 0;
 261         }
 262
 263 #ifndef NO_LIBDWARF
 264         if (session.show_lines) {
 265                 if (session.nr_probe != 0 || session.dellist) {
 266                         pr_warning("  Error: Don't use --line with"
 267                                    " --add/--del.\n");
 268                         usage_with_options(probe_usage, options);
 269                 }
 270                 init_vmlinux();
 271                 fd = open_vmlinux();
 272                 if (fd < 0)
 273                         die("Could not open debuginfo file.");
 274                 ret = find_line_range(fd, &session.line_range);
 275                 if (ret <= 0)
 276                         die("Source line is not found.\n");
 277                 close(fd);
 278                 show_line_range(&session.line_range);
 279                 return 0;
 280         }
 281 #endif
 282
 283         if (session.dellist) {
 284                 del_trace_kprobe_events(session.dellist);
 285                 strlist__delete(session.dellist);
 286                 if (session.nr_probe == 0)
 287                         return 0;
 288         }
 289
 290         /* Add probes */
 291         init_vmlinux();
 292
 293         if (session.need_dwarf)
 294 #ifdef NO_LIBDWARF
 295                 die("Debuginfo-analysis is not supported");
 296 #else   /* !NO_LIBDWARF */
 297                 pr_debug("Some probes require debuginfo.\n");
 298
 299         fd = open_vmlinux();
 300         if (fd < 0) {
 301                 if (session.need_dwarf)
 302                         die("Could not open debuginfo file.");
 303
 304                 pr_debug("Could not open vmlinux/module file."
 305                          " Try to use symbols.\n");
 306                 goto end_dwarf;
 307         }
 308
 309         /* Searching probe points */
 310         for (i = 0; i < session.nr_probe; i++) {
 311                 pp = &session.probes[i];
 312                 if (pp->found)
 313                         continue;
 314
 315                 lseek(fd, SEEK_SET, 0);
 316                 ret = find_probepoint(fd, pp);
 317                 if (ret > 0)
 318                         continue;
 319                 if (ret == 0) { /* No error but failed to find probe point. */
 320                         synthesize_perf_probe_point(pp);
 321                         die("Probe point '%s' not found. - probe not added.",
 322                             pp->probes[0]);
 323                 }
 324                 /* Error path */
 325                 if (session.need_dwarf) {
 326                         if (ret == -ENOENT)
 327                                 pr_warning("No dwarf info found in the vmlinux - please rebuild with CONFIG_DEBUG_INFO=y.\n");
 328                         die("Could not analyze debuginfo.");
 329                 }
 330                 pr_debug("An error occurred in debuginfo analysis."
 331                          " Try to use symbols.\n");
 332                 break;
 333         }
 334         close(fd);
 335
 336 end_dwarf:
 337 #endif /* !NO_LIBDWARF */
 338
 339         /* Synthesize probes without dwarf */
 340         for (i = 0; i < session.nr_probe; i++) {
 341                 pp = &session.probes[i];
 342                 if (pp->found)  /* This probe is already found. */
 343                         continue;
 344
 345                 evaluate_probe_point(pp);
 346                 ret = synthesize_trace_kprobe_event(pp);
 347                 if (ret == -E2BIG)
 348                         die("probe point definition becomes too long.");
 349                 else if (ret < 0)
 350                         die("Failed to synthesize a probe point.");
 351         }
 352
 353         /* Settng up probe points */
 354         add_trace_kprobe_events(session.probes, session.nr_probe,
 355                                 session.force_add);
 356         return 0;
 357 }
 358