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 <api/fs/debugfs.h>
41 #include "util/parse-options.h"
42 #include "util/probe-finder.h"
43 #include "util/probe-event.h"
45 #define DEFAULT_VAR_FILTER "!__k???tab_* & !__crc_*"
46 #define DEFAULT_FUNC_FILTER "!_*"
48 /* Session management structure */
61 struct perf_probe_event events[MAX_PROBES];
62 struct strlist *dellist;
63 struct line_range line_range;
66 struct strfilter *filter;
69 /* Parse an event definition. Note that any error must die. */
70 static int parse_probe_event(const char *str)
72 struct perf_probe_event *pev = ¶ms.events[params.nevents];
75 pr_debug("probe-definition(%d): %s\n", params.nevents, str);
76 if (++params.nevents == MAX_PROBES) {
77 pr_err("Too many probes (> %d) were specified.", MAX_PROBES);
81 pev->uprobes = params.uprobes;
83 pev->target = strdup(params.target);
86 params.target_used = true;
89 /* Parse a perf-probe command into event */
90 ret = parse_perf_probe_command(str, pev);
91 pr_debug("%d arguments\n", pev->nargs);
96 static int set_target(const char *ptr)
102 * The first argument after options can be an absolute path
103 * to an executable / library or kernel module.
105 * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
108 if (!params.target && ptr && *ptr == '/') {
109 params.target = strdup(ptr);
112 params.target_used = false;
115 buf = ptr + (strlen(ptr) - 3);
117 if (strcmp(buf, ".ko"))
118 params.uprobes = true;
125 static int parse_probe_event_argv(int argc, const char **argv)
127 int i, len, ret, found_target;
130 found_target = set_target(argv[0]);
131 if (found_target < 0)
134 if (found_target && argc == 1)
137 /* Bind up rest arguments */
139 for (i = 0; i < argc; i++) {
140 if (i == 0 && found_target)
143 len += strlen(argv[i]) + 1;
145 buf = zalloc(len + 1);
149 for (i = 0; i < argc; i++) {
150 if (i == 0 && found_target)
153 len += sprintf(&buf[len], "%s ", argv[i]);
155 params.mod_events = true;
156 ret = parse_probe_event(buf);
161 static int opt_add_probe_event(const struct option *opt __maybe_unused,
162 const char *str, int unset __maybe_unused)
165 params.mod_events = true;
166 return parse_probe_event(str);
171 static int opt_del_probe_event(const struct option *opt __maybe_unused,
172 const char *str, int unset __maybe_unused)
175 params.mod_events = true;
177 params.dellist = strlist__new(true, NULL);
178 strlist__add(params.dellist, str);
183 static int opt_set_target(const struct option *opt, const char *str,
184 int unset __maybe_unused)
190 if (!strcmp(opt->long_name, "exec"))
191 params.uprobes = true;
192 #ifdef HAVE_DWARF_SUPPORT
193 else if (!strcmp(opt->long_name, "module"))
194 params.uprobes = false;
199 /* Expand given path to absolute path, except for modulename */
200 if (params.uprobes || strchr(str, '/')) {
201 tmp = realpath(str, NULL);
203 pr_warning("Failed to get the absolute path of %s: %m\n", str);
213 params.target_used = false;
220 #ifdef HAVE_DWARF_SUPPORT
221 static int opt_show_lines(const struct option *opt __maybe_unused,
222 const char *str, int unset __maybe_unused)
229 if (params.show_lines) {
230 pr_warning("Warning: more than one --line options are"
231 " detected. Only the first one is valid.\n");
235 params.show_lines = true;
236 ret = parse_line_range_desc(str, ¶ms.line_range);
241 static int opt_show_vars(const struct option *opt __maybe_unused,
242 const char *str, int unset __maybe_unused)
244 struct perf_probe_event *pev = ¶ms.events[params.nevents];
250 ret = parse_probe_event(str);
251 if (!ret && pev->nargs != 0) {
252 pr_err(" Error: '--vars' doesn't accept arguments.\n");
255 params.show_vars = true;
261 static int opt_set_filter(const struct option *opt __maybe_unused,
262 const char *str, int unset __maybe_unused)
267 pr_debug2("Set filter: %s\n", str);
269 strfilter__delete(params.filter);
270 params.filter = strfilter__new(str, &err);
271 if (!params.filter) {
272 pr_err("Filter parse error at %td.\n", err - str + 1);
273 pr_err("Source: \"%s\"\n", str);
274 pr_err(" %*c\n", (int)(err - str + 1), '^');
282 static int init_params(void)
284 return line_range__init(¶ms.line_range);
287 static void cleanup_params(void)
291 for (i = 0; i < params.nevents; i++)
292 clear_perf_probe_event(params.events + i);
294 strlist__delete(params.dellist);
295 line_range__clear(¶ms.line_range);
298 strfilter__delete(params.filter);
299 memset(¶ms, 0, sizeof(params));
302 static void pr_err_with_code(const char *msg, int err)
304 char sbuf[STRERR_BUFSIZE];
307 pr_debug(" Reason: %s (Code: %d)",
308 strerror_r(-err, sbuf, sizeof(sbuf)), err);
313 __cmd_probe(int argc, const char **argv, const char *prefix __maybe_unused)
315 const char * const probe_usage[] = {
316 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
317 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
318 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
320 #ifdef HAVE_DWARF_SUPPORT
321 "perf probe [<options>] --line 'LINEDESC'",
322 "perf probe [<options>] --vars 'PROBEPOINT'",
326 struct option options[] = {
327 OPT_INCR('v', "verbose", &verbose,
328 "be more verbose (show parsed arguments, etc)"),
329 OPT_BOOLEAN('q', "quiet", ¶ms.quiet,
330 "be quiet (do not show any mesages)"),
331 OPT_BOOLEAN('l', "list", ¶ms.list_events,
332 "list up current probe events"),
333 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
334 opt_del_probe_event),
335 OPT_CALLBACK('a', "add", NULL,
336 #ifdef HAVE_DWARF_SUPPORT
337 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
340 "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]",
342 "probe point definition, where\n"
343 "\t\tGROUP:\tGroup name (optional)\n"
344 "\t\tEVENT:\tEvent name\n"
345 "\t\tFUNC:\tFunction name\n"
346 "\t\tOFF:\tOffset from function entry (in byte)\n"
347 "\t\t%return:\tPut the probe at function return\n"
348 #ifdef HAVE_DWARF_SUPPORT
349 "\t\tSRC:\tSource code path\n"
350 "\t\tRL:\tRelative line number from function entry.\n"
351 "\t\tAL:\tAbsolute line number in file.\n"
352 "\t\tPT:\tLazy expression of line code.\n"
353 "\t\tARG:\tProbe argument (local variable name or\n"
354 "\t\t\tkprobe-tracer argument format.)\n",
356 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
358 opt_add_probe_event),
359 OPT_BOOLEAN('f', "force", ¶ms.force_add, "forcibly add events"
360 " with existing name"),
361 #ifdef HAVE_DWARF_SUPPORT
362 OPT_CALLBACK('L', "line", NULL,
363 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
364 "Show source code lines.", opt_show_lines),
365 OPT_CALLBACK('V', "vars", NULL,
366 "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
367 "Show accessible variables on PROBEDEF", opt_show_vars),
368 OPT_BOOLEAN('\0', "externs", ¶ms.show_ext_vars,
369 "Show external variables too (with --vars only)"),
370 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
371 "file", "vmlinux pathname"),
372 OPT_STRING('s', "source", &symbol_conf.source_prefix,
373 "directory", "path to kernel source"),
374 OPT_CALLBACK('m', "module", NULL, "modname|path",
375 "target module name (for online) or path (for offline)",
378 OPT__DRY_RUN(&probe_event_dry_run),
379 OPT_INTEGER('\0', "max-probes", ¶ms.max_probe_points,
380 "Set how many probe points can be found for a probe."),
381 OPT_BOOLEAN('F', "funcs", ¶ms.show_funcs,
382 "Show potential probe-able functions."),
383 OPT_CALLBACK('\0', "filter", NULL,
384 "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
385 "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
386 "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
388 OPT_CALLBACK('x', "exec", NULL, "executable|path",
389 "target executable name or path", opt_set_target),
390 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
391 "Enable symbol demangling"),
392 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
393 "Enable kernel symbol demangling"),
398 set_option_flag(options, 'a', "add", PARSE_OPT_EXCLUSIVE);
399 set_option_flag(options, 'd', "del", PARSE_OPT_EXCLUSIVE);
400 set_option_flag(options, 'l', "list", PARSE_OPT_EXCLUSIVE);
401 #ifdef HAVE_DWARF_SUPPORT
402 set_option_flag(options, 'L', "line", PARSE_OPT_EXCLUSIVE);
403 set_option_flag(options, 'V', "vars", PARSE_OPT_EXCLUSIVE);
406 argc = parse_options(argc, argv, options, probe_usage,
407 PARSE_OPT_STOP_AT_NON_OPTION);
409 if (strcmp(argv[0], "-") == 0) {
410 pr_warning(" Error: '-' is not supported.\n");
411 usage_with_options(probe_usage, options);
413 ret = parse_probe_event_argv(argc, argv);
415 pr_err_with_code(" Error: Command Parse Error.", ret);
422 pr_err(" Error: -v and -q are exclusive.\n");
428 if (params.max_probe_points == 0)
429 params.max_probe_points = MAX_PROBES;
431 if ((!params.nevents && !params.dellist && !params.list_events &&
432 !params.show_lines && !params.show_funcs))
433 usage_with_options(probe_usage, options);
436 * Only consider the user's kernel image path if given.
438 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
440 if (params.list_events) {
441 if (params.uprobes) {
442 pr_warning(" Error: Don't use --list with --exec.\n");
443 usage_with_options(probe_usage, options);
445 ret = show_perf_probe_events();
447 pr_err_with_code(" Error: Failed to show event list.", ret);
450 if (params.show_funcs) {
452 params.filter = strfilter__new(DEFAULT_FUNC_FILTER,
454 ret = show_available_funcs(params.target, params.filter,
456 strfilter__delete(params.filter);
457 params.filter = NULL;
459 pr_err_with_code(" Error: Failed to show functions.", ret);
463 #ifdef HAVE_DWARF_SUPPORT
464 if (params.show_lines) {
465 ret = show_line_range(¶ms.line_range, params.target,
468 pr_err_with_code(" Error: Failed to show lines.", ret);
471 if (params.show_vars) {
473 params.filter = strfilter__new(DEFAULT_VAR_FILTER,
476 ret = show_available_vars(params.events, params.nevents,
477 params.max_probe_points,
480 params.show_ext_vars);
481 strfilter__delete(params.filter);
482 params.filter = NULL;
484 pr_err_with_code(" Error: Failed to show vars.", ret);
489 if (params.dellist) {
490 ret = del_perf_probe_events(params.dellist);
492 pr_err_with_code(" Error: Failed to delete events.", ret);
497 if (params.nevents) {
498 /* Ensure the last given target is used */
499 if (params.target && !params.target_used) {
500 pr_warning(" Error: -x/-m must follow the probe definitions.\n");
501 usage_with_options(probe_usage, options);
504 ret = add_perf_probe_events(params.events, params.nevents,
505 params.max_probe_points,
508 pr_err_with_code(" Error: Failed to add events.", ret);
515 int cmd_probe(int argc, const char **argv, const char *prefix)
521 ret = __cmd_probe(argc, argv, prefix);