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 #include <sys/utsname.h>
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <fcntl.h>
  27 #include <errno.h>
  28 #include <stdio.h>
  29 #include <unistd.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32
  33 #include "perf.h"
  34 #include "builtin.h"
  35 #include "util/util.h"
  36 #include "util/strlist.h"
  37 #include "util/strfilter.h"
  38 #include "util/symbol.h"
  39 #include "util/debug.h"
  40 #include "util/parse-options.h"
  41 #include "util/probe-finder.h"
  42 #include "util/probe-event.h"
  43 #include "util/probe-file.h"
  44
  45 #define DEFAULT_VAR_FILTER "!__k???tab_* & !__crc_*"
  46 #define DEFAULT_FUNC_FILTER "!_*"
  47 #define DEFAULT_LIST_FILTER "*:*"
  48
  49 /* Session management structure */
  50 static struct {
  51         int command;    /* Command short_name */
  52         bool list_events;
  53         bool uprobes;
  54         bool quiet;
  55         bool target_used;
  56         int nevents;
  57         struct perf_probe_event events[MAX_PROBES];
  58         struct line_range line_range;
  59         char *target;
  60         struct strfilter *filter;
  61 } params;
  62
  63 /* Parse an event definition. Note that any error must die. */
  64 static int parse_probe_event(const char *str)
  65 {
  66         struct perf_probe_event *pev = &params.events[params.nevents];
  67         int ret;
  68
  69         pr_debug("probe-definition(%d): %s\n", params.nevents, str);
  70         if (++params.nevents == MAX_PROBES) {
  71                 pr_err("Too many probes (> %d) were specified.", MAX_PROBES);
  72                 return -1;
  73         }
  74
  75         pev->uprobes = params.uprobes;
  76         if (params.target) {
  77                 pev->target = strdup(params.target);
  78                 if (!pev->target)
  79                         return -ENOMEM;
  80                 params.target_used = true;
  81         }
  82
  83         /* Parse a perf-probe command into event */
  84         ret = parse_perf_probe_command(str, pev);
  85         pr_debug("%d arguments\n", pev->nargs);
  86
  87         return ret;
  88 }
  89
  90 static int params_add_filter(const char *str)
  91 {
  92         const char *err = NULL;
  93         int ret = 0;
  94
  95         pr_debug2("Add filter: %s\n", str);
  96         if (!params.filter) {
  97                 params.filter = strfilter__new(str, &err);
  98                 if (!params.filter)
  99                         ret = err ? -EINVAL : -ENOMEM;
 100         } else
 101                 ret = strfilter__or(params.filter, str, &err);
 102
 103         if (ret == -EINVAL) {
 104                 pr_err("Filter parse error at %td.\n", err - str + 1);
 105                 pr_err("Source: \"%s\"\n", str);
 106                 pr_err("         %*c\n", (int)(err - str + 1), '^');
 107         }
 108
 109         return ret;
 110 }
 111
 112 static int set_target(const char *ptr)
 113 {
 114         int found = 0;
 115         const char *buf;
 116
 117         /*
 118          * The first argument after options can be an absolute path
 119          * to an executable / library or kernel module.
 120          *
 121          * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
 122          * short module name.
 123          */
 124         if (!params.target && ptr && *ptr == '/') {
 125                 params.target = strdup(ptr);
 126                 if (!params.target)
 127                         return -ENOMEM;
 128                 params.target_used = false;
 129
 130                 found = 1;
 131                 buf = ptr + (strlen(ptr) - 3);
 132
 133                 if (strcmp(buf, ".ko"))
 134                         params.uprobes = true;
 135
 136         }
 137
 138         return found;
 139 }
 140
 141 static int parse_probe_event_argv(int argc, const char **argv)
 142 {
 143         int i, len, ret, found_target;
 144         char *buf;
 145
 146         found_target = set_target(argv[0]);
 147         if (found_target < 0)
 148                 return found_target;
 149
 150         if (found_target && argc == 1)
 151                 return 0;
 152
 153         /* Bind up rest arguments */
 154         len = 0;
 155         for (i = 0; i < argc; i++) {
 156                 if (i == 0 && found_target)
 157                         continue;
 158
 159                 len += strlen(argv[i]) + 1;
 160         }
 161         buf = zalloc(len + 1);
 162         if (buf == NULL)
 163                 return -ENOMEM;
 164         len = 0;
 165         for (i = 0; i < argc; i++) {
 166                 if (i == 0 && found_target)
 167                         continue;
 168
 169                 len += sprintf(&buf[len], "%s ", argv[i]);
 170         }
 171         ret = parse_probe_event(buf);
 172         free(buf);
 173         return ret;
 174 }
 175
 176 static int opt_set_target(const struct option *opt, const char *str,
 177                         int unset __maybe_unused)
 178 {
 179         int ret = -ENOENT;
 180         char *tmp;
 181
 182         if  (str) {
 183                 if (!strcmp(opt->long_name, "exec"))
 184                         params.uprobes = true;
 185 #ifdef HAVE_DWARF_SUPPORT
 186                 else if (!strcmp(opt->long_name, "module"))
 187                         params.uprobes = false;
 188 #endif
 189                 else
 190                         return ret;
 191
 192                 /* Expand given path to absolute path, except for modulename */
 193                 if (params.uprobes || strchr(str, '/')) {
 194                         tmp = realpath(str, NULL);
 195                         if (!tmp) {
 196                                 pr_warning("Failed to get the absolute path of %s: %m\n", str);
 197                                 return ret;
 198                         }
 199                 } else {
 200                         tmp = strdup(str);
 201                         if (!tmp)
 202                                 return -ENOMEM;
 203                 }
 204                 free(params.target);
 205                 params.target = tmp;
 206                 params.target_used = false;
 207                 ret = 0;
 208         }
 209
 210         return ret;
 211 }
 212
 213 /* Command option callbacks */
 214
 215 #ifdef HAVE_DWARF_SUPPORT
 216 static int opt_show_lines(const struct option *opt,
 217                           const char *str, int unset __maybe_unused)
 218 {
 219         int ret = 0;
 220
 221         if (!str)
 222                 return 0;
 223
 224         if (params.command == 'L') {
 225                 pr_warning("Warning: more than one --line options are"
 226                            " detected. Only the first one is valid.\n");
 227                 return 0;
 228         }
 229
 230         params.command = opt->short_name;
 231         ret = parse_line_range_desc(str, &params.line_range);
 232
 233         return ret;
 234 }
 235
 236 static int opt_show_vars(const struct option *opt,
 237                          const char *str, int unset __maybe_unused)
 238 {
 239         struct perf_probe_event *pev = &params.events[params.nevents];
 240         int ret;
 241
 242         if (!str)
 243                 return 0;
 244
 245         ret = parse_probe_event(str);
 246         if (!ret && pev->nargs != 0) {
 247                 pr_err("  Error: '--vars' doesn't accept arguments.\n");
 248                 return -EINVAL;
 249         }
 250         params.command = opt->short_name;
 251
 252         return ret;
 253 }
 254 #endif
 255 static int opt_add_probe_event(const struct option *opt,
 256                               const char *str, int unset __maybe_unused)
 257 {
 258         if (str) {
 259                 params.command = opt->short_name;
 260                 return parse_probe_event(str);
 261         }
 262
 263         return 0;
 264 }
 265
 266 static int opt_set_filter_with_command(const struct option *opt,
 267                                        const char *str, int unset)
 268 {
 269         if (!unset)
 270                 params.command = opt->short_name;
 271
 272         if (str)
 273                 return params_add_filter(str);
 274
 275         return 0;
 276 }
 277
 278 static int opt_set_filter(const struct option *opt __maybe_unused,
 279                           const char *str, int unset __maybe_unused)
 280 {
 281         if (str)
 282                 return params_add_filter(str);
 283
 284         return 0;
 285 }
 286
 287 static int init_params(void)
 288 {
 289         return line_range__init(&params.line_range);
 290 }
 291
 292 static void cleanup_params(void)
 293 {
 294         int i;
 295
 296         for (i = 0; i < params.nevents; i++)
 297                 clear_perf_probe_event(params.events + i);
 298         line_range__clear(&params.line_range);
 299         free(params.target);
 300         strfilter__delete(params.filter);
 301         memset(&params, 0, sizeof(params));
 302 }
 303
 304 static void pr_err_with_code(const char *msg, int err)
 305 {
 306         char sbuf[STRERR_BUFSIZE];
 307
 308         pr_err("%s", msg);
 309         pr_debug(" Reason: %s (Code: %d)",
 310                  strerror_r(-err, sbuf, sizeof(sbuf)), err);
 311         pr_err("\n");
 312 }
 313
 314 static int perf_add_probe_events(struct perf_probe_event *pevs, int npevs)
 315 {
 316         int ret;
 317         int i, k;
 318         const char *event = NULL, *group = NULL;
 319
 320         ret = convert_perf_probe_events(pevs, npevs);
 321         if (ret < 0)
 322                 goto out_cleanup;
 323
 324         ret = apply_perf_probe_events(pevs, npevs);
 325         if (ret < 0)
 326                 goto out_cleanup;
 327
 328         for (i = k = 0; i < npevs; i++)
 329                 k += pevs[i].ntevs;
 330
 331         pr_info("Added new event%s\n", (k > 1) ? "s:" : ":");
 332         for (i = 0; i < npevs; i++) {
 333                 struct perf_probe_event *pev = &pevs[i];
 334
 335                 for (k = 0; k < pev->ntevs; k++) {
 336                         struct probe_trace_event *tev = &pev->tevs[k];
 337
 338                         /* We use tev's name for showing new events */
 339                         show_perf_probe_event(tev->group, tev->event, pev,
 340                                               tev->point.module, false);
 341
 342                         /* Save the last valid name */
 343                         event = tev->event;
 344                         group = tev->group;
 345                 }
 346         }
 347
 348         /* Note that it is possible to skip all events because of blacklist */
 349         if (event) {
 350                 /* Show how to use the event. */
 351                 pr_info("\nYou can now use it in all perf tools, such as:\n\n");
 352                 pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", group, event);
 353         }
 354
 355 out_cleanup:
 356         cleanup_perf_probe_events(pevs, npevs);
 357         return ret;
 358 }
 359
 360 static int perf_del_probe_events(struct strfilter *filter)
 361 {
 362         int ret, ret2, ufd = -1, kfd = -1;
 363         char *str = strfilter__string(filter);
 364         struct strlist *klist = NULL, *ulist = NULL;
 365         struct str_node *ent;
 366
 367         if (!str)
 368                 return -EINVAL;
 369
 370         pr_debug("Delete filter: \'%s\'\n", str);
 371
 372         /* Get current event names */
 373         ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
 374         if (ret < 0)
 375                 goto out;
 376
 377         klist = strlist__new(NULL, NULL);
 378         if (!klist)
 379                 return -ENOMEM;
 380
 381         ret = probe_file__get_events(kfd, filter, klist);
 382         if (ret == 0) {
 383                 strlist__for_each(ent, klist)
 384                         pr_info("Removed event: %s\n", ent->s);
 385
 386                 ret = probe_file__del_strlist(kfd, klist);
 387                 if (ret < 0)
 388                         goto error;
 389         }
 390
 391         ret2 = probe_file__get_events(ufd, filter, ulist);
 392         if (ret2 == 0) {
 393                 strlist__for_each(ent, ulist)
 394                         pr_info("Removed event: %s\n", ent->s);
 395
 396                 ret2 = probe_file__del_strlist(ufd, ulist);
 397                 if (ret2 < 0)
 398                         goto error;
 399         }
 400
 401         if (ret == -ENOENT && ret2 == -ENOENT)
 402                 pr_debug("\"%s\" does not hit any event.\n", str);
 403                 /* Note that this is silently ignored */
 404         ret = 0;
 405
 406 error:
 407         if (kfd >= 0)
 408                 close(kfd);
 409         if (ufd >= 0)
 410                 close(ufd);
 411 out:
 412         strlist__delete(klist);
 413         strlist__delete(ulist);
 414         free(str);
 415
 416         return ret;
 417 }
 418
 419 static int
 420 __cmd_probe(int argc, const char **argv, const char *prefix __maybe_unused)
 421 {
 422         const char * const probe_usage[] = {
 423                 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
 424                 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
 425                 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
 426                 "perf probe --list [GROUP:]EVENT ...",
 427 #ifdef HAVE_DWARF_SUPPORT
 428                 "perf probe [<options>] --line 'LINEDESC'",
 429                 "perf probe [<options>] --vars 'PROBEPOINT'",
 430 #endif
 431                 "perf probe [<options>] --funcs",
 432                 NULL
 433         };
 434         struct option options[] = {
 435         OPT_INCR('v', "verbose", &verbose,
 436                     "be more verbose (show parsed arguments, etc)"),
 437         OPT_BOOLEAN('q', "quiet", &params.quiet,
 438                     "be quiet (do not show any mesages)"),
 439         OPT_CALLBACK_DEFAULT('l', "list", NULL, "[GROUP:]EVENT",
 440                              "list up probe events",
 441                              opt_set_filter_with_command, DEFAULT_LIST_FILTER),
 442         OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
 443                      opt_set_filter_with_command),
 444         OPT_CALLBACK('a', "add", NULL,
 445 #ifdef HAVE_DWARF_SUPPORT
 446                 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
 447                 " [[NAME=]ARG ...]",
 448 #else
 449                 "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]",
 450 #endif
 451                 "probe point definition, where\n"
 452                 "\t\tGROUP:\tGroup name (optional)\n"
 453                 "\t\tEVENT:\tEvent name\n"
 454                 "\t\tFUNC:\tFunction name\n"
 455                 "\t\tOFF:\tOffset from function entry (in byte)\n"
 456                 "\t\t%return:\tPut the probe at function return\n"
 457 #ifdef HAVE_DWARF_SUPPORT
 458                 "\t\tSRC:\tSource code path\n"
 459                 "\t\tRL:\tRelative line number from function entry.\n"
 460                 "\t\tAL:\tAbsolute line number in file.\n"
 461                 "\t\tPT:\tLazy expression of line code.\n"
 462                 "\t\tARG:\tProbe argument (local variable name or\n"
 463                 "\t\t\tkprobe-tracer argument format.)\n",
 464 #else
 465                 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
 466 #endif
 467                 opt_add_probe_event),
 468         OPT_BOOLEAN('f', "force", &probe_conf.force_add, "forcibly add events"
 469                     " with existing name"),
 470 #ifdef HAVE_DWARF_SUPPORT
 471         OPT_CALLBACK('L', "line", NULL,
 472                      "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
 473                      "Show source code lines.", opt_show_lines),
 474         OPT_CALLBACK('V', "vars", NULL,
 475                      "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
 476                      "Show accessible variables on PROBEDEF", opt_show_vars),
 477         OPT_BOOLEAN('\0', "externs", &probe_conf.show_ext_vars,
 478                     "Show external variables too (with --vars only)"),
 479         OPT_BOOLEAN('\0', "range", &probe_conf.show_location_range,
 480                 "Show variables location range in scope (with --vars only)"),
 481         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 482                    "file", "vmlinux pathname"),
 483         OPT_STRING('s', "source", &symbol_conf.source_prefix,
 484                    "directory", "path to kernel source"),
 485         OPT_CALLBACK('m', "module", NULL, "modname|path",
 486                 "target module name (for online) or path (for offline)",
 487                 opt_set_target),
 488         OPT_BOOLEAN('\0', "no-inlines", &probe_conf.no_inlines,
 489                 "Don't search inlined functions"),
 490 #endif
 491         OPT__DRY_RUN(&probe_event_dry_run),
 492         OPT_INTEGER('\0', "max-probes", &probe_conf.max_probes,
 493                  "Set how many probe points can be found for a probe."),
 494         OPT_CALLBACK_DEFAULT('F', "funcs", NULL, "[FILTER]",
 495                              "Show potential probe-able functions.",
 496                              opt_set_filter_with_command, DEFAULT_FUNC_FILTER),
 497         OPT_CALLBACK('\0', "filter", NULL,
 498                      "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
 499                      "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
 500                      "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
 501                      opt_set_filter),
 502         OPT_CALLBACK('x', "exec", NULL, "executable|path",
 503                         "target executable name or path", opt_set_target),
 504         OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
 505                     "Enable symbol demangling"),
 506         OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
 507                     "Enable kernel symbol demangling"),
 508         OPT_END()
 509         };
 510         int ret;
 511
 512         set_option_flag(options, 'a', "add", PARSE_OPT_EXCLUSIVE);
 513         set_option_flag(options, 'd', "del", PARSE_OPT_EXCLUSIVE);
 514         set_option_flag(options, 'l', "list", PARSE_OPT_EXCLUSIVE);
 515 #ifdef HAVE_DWARF_SUPPORT
 516         set_option_flag(options, 'L', "line", PARSE_OPT_EXCLUSIVE);
 517         set_option_flag(options, 'V', "vars", PARSE_OPT_EXCLUSIVE);
 518 #endif
 519         set_option_flag(options, 'F', "funcs", PARSE_OPT_EXCLUSIVE);
 520
 521         argc = parse_options(argc, argv, options, probe_usage,
 522                              PARSE_OPT_STOP_AT_NON_OPTION);
 523         if (argc > 0) {
 524                 if (strcmp(argv[0], "-") == 0) {
 525                         pr_warning("  Error: '-' is not supported.\n");
 526                         usage_with_options(probe_usage, options);
 527                 }
 528                 if (params.command && params.command != 'a') {
 529                         pr_warning("  Error: another command except --add is set.\n");
 530                         usage_with_options(probe_usage, options);
 531                 }
 532                 ret = parse_probe_event_argv(argc, argv);
 533                 if (ret < 0) {
 534                         pr_err_with_code("  Error: Command Parse Error.", ret);
 535                         return ret;
 536                 }
 537                 params.command = 'a';
 538         }
 539
 540         if (params.quiet) {
 541                 if (verbose != 0) {
 542                         pr_err("  Error: -v and -q are exclusive.\n");
 543                         return -EINVAL;
 544                 }
 545                 verbose = -1;
 546         }
 547
 548         if (probe_conf.max_probes == 0)
 549                 probe_conf.max_probes = MAX_PROBES;
 550
 551         /*
 552          * Only consider the user's kernel image path if given.
 553          */
 554         symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
 555
 556         switch (params.command) {
 557         case 'l':
 558                 if (params.uprobes) {
 559                         pr_warning("  Error: Don't use --list with --exec.\n");
 560                         usage_with_options(probe_usage, options);
 561                 }
 562                 ret = show_perf_probe_events(params.filter);
 563                 if (ret < 0)
 564                         pr_err_with_code("  Error: Failed to show event list.", ret);
 565                 return ret;
 566         case 'F':
 567                 ret = show_available_funcs(params.target, params.filter,
 568                                         params.uprobes);
 569                 if (ret < 0)
 570                         pr_err_with_code("  Error: Failed to show functions.", ret);
 571                 return ret;
 572 #ifdef HAVE_DWARF_SUPPORT
 573         case 'L':
 574                 ret = show_line_range(&params.line_range, params.target,
 575                                       params.uprobes);
 576                 if (ret < 0)
 577                         pr_err_with_code("  Error: Failed to show lines.", ret);
 578                 return ret;
 579         case 'V':
 580                 if (!params.filter)
 581                         params.filter = strfilter__new(DEFAULT_VAR_FILTER,
 582                                                        NULL);
 583
 584                 ret = show_available_vars(params.events, params.nevents,
 585                                           params.filter);
 586                 if (ret < 0)
 587                         pr_err_with_code("  Error: Failed to show vars.", ret);
 588                 return ret;
 589 #endif
 590         case 'd':
 591                 ret = perf_del_probe_events(params.filter);
 592                 if (ret < 0) {
 593                         pr_err_with_code("  Error: Failed to delete events.", ret);
 594                         return ret;
 595                 }
 596                 break;
 597         case 'a':
 598                 /* Ensure the last given target is used */
 599                 if (params.target && !params.target_used) {
 600                         pr_warning("  Error: -x/-m must follow the probe definitions.\n");
 601                         usage_with_options(probe_usage, options);
 602                 }
 603
 604                 ret = perf_add_probe_events(params.events, params.nevents);
 605                 if (ret < 0) {
 606                         pr_err_with_code("  Error: Failed to add events.", ret);
 607                         return ret;
 608                 }
 609                 break;
 610         default:
 611                 usage_with_options(probe_usage, options);
 612         }
 613         return 0;
 614 }
 615
 616 int cmd_probe(int argc, const char **argv, const char *prefix)
 617 {
 618         int ret;
 619
 620         ret = init_params();
 621         if (!ret) {
 622                 ret = __cmd_probe(argc, argv, prefix);
 623                 cleanup_params();
 624         }
 625
 626         return ret < 0 ? ret : 0;
 627 }