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;
84 pev->nsi = nsinfo__get(params.nsi);
86 /* Parse a perf-probe command into event */
87 ret = parse_perf_probe_command(str, pev);
88 pr_debug("%d arguments\n", pev->nargs);
93 static int params_add_filter(const char *str)
95 const char *err = NULL;
98 pr_debug2("Add filter: %s\n", str);
100 params.filter = strfilter__new(str, &err);
102 ret = err ? -EINVAL : -ENOMEM;
104 ret = strfilter__or(params.filter, str, &err);
106 if (ret == -EINVAL) {
107 pr_err("Filter parse error at %td.\n", err - str + 1);
108 pr_err("Source: \"%s\"\n", str);
109 pr_err(" %*c\n", (int)(err - str + 1), '^');
115 static int set_target(const char *ptr)
121 * The first argument after options can be an absolute path
122 * to an executable / library or kernel module.
124 * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
127 if (!params.target && ptr && *ptr == '/') {
128 params.target = strdup(ptr);
131 params.target_used = false;
134 buf = ptr + (strlen(ptr) - 3);
136 if (strcmp(buf, ".ko"))
137 params.uprobes = true;
144 static int parse_probe_event_argv(int argc, const char **argv)
146 int i, len, ret, found_target;
149 found_target = set_target(argv[0]);
150 if (found_target < 0)
153 if (found_target && argc == 1)
156 /* Bind up rest arguments */
158 for (i = 0; i < argc; i++) {
159 if (i == 0 && found_target)
162 len += strlen(argv[i]) + 1;
164 buf = zalloc(len + 1);
168 for (i = 0; i < argc; i++) {
169 if (i == 0 && found_target)
172 len += sprintf(&buf[len], "%s ", argv[i]);
174 ret = parse_probe_event(buf);
179 static int opt_set_target(const struct option *opt, const char *str,
180 int unset __maybe_unused)
186 if (!strcmp(opt->long_name, "exec"))
187 params.uprobes = true;
188 else if (!strcmp(opt->long_name, "module"))
189 params.uprobes = false;
193 /* Expand given path to absolute path, except for modulename */
194 if (params.uprobes || strchr(str, '/')) {
195 tmp = nsinfo__realpath(str, params.nsi);
197 pr_warning("Failed to get the absolute path of %s: %m\n", str);
207 params.target_used = false;
214 static int opt_set_target_ns(const struct option *opt __maybe_unused,
215 const char *str, int unset __maybe_unused)
223 ns_pid = (pid_t)strtol(str, NULL, 10);
226 pr_warning("Failed to parse %s as a pid: %s\n", str,
230 nsip = nsinfo__new(ns_pid);
231 if (nsip && nsip->need_setns)
232 params.nsi = nsinfo__get(nsip);
242 /* Command option callbacks */
244 #ifdef HAVE_DWARF_SUPPORT
245 static int opt_show_lines(const struct option *opt,
246 const char *str, int unset __maybe_unused)
253 if (params.command == 'L') {
254 pr_warning("Warning: more than one --line options are"
255 " detected. Only the first one is valid.\n");
259 params.command = opt->short_name;
260 ret = parse_line_range_desc(str, ¶ms.line_range);
265 static int opt_show_vars(const struct option *opt,
266 const char *str, int unset __maybe_unused)
268 struct perf_probe_event *pev = ¶ms.events[params.nevents];
274 ret = parse_probe_event(str);
275 if (!ret && pev->nargs != 0) {
276 pr_err(" Error: '--vars' doesn't accept arguments.\n");
279 params.command = opt->short_name;
284 # define opt_show_lines NULL
285 # define opt_show_vars NULL
287 static int opt_add_probe_event(const struct option *opt,
288 const char *str, int unset __maybe_unused)
291 params.command = opt->short_name;
292 return parse_probe_event(str);
298 static int opt_set_filter_with_command(const struct option *opt,
299 const char *str, int unset)
302 params.command = opt->short_name;
305 return params_add_filter(str);
310 static int opt_set_filter(const struct option *opt __maybe_unused,
311 const char *str, int unset __maybe_unused)
314 return params_add_filter(str);
319 static int init_params(void)
321 return line_range__init(¶ms.line_range);
324 static void cleanup_params(void)
328 for (i = 0; i < params.nevents; i++)
329 clear_perf_probe_event(params.events + i);
330 line_range__clear(¶ms.line_range);
332 strfilter__delete(params.filter);
333 nsinfo__put(params.nsi);
334 memset(¶ms, 0, sizeof(params));
337 static void pr_err_with_code(const char *msg, int err)
339 char sbuf[STRERR_BUFSIZE];
342 pr_debug(" Reason: %s (Code: %d)",
343 str_error_r(-err, sbuf, sizeof(sbuf)), err);
347 static int perf_add_probe_events(struct perf_probe_event *pevs, int npevs)
351 const char *event = NULL, *group = NULL;
353 ret = init_probe_symbol_maps(pevs->uprobes);
357 ret = convert_perf_probe_events(pevs, npevs);
361 if (params.command == 'D') { /* it shows definition */
362 ret = show_probe_trace_events(pevs, npevs);
366 ret = apply_perf_probe_events(pevs, npevs);
370 for (i = k = 0; i < npevs; i++)
373 pr_info("Added new event%s\n", (k > 1) ? "s:" : ":");
374 for (i = 0; i < npevs; i++) {
375 struct perf_probe_event *pev = &pevs[i];
377 for (k = 0; k < pev->ntevs; k++) {
378 struct probe_trace_event *tev = &pev->tevs[k];
380 /* We use tev's name for showing new events */
381 show_perf_probe_event(tev->group, tev->event, pev,
382 tev->point.module, false);
384 /* Save the last valid name */
390 /* Note that it is possible to skip all events because of blacklist */
392 /* Show how to use the event. */
393 pr_info("\nYou can now use it in all perf tools, such as:\n\n");
394 pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", group, event);
398 cleanup_perf_probe_events(pevs, npevs);
399 exit_probe_symbol_maps();
403 static int del_perf_probe_caches(struct strfilter *filter)
405 struct probe_cache *cache;
406 struct strlist *bidlist;
410 bidlist = build_id_cache__list_all(false);
413 pr_debug("Failed to get buildids: %d\n", ret);
414 return ret ?: -ENOMEM;
417 strlist__for_each_entry(nd, bidlist) {
418 cache = probe_cache__new(nd->s, NULL);
421 if (probe_cache__filter_purge(cache, filter) < 0 ||
422 probe_cache__commit(cache) < 0)
423 pr_warning("Failed to remove entries for %s\n", nd->s);
424 probe_cache__delete(cache);
429 static int perf_del_probe_events(struct strfilter *filter)
431 int ret, ret2, ufd = -1, kfd = -1;
432 char *str = strfilter__string(filter);
433 struct strlist *klist = NULL, *ulist = NULL;
434 struct str_node *ent;
439 pr_debug("Delete filter: \'%s\'\n", str);
441 if (probe_conf.cache)
442 return del_perf_probe_caches(filter);
444 /* Get current event names */
445 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
449 klist = strlist__new(NULL, NULL);
450 ulist = strlist__new(NULL, NULL);
451 if (!klist || !ulist) {
456 ret = probe_file__get_events(kfd, filter, klist);
458 strlist__for_each_entry(ent, klist)
459 pr_info("Removed event: %s\n", ent->s);
461 ret = probe_file__del_strlist(kfd, klist);
466 ret2 = probe_file__get_events(ufd, filter, ulist);
468 strlist__for_each_entry(ent, ulist)
469 pr_info("Removed event: %s\n", ent->s);
471 ret2 = probe_file__del_strlist(ufd, ulist);
476 if (ret == -ENOENT && ret2 == -ENOENT)
477 pr_warning("\"%s\" does not hit any event.\n", str);
487 strlist__delete(klist);
488 strlist__delete(ulist);
494 #ifdef HAVE_DWARF_SUPPORT
495 #define PROBEDEF_STR \
496 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT [[NAME=]ARG ...]"
498 #define PROBEDEF_STR "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]"
503 __cmd_probe(int argc, const char **argv)
505 const char * const probe_usage[] = {
506 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
507 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
508 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
509 "perf probe --list [GROUP:]EVENT ...",
510 #ifdef HAVE_DWARF_SUPPORT
511 "perf probe [<options>] --line 'LINEDESC'",
512 "perf probe [<options>] --vars 'PROBEPOINT'",
514 "perf probe [<options>] --funcs",
517 struct option options[] = {
518 OPT_INCR('v', "verbose", &verbose,
519 "be more verbose (show parsed arguments, etc)"),
520 OPT_BOOLEAN('q', "quiet", ¶ms.quiet,
521 "be quiet (do not show any messages)"),
522 OPT_CALLBACK_DEFAULT('l', "list", NULL, "[GROUP:]EVENT",
523 "list up probe events",
524 opt_set_filter_with_command, DEFAULT_LIST_FILTER),
525 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
526 opt_set_filter_with_command),
527 OPT_CALLBACK('a', "add", NULL, PROBEDEF_STR,
528 "probe point definition, where\n"
529 "\t\tGROUP:\tGroup name (optional)\n"
530 "\t\tEVENT:\tEvent name\n"
531 "\t\tFUNC:\tFunction name\n"
532 "\t\tOFF:\tOffset from function entry (in byte)\n"
533 "\t\t%return:\tPut the probe at function return\n"
534 #ifdef HAVE_DWARF_SUPPORT
535 "\t\tSRC:\tSource code path\n"
536 "\t\tRL:\tRelative line number from function entry.\n"
537 "\t\tAL:\tAbsolute line number in file.\n"
538 "\t\tPT:\tLazy expression of line code.\n"
539 "\t\tARG:\tProbe argument (local variable name or\n"
540 "\t\t\tkprobe-tracer argument format.)\n",
542 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
544 opt_add_probe_event),
545 OPT_CALLBACK('D', "definition", NULL, PROBEDEF_STR,
546 "Show trace event definition of given traceevent for k/uprobe_events.",
547 opt_add_probe_event),
548 OPT_BOOLEAN('f', "force", &probe_conf.force_add, "forcibly add events"
549 " with existing name"),
550 OPT_CALLBACK('L', "line", NULL,
551 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
552 "Show source code lines.", opt_show_lines),
553 OPT_CALLBACK('V', "vars", NULL,
554 "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
555 "Show accessible variables on PROBEDEF", opt_show_vars),
556 OPT_BOOLEAN('\0', "externs", &probe_conf.show_ext_vars,
557 "Show external variables too (with --vars only)"),
558 OPT_BOOLEAN('\0', "range", &probe_conf.show_location_range,
559 "Show variables location range in scope (with --vars only)"),
560 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
561 "file", "vmlinux pathname"),
562 OPT_STRING('s', "source", &symbol_conf.source_prefix,
563 "directory", "path to kernel source"),
564 OPT_BOOLEAN('\0', "no-inlines", &probe_conf.no_inlines,
565 "Don't search inlined functions"),
566 OPT__DRY_RUN(&probe_event_dry_run),
567 OPT_INTEGER('\0', "max-probes", &probe_conf.max_probes,
568 "Set how many probe points can be found for a probe."),
569 OPT_CALLBACK_DEFAULT('F', "funcs", NULL, "[FILTER]",
570 "Show potential probe-able functions.",
571 opt_set_filter_with_command, DEFAULT_FUNC_FILTER),
572 OPT_CALLBACK('\0', "filter", NULL,
573 "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
574 "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
575 "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
577 OPT_CALLBACK('x', "exec", NULL, "executable|path",
578 "target executable name or path", opt_set_target),
579 OPT_CALLBACK('m', "module", NULL, "modname|path",
580 "target module name (for online) or path (for offline)",
582 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
583 "Enable symbol demangling"),
584 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
585 "Enable kernel symbol demangling"),
586 OPT_BOOLEAN(0, "cache", &probe_conf.cache, "Manipulate probe cache"),
587 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
588 "Look for files with symbols relative to this directory"),
589 OPT_CALLBACK(0, "target-ns", NULL, "pid",
590 "target pid for namespace contexts", opt_set_target_ns),
595 set_option_flag(options, 'a', "add", PARSE_OPT_EXCLUSIVE);
596 set_option_flag(options, 'd', "del", PARSE_OPT_EXCLUSIVE);
597 set_option_flag(options, 'D', "definition", PARSE_OPT_EXCLUSIVE);
598 set_option_flag(options, 'l', "list", PARSE_OPT_EXCLUSIVE);
599 #ifdef HAVE_DWARF_SUPPORT
600 set_option_flag(options, 'L', "line", PARSE_OPT_EXCLUSIVE);
601 set_option_flag(options, 'V', "vars", PARSE_OPT_EXCLUSIVE);
603 # define set_nobuild(s, l, c) set_option_nobuild(options, s, l, "NO_DWARF=1", c)
604 set_nobuild('L', "line", false);
605 set_nobuild('V', "vars", false);
606 set_nobuild('\0', "externs", false);
607 set_nobuild('\0', "range", false);
608 set_nobuild('k', "vmlinux", true);
609 set_nobuild('s', "source", true);
610 set_nobuild('\0', "no-inlines", true);
613 set_option_flag(options, 'F', "funcs", PARSE_OPT_EXCLUSIVE);
615 argc = parse_options(argc, argv, options, probe_usage,
616 PARSE_OPT_STOP_AT_NON_OPTION);
618 if (strcmp(argv[0], "-") == 0) {
619 usage_with_options_msg(probe_usage, options,
620 "'-' is not supported.\n");
622 if (params.command && params.command != 'a') {
623 usage_with_options_msg(probe_usage, options,
624 "another command except --add is set.\n");
626 ret = parse_probe_event_argv(argc, argv);
628 pr_err_with_code(" Error: Command Parse Error.", ret);
631 params.command = 'a';
636 pr_err(" Error: -v and -q are exclusive.\n");
642 if (probe_conf.max_probes == 0)
643 probe_conf.max_probes = MAX_PROBES;
646 * Only consider the user's kernel image path if given.
648 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
651 * Except for --list, --del and --add, other command doesn't depend
652 * nor change running kernel. So if user gives offline vmlinux,
653 * ignore its buildid.
655 if (!strchr("lda", params.command) && symbol_conf.vmlinux_name)
656 symbol_conf.ignore_vmlinux_buildid = true;
658 switch (params.command) {
660 if (params.uprobes) {
661 pr_err(" Error: Don't use --list with --exec.\n");
662 parse_options_usage(probe_usage, options, "l", true);
663 parse_options_usage(NULL, options, "x", true);
666 ret = show_perf_probe_events(params.filter);
668 pr_err_with_code(" Error: Failed to show event list.", ret);
671 ret = show_available_funcs(params.target, params.nsi,
672 params.filter, params.uprobes);
674 pr_err_with_code(" Error: Failed to show functions.", ret);
676 #ifdef HAVE_DWARF_SUPPORT
678 ret = show_line_range(¶ms.line_range, params.target,
679 params.nsi, params.uprobes);
681 pr_err_with_code(" Error: Failed to show lines.", ret);
685 params.filter = strfilter__new(DEFAULT_VAR_FILTER,
688 ret = show_available_vars(params.events, params.nevents,
691 pr_err_with_code(" Error: Failed to show vars.", ret);
695 ret = perf_del_probe_events(params.filter);
697 pr_err_with_code(" Error: Failed to delete events.", ret);
704 /* Ensure the last given target is used */
705 if (params.target && !params.target_used) {
706 pr_err(" Error: -x/-m must follow the probe definitions.\n");
707 parse_options_usage(probe_usage, options, "m", true);
708 parse_options_usage(NULL, options, "x", true);
712 ret = perf_add_probe_events(params.events, params.nevents);
714 pr_err_with_code(" Error: Failed to add events.", ret);
719 usage_with_options(probe_usage, options);
724 int cmd_probe(int argc, const char **argv)
730 ret = __cmd_probe(argc, argv);
734 return ret < 0 ? ret : 0;