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 */
59 struct perf_probe_event events[MAX_PROBES];
60 struct strlist *dellist;
61 struct line_range line_range;
64 struct strfilter *filter;
67 /* Parse an event definition. Note that any error must die. */
68 static int parse_probe_event(const char *str)
70 struct perf_probe_event *pev = ¶ms.events[params.nevents];
73 pr_debug("probe-definition(%d): %s\n", params.nevents, str);
74 if (++params.nevents == MAX_PROBES) {
75 pr_err("Too many probes (> %d) were specified.", MAX_PROBES);
79 pev->uprobes = params.uprobes;
81 /* Parse a perf-probe command into event */
82 ret = parse_perf_probe_command(str, pev);
83 pr_debug("%d arguments\n", pev->nargs);
88 static int set_target(const char *ptr)
94 * The first argument after options can be an absolute path
95 * to an executable / library or kernel module.
97 * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
100 if (!params.target && ptr && *ptr == '/') {
103 buf = ptr + (strlen(ptr) - 3);
105 if (strcmp(buf, ".ko"))
106 params.uprobes = true;
113 static int parse_probe_event_argv(int argc, const char **argv)
115 int i, len, ret, found_target;
118 found_target = set_target(argv[0]);
119 if (found_target && argc == 1)
122 /* Bind up rest arguments */
124 for (i = 0; i < argc; i++) {
125 if (i == 0 && found_target)
128 len += strlen(argv[i]) + 1;
130 buf = zalloc(len + 1);
134 for (i = 0; i < argc; i++) {
135 if (i == 0 && found_target)
138 len += sprintf(&buf[len], "%s ", argv[i]);
140 params.mod_events = true;
141 ret = parse_probe_event(buf);
146 static int opt_add_probe_event(const struct option *opt __maybe_unused,
147 const char *str, int unset __maybe_unused)
150 params.mod_events = true;
151 return parse_probe_event(str);
156 static int opt_del_probe_event(const struct option *opt __maybe_unused,
157 const char *str, int unset __maybe_unused)
160 params.mod_events = true;
162 params.dellist = strlist__new(true, NULL);
163 strlist__add(params.dellist, str);
168 static int opt_set_target(const struct option *opt, const char *str,
169 int unset __maybe_unused)
174 if (str && !params.target) {
175 if (!strcmp(opt->long_name, "exec"))
176 params.uprobes = true;
177 #ifdef HAVE_DWARF_SUPPORT
178 else if (!strcmp(opt->long_name, "module"))
179 params.uprobes = false;
184 /* Expand given path to absolute path, except for modulename */
185 if (params.uprobes || strchr(str, '/')) {
186 tmp = realpath(str, NULL);
188 pr_warning("Failed to get the absolute path of %s: %m\n", str);
203 #ifdef HAVE_DWARF_SUPPORT
204 static int opt_show_lines(const struct option *opt __maybe_unused,
205 const char *str, int unset __maybe_unused)
212 if (params.show_lines) {
213 pr_warning("Warning: more than one --line options are"
214 " detected. Only the first one is valid.\n");
218 params.show_lines = true;
219 ret = parse_line_range_desc(str, ¶ms.line_range);
220 INIT_LIST_HEAD(¶ms.line_range.line_list);
225 static int opt_show_vars(const struct option *opt __maybe_unused,
226 const char *str, int unset __maybe_unused)
228 struct perf_probe_event *pev = ¶ms.events[params.nevents];
234 ret = parse_probe_event(str);
235 if (!ret && pev->nargs != 0) {
236 pr_err(" Error: '--vars' doesn't accept arguments.\n");
239 params.show_vars = true;
245 static int opt_set_filter(const struct option *opt __maybe_unused,
246 const char *str, int unset __maybe_unused)
251 pr_debug2("Set filter: %s\n", str);
253 strfilter__delete(params.filter);
254 params.filter = strfilter__new(str, &err);
255 if (!params.filter) {
256 pr_err("Filter parse error at %td.\n", err - str + 1);
257 pr_err("Source: \"%s\"\n", str);
258 pr_err(" %*c\n", (int)(err - str + 1), '^');
266 int cmd_probe(int argc, const char **argv, const char *prefix __maybe_unused)
268 const char * const probe_usage[] = {
269 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
270 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
271 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
273 #ifdef HAVE_DWARF_SUPPORT
274 "perf probe [<options>] --line 'LINEDESC'",
275 "perf probe [<options>] --vars 'PROBEPOINT'",
279 const struct option options[] = {
280 OPT_INCR('v', "verbose", &verbose,
281 "be more verbose (show parsed arguments, etc)"),
282 OPT_BOOLEAN('l', "list", ¶ms.list_events,
283 "list up current probe events"),
284 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
285 opt_del_probe_event),
286 OPT_CALLBACK('a', "add", NULL,
287 #ifdef HAVE_DWARF_SUPPORT
288 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
291 "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]",
293 "probe point definition, where\n"
294 "\t\tGROUP:\tGroup name (optional)\n"
295 "\t\tEVENT:\tEvent name\n"
296 "\t\tFUNC:\tFunction name\n"
297 "\t\tOFF:\tOffset from function entry (in byte)\n"
298 "\t\t%return:\tPut the probe at function return\n"
299 #ifdef HAVE_DWARF_SUPPORT
300 "\t\tSRC:\tSource code path\n"
301 "\t\tRL:\tRelative line number from function entry.\n"
302 "\t\tAL:\tAbsolute line number in file.\n"
303 "\t\tPT:\tLazy expression of line code.\n"
304 "\t\tARG:\tProbe argument (local variable name or\n"
305 "\t\t\tkprobe-tracer argument format.)\n",
307 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
309 opt_add_probe_event),
310 OPT_BOOLEAN('f', "force", ¶ms.force_add, "forcibly add events"
311 " with existing name"),
312 #ifdef HAVE_DWARF_SUPPORT
313 OPT_CALLBACK('L', "line", NULL,
314 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
315 "Show source code lines.", opt_show_lines),
316 OPT_CALLBACK('V', "vars", NULL,
317 "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
318 "Show accessible variables on PROBEDEF", opt_show_vars),
319 OPT_BOOLEAN('\0', "externs", ¶ms.show_ext_vars,
320 "Show external variables too (with --vars only)"),
321 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
322 "file", "vmlinux pathname"),
323 OPT_STRING('s', "source", &symbol_conf.source_prefix,
324 "directory", "path to kernel source"),
325 OPT_CALLBACK('m', "module", NULL, "modname|path",
326 "target module name (for online) or path (for offline)",
329 OPT__DRY_RUN(&probe_event_dry_run),
330 OPT_INTEGER('\0', "max-probes", ¶ms.max_probe_points,
331 "Set how many probe points can be found for a probe."),
332 OPT_BOOLEAN('F', "funcs", ¶ms.show_funcs,
333 "Show potential probe-able functions."),
334 OPT_CALLBACK('\0', "filter", NULL,
335 "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
336 "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
337 "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
339 OPT_CALLBACK('x', "exec", NULL, "executable|path",
340 "target executable name or path", opt_set_target),
341 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
342 "Disable symbol demangling"),
347 argc = parse_options(argc, argv, options, probe_usage,
348 PARSE_OPT_STOP_AT_NON_OPTION);
350 if (strcmp(argv[0], "-") == 0) {
351 pr_warning(" Error: '-' is not supported.\n");
352 usage_with_options(probe_usage, options);
354 ret = parse_probe_event_argv(argc, argv);
356 pr_err(" Error: Parse Error. (%d)\n", ret);
361 if (params.max_probe_points == 0)
362 params.max_probe_points = MAX_PROBES;
364 if ((!params.nevents && !params.dellist && !params.list_events &&
365 !params.show_lines && !params.show_funcs))
366 usage_with_options(probe_usage, options);
369 * Only consider the user's kernel image path if given.
371 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
373 if (params.list_events) {
374 if (params.mod_events) {
375 pr_err(" Error: Don't use --list with --add/--del.\n");
376 usage_with_options(probe_usage, options);
378 if (params.show_lines) {
379 pr_err(" Error: Don't use --list with --line.\n");
380 usage_with_options(probe_usage, options);
382 if (params.show_vars) {
383 pr_err(" Error: Don't use --list with --vars.\n");
384 usage_with_options(probe_usage, options);
386 if (params.show_funcs) {
387 pr_err(" Error: Don't use --list with --funcs.\n");
388 usage_with_options(probe_usage, options);
390 if (params.uprobes) {
391 pr_warning(" Error: Don't use --list with --exec.\n");
392 usage_with_options(probe_usage, options);
394 ret = show_perf_probe_events();
396 pr_err(" Error: Failed to show event list. (%d)\n",
400 if (params.show_funcs) {
401 if (params.nevents != 0 || params.dellist) {
402 pr_err(" Error: Don't use --funcs with"
404 usage_with_options(probe_usage, options);
406 if (params.show_lines) {
407 pr_err(" Error: Don't use --funcs with --line.\n");
408 usage_with_options(probe_usage, options);
410 if (params.show_vars) {
411 pr_err(" Error: Don't use --funcs with --vars.\n");
412 usage_with_options(probe_usage, options);
415 params.filter = strfilter__new(DEFAULT_FUNC_FILTER,
417 ret = show_available_funcs(params.target, params.filter,
419 strfilter__delete(params.filter);
421 pr_err(" Error: Failed to show functions."
426 #ifdef HAVE_DWARF_SUPPORT
427 if (params.show_lines) {
428 if (params.mod_events) {
429 pr_err(" Error: Don't use --line with"
431 usage_with_options(probe_usage, options);
433 if (params.show_vars) {
434 pr_err(" Error: Don't use --line with --vars.\n");
435 usage_with_options(probe_usage, options);
438 ret = show_line_range(¶ms.line_range, params.target);
440 pr_err(" Error: Failed to show lines. (%d)\n", ret);
443 if (params.show_vars) {
444 if (params.mod_events) {
445 pr_err(" Error: Don't use --vars with"
447 usage_with_options(probe_usage, options);
450 params.filter = strfilter__new(DEFAULT_VAR_FILTER,
453 ret = show_available_vars(params.events, params.nevents,
454 params.max_probe_points,
457 params.show_ext_vars);
458 strfilter__delete(params.filter);
460 pr_err(" Error: Failed to show vars. (%d)\n", ret);
465 if (params.dellist) {
466 ret = del_perf_probe_events(params.dellist);
467 strlist__delete(params.dellist);
469 pr_err(" Error: Failed to delete events. (%d)\n", ret);
474 if (params.nevents) {
475 ret = add_perf_probe_events(params.events, params.nevents,
476 params.max_probe_points,
480 pr_err(" Error: Failed to add events. (%d)\n", ret);