Commit | Line | Data |
---|---|---|
4ea42b18 MH |
1 | /* |
2 | * builtin-probe.c | |
3 | * | |
4 | * Builtin probe command: Set up probe events by C expression | |
5 | * | |
6 | * Written by Masami Hiramatsu <mhiramat@redhat.com> | |
7 | * | |
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. | |
12 | * | |
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. | |
17 | * | |
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. | |
21 | * | |
22 | */ | |
4ea42b18 MH |
23 | #include <sys/utsname.h> |
24 | #include <sys/types.h> | |
25 | #include <sys/stat.h> | |
26 | #include <fcntl.h> | |
27 | #include <errno.h> | |
28 | #include <stdio.h> | |
29 | #include <unistd.h> | |
30 | #include <stdlib.h> | |
31 | #include <string.h> | |
32 | ||
4ea42b18 MH |
33 | #include "perf.h" |
34 | #include "builtin.h" | |
35 | #include "util/util.h" | |
fa28244d | 36 | #include "util/strlist.h" |
bd09d7b5 | 37 | #include "util/strfilter.h" |
e0faa8d3 | 38 | #include "util/symbol.h" |
89c69c0e | 39 | #include "util/debug.h" |
96c96612 | 40 | #include "util/debugfs.h" |
4ea42b18 | 41 | #include "util/parse-options.h" |
4ea42b18 | 42 | #include "util/probe-finder.h" |
50656eec | 43 | #include "util/probe-event.h" |
4ea42b18 | 44 | |
bd09d7b5 | 45 | #define DEFAULT_VAR_FILTER "!__k???tab_* & !__crc_*" |
3c42258c | 46 | #define DEFAULT_FUNC_FILTER "!_*" |
4ea42b18 MH |
47 | |
48 | /* Session management structure */ | |
49 | static struct { | |
fac13fd5 | 50 | bool list_events; |
d761b08b | 51 | bool force_add; |
631c9def | 52 | bool show_lines; |
cf6eb489 | 53 | bool show_vars; |
fb8c5a56 | 54 | bool show_ext_vars; |
e80711ca | 55 | bool show_funcs; |
cf6eb489 | 56 | bool mod_events; |
4235b045 MH |
57 | int nevents; |
58 | struct perf_probe_event events[MAX_PROBES]; | |
fa28244d | 59 | struct strlist *dellist; |
631c9def | 60 | struct line_range line_range; |
4eced234 | 61 | const char *target; |
ef4a3565 | 62 | int max_probe_points; |
bd09d7b5 | 63 | struct strfilter *filter; |
12a1fadb | 64 | } params; |
4ea42b18 | 65 | |
253977b0 | 66 | /* Parse an event definition. Note that any error must die. */ |
146a1439 | 67 | static int parse_probe_event(const char *str) |
4ea42b18 | 68 | { |
4235b045 | 69 | struct perf_probe_event *pev = ¶ms.events[params.nevents]; |
146a1439 | 70 | int ret; |
4ea42b18 | 71 | |
4235b045 | 72 | pr_debug("probe-definition(%d): %s\n", params.nevents, str); |
8a7ddad8 ACM |
73 | if (++params.nevents == MAX_PROBES) { |
74 | pr_err("Too many probes (> %d) were specified.", MAX_PROBES); | |
75 | return -1; | |
76 | } | |
4ea42b18 | 77 | |
4235b045 | 78 | /* Parse a perf-probe command into event */ |
146a1439 | 79 | ret = parse_perf_probe_command(str, pev); |
4235b045 | 80 | pr_debug("%d arguments\n", pev->nargs); |
146a1439 MH |
81 | |
82 | return ret; | |
46ab4926 MH |
83 | } |
84 | ||
146a1439 | 85 | static int parse_probe_event_argv(int argc, const char **argv) |
d1bde3f7 | 86 | { |
146a1439 | 87 | int i, len, ret; |
d1bde3f7 MH |
88 | char *buf; |
89 | ||
90 | /* Bind up rest arguments */ | |
91 | len = 0; | |
92 | for (i = 0; i < argc; i++) | |
93 | len += strlen(argv[i]) + 1; | |
8a7ddad8 ACM |
94 | buf = zalloc(len + 1); |
95 | if (buf == NULL) | |
96 | return -ENOMEM; | |
d1bde3f7 MH |
97 | len = 0; |
98 | for (i = 0; i < argc; i++) | |
99 | len += sprintf(&buf[len], "%s ", argv[i]); | |
cf6eb489 | 100 | params.mod_events = true; |
146a1439 | 101 | ret = parse_probe_event(buf); |
d1bde3f7 | 102 | free(buf); |
146a1439 | 103 | return ret; |
d1bde3f7 MH |
104 | } |
105 | ||
253977b0 | 106 | static int opt_add_probe_event(const struct option *opt __used, |
46ab4926 MH |
107 | const char *str, int unset __used) |
108 | { | |
cf6eb489 MH |
109 | if (str) { |
110 | params.mod_events = true; | |
146a1439 | 111 | return parse_probe_event(str); |
cf6eb489 | 112 | } else |
146a1439 | 113 | return 0; |
4ea42b18 MH |
114 | } |
115 | ||
fa28244d MH |
116 | static int opt_del_probe_event(const struct option *opt __used, |
117 | const char *str, int unset __used) | |
118 | { | |
119 | if (str) { | |
cf6eb489 | 120 | params.mod_events = true; |
12a1fadb MH |
121 | if (!params.dellist) |
122 | params.dellist = strlist__new(true, NULL); | |
123 | strlist__add(params.dellist, str); | |
fa28244d MH |
124 | } |
125 | return 0; | |
126 | } | |
127 | ||
4b4da7f7 | 128 | #ifdef DWARF_SUPPORT |
0eda7385 HM |
129 | static int opt_show_lines(const struct option *opt __used, |
130 | const char *str, int unset __used) | |
131 | { | |
146a1439 MH |
132 | int ret = 0; |
133 | ||
13e27d76 MH |
134 | if (!str) |
135 | return 0; | |
136 | ||
137 | if (params.show_lines) { | |
138 | pr_warning("Warning: more than one --line options are" | |
139 | " detected. Only the first one is valid.\n"); | |
140 | return 0; | |
141 | } | |
142 | ||
12a1fadb | 143 | params.show_lines = true; |
13e27d76 MH |
144 | ret = parse_line_range_desc(str, ¶ms.line_range); |
145 | INIT_LIST_HEAD(¶ms.line_range.line_list); | |
146a1439 MH |
146 | |
147 | return ret; | |
0eda7385 | 148 | } |
cf6eb489 MH |
149 | |
150 | static int opt_show_vars(const struct option *opt __used, | |
151 | const char *str, int unset __used) | |
152 | { | |
153 | struct perf_probe_event *pev = ¶ms.events[params.nevents]; | |
154 | int ret; | |
155 | ||
156 | if (!str) | |
157 | return 0; | |
158 | ||
159 | ret = parse_probe_event(str); | |
160 | if (!ret && pev->nargs != 0) { | |
161 | pr_err(" Error: '--vars' doesn't accept arguments.\n"); | |
162 | return -EINVAL; | |
163 | } | |
164 | params.show_vars = true; | |
165 | ||
166 | return ret; | |
167 | } | |
3c42258c | 168 | #endif |
bd09d7b5 MH |
169 | |
170 | static int opt_set_filter(const struct option *opt __used, | |
171 | const char *str, int unset __used) | |
172 | { | |
173 | const char *err; | |
174 | ||
175 | if (str) { | |
176 | pr_debug2("Set filter: %s\n", str); | |
177 | if (params.filter) | |
178 | strfilter__delete(params.filter); | |
179 | params.filter = strfilter__new(str, &err); | |
180 | if (!params.filter) { | |
823c7164 | 181 | pr_err("Filter parse error at %td.\n", err - str + 1); |
bd09d7b5 MH |
182 | pr_err("Source: \"%s\"\n", str); |
183 | pr_err(" %*c\n", (int)(err - str + 1), '^'); | |
184 | return -EINVAL; | |
185 | } | |
186 | } | |
187 | ||
188 | return 0; | |
189 | } | |
4ea42b18 MH |
190 | |
191 | static const char * const probe_usage[] = { | |
46ab4926 MH |
192 | "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]", |
193 | "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]", | |
fa28244d | 194 | "perf probe [<options>] --del '[GROUP:]EVENT' ...", |
4de189fe | 195 | "perf probe --list", |
4b4da7f7 | 196 | #ifdef DWARF_SUPPORT |
469b9b88 MH |
197 | "perf probe [<options>] --line 'LINEDESC'", |
198 | "perf probe [<options>] --vars 'PROBEPOINT'", | |
f3ab481c | 199 | #endif |
4ea42b18 MH |
200 | NULL |
201 | }; | |
202 | ||
203 | static const struct option options[] = { | |
c0555642 | 204 | OPT_INCR('v', "verbose", &verbose, |
89c69c0e | 205 | "be more verbose (show parsed arguments, etc)"), |
12a1fadb | 206 | OPT_BOOLEAN('l', "list", ¶ms.list_events, |
fac13fd5 | 207 | "list up current probe events"), |
fa28244d MH |
208 | OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.", |
209 | opt_del_probe_event), | |
46ab4926 | 210 | OPT_CALLBACK('a', "add", NULL, |
4b4da7f7 | 211 | #ifdef DWARF_SUPPORT |
32cb0dd5 | 212 | "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT" |
48481938 | 213 | " [[NAME=]ARG ...]", |
4b4da7f7 | 214 | #else |
48481938 | 215 | "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]", |
23e8ec0d | 216 | #endif |
4ea42b18 | 217 | "probe point definition, where\n" |
af663d75 MH |
218 | "\t\tGROUP:\tGroup name (optional)\n" |
219 | "\t\tEVENT:\tEvent name\n" | |
4ea42b18 | 220 | "\t\tFUNC:\tFunction name\n" |
2a9c8c36 | 221 | "\t\tOFF:\tOffset from function entry (in byte)\n" |
253977b0 | 222 | "\t\t%return:\tPut the probe at function return\n" |
4b4da7f7 | 223 | #ifdef DWARF_SUPPORT |
4ea42b18 | 224 | "\t\tSRC:\tSource code path\n" |
2a9c8c36 MH |
225 | "\t\tRL:\tRelative line number from function entry.\n" |
226 | "\t\tAL:\tAbsolute line number in file.\n" | |
227 | "\t\tPT:\tLazy expression of line code.\n" | |
4ea42b18 | 228 | "\t\tARG:\tProbe argument (local variable name or\n" |
50656eec | 229 | "\t\t\tkprobe-tracer argument format.)\n", |
4b4da7f7 MH |
230 | #else |
231 | "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n", | |
232 | #endif | |
253977b0 | 233 | opt_add_probe_event), |
12a1fadb | 234 | OPT_BOOLEAN('f', "force", ¶ms.force_add, "forcibly add events" |
d761b08b | 235 | " with existing name"), |
4b4da7f7 | 236 | #ifdef DWARF_SUPPORT |
631c9def | 237 | OPT_CALLBACK('L', "line", NULL, |
085ea739 | 238 | "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]", |
631c9def | 239 | "Show source code lines.", opt_show_lines), |
cf6eb489 MH |
240 | OPT_CALLBACK('V', "vars", NULL, |
241 | "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT", | |
242 | "Show accessible variables on PROBEDEF", opt_show_vars), | |
fb8c5a56 MH |
243 | OPT_BOOLEAN('\0', "externs", ¶ms.show_ext_vars, |
244 | "Show external variables too (with --vars only)"), | |
4b4da7f7 MH |
245 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
246 | "file", "vmlinux pathname"), | |
9ed7e1b8 CD |
247 | OPT_STRING('s', "source", &symbol_conf.source_prefix, |
248 | "directory", "path to kernel source"), | |
4eced234 | 249 | OPT_STRING('m', "module", ¶ms.target, |
14a8fd7c MH |
250 | "modname|path", |
251 | "target module name (for online) or path (for offline)"), | |
631c9def | 252 | #endif |
f4d7da49 | 253 | OPT__DRY_RUN(&probe_event_dry_run), |
ef4a3565 MH |
254 | OPT_INTEGER('\0', "max-probes", ¶ms.max_probe_points, |
255 | "Set how many probe points can be found for a probe."), | |
e80711ca MH |
256 | OPT_BOOLEAN('F', "funcs", ¶ms.show_funcs, |
257 | "Show potential probe-able functions."), | |
3c42258c MH |
258 | OPT_CALLBACK('\0', "filter", NULL, |
259 | "[!]FILTER", "Set a filter (with --vars/funcs only)\n" | |
260 | "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n" | |
261 | "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)", | |
262 | opt_set_filter), | |
4ea42b18 MH |
263 | OPT_END() |
264 | }; | |
265 | ||
4ea42b18 MH |
266 | int cmd_probe(int argc, const char **argv, const char *prefix __used) |
267 | { | |
146a1439 MH |
268 | int ret; |
269 | ||
4ea42b18 | 270 | argc = parse_options(argc, argv, options, probe_usage, |
46ab4926 | 271 | PARSE_OPT_STOP_AT_NON_OPTION); |
ce11a603 MH |
272 | if (argc > 0) { |
273 | if (strcmp(argv[0], "-") == 0) { | |
274 | pr_warning(" Error: '-' is not supported.\n"); | |
275 | usage_with_options(probe_usage, options); | |
276 | } | |
146a1439 MH |
277 | ret = parse_probe_event_argv(argc, argv); |
278 | if (ret < 0) { | |
279 | pr_err(" Error: Parse Error. (%d)\n", ret); | |
280 | return ret; | |
281 | } | |
ce11a603 | 282 | } |
46ab4926 | 283 | |
ef4a3565 MH |
284 | if (params.max_probe_points == 0) |
285 | params.max_probe_points = MAX_PROBES; | |
286 | ||
4235b045 | 287 | if ((!params.nevents && !params.dellist && !params.list_events && |
e80711ca | 288 | !params.show_lines && !params.show_funcs)) |
4ea42b18 MH |
289 | usage_with_options(probe_usage, options); |
290 | ||
fd930ff9 FBH |
291 | /* |
292 | * Only consider the user's kernel image path if given. | |
293 | */ | |
294 | symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL); | |
295 | ||
12a1fadb | 296 | if (params.list_events) { |
cf6eb489 | 297 | if (params.mod_events) { |
146a1439 | 298 | pr_err(" Error: Don't use --list with --add/--del.\n"); |
fa28244d MH |
299 | usage_with_options(probe_usage, options); |
300 | } | |
12a1fadb | 301 | if (params.show_lines) { |
146a1439 | 302 | pr_err(" Error: Don't use --list with --line.\n"); |
631c9def MH |
303 | usage_with_options(probe_usage, options); |
304 | } | |
cf6eb489 MH |
305 | if (params.show_vars) { |
306 | pr_err(" Error: Don't use --list with --vars.\n"); | |
307 | usage_with_options(probe_usage, options); | |
308 | } | |
e80711ca MH |
309 | if (params.show_funcs) { |
310 | pr_err(" Error: Don't use --list with --funcs.\n"); | |
311 | usage_with_options(probe_usage, options); | |
312 | } | |
146a1439 MH |
313 | ret = show_perf_probe_events(); |
314 | if (ret < 0) | |
315 | pr_err(" Error: Failed to show event list. (%d)\n", | |
316 | ret); | |
317 | return ret; | |
4de189fe | 318 | } |
e80711ca MH |
319 | if (params.show_funcs) { |
320 | if (params.nevents != 0 || params.dellist) { | |
321 | pr_err(" Error: Don't use --funcs with" | |
322 | " --add/--del.\n"); | |
323 | usage_with_options(probe_usage, options); | |
324 | } | |
325 | if (params.show_lines) { | |
326 | pr_err(" Error: Don't use --funcs with --line.\n"); | |
327 | usage_with_options(probe_usage, options); | |
328 | } | |
329 | if (params.show_vars) { | |
330 | pr_err(" Error: Don't use --funcs with --vars.\n"); | |
331 | usage_with_options(probe_usage, options); | |
332 | } | |
3c42258c MH |
333 | if (!params.filter) |
334 | params.filter = strfilter__new(DEFAULT_FUNC_FILTER, | |
335 | NULL); | |
4eced234 | 336 | ret = show_available_funcs(params.target, |
3c42258c MH |
337 | params.filter); |
338 | strfilter__delete(params.filter); | |
e80711ca MH |
339 | if (ret < 0) |
340 | pr_err(" Error: Failed to show functions." | |
341 | " (%d)\n", ret); | |
342 | return ret; | |
343 | } | |
4de189fe | 344 | |
4b4da7f7 | 345 | #ifdef DWARF_SUPPORT |
12a1fadb | 346 | if (params.show_lines) { |
cf6eb489 MH |
347 | if (params.mod_events) { |
348 | pr_err(" Error: Don't use --line with" | |
349 | " --add/--del.\n"); | |
350 | usage_with_options(probe_usage, options); | |
351 | } | |
352 | if (params.show_vars) { | |
353 | pr_err(" Error: Don't use --line with --vars.\n"); | |
631c9def MH |
354 | usage_with_options(probe_usage, options); |
355 | } | |
e0faa8d3 | 356 | |
4eced234 | 357 | ret = show_line_range(¶ms.line_range, params.target); |
146a1439 MH |
358 | if (ret < 0) |
359 | pr_err(" Error: Failed to show lines. (%d)\n", ret); | |
360 | return ret; | |
631c9def | 361 | } |
cf6eb489 MH |
362 | if (params.show_vars) { |
363 | if (params.mod_events) { | |
364 | pr_err(" Error: Don't use --vars with" | |
365 | " --add/--del.\n"); | |
366 | usage_with_options(probe_usage, options); | |
367 | } | |
bd09d7b5 MH |
368 | if (!params.filter) |
369 | params.filter = strfilter__new(DEFAULT_VAR_FILTER, | |
370 | NULL); | |
371 | ||
cf6eb489 | 372 | ret = show_available_vars(params.events, params.nevents, |
fb8c5a56 | 373 | params.max_probe_points, |
4eced234 | 374 | params.target, |
bd09d7b5 | 375 | params.filter, |
fb8c5a56 | 376 | params.show_ext_vars); |
bd09d7b5 | 377 | strfilter__delete(params.filter); |
cf6eb489 MH |
378 | if (ret < 0) |
379 | pr_err(" Error: Failed to show vars. (%d)\n", ret); | |
380 | return ret; | |
381 | } | |
631c9def MH |
382 | #endif |
383 | ||
12a1fadb | 384 | if (params.dellist) { |
146a1439 | 385 | ret = del_perf_probe_events(params.dellist); |
12a1fadb | 386 | strlist__delete(params.dellist); |
146a1439 MH |
387 | if (ret < 0) { |
388 | pr_err(" Error: Failed to delete events. (%d)\n", ret); | |
389 | return ret; | |
390 | } | |
fa28244d MH |
391 | } |
392 | ||
146a1439 MH |
393 | if (params.nevents) { |
394 | ret = add_perf_probe_events(params.events, params.nevents, | |
c82ec0a2 | 395 | params.max_probe_points, |
4eced234 | 396 | params.target, |
c82ec0a2 | 397 | params.force_add); |
146a1439 MH |
398 | if (ret < 0) { |
399 | pr_err(" Error: Failed to add events. (%d)\n", ret); | |
400 | return ret; | |
401 | } | |
402 | } | |
4ea42b18 MH |
403 | return 0; |
404 | } |