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 <lk/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
)
173 if (str
&& !params
.target
) {
174 if (!strcmp(opt
->long_name
, "exec"))
175 params
.uprobes
= true;
177 else if (!strcmp(opt
->long_name
, "module"))
178 params
.uprobes
= false;
191 static int opt_show_lines(const struct option
*opt __maybe_unused
,
192 const char *str
, int unset __maybe_unused
)
199 if (params
.show_lines
) {
200 pr_warning("Warning: more than one --line options are"
201 " detected. Only the first one is valid.\n");
205 params
.show_lines
= true;
206 ret
= parse_line_range_desc(str
, ¶ms
.line_range
);
207 INIT_LIST_HEAD(¶ms
.line_range
.line_list
);
212 static int opt_show_vars(const struct option
*opt __maybe_unused
,
213 const char *str
, int unset __maybe_unused
)
215 struct perf_probe_event
*pev
= ¶ms
.events
[params
.nevents
];
221 ret
= parse_probe_event(str
);
222 if (!ret
&& pev
->nargs
!= 0) {
223 pr_err(" Error: '--vars' doesn't accept arguments.\n");
226 params
.show_vars
= true;
232 static int opt_set_filter(const struct option
*opt __maybe_unused
,
233 const char *str
, int unset __maybe_unused
)
238 pr_debug2("Set filter: %s\n", str
);
240 strfilter__delete(params
.filter
);
241 params
.filter
= strfilter__new(str
, &err
);
242 if (!params
.filter
) {
243 pr_err("Filter parse error at %td.\n", err
- str
+ 1);
244 pr_err("Source: \"%s\"\n", str
);
245 pr_err(" %*c\n", (int)(err
- str
+ 1), '^');
253 int cmd_probe(int argc
, const char **argv
, const char *prefix __maybe_unused
)
255 const char * const probe_usage
[] = {
256 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
257 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
258 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
261 "perf probe [<options>] --line 'LINEDESC'",
262 "perf probe [<options>] --vars 'PROBEPOINT'",
266 const struct option options
[] = {
267 OPT_INCR('v', "verbose", &verbose
,
268 "be more verbose (show parsed arguments, etc)"),
269 OPT_BOOLEAN('l', "list", ¶ms
.list_events
,
270 "list up current probe events"),
271 OPT_CALLBACK('d', "del", NULL
, "[GROUP:]EVENT", "delete a probe event.",
272 opt_del_probe_event
),
273 OPT_CALLBACK('a', "add", NULL
,
275 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
278 "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]",
280 "probe point definition, where\n"
281 "\t\tGROUP:\tGroup name (optional)\n"
282 "\t\tEVENT:\tEvent name\n"
283 "\t\tFUNC:\tFunction name\n"
284 "\t\tOFF:\tOffset from function entry (in byte)\n"
285 "\t\t%return:\tPut the probe at function return\n"
287 "\t\tSRC:\tSource code path\n"
288 "\t\tRL:\tRelative line number from function entry.\n"
289 "\t\tAL:\tAbsolute line number in file.\n"
290 "\t\tPT:\tLazy expression of line code.\n"
291 "\t\tARG:\tProbe argument (local variable name or\n"
292 "\t\t\tkprobe-tracer argument format.)\n",
294 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
296 opt_add_probe_event
),
297 OPT_BOOLEAN('f', "force", ¶ms
.force_add
, "forcibly add events"
298 " with existing name"),
300 OPT_CALLBACK('L', "line", NULL
,
301 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
302 "Show source code lines.", opt_show_lines
),
303 OPT_CALLBACK('V', "vars", NULL
,
304 "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
305 "Show accessible variables on PROBEDEF", opt_show_vars
),
306 OPT_BOOLEAN('\0', "externs", ¶ms
.show_ext_vars
,
307 "Show external variables too (with --vars only)"),
308 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
309 "file", "vmlinux pathname"),
310 OPT_STRING('s', "source", &symbol_conf
.source_prefix
,
311 "directory", "path to kernel source"),
312 OPT_CALLBACK('m', "module", NULL
, "modname|path",
313 "target module name (for online) or path (for offline)",
316 OPT__DRY_RUN(&probe_event_dry_run
),
317 OPT_INTEGER('\0', "max-probes", ¶ms
.max_probe_points
,
318 "Set how many probe points can be found for a probe."),
319 OPT_BOOLEAN('F', "funcs", ¶ms
.show_funcs
,
320 "Show potential probe-able functions."),
321 OPT_CALLBACK('\0', "filter", NULL
,
322 "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
323 "\t\t\t(default: \"" DEFAULT_VAR_FILTER
"\" for --vars,\n"
324 "\t\t\t \"" DEFAULT_FUNC_FILTER
"\" for --funcs)",
326 OPT_CALLBACK('x', "exec", NULL
, "executable|path",
327 "target executable name or path", opt_set_target
),
332 argc
= parse_options(argc
, argv
, options
, probe_usage
,
333 PARSE_OPT_STOP_AT_NON_OPTION
);
335 if (strcmp(argv
[0], "-") == 0) {
336 pr_warning(" Error: '-' is not supported.\n");
337 usage_with_options(probe_usage
, options
);
339 ret
= parse_probe_event_argv(argc
, argv
);
341 pr_err(" Error: Parse Error. (%d)\n", ret
);
346 if (params
.max_probe_points
== 0)
347 params
.max_probe_points
= MAX_PROBES
;
349 if ((!params
.nevents
&& !params
.dellist
&& !params
.list_events
&&
350 !params
.show_lines
&& !params
.show_funcs
))
351 usage_with_options(probe_usage
, options
);
354 * Only consider the user's kernel image path if given.
356 symbol_conf
.try_vmlinux_path
= (symbol_conf
.vmlinux_name
== NULL
);
358 if (params
.list_events
) {
359 if (params
.mod_events
) {
360 pr_err(" Error: Don't use --list with --add/--del.\n");
361 usage_with_options(probe_usage
, options
);
363 if (params
.show_lines
) {
364 pr_err(" Error: Don't use --list with --line.\n");
365 usage_with_options(probe_usage
, options
);
367 if (params
.show_vars
) {
368 pr_err(" Error: Don't use --list with --vars.\n");
369 usage_with_options(probe_usage
, options
);
371 if (params
.show_funcs
) {
372 pr_err(" Error: Don't use --list with --funcs.\n");
373 usage_with_options(probe_usage
, options
);
375 if (params
.uprobes
) {
376 pr_warning(" Error: Don't use --list with --exec.\n");
377 usage_with_options(probe_usage
, options
);
379 ret
= show_perf_probe_events();
381 pr_err(" Error: Failed to show event list. (%d)\n",
385 if (params
.show_funcs
) {
386 if (params
.nevents
!= 0 || params
.dellist
) {
387 pr_err(" Error: Don't use --funcs with"
389 usage_with_options(probe_usage
, options
);
391 if (params
.show_lines
) {
392 pr_err(" Error: Don't use --funcs with --line.\n");
393 usage_with_options(probe_usage
, options
);
395 if (params
.show_vars
) {
396 pr_err(" Error: Don't use --funcs with --vars.\n");
397 usage_with_options(probe_usage
, options
);
400 params
.filter
= strfilter__new(DEFAULT_FUNC_FILTER
,
402 ret
= show_available_funcs(params
.target
, params
.filter
,
404 strfilter__delete(params
.filter
);
406 pr_err(" Error: Failed to show functions."
412 if (params
.show_lines
&& !params
.uprobes
) {
413 if (params
.mod_events
) {
414 pr_err(" Error: Don't use --line with"
416 usage_with_options(probe_usage
, options
);
418 if (params
.show_vars
) {
419 pr_err(" Error: Don't use --line with --vars.\n");
420 usage_with_options(probe_usage
, options
);
423 ret
= show_line_range(¶ms
.line_range
, params
.target
);
425 pr_err(" Error: Failed to show lines. (%d)\n", ret
);
428 if (params
.show_vars
) {
429 if (params
.mod_events
) {
430 pr_err(" Error: Don't use --vars with"
432 usage_with_options(probe_usage
, options
);
435 params
.filter
= strfilter__new(DEFAULT_VAR_FILTER
,
438 ret
= show_available_vars(params
.events
, params
.nevents
,
439 params
.max_probe_points
,
442 params
.show_ext_vars
);
443 strfilter__delete(params
.filter
);
445 pr_err(" Error: Failed to show vars. (%d)\n", ret
);
450 if (params
.dellist
) {
451 ret
= del_perf_probe_events(params
.dellist
);
452 strlist__delete(params
.dellist
);
454 pr_err(" Error: Failed to delete events. (%d)\n", ret
);
459 if (params
.nevents
) {
460 ret
= add_perf_probe_events(params
.events
, params
.nevents
,
461 params
.max_probe_points
,
465 pr_err(" Error: Failed to add events. (%d)\n", ret
);