4 * Builtin probe command: Set up probe events by C expression
6 * Written by Masami Hiramatsu <mhiramat@redhat.com>
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.
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.
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.
23 #include <sys/utsname.h>
24 #include <sys/types.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 <subcmd/parse-options.h>
41 #include "util/probe-finder.h"
42 #include "util/probe-event.h"
43 #include "util/probe-file.h"
45 #define DEFAULT_VAR_FILTER "!__k???tab_* & !__crc_*"
46 #define DEFAULT_FUNC_FILTER "!_*"
47 #define DEFAULT_LIST_FILTER "*"
49 /* Session management structure */
51 int command; /* Command short_name */
57 struct perf_probe_event events[MAX_PROBES];
58 struct line_range line_range;
60 struct strfilter *filter;
63 /* Parse an event definition. Note that any error must die. */
64 static int parse_probe_event(const char *str)
66 struct perf_probe_event *pev = ¶ms.events[params.nevents];
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);
75 pev->uprobes = params.uprobes;
77 pev->target = strdup(params.target);
80 params.target_used = true;
83 /* Parse a perf-probe command into event */
84 ret = parse_perf_probe_command(str, pev);
85 pr_debug("%d arguments\n", pev->nargs);
90 static int params_add_filter(const char *str)
92 const char *err = NULL;
95 pr_debug2("Add filter: %s\n", str);
97 params.filter = strfilter__new(str, &err);
99 ret = err ? -EINVAL : -ENOMEM;
101 ret = strfilter__or(params.filter, str, &err);
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), '^');
112 static int set_target(const char *ptr)
118 * The first argument after options can be an absolute path
119 * to an executable / library or kernel module.
121 * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
124 if (!params.target && ptr && *ptr == '/') {
125 params.target = strdup(ptr);
128 params.target_used = false;
131 buf = ptr + (strlen(ptr) - 3);
133 if (strcmp(buf, ".ko"))
134 params.uprobes = true;
141 static int parse_probe_event_argv(int argc, const char **argv)
143 int i, len, ret, found_target;
146 found_target = set_target(argv[0]);
147 if (found_target < 0)
150 if (found_target && argc == 1)
153 /* Bind up rest arguments */
155 for (i = 0; i < argc; i++) {
156 if (i == 0 && found_target)
159 len += strlen(argv[i]) + 1;
161 buf = zalloc(len + 1);
165 for (i = 0; i < argc; i++) {
166 if (i == 0 && found_target)
169 len += sprintf(&buf[len], "%s ", argv[i]);
171 ret = parse_probe_event(buf);
176 static int opt_set_target(const struct option *opt, const char *str,
177 int unset __maybe_unused)
183 if (!strcmp(opt->long_name, "exec"))
184 params.uprobes = true;
185 else if (!strcmp(opt->long_name, "module"))
186 params.uprobes = false;
190 /* Expand given path to absolute path, except for modulename */
191 if (params.uprobes || strchr(str, '/')) {
192 tmp = realpath(str, NULL);
194 pr_warning("Failed to get the absolute path of %s: %m\n", str);
204 params.target_used = false;
211 /* Command option callbacks */
213 #ifdef HAVE_DWARF_SUPPORT
214 static int opt_show_lines(const struct option *opt,
215 const char *str, int unset __maybe_unused)
222 if (params.command == 'L') {
223 pr_warning("Warning: more than one --line options are"
224 " detected. Only the first one is valid.\n");
228 params.command = opt->short_name;
229 ret = parse_line_range_desc(str, ¶ms.line_range);
234 static int opt_show_vars(const struct option *opt,
235 const char *str, int unset __maybe_unused)
237 struct perf_probe_event *pev = ¶ms.events[params.nevents];
243 ret = parse_probe_event(str);
244 if (!ret && pev->nargs != 0) {
245 pr_err(" Error: '--vars' doesn't accept arguments.\n");
248 params.command = opt->short_name;
253 # define opt_show_lines NULL
254 # define opt_show_vars NULL
256 static int opt_add_probe_event(const struct option *opt,
257 const char *str, int unset __maybe_unused)
260 params.command = opt->short_name;
261 return parse_probe_event(str);
267 static int opt_set_filter_with_command(const struct option *opt,
268 const char *str, int unset)
271 params.command = opt->short_name;
274 return params_add_filter(str);
279 static int opt_set_filter(const struct option *opt __maybe_unused,
280 const char *str, int unset __maybe_unused)
283 return params_add_filter(str);
288 static int init_params(void)
290 return line_range__init(¶ms.line_range);
293 static void cleanup_params(void)
297 for (i = 0; i < params.nevents; i++)
298 clear_perf_probe_event(params.events + i);
299 line_range__clear(¶ms.line_range);
301 strfilter__delete(params.filter);
302 memset(¶ms, 0, sizeof(params));
305 static void pr_err_with_code(const char *msg, int err)
307 char sbuf[STRERR_BUFSIZE];
310 pr_debug(" Reason: %s (Code: %d)",
311 str_error_r(-err, sbuf, sizeof(sbuf)), err);
315 static int perf_add_probe_events(struct perf_probe_event *pevs, int npevs)
319 const char *event = NULL, *group = NULL;
321 ret = init_probe_symbol_maps(pevs->uprobes);
325 ret = convert_perf_probe_events(pevs, npevs);
329 ret = apply_perf_probe_events(pevs, npevs);
333 for (i = k = 0; i < npevs; i++)
336 pr_info("Added new event%s\n", (k > 1) ? "s:" : ":");
337 for (i = 0; i < npevs; i++) {
338 struct perf_probe_event *pev = &pevs[i];
340 for (k = 0; k < pev->ntevs; k++) {
341 struct probe_trace_event *tev = &pev->tevs[k];
343 /* We use tev's name for showing new events */
344 show_perf_probe_event(tev->group, tev->event, pev,
345 tev->point.module, false);
347 /* Save the last valid name */
353 /* Note that it is possible to skip all events because of blacklist */
355 /* Show how to use the event. */
356 pr_info("\nYou can now use it in all perf tools, such as:\n\n");
357 pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", group, event);
361 cleanup_perf_probe_events(pevs, npevs);
362 exit_probe_symbol_maps();
366 static int del_perf_probe_caches(struct strfilter *filter)
368 struct probe_cache *cache;
369 struct strlist *bidlist;
373 bidlist = build_id_cache__list_all(false);
376 pr_debug("Failed to get buildids: %d\n", ret);
377 return ret ?: -ENOMEM;
380 strlist__for_each_entry(nd, bidlist) {
381 cache = probe_cache__new(nd->s);
384 if (probe_cache__filter_purge(cache, filter) < 0 ||
385 probe_cache__commit(cache) < 0)
386 pr_warning("Failed to remove entries for %s\n", nd->s);
387 probe_cache__delete(cache);
392 static int perf_del_probe_events(struct strfilter *filter)
394 int ret, ret2, ufd = -1, kfd = -1;
395 char *str = strfilter__string(filter);
396 struct strlist *klist = NULL, *ulist = NULL;
397 struct str_node *ent;
402 pr_debug("Delete filter: \'%s\'\n", str);
404 if (probe_conf.cache)
405 return del_perf_probe_caches(filter);
407 /* Get current event names */
408 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
412 klist = strlist__new(NULL, NULL);
413 ulist = strlist__new(NULL, NULL);
414 if (!klist || !ulist) {
419 ret = probe_file__get_events(kfd, filter, klist);
421 strlist__for_each_entry(ent, klist)
422 pr_info("Removed event: %s\n", ent->s);
424 ret = probe_file__del_strlist(kfd, klist);
429 ret2 = probe_file__get_events(ufd, filter, ulist);
431 strlist__for_each_entry(ent, ulist)
432 pr_info("Removed event: %s\n", ent->s);
434 ret2 = probe_file__del_strlist(ufd, ulist);
439 if (ret == -ENOENT && ret2 == -ENOENT)
440 pr_debug("\"%s\" does not hit any event.\n", str);
441 /* Note that this is silently ignored */
450 strlist__delete(klist);
451 strlist__delete(ulist);
458 __cmd_probe(int argc, const char **argv, const char *prefix __maybe_unused)
460 const char * const probe_usage[] = {
461 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
462 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
463 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
464 "perf probe --list [GROUP:]EVENT ...",
465 #ifdef HAVE_DWARF_SUPPORT
466 "perf probe [<options>] --line 'LINEDESC'",
467 "perf probe [<options>] --vars 'PROBEPOINT'",
469 "perf probe [<options>] --funcs",
472 struct option options[] = {
473 OPT_INCR('v', "verbose", &verbose,
474 "be more verbose (show parsed arguments, etc)"),
475 OPT_BOOLEAN('q', "quiet", ¶ms.quiet,
476 "be quiet (do not show any mesages)"),
477 OPT_CALLBACK_DEFAULT('l', "list", NULL, "[GROUP:]EVENT",
478 "list up probe events",
479 opt_set_filter_with_command, DEFAULT_LIST_FILTER),
480 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
481 opt_set_filter_with_command),
482 OPT_CALLBACK('a', "add", NULL,
483 #ifdef HAVE_DWARF_SUPPORT
484 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
487 "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]",
489 "probe point definition, where\n"
490 "\t\tGROUP:\tGroup name (optional)\n"
491 "\t\tEVENT:\tEvent name\n"
492 "\t\tFUNC:\tFunction name\n"
493 "\t\tOFF:\tOffset from function entry (in byte)\n"
494 "\t\t%return:\tPut the probe at function return\n"
495 #ifdef HAVE_DWARF_SUPPORT
496 "\t\tSRC:\tSource code path\n"
497 "\t\tRL:\tRelative line number from function entry.\n"
498 "\t\tAL:\tAbsolute line number in file.\n"
499 "\t\tPT:\tLazy expression of line code.\n"
500 "\t\tARG:\tProbe argument (local variable name or\n"
501 "\t\t\tkprobe-tracer argument format.)\n",
503 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
505 opt_add_probe_event),
506 OPT_BOOLEAN('f', "force", &probe_conf.force_add, "forcibly add events"
507 " with existing name"),
508 OPT_CALLBACK('L', "line", NULL,
509 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
510 "Show source code lines.", opt_show_lines),
511 OPT_CALLBACK('V', "vars", NULL,
512 "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
513 "Show accessible variables on PROBEDEF", opt_show_vars),
514 OPT_BOOLEAN('\0', "externs", &probe_conf.show_ext_vars,
515 "Show external variables too (with --vars only)"),
516 OPT_BOOLEAN('\0', "range", &probe_conf.show_location_range,
517 "Show variables location range in scope (with --vars only)"),
518 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
519 "file", "vmlinux pathname"),
520 OPT_STRING('s', "source", &symbol_conf.source_prefix,
521 "directory", "path to kernel source"),
522 OPT_BOOLEAN('\0', "no-inlines", &probe_conf.no_inlines,
523 "Don't search inlined functions"),
524 OPT__DRY_RUN(&probe_event_dry_run),
525 OPT_INTEGER('\0', "max-probes", &probe_conf.max_probes,
526 "Set how many probe points can be found for a probe."),
527 OPT_CALLBACK_DEFAULT('F', "funcs", NULL, "[FILTER]",
528 "Show potential probe-able functions.",
529 opt_set_filter_with_command, DEFAULT_FUNC_FILTER),
530 OPT_CALLBACK('\0', "filter", NULL,
531 "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
532 "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
533 "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
535 OPT_CALLBACK('x', "exec", NULL, "executable|path",
536 "target executable name or path", opt_set_target),
537 OPT_CALLBACK('m', "module", NULL, "modname|path",
538 "target module name (for online) or path (for offline)",
540 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
541 "Enable symbol demangling"),
542 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
543 "Enable kernel symbol demangling"),
544 OPT_BOOLEAN(0, "cache", &probe_conf.cache, "Manipulate probe cache"),
549 set_option_flag(options, 'a', "add", PARSE_OPT_EXCLUSIVE);
550 set_option_flag(options, 'd', "del", PARSE_OPT_EXCLUSIVE);
551 set_option_flag(options, 'l', "list", PARSE_OPT_EXCLUSIVE);
552 #ifdef HAVE_DWARF_SUPPORT
553 set_option_flag(options, 'L', "line", PARSE_OPT_EXCLUSIVE);
554 set_option_flag(options, 'V', "vars", PARSE_OPT_EXCLUSIVE);
556 # define set_nobuild(s, l, c) set_option_nobuild(options, s, l, "NO_DWARF=1", c)
557 set_nobuild('L', "line", false);
558 set_nobuild('V', "vars", false);
559 set_nobuild('\0', "externs", false);
560 set_nobuild('\0', "range", false);
561 set_nobuild('k', "vmlinux", true);
562 set_nobuild('s', "source", true);
563 set_nobuild('\0', "no-inlines", true);
566 set_option_flag(options, 'F', "funcs", PARSE_OPT_EXCLUSIVE);
568 argc = parse_options(argc, argv, options, probe_usage,
569 PARSE_OPT_STOP_AT_NON_OPTION);
571 if (strcmp(argv[0], "-") == 0) {
572 usage_with_options_msg(probe_usage, options,
573 "'-' is not supported.\n");
575 if (params.command && params.command != 'a') {
576 usage_with_options_msg(probe_usage, options,
577 "another command except --add is set.\n");
579 ret = parse_probe_event_argv(argc, argv);
581 pr_err_with_code(" Error: Command Parse Error.", ret);
584 params.command = 'a';
589 pr_err(" Error: -v and -q are exclusive.\n");
595 if (probe_conf.max_probes == 0)
596 probe_conf.max_probes = MAX_PROBES;
599 * Only consider the user's kernel image path if given.
601 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
603 switch (params.command) {
605 if (params.uprobes) {
606 pr_err(" Error: Don't use --list with --exec.\n");
607 parse_options_usage(probe_usage, options, "l", true);
608 parse_options_usage(NULL, options, "x", true);
611 ret = show_perf_probe_events(params.filter);
613 pr_err_with_code(" Error: Failed to show event list.", ret);
616 ret = show_available_funcs(params.target, params.filter,
619 pr_err_with_code(" Error: Failed to show functions.", ret);
621 #ifdef HAVE_DWARF_SUPPORT
623 ret = show_line_range(¶ms.line_range, params.target,
626 pr_err_with_code(" Error: Failed to show lines.", ret);
630 params.filter = strfilter__new(DEFAULT_VAR_FILTER,
633 ret = show_available_vars(params.events, params.nevents,
636 pr_err_with_code(" Error: Failed to show vars.", ret);
640 ret = perf_del_probe_events(params.filter);
642 pr_err_with_code(" Error: Failed to delete events.", ret);
647 /* Ensure the last given target is used */
648 if (params.target && !params.target_used) {
649 pr_err(" Error: -x/-m must follow the probe definitions.\n");
650 parse_options_usage(probe_usage, options, "m", true);
651 parse_options_usage(NULL, options, "x", true);
655 ret = perf_add_probe_events(params.events, params.nevents);
657 pr_err_with_code(" Error: Failed to add events.", ret);
662 usage_with_options(probe_usage, options);
667 int cmd_probe(int argc, const char **argv, const char *prefix)
673 ret = __cmd_probe(argc, argv, prefix);
677 return ret < 0 ? ret : 0;