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;
64 /* Parse an event definition. Note that any error must die. */
65 static int parse_probe_event(const char *str)
67 struct perf_probe_event *pev = ¶ms.events[params.nevents];
70 pr_debug("probe-definition(%d): %s\n", params.nevents, str);
71 if (++params.nevents == MAX_PROBES) {
72 pr_err("Too many probes (> %d) were specified.", MAX_PROBES);
76 pev->uprobes = params.uprobes;
78 pev->target = strdup(params.target);
81 params.target_used = true;
85 pev->nsi = nsinfo__get(params.nsi);
87 /* Parse a perf-probe command into event */
88 ret = parse_perf_probe_command(str, pev);
89 pr_debug("%d arguments\n", pev->nargs);
94 static int params_add_filter(const char *str)
96 const char *err = NULL;
99 pr_debug2("Add filter: %s\n", str);
100 if (!params.filter) {
101 params.filter = strfilter__new(str, &err);
103 ret = err ? -EINVAL : -ENOMEM;
105 ret = strfilter__or(params.filter, str, &err);
107 if (ret == -EINVAL) {
108 pr_err("Filter parse error at %td.\n", err - str + 1);
109 pr_err("Source: \"%s\"\n", str);
110 pr_err(" %*c\n", (int)(err - str + 1), '^');
116 static int set_target(const char *ptr)
122 * The first argument after options can be an absolute path
123 * to an executable / library or kernel module.
125 * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
128 if (!params.target && ptr && *ptr == '/') {
129 params.target = strdup(ptr);
132 params.target_used = false;
135 buf = ptr + (strlen(ptr) - 3);
137 if (strcmp(buf, ".ko"))
138 params.uprobes = true;
145 static int parse_probe_event_argv(int argc, const char **argv)
147 int i, len, ret, found_target;
150 found_target = set_target(argv[0]);
151 if (found_target < 0)
154 if (found_target && argc == 1)
157 /* Bind up rest arguments */
159 for (i = 0; i < argc; i++) {
160 if (i == 0 && found_target)
163 len += strlen(argv[i]) + 1;
165 buf = zalloc(len + 1);
169 for (i = 0; i < argc; i++) {
170 if (i == 0 && found_target)
173 len += sprintf(&buf[len], "%s ", argv[i]);
175 ret = parse_probe_event(buf);
180 static int opt_set_target(const struct option *opt, const char *str,
181 int unset __maybe_unused)
187 if (!strcmp(opt->long_name, "exec"))
188 params.uprobes = true;
189 else if (!strcmp(opt->long_name, "module"))
190 params.uprobes = false;
194 /* Expand given path to absolute path, except for modulename */
195 if (params.uprobes || strchr(str, '/')) {
196 tmp = nsinfo__realpath(str, params.nsi);
198 pr_warning("Failed to get the absolute path of %s: %m\n", str);
208 params.target_used = false;
215 static int opt_set_target_ns(const struct option *opt __maybe_unused,
216 const char *str, int unset __maybe_unused)
224 ns_pid = (pid_t)strtol(str, NULL, 10);
227 pr_warning("Failed to parse %s as a pid: %s\n", str,
231 nsip = nsinfo__new(ns_pid);
232 if (nsip && nsip->need_setns)
233 params.nsi = nsinfo__get(nsip);
243 /* Command option callbacks */
245 #ifdef HAVE_DWARF_SUPPORT
246 static int opt_show_lines(const struct option *opt,
247 const char *str, int unset __maybe_unused)
254 if (params.command == 'L') {
255 pr_warning("Warning: more than one --line options are"
256 " detected. Only the first one is valid.\n");
260 params.command = opt->short_name;
261 ret = parse_line_range_desc(str, ¶ms.line_range);
266 static int opt_show_vars(const struct option *opt,
267 const char *str, int unset __maybe_unused)
269 struct perf_probe_event *pev = ¶ms.events[params.nevents];
275 ret = parse_probe_event(str);
276 if (!ret && pev->nargs != 0) {
277 pr_err(" Error: '--vars' doesn't accept arguments.\n");
280 params.command = opt->short_name;
285 # define opt_show_lines NULL
286 # define opt_show_vars NULL
288 static int opt_add_probe_event(const struct option *opt,
289 const char *str, int unset __maybe_unused)
292 params.command = opt->short_name;
293 return parse_probe_event(str);
299 static int opt_set_filter_with_command(const struct option *opt,
300 const char *str, int unset)
303 params.command = opt->short_name;
306 return params_add_filter(str);
311 static int opt_set_filter(const struct option *opt __maybe_unused,
312 const char *str, int unset __maybe_unused)
315 return params_add_filter(str);
320 static int init_params(void)
322 return line_range__init(¶ms.line_range);
325 static void cleanup_params(void)
329 for (i = 0; i < params.nevents; i++)
330 clear_perf_probe_event(params.events + i);
331 line_range__clear(¶ms.line_range);
333 strfilter__delete(params.filter);
334 nsinfo__put(params.nsi);
335 memset(¶ms, 0, sizeof(params));
338 static void pr_err_with_code(const char *msg, int err)
340 char sbuf[STRERR_BUFSIZE];
343 pr_debug(" Reason: %s (Code: %d)",
344 str_error_r(-err, sbuf, sizeof(sbuf)), err);
348 static int perf_add_probe_events(struct perf_probe_event *pevs, int npevs)
352 const char *event = NULL, *group = NULL;
354 ret = init_probe_symbol_maps(pevs->uprobes);
358 ret = convert_perf_probe_events(pevs, npevs);
362 if (params.command == 'D') { /* it shows definition */
363 ret = show_probe_trace_events(pevs, npevs);
367 ret = apply_perf_probe_events(pevs, npevs);
371 for (i = k = 0; i < npevs; i++)
374 pr_info("Added new event%s\n", (k > 1) ? "s:" : ":");
375 for (i = 0; i < npevs; i++) {
376 struct perf_probe_event *pev = &pevs[i];
378 for (k = 0; k < pev->ntevs; k++) {
379 struct probe_trace_event *tev = &pev->tevs[k];
380 /* Skipped events have no event name */
384 /* We use tev's name for showing new events */
385 show_perf_probe_event(tev->group, tev->event, pev,
386 tev->point.module, false);
388 /* Save the last valid name */
394 /* Note that it is possible to skip all events because of blacklist */
396 /* Show how to use the event. */
397 pr_info("\nYou can now use it in all perf tools, such as:\n\n");
398 pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", group, event);
402 cleanup_perf_probe_events(pevs, npevs);
403 exit_probe_symbol_maps();
407 static int del_perf_probe_caches(struct strfilter *filter)
409 struct probe_cache *cache;
410 struct strlist *bidlist;
414 bidlist = build_id_cache__list_all(false);
417 pr_debug("Failed to get buildids: %d\n", ret);
418 return ret ?: -ENOMEM;
421 strlist__for_each_entry(nd, bidlist) {
422 cache = probe_cache__new(nd->s, NULL);
425 if (probe_cache__filter_purge(cache, filter) < 0 ||
426 probe_cache__commit(cache) < 0)
427 pr_warning("Failed to remove entries for %s\n", nd->s);
428 probe_cache__delete(cache);
433 static int perf_del_probe_events(struct strfilter *filter)
435 int ret, ret2, ufd = -1, kfd = -1;
436 char *str = strfilter__string(filter);
437 struct strlist *klist = NULL, *ulist = NULL;
438 struct str_node *ent;
443 pr_debug("Delete filter: \'%s\'\n", str);
445 if (probe_conf.cache)
446 return del_perf_probe_caches(filter);
448 /* Get current event names */
449 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
453 klist = strlist__new(NULL, NULL);
454 ulist = strlist__new(NULL, NULL);
455 if (!klist || !ulist) {
460 ret = probe_file__get_events(kfd, filter, klist);
462 strlist__for_each_entry(ent, klist)
463 pr_info("Removed event: %s\n", ent->s);
465 ret = probe_file__del_strlist(kfd, klist);
470 ret2 = probe_file__get_events(ufd, filter, ulist);
472 strlist__for_each_entry(ent, ulist)
473 pr_info("Removed event: %s\n", ent->s);
475 ret2 = probe_file__del_strlist(ufd, ulist);
480 if (ret == -ENOENT && ret2 == -ENOENT)
481 pr_warning("\"%s\" does not hit any event.\n", str);
491 strlist__delete(klist);
492 strlist__delete(ulist);
498 #ifdef HAVE_DWARF_SUPPORT
499 #define PROBEDEF_STR \
500 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT [[NAME=]ARG ...]"
502 #define PROBEDEF_STR "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]"
507 __cmd_probe(int argc, const char **argv)
509 const char * const probe_usage[] = {
510 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
511 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
512 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
513 "perf probe --list [GROUP:]EVENT ...",
514 #ifdef HAVE_DWARF_SUPPORT
515 "perf probe [<options>] --line 'LINEDESC'",
516 "perf probe [<options>] --vars 'PROBEPOINT'",
518 "perf probe [<options>] --funcs",
521 struct option options[] = {
522 OPT_INCR('v', "verbose", &verbose,
523 "be more verbose (show parsed arguments, etc)"),
524 OPT_BOOLEAN('q', "quiet", ¶ms.quiet,
525 "be quiet (do not show any messages)"),
526 OPT_CALLBACK_DEFAULT('l', "list", NULL, "[GROUP:]EVENT",
527 "list up probe events",
528 opt_set_filter_with_command, DEFAULT_LIST_FILTER),
529 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
530 opt_set_filter_with_command),
531 OPT_CALLBACK('a', "add", NULL, PROBEDEF_STR,
532 "probe point definition, where\n"
533 "\t\tGROUP:\tGroup name (optional)\n"
534 "\t\tEVENT:\tEvent name\n"
535 "\t\tFUNC:\tFunction name\n"
536 "\t\tOFF:\tOffset from function entry (in byte)\n"
537 "\t\t%return:\tPut the probe at function return\n"
538 #ifdef HAVE_DWARF_SUPPORT
539 "\t\tSRC:\tSource code path\n"
540 "\t\tRL:\tRelative line number from function entry.\n"
541 "\t\tAL:\tAbsolute line number in file.\n"
542 "\t\tPT:\tLazy expression of line code.\n"
543 "\t\tARG:\tProbe argument (local variable name or\n"
544 "\t\t\tkprobe-tracer argument format.)\n",
546 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
548 opt_add_probe_event),
549 OPT_CALLBACK('D', "definition", NULL, PROBEDEF_STR,
550 "Show trace event definition of given traceevent for k/uprobe_events.",
551 opt_add_probe_event),
552 OPT_BOOLEAN('f', "force", &probe_conf.force_add, "forcibly add events"
553 " with existing name"),
554 OPT_CALLBACK('L', "line", NULL,
555 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
556 "Show source code lines.", opt_show_lines),
557 OPT_CALLBACK('V', "vars", NULL,
558 "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
559 "Show accessible variables on PROBEDEF", opt_show_vars),
560 OPT_BOOLEAN('\0', "externs", &probe_conf.show_ext_vars,
561 "Show external variables too (with --vars only)"),
562 OPT_BOOLEAN('\0', "range", &probe_conf.show_location_range,
563 "Show variables location range in scope (with --vars only)"),
564 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
565 "file", "vmlinux pathname"),
566 OPT_STRING('s', "source", &symbol_conf.source_prefix,
567 "directory", "path to kernel source"),
568 OPT_BOOLEAN('\0', "no-inlines", &probe_conf.no_inlines,
569 "Don't search inlined functions"),
570 OPT__DRY_RUN(&probe_event_dry_run),
571 OPT_INTEGER('\0', "max-probes", &probe_conf.max_probes,
572 "Set how many probe points can be found for a probe."),
573 OPT_CALLBACK_DEFAULT('F', "funcs", NULL, "[FILTER]",
574 "Show potential probe-able functions.",
575 opt_set_filter_with_command, DEFAULT_FUNC_FILTER),
576 OPT_CALLBACK('\0', "filter", NULL,
577 "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
578 "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
579 "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
581 OPT_CALLBACK('x', "exec", NULL, "executable|path",
582 "target executable name or path", opt_set_target),
583 OPT_CALLBACK('m', "module", NULL, "modname|path",
584 "target module name (for online) or path (for offline)",
586 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
587 "Enable symbol demangling"),
588 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
589 "Enable kernel symbol demangling"),
590 OPT_BOOLEAN(0, "cache", &probe_conf.cache, "Manipulate probe cache"),
591 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
592 "Look for files with symbols relative to this directory"),
593 OPT_CALLBACK(0, "target-ns", NULL, "pid",
594 "target pid for namespace contexts", opt_set_target_ns),
599 set_option_flag(options, 'a', "add", PARSE_OPT_EXCLUSIVE);
600 set_option_flag(options, 'd', "del", PARSE_OPT_EXCLUSIVE);
601 set_option_flag(options, 'D', "definition", PARSE_OPT_EXCLUSIVE);
602 set_option_flag(options, 'l', "list", PARSE_OPT_EXCLUSIVE);
603 #ifdef HAVE_DWARF_SUPPORT
604 set_option_flag(options, 'L', "line", PARSE_OPT_EXCLUSIVE);
605 set_option_flag(options, 'V', "vars", PARSE_OPT_EXCLUSIVE);
607 # define set_nobuild(s, l, c) set_option_nobuild(options, s, l, "NO_DWARF=1", c)
608 set_nobuild('L', "line", false);
609 set_nobuild('V', "vars", false);
610 set_nobuild('\0', "externs", false);
611 set_nobuild('\0', "range", false);
612 set_nobuild('k', "vmlinux", true);
613 set_nobuild('s', "source", true);
614 set_nobuild('\0', "no-inlines", true);
617 set_option_flag(options, 'F', "funcs", PARSE_OPT_EXCLUSIVE);
619 argc = parse_options(argc, argv, options, probe_usage,
620 PARSE_OPT_STOP_AT_NON_OPTION);
622 if (strcmp(argv[0], "-") == 0) {
623 usage_with_options_msg(probe_usage, options,
624 "'-' is not supported.\n");
626 if (params.command && params.command != 'a') {
627 usage_with_options_msg(probe_usage, options,
628 "another command except --add is set.\n");
630 ret = parse_probe_event_argv(argc, argv);
632 pr_err_with_code(" Error: Command Parse Error.", ret);
635 params.command = 'a';
640 pr_err(" Error: -v and -q are exclusive.\n");
646 if (probe_conf.max_probes == 0)
647 probe_conf.max_probes = MAX_PROBES;
650 * Only consider the user's kernel image path if given.
652 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
655 * Except for --list, --del and --add, other command doesn't depend
656 * nor change running kernel. So if user gives offline vmlinux,
657 * ignore its buildid.
659 if (!strchr("lda", params.command) && symbol_conf.vmlinux_name)
660 symbol_conf.ignore_vmlinux_buildid = true;
662 switch (params.command) {
664 if (params.uprobes) {
665 pr_err(" Error: Don't use --list with --exec.\n");
666 parse_options_usage(probe_usage, options, "l", true);
667 parse_options_usage(NULL, options, "x", true);
670 ret = show_perf_probe_events(params.filter);
672 pr_err_with_code(" Error: Failed to show event list.", ret);
675 ret = show_available_funcs(params.target, params.nsi,
676 params.filter, params.uprobes);
678 pr_err_with_code(" Error: Failed to show functions.", ret);
680 #ifdef HAVE_DWARF_SUPPORT
682 ret = show_line_range(¶ms.line_range, params.target,
683 params.nsi, params.uprobes);
685 pr_err_with_code(" Error: Failed to show lines.", ret);
689 params.filter = strfilter__new(DEFAULT_VAR_FILTER,
692 ret = show_available_vars(params.events, params.nevents,
695 pr_err_with_code(" Error: Failed to show vars.", ret);
699 ret = perf_del_probe_events(params.filter);
701 pr_err_with_code(" Error: Failed to delete events.", ret);
708 /* Ensure the last given target is used */
709 if (params.target && !params.target_used) {
710 pr_err(" Error: -x/-m must follow the probe definitions.\n");
711 parse_options_usage(probe_usage, options, "m", true);
712 parse_options_usage(NULL, options, "x", true);
716 ret = perf_add_probe_events(params.events, params.nevents);
720 * When perf_add_probe_events() fails it calls
721 * cleanup_perf_probe_events(pevs, npevs), i.e.
722 * cleanup_perf_probe_events(params.events, params.nevents), which
723 * will call clear_perf_probe_event(), so set nevents to zero
724 * to avoid cleanup_params() to call clear_perf_probe_event() again
728 pr_err_with_code(" Error: Failed to add events.", ret);
733 usage_with_options(probe_usage, options);
738 int cmd_probe(int argc, const char **argv)
744 ret = __cmd_probe(argc, argv);
748 return ret < 0 ? ret : 0;