1 // SPDX-License-Identifier: GPL-2.0-or-later
5 * Builtin probe command: Set up probe events by C expression
7 * Written by Masami Hiramatsu <mhiramat@redhat.com>
9 #include <sys/utsname.h>
10 #include <sys/types.h>
20 #include "namespaces.h"
21 #include "util/build-id.h"
22 #include "util/strlist.h"
23 #include "util/strfilter.h"
24 #include "util/symbol_conf.h"
25 #include "util/debug.h"
26 #include <subcmd/parse-options.h>
27 #include "util/probe-finder.h"
28 #include "util/probe-event.h"
29 #include "util/probe-file.h"
30 #include <linux/string.h>
31 #include <linux/zalloc.h>
33 #define DEFAULT_VAR_FILTER "!__k???tab_* & !__crc_*"
34 #define DEFAULT_FUNC_FILTER "!_* & !*@plt"
35 #define DEFAULT_LIST_FILTER "*"
37 /* Session management structure */
39 int command; /* Command short_name */
45 struct perf_probe_event events[MAX_PROBES];
46 struct line_range line_range;
48 struct strfilter *filter;
52 /* Parse an event definition. Note that any error must die. */
53 static int parse_probe_event(const char *str)
55 struct perf_probe_event *pev = ¶ms.events[params.nevents];
58 pr_debug("probe-definition(%d): %s\n", params.nevents, str);
59 if (++params.nevents == MAX_PROBES) {
60 pr_err("Too many probes (> %d) were specified.", MAX_PROBES);
64 pev->uprobes = params.uprobes;
66 pev->target = strdup(params.target);
69 params.target_used = true;
72 pev->nsi = nsinfo__get(params.nsi);
74 /* Parse a perf-probe command into event */
75 ret = parse_perf_probe_command(str, pev);
76 pr_debug("%d arguments\n", pev->nargs);
81 static int params_add_filter(const char *str)
83 const char *err = NULL;
86 pr_debug2("Add filter: %s\n", str);
88 params.filter = strfilter__new(str, &err);
90 ret = err ? -EINVAL : -ENOMEM;
92 ret = strfilter__or(params.filter, str, &err);
95 pr_err("Filter parse error at %td.\n", err - str + 1);
96 pr_err("Source: \"%s\"\n", str);
97 pr_err(" %*c\n", (int)(err - str + 1), '^');
103 static int set_target(const char *ptr)
109 * The first argument after options can be an absolute path
110 * to an executable / library or kernel module.
112 * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
115 if (!params.target && ptr && *ptr == '/') {
116 params.target = strdup(ptr);
119 params.target_used = false;
122 buf = ptr + (strlen(ptr) - 3);
124 if (strcmp(buf, ".ko"))
125 params.uprobes = true;
132 static int parse_probe_event_argv(int argc, const char **argv)
134 int i, len, ret, found_target;
137 found_target = set_target(argv[0]);
138 if (found_target < 0)
141 if (found_target && argc == 1)
144 /* Bind up rest arguments */
146 for (i = 0; i < argc; i++) {
147 if (i == 0 && found_target)
150 len += strlen(argv[i]) + 1;
152 buf = zalloc(len + 1);
156 for (i = 0; i < argc; i++) {
157 if (i == 0 && found_target)
160 len += sprintf(&buf[len], "%s ", argv[i]);
162 ret = parse_probe_event(buf);
167 static int opt_set_target(const struct option *opt, const char *str,
168 int unset __maybe_unused)
174 if (!strcmp(opt->long_name, "exec"))
175 params.uprobes = true;
176 else if (!strcmp(opt->long_name, "module"))
177 params.uprobes = false;
181 /* Expand given path to absolute path, except for modulename */
182 if (params.uprobes || strchr(str, '/')) {
183 tmp = nsinfo__realpath(str, params.nsi);
185 pr_warning("Failed to get the absolute path of %s: %m\n", str);
195 params.target_used = false;
202 static int opt_set_target_ns(const struct option *opt __maybe_unused,
203 const char *str, int unset __maybe_unused)
211 ns_pid = (pid_t)strtol(str, NULL, 10);
214 pr_warning("Failed to parse %s as a pid: %s\n", str,
218 nsip = nsinfo__new(ns_pid);
219 if (nsip && nsip->need_setns)
220 params.nsi = nsinfo__get(nsip);
230 /* Command option callbacks */
232 #ifdef HAVE_DWARF_SUPPORT
233 static int opt_show_lines(const struct option *opt,
234 const char *str, int unset __maybe_unused)
241 if (params.command == 'L') {
242 pr_warning("Warning: more than one --line options are"
243 " detected. Only the first one is valid.\n");
247 params.command = opt->short_name;
248 ret = parse_line_range_desc(str, ¶ms.line_range);
253 static int opt_show_vars(const struct option *opt,
254 const char *str, int unset __maybe_unused)
256 struct perf_probe_event *pev = ¶ms.events[params.nevents];
262 ret = parse_probe_event(str);
263 if (!ret && pev->nargs != 0) {
264 pr_err(" Error: '--vars' doesn't accept arguments.\n");
267 params.command = opt->short_name;
272 # define opt_show_lines NULL
273 # define opt_show_vars NULL
275 static int opt_add_probe_event(const struct option *opt,
276 const char *str, int unset __maybe_unused)
279 params.command = opt->short_name;
280 return parse_probe_event(str);
286 static int opt_set_filter_with_command(const struct option *opt,
287 const char *str, int unset)
290 params.command = opt->short_name;
293 return params_add_filter(str);
298 static int opt_set_filter(const struct option *opt __maybe_unused,
299 const char *str, int unset __maybe_unused)
302 return params_add_filter(str);
307 static int init_params(void)
309 return line_range__init(¶ms.line_range);
312 static void cleanup_params(void)
316 for (i = 0; i < params.nevents; i++)
317 clear_perf_probe_event(params.events + i);
318 line_range__clear(¶ms.line_range);
320 strfilter__delete(params.filter);
321 nsinfo__put(params.nsi);
322 memset(¶ms, 0, sizeof(params));
325 static void pr_err_with_code(const char *msg, int err)
327 char sbuf[STRERR_BUFSIZE];
330 pr_debug(" Reason: %s (Code: %d)",
331 str_error_r(-err, sbuf, sizeof(sbuf)), err);
335 static int perf_add_probe_events(struct perf_probe_event *pevs, int npevs)
339 const char *event = NULL, *group = NULL;
341 ret = init_probe_symbol_maps(pevs->uprobes);
345 ret = convert_perf_probe_events(pevs, npevs);
349 if (params.command == 'D') { /* it shows definition */
350 if (probe_conf.bootconfig)
351 ret = show_bootconfig_events(pevs, npevs);
353 ret = show_probe_trace_events(pevs, npevs);
357 ret = apply_perf_probe_events(pevs, npevs);
361 for (i = k = 0; i < npevs; i++)
364 pr_info("Added new event%s\n", (k > 1) ? "s:" : ":");
365 for (i = 0; i < npevs; i++) {
366 struct perf_probe_event *pev = &pevs[i];
368 for (k = 0; k < pev->ntevs; k++) {
369 struct probe_trace_event *tev = &pev->tevs[k];
370 /* Skipped events have no event name */
374 /* We use tev's name for showing new events */
375 show_perf_probe_event(tev->group, tev->event, pev,
376 tev->point.module, false);
378 /* Save the last valid name */
384 /* Note that it is possible to skip all events because of blacklist */
386 /* Show how to use the event. */
387 pr_info("\nYou can now use it in all perf tools, such as:\n\n");
388 pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", group, event);
392 cleanup_perf_probe_events(pevs, npevs);
393 exit_probe_symbol_maps();
397 static int del_perf_probe_caches(struct strfilter *filter)
399 struct probe_cache *cache;
400 struct strlist *bidlist;
404 bidlist = build_id_cache__list_all(false);
407 pr_debug("Failed to get buildids: %d\n", ret);
408 return ret ?: -ENOMEM;
411 strlist__for_each_entry(nd, bidlist) {
412 cache = probe_cache__new(nd->s, NULL);
415 if (probe_cache__filter_purge(cache, filter) < 0 ||
416 probe_cache__commit(cache) < 0)
417 pr_warning("Failed to remove entries for %s\n", nd->s);
418 probe_cache__delete(cache);
423 static int perf_del_probe_events(struct strfilter *filter)
425 int ret, ret2, ufd = -1, kfd = -1;
426 char *str = strfilter__string(filter);
427 struct strlist *klist = NULL, *ulist = NULL;
428 struct str_node *ent;
433 pr_debug("Delete filter: \'%s\'\n", str);
435 if (probe_conf.cache)
436 return del_perf_probe_caches(filter);
438 /* Get current event names */
439 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
443 klist = strlist__new(NULL, NULL);
444 ulist = strlist__new(NULL, NULL);
445 if (!klist || !ulist) {
450 ret = probe_file__get_events(kfd, filter, klist);
452 strlist__for_each_entry(ent, klist)
453 pr_info("Removed event: %s\n", ent->s);
455 ret = probe_file__del_strlist(kfd, klist);
458 } else if (ret == -ENOMEM)
461 ret2 = probe_file__get_events(ufd, filter, ulist);
463 strlist__for_each_entry(ent, ulist)
464 pr_info("Removed event: %s\n", ent->s);
466 ret2 = probe_file__del_strlist(ufd, ulist);
469 } else if (ret2 == -ENOMEM)
472 if (ret == -ENOENT && ret2 == -ENOENT)
473 pr_warning("\"%s\" does not hit any event.\n", str);
483 strlist__delete(klist);
484 strlist__delete(ulist);
490 #ifdef HAVE_DWARF_SUPPORT
491 #define PROBEDEF_STR \
492 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT [[NAME=]ARG ...]"
494 #define PROBEDEF_STR "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]"
499 __cmd_probe(int argc, const char **argv)
501 const char * const probe_usage[] = {
502 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
503 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
504 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
505 "perf probe --list [GROUP:]EVENT ...",
506 #ifdef HAVE_DWARF_SUPPORT
507 "perf probe [<options>] --line 'LINEDESC'",
508 "perf probe [<options>] --vars 'PROBEPOINT'",
510 "perf probe [<options>] --funcs",
513 struct option options[] = {
514 OPT_INCR('v', "verbose", &verbose,
515 "be more verbose (show parsed arguments, etc)"),
516 OPT_BOOLEAN('q', "quiet", ¶ms.quiet,
517 "be quiet (do not show any messages)"),
518 OPT_CALLBACK_DEFAULT('l', "list", NULL, "[GROUP:]EVENT",
519 "list up probe events",
520 opt_set_filter_with_command, DEFAULT_LIST_FILTER),
521 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
522 opt_set_filter_with_command),
523 OPT_CALLBACK('a', "add", NULL, PROBEDEF_STR,
524 "probe point definition, where\n"
525 "\t\tGROUP:\tGroup name (optional)\n"
526 "\t\tEVENT:\tEvent name\n"
527 "\t\tFUNC:\tFunction name\n"
528 "\t\tOFF:\tOffset from function entry (in byte)\n"
529 "\t\t%return:\tPut the probe at function return\n"
530 #ifdef HAVE_DWARF_SUPPORT
531 "\t\tSRC:\tSource code path\n"
532 "\t\tRL:\tRelative line number from function entry.\n"
533 "\t\tAL:\tAbsolute line number in file.\n"
534 "\t\tPT:\tLazy expression of line code.\n"
535 "\t\tARG:\tProbe argument (local variable name or\n"
536 "\t\t\tkprobe-tracer argument format.)\n",
538 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
540 opt_add_probe_event),
541 OPT_CALLBACK('D', "definition", NULL, PROBEDEF_STR,
542 "Show trace event definition of given traceevent for k/uprobe_events.",
543 opt_add_probe_event),
544 OPT_BOOLEAN('f', "force", &probe_conf.force_add, "forcibly add events"
545 " with existing name"),
546 OPT_CALLBACK('L', "line", NULL,
547 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
548 "Show source code lines.", opt_show_lines),
549 OPT_CALLBACK('V', "vars", NULL,
550 "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
551 "Show accessible variables on PROBEDEF", opt_show_vars),
552 OPT_BOOLEAN('\0', "externs", &probe_conf.show_ext_vars,
553 "Show external variables too (with --vars only)"),
554 OPT_BOOLEAN('\0', "range", &probe_conf.show_location_range,
555 "Show variables location range in scope (with --vars only)"),
556 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
557 "file", "vmlinux pathname"),
558 OPT_STRING('s', "source", &symbol_conf.source_prefix,
559 "directory", "path to kernel source"),
560 OPT_BOOLEAN('\0', "no-inlines", &probe_conf.no_inlines,
561 "Don't search inlined functions"),
562 OPT__DRY_RUN(&probe_event_dry_run),
563 OPT_INTEGER('\0', "max-probes", &probe_conf.max_probes,
564 "Set how many probe points can be found for a probe."),
565 OPT_CALLBACK_DEFAULT('F', "funcs", NULL, "[FILTER]",
566 "Show potential probe-able functions.",
567 opt_set_filter_with_command, DEFAULT_FUNC_FILTER),
568 OPT_CALLBACK('\0', "filter", NULL,
569 "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
570 "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
571 "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
573 OPT_CALLBACK('x', "exec", NULL, "executable|path",
574 "target executable name or path", opt_set_target),
575 OPT_CALLBACK('m', "module", NULL, "modname|path",
576 "target module name (for online) or path (for offline)",
578 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
579 "Enable symbol demangling"),
580 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
581 "Enable kernel symbol demangling"),
582 OPT_BOOLEAN(0, "cache", &probe_conf.cache, "Manipulate probe cache"),
583 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
584 "Look for files with symbols relative to this directory"),
585 OPT_CALLBACK(0, "target-ns", NULL, "pid",
586 "target pid for namespace contexts", opt_set_target_ns),
587 OPT_BOOLEAN(0, "bootconfig", &probe_conf.bootconfig,
588 "Output probe definition with bootconfig format"),
593 set_option_flag(options, 'a', "add", PARSE_OPT_EXCLUSIVE);
594 set_option_flag(options, 'd', "del", PARSE_OPT_EXCLUSIVE);
595 set_option_flag(options, 'D', "definition", PARSE_OPT_EXCLUSIVE);
596 set_option_flag(options, 'l', "list", PARSE_OPT_EXCLUSIVE);
597 #ifdef HAVE_DWARF_SUPPORT
598 set_option_flag(options, 'L', "line", PARSE_OPT_EXCLUSIVE);
599 set_option_flag(options, 'V', "vars", PARSE_OPT_EXCLUSIVE);
601 # define set_nobuild(s, l, c) set_option_nobuild(options, s, l, "NO_DWARF=1", c)
602 set_nobuild('L', "line", false);
603 set_nobuild('V', "vars", false);
604 set_nobuild('\0', "externs", false);
605 set_nobuild('\0', "range", false);
606 set_nobuild('k', "vmlinux", true);
607 set_nobuild('s', "source", true);
608 set_nobuild('\0', "no-inlines", true);
611 set_option_flag(options, 'F', "funcs", PARSE_OPT_EXCLUSIVE);
613 argc = parse_options(argc, argv, options, probe_usage,
614 PARSE_OPT_STOP_AT_NON_OPTION);
616 if (strcmp(argv[0], "-") == 0) {
617 usage_with_options_msg(probe_usage, options,
618 "'-' is not supported.\n");
620 if (params.command && params.command != 'a') {
621 usage_with_options_msg(probe_usage, options,
622 "another command except --add is set.\n");
624 ret = parse_probe_event_argv(argc, argv);
626 pr_err_with_code(" Error: Command Parse Error.", ret);
629 params.command = 'a';
634 pr_err(" Error: -v and -q are exclusive.\n");
640 if (probe_conf.max_probes == 0)
641 probe_conf.max_probes = MAX_PROBES;
644 * Only consider the user's kernel image path if given.
646 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
649 * Except for --list, --del and --add, other command doesn't depend
650 * nor change running kernel. So if user gives offline vmlinux,
651 * ignore its buildid.
653 if (!strchr("lda", params.command) && symbol_conf.vmlinux_name)
654 symbol_conf.ignore_vmlinux_buildid = true;
656 switch (params.command) {
658 if (params.uprobes) {
659 pr_err(" Error: Don't use --list with --exec.\n");
660 parse_options_usage(probe_usage, options, "l", true);
661 parse_options_usage(NULL, options, "x", true);
664 ret = show_perf_probe_events(params.filter);
666 pr_err_with_code(" Error: Failed to show event list.", ret);
669 ret = show_available_funcs(params.target, params.nsi,
670 params.filter, params.uprobes);
672 pr_err_with_code(" Error: Failed to show functions.", ret);
674 #ifdef HAVE_DWARF_SUPPORT
676 ret = show_line_range(¶ms.line_range, params.target,
677 params.nsi, params.uprobes);
679 pr_err_with_code(" Error: Failed to show lines.", ret);
683 params.filter = strfilter__new(DEFAULT_VAR_FILTER,
686 ret = show_available_vars(params.events, params.nevents,
689 pr_err_with_code(" Error: Failed to show vars.", ret);
693 ret = perf_del_probe_events(params.filter);
695 pr_err_with_code(" Error: Failed to delete events.", ret);
700 if (probe_conf.bootconfig && params.uprobes) {
701 pr_err(" Error: --bootconfig doesn't support uprobes.\n");
707 /* Ensure the last given target is used */
708 if (params.target && !params.target_used) {
709 pr_err(" Error: -x/-m must follow the probe definitions.\n");
710 parse_options_usage(probe_usage, options, "m", true);
711 parse_options_usage(NULL, options, "x", true);
715 ret = perf_add_probe_events(params.events, params.nevents);
719 * When perf_add_probe_events() fails it calls
720 * cleanup_perf_probe_events(pevs, npevs), i.e.
721 * cleanup_perf_probe_events(params.events, params.nevents), which
722 * will call clear_perf_probe_event(), so set nevents to zero
723 * to avoid cleanup_params() to call clear_perf_probe_event() again
727 pr_err_with_code(" Error: Failed to add events.", ret);
732 usage_with_options(probe_usage, options);
737 int cmd_probe(int argc, const char **argv)
743 ret = __cmd_probe(argc, argv);
747 return ret < 0 ? ret : 0;