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" |
4b6ab94e | 40 | #include <subcmd/parse-options.h> |
4ea42b18 | 41 | #include "util/probe-finder.h" |
50656eec | 42 | #include "util/probe-event.h" |
e607f142 | 43 | #include "util/probe-file.h" |
4ea42b18 | 44 | |
bd09d7b5 | 45 | #define DEFAULT_VAR_FILTER "!__k???tab_* & !__crc_*" |
3c42258c | 46 | #define DEFAULT_FUNC_FILTER "!_*" |
1f3736c9 | 47 | #define DEFAULT_LIST_FILTER "*" |
4ea42b18 MH |
48 | |
49 | /* Session management structure */ | |
50 | static struct { | |
b1019d5e | 51 | int command; /* Command short_name */ |
fac13fd5 | 52 | bool list_events; |
225466f1 | 53 | bool uprobes; |
5e17b28f | 54 | bool quiet; |
8cb0aa4c | 55 | bool target_used; |
4235b045 MH |
56 | int nevents; |
57 | struct perf_probe_event events[MAX_PROBES]; | |
631c9def | 58 | struct line_range line_range; |
e53b00d3 | 59 | char *target; |
bd09d7b5 | 60 | struct strfilter *filter; |
544abd44 | 61 | struct nsinfo *nsi; |
12a1fadb | 62 | } params; |
4ea42b18 | 63 | |
253977b0 | 64 | /* Parse an event definition. Note that any error must die. */ |
146a1439 | 65 | static int parse_probe_event(const char *str) |
4ea42b18 | 66 | { |
4235b045 | 67 | struct perf_probe_event *pev = ¶ms.events[params.nevents]; |
146a1439 | 68 | int ret; |
4ea42b18 | 69 | |
4235b045 | 70 | pr_debug("probe-definition(%d): %s\n", params.nevents, str); |
8a7ddad8 ACM |
71 | if (++params.nevents == MAX_PROBES) { |
72 | pr_err("Too many probes (> %d) were specified.", MAX_PROBES); | |
73 | return -1; | |
74 | } | |
4ea42b18 | 75 | |
225466f1 | 76 | pev->uprobes = params.uprobes; |
7afb3fab MH |
77 | if (params.target) { |
78 | pev->target = strdup(params.target); | |
79 | if (!pev->target) | |
80 | return -ENOMEM; | |
8cb0aa4c | 81 | params.target_used = true; |
7afb3fab | 82 | } |
225466f1 | 83 | |
362379aa | 84 | pev->nsi = nsinfo__get(params.nsi); |
544abd44 | 85 | |
4235b045 | 86 | /* Parse a perf-probe command into event */ |
146a1439 | 87 | ret = parse_perf_probe_command(str, pev); |
4235b045 | 88 | pr_debug("%d arguments\n", pev->nargs); |
146a1439 MH |
89 | |
90 | return ret; | |
46ab4926 MH |
91 | } |
92 | ||
b6a89643 MH |
93 | static int params_add_filter(const char *str) |
94 | { | |
95 | const char *err = NULL; | |
96 | int ret = 0; | |
97 | ||
98 | pr_debug2("Add filter: %s\n", str); | |
99 | if (!params.filter) { | |
100 | params.filter = strfilter__new(str, &err); | |
101 | if (!params.filter) | |
102 | ret = err ? -EINVAL : -ENOMEM; | |
103 | } else | |
104 | ret = strfilter__or(params.filter, str, &err); | |
105 | ||
106 | if (ret == -EINVAL) { | |
107 | pr_err("Filter parse error at %td.\n", err - str + 1); | |
108 | pr_err("Source: \"%s\"\n", str); | |
109 | pr_err(" %*c\n", (int)(err - str + 1), '^'); | |
110 | } | |
111 | ||
112 | return ret; | |
113 | } | |
114 | ||
73eff9f5 SD |
115 | static int set_target(const char *ptr) |
116 | { | |
117 | int found = 0; | |
118 | const char *buf; | |
119 | ||
120 | /* | |
121 | * The first argument after options can be an absolute path | |
122 | * to an executable / library or kernel module. | |
123 | * | |
124 | * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH, | |
125 | * short module name. | |
126 | */ | |
127 | if (!params.target && ptr && *ptr == '/') { | |
e53b00d3 MH |
128 | params.target = strdup(ptr); |
129 | if (!params.target) | |
130 | return -ENOMEM; | |
8cb0aa4c | 131 | params.target_used = false; |
e53b00d3 | 132 | |
73eff9f5 SD |
133 | found = 1; |
134 | buf = ptr + (strlen(ptr) - 3); | |
135 | ||
136 | if (strcmp(buf, ".ko")) | |
137 | params.uprobes = true; | |
138 | ||
139 | } | |
140 | ||
141 | return found; | |
142 | } | |
143 | ||
146a1439 | 144 | static int parse_probe_event_argv(int argc, const char **argv) |
d1bde3f7 | 145 | { |
73eff9f5 | 146 | int i, len, ret, found_target; |
d1bde3f7 MH |
147 | char *buf; |
148 | ||
73eff9f5 | 149 | found_target = set_target(argv[0]); |
e53b00d3 MH |
150 | if (found_target < 0) |
151 | return found_target; | |
152 | ||
73eff9f5 SD |
153 | if (found_target && argc == 1) |
154 | return 0; | |
155 | ||
d1bde3f7 MH |
156 | /* Bind up rest arguments */ |
157 | len = 0; | |
73eff9f5 SD |
158 | for (i = 0; i < argc; i++) { |
159 | if (i == 0 && found_target) | |
160 | continue; | |
161 | ||
d1bde3f7 | 162 | len += strlen(argv[i]) + 1; |
73eff9f5 | 163 | } |
8a7ddad8 ACM |
164 | buf = zalloc(len + 1); |
165 | if (buf == NULL) | |
166 | return -ENOMEM; | |
d1bde3f7 | 167 | len = 0; |
73eff9f5 SD |
168 | for (i = 0; i < argc; i++) { |
169 | if (i == 0 && found_target) | |
170 | continue; | |
171 | ||
d1bde3f7 | 172 | len += sprintf(&buf[len], "%s ", argv[i]); |
73eff9f5 | 173 | } |
146a1439 | 174 | ret = parse_probe_event(buf); |
d1bde3f7 | 175 | free(buf); |
146a1439 | 176 | return ret; |
d1bde3f7 MH |
177 | } |
178 | ||
225466f1 | 179 | static int opt_set_target(const struct option *opt, const char *str, |
1d037ca1 | 180 | int unset __maybe_unused) |
225466f1 SD |
181 | { |
182 | int ret = -ENOENT; | |
8a613d40 | 183 | char *tmp; |
225466f1 | 184 | |
7afb3fab | 185 | if (str) { |
225466f1 SD |
186 | if (!strcmp(opt->long_name, "exec")) |
187 | params.uprobes = true; | |
225466f1 SD |
188 | else if (!strcmp(opt->long_name, "module")) |
189 | params.uprobes = false; | |
225466f1 SD |
190 | else |
191 | return ret; | |
192 | ||
8a613d40 MH |
193 | /* Expand given path to absolute path, except for modulename */ |
194 | if (params.uprobes || strchr(str, '/')) { | |
544abd44 | 195 | tmp = nsinfo__realpath(str, params.nsi); |
8a613d40 MH |
196 | if (!tmp) { |
197 | pr_warning("Failed to get the absolute path of %s: %m\n", str); | |
198 | return ret; | |
199 | } | |
200 | } else { | |
201 | tmp = strdup(str); | |
202 | if (!tmp) | |
203 | return -ENOMEM; | |
204 | } | |
7afb3fab | 205 | free(params.target); |
8a613d40 | 206 | params.target = tmp; |
8cb0aa4c | 207 | params.target_used = false; |
225466f1 SD |
208 | ret = 0; |
209 | } | |
210 | ||
211 | return ret; | |
212 | } | |
213 | ||
544abd44 KJ |
214 | static int opt_set_target_ns(const struct option *opt __maybe_unused, |
215 | const char *str, int unset __maybe_unused) | |
216 | { | |
217 | int ret = -ENOENT; | |
218 | pid_t ns_pid; | |
219 | struct nsinfo *nsip; | |
220 | ||
221 | if (str) { | |
222 | errno = 0; | |
223 | ns_pid = (pid_t)strtol(str, NULL, 10); | |
224 | if (errno != 0) { | |
225 | ret = -errno; | |
226 | pr_warning("Failed to parse %s as a pid: %s\n", str, | |
227 | strerror(errno)); | |
228 | return ret; | |
229 | } | |
230 | nsip = nsinfo__new(ns_pid); | |
231 | if (nsip && nsip->need_setns) | |
232 | params.nsi = nsinfo__get(nsip); | |
233 | nsinfo__put(nsip); | |
234 | ||
235 | ret = 0; | |
236 | } | |
237 | ||
238 | return ret; | |
239 | } | |
240 | ||
241 | ||
b1019d5e MH |
242 | /* Command option callbacks */ |
243 | ||
89fe808a | 244 | #ifdef HAVE_DWARF_SUPPORT |
b1019d5e | 245 | static int opt_show_lines(const struct option *opt, |
1d037ca1 | 246 | const char *str, int unset __maybe_unused) |
0eda7385 | 247 | { |
146a1439 MH |
248 | int ret = 0; |
249 | ||
13e27d76 MH |
250 | if (!str) |
251 | return 0; | |
252 | ||
b1019d5e | 253 | if (params.command == 'L') { |
13e27d76 MH |
254 | pr_warning("Warning: more than one --line options are" |
255 | " detected. Only the first one is valid.\n"); | |
256 | return 0; | |
257 | } | |
258 | ||
b1019d5e | 259 | params.command = opt->short_name; |
13e27d76 | 260 | ret = parse_line_range_desc(str, ¶ms.line_range); |
146a1439 MH |
261 | |
262 | return ret; | |
0eda7385 | 263 | } |
cf6eb489 | 264 | |
b1019d5e | 265 | static int opt_show_vars(const struct option *opt, |
1d037ca1 | 266 | const char *str, int unset __maybe_unused) |
cf6eb489 MH |
267 | { |
268 | struct perf_probe_event *pev = ¶ms.events[params.nevents]; | |
269 | int ret; | |
270 | ||
271 | if (!str) | |
272 | return 0; | |
273 | ||
274 | ret = parse_probe_event(str); | |
275 | if (!ret && pev->nargs != 0) { | |
276 | pr_err(" Error: '--vars' doesn't accept arguments.\n"); | |
277 | return -EINVAL; | |
278 | } | |
b1019d5e | 279 | params.command = opt->short_name; |
cf6eb489 MH |
280 | |
281 | return ret; | |
282 | } | |
48e1cab1 WN |
283 | #else |
284 | # define opt_show_lines NULL | |
285 | # define opt_show_vars NULL | |
3c42258c | 286 | #endif |
b1019d5e MH |
287 | static int opt_add_probe_event(const struct option *opt, |
288 | const char *str, int unset __maybe_unused) | |
289 | { | |
290 | if (str) { | |
291 | params.command = opt->short_name; | |
292 | return parse_probe_event(str); | |
293 | } | |
294 | ||
295 | return 0; | |
296 | } | |
297 | ||
298 | static int opt_set_filter_with_command(const struct option *opt, | |
299 | const char *str, int unset) | |
9f7811d0 MH |
300 | { |
301 | if (!unset) | |
b1019d5e | 302 | params.command = opt->short_name; |
9f7811d0 MH |
303 | |
304 | if (str) | |
305 | return params_add_filter(str); | |
306 | ||
307 | return 0; | |
308 | } | |
bd09d7b5 | 309 | |
1d037ca1 IT |
310 | static int opt_set_filter(const struct option *opt __maybe_unused, |
311 | const char *str, int unset __maybe_unused) | |
bd09d7b5 | 312 | { |
b6a89643 MH |
313 | if (str) |
314 | return params_add_filter(str); | |
bd09d7b5 | 315 | |
b6a89643 | 316 | return 0; |
bd09d7b5 | 317 | } |
4ea42b18 | 318 | |
5a62257a | 319 | static int init_params(void) |
e53b00d3 | 320 | { |
5a62257a | 321 | return line_range__init(¶ms.line_range); |
e53b00d3 MH |
322 | } |
323 | ||
324 | static void cleanup_params(void) | |
325 | { | |
326 | int i; | |
327 | ||
328 | for (i = 0; i < params.nevents; i++) | |
329 | clear_perf_probe_event(params.events + i); | |
e53b00d3 MH |
330 | line_range__clear(¶ms.line_range); |
331 | free(params.target); | |
200802a4 | 332 | strfilter__delete(params.filter); |
544abd44 | 333 | nsinfo__put(params.nsi); |
e53b00d3 MH |
334 | memset(¶ms, 0, sizeof(params)); |
335 | } | |
336 | ||
b4bf1130 MH |
337 | static void pr_err_with_code(const char *msg, int err) |
338 | { | |
5f03cba4 MH |
339 | char sbuf[STRERR_BUFSIZE]; |
340 | ||
b4bf1130 | 341 | pr_err("%s", msg); |
5f03cba4 | 342 | pr_debug(" Reason: %s (Code: %d)", |
c8b5f2c9 | 343 | str_error_r(-err, sbuf, sizeof(sbuf)), err); |
b4bf1130 MH |
344 | pr_err("\n"); |
345 | } | |
346 | ||
b02137cc NK |
347 | static int perf_add_probe_events(struct perf_probe_event *pevs, int npevs) |
348 | { | |
349 | int ret; | |
350 | int i, k; | |
351 | const char *event = NULL, *group = NULL; | |
352 | ||
9bae1e8c NK |
353 | ret = init_probe_symbol_maps(pevs->uprobes); |
354 | if (ret < 0) | |
355 | return ret; | |
356 | ||
b02137cc NK |
357 | ret = convert_perf_probe_events(pevs, npevs); |
358 | if (ret < 0) | |
359 | goto out_cleanup; | |
360 | ||
1c20b1d1 MH |
361 | if (params.command == 'D') { /* it shows definition */ |
362 | ret = show_probe_trace_events(pevs, npevs); | |
363 | goto out_cleanup; | |
364 | } | |
365 | ||
b02137cc NK |
366 | ret = apply_perf_probe_events(pevs, npevs); |
367 | if (ret < 0) | |
368 | goto out_cleanup; | |
369 | ||
370 | for (i = k = 0; i < npevs; i++) | |
371 | k += pevs[i].ntevs; | |
372 | ||
373 | pr_info("Added new event%s\n", (k > 1) ? "s:" : ":"); | |
374 | for (i = 0; i < npevs; i++) { | |
375 | struct perf_probe_event *pev = &pevs[i]; | |
376 | ||
377 | for (k = 0; k < pev->ntevs; k++) { | |
378 | struct probe_trace_event *tev = &pev->tevs[k]; | |
379 | ||
380 | /* We use tev's name for showing new events */ | |
381 | show_perf_probe_event(tev->group, tev->event, pev, | |
382 | tev->point.module, false); | |
383 | ||
384 | /* Save the last valid name */ | |
385 | event = tev->event; | |
386 | group = tev->group; | |
387 | } | |
388 | } | |
389 | ||
390 | /* Note that it is possible to skip all events because of blacklist */ | |
391 | if (event) { | |
392 | /* Show how to use the event. */ | |
393 | pr_info("\nYou can now use it in all perf tools, such as:\n\n"); | |
394 | pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", group, event); | |
395 | } | |
396 | ||
397 | out_cleanup: | |
398 | cleanup_perf_probe_events(pevs, npevs); | |
9bae1e8c | 399 | exit_probe_symbol_maps(); |
b02137cc NK |
400 | return ret; |
401 | } | |
402 | ||
4a0f65c1 MH |
403 | static int del_perf_probe_caches(struct strfilter *filter) |
404 | { | |
405 | struct probe_cache *cache; | |
406 | struct strlist *bidlist; | |
407 | struct str_node *nd; | |
408 | int ret; | |
409 | ||
c3492a3a | 410 | bidlist = build_id_cache__list_all(false); |
4a0f65c1 MH |
411 | if (!bidlist) { |
412 | ret = -errno; | |
413 | pr_debug("Failed to get buildids: %d\n", ret); | |
414 | return ret ?: -ENOMEM; | |
415 | } | |
416 | ||
417 | strlist__for_each_entry(nd, bidlist) { | |
f045b8c4 | 418 | cache = probe_cache__new(nd->s, NULL); |
4a0f65c1 MH |
419 | if (!cache) |
420 | continue; | |
421 | if (probe_cache__filter_purge(cache, filter) < 0 || | |
422 | probe_cache__commit(cache) < 0) | |
423 | pr_warning("Failed to remove entries for %s\n", nd->s); | |
424 | probe_cache__delete(cache); | |
425 | } | |
426 | return 0; | |
427 | } | |
428 | ||
e607f142 NK |
429 | static int perf_del_probe_events(struct strfilter *filter) |
430 | { | |
431 | int ret, ret2, ufd = -1, kfd = -1; | |
432 | char *str = strfilter__string(filter); | |
433 | struct strlist *klist = NULL, *ulist = NULL; | |
434 | struct str_node *ent; | |
435 | ||
436 | if (!str) | |
437 | return -EINVAL; | |
438 | ||
439 | pr_debug("Delete filter: \'%s\'\n", str); | |
440 | ||
4a0f65c1 MH |
441 | if (probe_conf.cache) |
442 | return del_perf_probe_caches(filter); | |
443 | ||
e607f142 NK |
444 | /* Get current event names */ |
445 | ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW); | |
446 | if (ret < 0) | |
447 | goto out; | |
448 | ||
449 | klist = strlist__new(NULL, NULL); | |
0fb18553 MH |
450 | ulist = strlist__new(NULL, NULL); |
451 | if (!klist || !ulist) { | |
452 | ret = -ENOMEM; | |
453 | goto out; | |
454 | } | |
e607f142 NK |
455 | |
456 | ret = probe_file__get_events(kfd, filter, klist); | |
457 | if (ret == 0) { | |
602a1f4d | 458 | strlist__for_each_entry(ent, klist) |
e607f142 NK |
459 | pr_info("Removed event: %s\n", ent->s); |
460 | ||
461 | ret = probe_file__del_strlist(kfd, klist); | |
462 | if (ret < 0) | |
463 | goto error; | |
464 | } | |
465 | ||
466 | ret2 = probe_file__get_events(ufd, filter, ulist); | |
467 | if (ret2 == 0) { | |
602a1f4d | 468 | strlist__for_each_entry(ent, ulist) |
e607f142 NK |
469 | pr_info("Removed event: %s\n", ent->s); |
470 | ||
471 | ret2 = probe_file__del_strlist(ufd, ulist); | |
472 | if (ret2 < 0) | |
473 | goto error; | |
474 | } | |
475 | ||
476 | if (ret == -ENOENT && ret2 == -ENOENT) | |
70946723 KW |
477 | pr_warning("\"%s\" does not hit any event.\n", str); |
478 | else | |
479 | ret = 0; | |
e607f142 NK |
480 | |
481 | error: | |
482 | if (kfd >= 0) | |
483 | close(kfd); | |
484 | if (ufd >= 0) | |
485 | close(ufd); | |
486 | out: | |
487 | strlist__delete(klist); | |
488 | strlist__delete(ulist); | |
489 | free(str); | |
490 | ||
491 | return ret; | |
492 | } | |
493 | ||
1c20b1d1 MH |
494 | #ifdef HAVE_DWARF_SUPPORT |
495 | #define PROBEDEF_STR \ | |
496 | "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT [[NAME=]ARG ...]" | |
497 | #else | |
498 | #define PROBEDEF_STR "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]" | |
499 | #endif | |
500 | ||
501 | ||
e53b00d3 | 502 | static int |
b0ad8ea6 | 503 | __cmd_probe(int argc, const char **argv) |
11c4e4a3 ACM |
504 | { |
505 | const char * const probe_usage[] = { | |
506 | "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]", | |
507 | "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]", | |
508 | "perf probe [<options>] --del '[GROUP:]EVENT' ...", | |
b6a89643 | 509 | "perf probe --list [GROUP:]EVENT ...", |
89fe808a | 510 | #ifdef HAVE_DWARF_SUPPORT |
11c4e4a3 ACM |
511 | "perf probe [<options>] --line 'LINEDESC'", |
512 | "perf probe [<options>] --vars 'PROBEPOINT'", | |
f3ab481c | 513 | #endif |
b3ac032b | 514 | "perf probe [<options>] --funcs", |
11c4e4a3 | 515 | NULL |
b6a89643 | 516 | }; |
13dcbbc0 | 517 | struct option options[] = { |
c0555642 | 518 | OPT_INCR('v', "verbose", &verbose, |
89c69c0e | 519 | "be more verbose (show parsed arguments, etc)"), |
5e17b28f | 520 | OPT_BOOLEAN('q', "quiet", ¶ms.quiet, |
0a95160e | 521 | "be quiet (do not show any messages)"), |
b6a89643 | 522 | OPT_CALLBACK_DEFAULT('l', "list", NULL, "[GROUP:]EVENT", |
b1019d5e MH |
523 | "list up probe events", |
524 | opt_set_filter_with_command, DEFAULT_LIST_FILTER), | |
fa28244d | 525 | OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.", |
b1019d5e | 526 | opt_set_filter_with_command), |
1c20b1d1 | 527 | OPT_CALLBACK('a', "add", NULL, PROBEDEF_STR, |
4ea42b18 | 528 | "probe point definition, where\n" |
af663d75 MH |
529 | "\t\tGROUP:\tGroup name (optional)\n" |
530 | "\t\tEVENT:\tEvent name\n" | |
4ea42b18 | 531 | "\t\tFUNC:\tFunction name\n" |
2a9c8c36 | 532 | "\t\tOFF:\tOffset from function entry (in byte)\n" |
253977b0 | 533 | "\t\t%return:\tPut the probe at function return\n" |
89fe808a | 534 | #ifdef HAVE_DWARF_SUPPORT |
4ea42b18 | 535 | "\t\tSRC:\tSource code path\n" |
2a9c8c36 MH |
536 | "\t\tRL:\tRelative line number from function entry.\n" |
537 | "\t\tAL:\tAbsolute line number in file.\n" | |
538 | "\t\tPT:\tLazy expression of line code.\n" | |
4ea42b18 | 539 | "\t\tARG:\tProbe argument (local variable name or\n" |
50656eec | 540 | "\t\t\tkprobe-tracer argument format.)\n", |
4b4da7f7 MH |
541 | #else |
542 | "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n", | |
543 | #endif | |
253977b0 | 544 | opt_add_probe_event), |
1c20b1d1 MH |
545 | OPT_CALLBACK('D', "definition", NULL, PROBEDEF_STR, |
546 | "Show trace event definition of given traceevent for k/uprobe_events.", | |
547 | opt_add_probe_event), | |
ddb2f58f | 548 | OPT_BOOLEAN('f', "force", &probe_conf.force_add, "forcibly add events" |
d761b08b | 549 | " with existing name"), |
631c9def | 550 | OPT_CALLBACK('L', "line", NULL, |
085ea739 | 551 | "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]", |
631c9def | 552 | "Show source code lines.", opt_show_lines), |
cf6eb489 MH |
553 | OPT_CALLBACK('V', "vars", NULL, |
554 | "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT", | |
555 | "Show accessible variables on PROBEDEF", opt_show_vars), | |
ddb2f58f | 556 | OPT_BOOLEAN('\0', "externs", &probe_conf.show_ext_vars, |
fb8c5a56 | 557 | "Show external variables too (with --vars only)"), |
349e8d26 HK |
558 | OPT_BOOLEAN('\0', "range", &probe_conf.show_location_range, |
559 | "Show variables location range in scope (with --vars only)"), | |
4b4da7f7 MH |
560 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
561 | "file", "vmlinux pathname"), | |
9ed7e1b8 CD |
562 | OPT_STRING('s', "source", &symbol_conf.source_prefix, |
563 | "directory", "path to kernel source"), | |
6cfd1f68 MH |
564 | OPT_BOOLEAN('\0', "no-inlines", &probe_conf.no_inlines, |
565 | "Don't search inlined functions"), | |
f4d7da49 | 566 | OPT__DRY_RUN(&probe_event_dry_run), |
ddb2f58f | 567 | OPT_INTEGER('\0', "max-probes", &probe_conf.max_probes, |
ef4a3565 | 568 | "Set how many probe points can be found for a probe."), |
9f7811d0 MH |
569 | OPT_CALLBACK_DEFAULT('F', "funcs", NULL, "[FILTER]", |
570 | "Show potential probe-able functions.", | |
b1019d5e | 571 | opt_set_filter_with_command, DEFAULT_FUNC_FILTER), |
3c42258c MH |
572 | OPT_CALLBACK('\0', "filter", NULL, |
573 | "[!]FILTER", "Set a filter (with --vars/funcs only)\n" | |
574 | "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n" | |
575 | "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)", | |
576 | opt_set_filter), | |
225466f1 SD |
577 | OPT_CALLBACK('x', "exec", NULL, "executable|path", |
578 | "target executable name or path", opt_set_target), | |
1a8ac29c MH |
579 | OPT_CALLBACK('m', "module", NULL, "modname|path", |
580 | "target module name (for online) or path (for offline)", | |
581 | opt_set_target), | |
35e17b24 | 582 | OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle, |
4cdcc33d | 583 | "Enable symbol demangling"), |
763122ad AK |
584 | OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel, |
585 | "Enable kernel symbol demangling"), | |
2fd457a3 | 586 | OPT_BOOLEAN(0, "cache", &probe_conf.cache, "Manipulate probe cache"), |
d5c3a937 UKK |
587 | OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", |
588 | "Look for files with symbols relative to this directory"), | |
544abd44 KJ |
589 | OPT_CALLBACK(0, "target-ns", NULL, "pid", |
590 | "target pid for namespace contexts", opt_set_target_ns), | |
4ea42b18 | 591 | OPT_END() |
11c4e4a3 | 592 | }; |
146a1439 MH |
593 | int ret; |
594 | ||
13dcbbc0 NK |
595 | set_option_flag(options, 'a', "add", PARSE_OPT_EXCLUSIVE); |
596 | set_option_flag(options, 'd', "del", PARSE_OPT_EXCLUSIVE); | |
1c20b1d1 | 597 | set_option_flag(options, 'D', "definition", PARSE_OPT_EXCLUSIVE); |
13dcbbc0 NK |
598 | set_option_flag(options, 'l', "list", PARSE_OPT_EXCLUSIVE); |
599 | #ifdef HAVE_DWARF_SUPPORT | |
600 | set_option_flag(options, 'L', "line", PARSE_OPT_EXCLUSIVE); | |
601 | set_option_flag(options, 'V', "vars", PARSE_OPT_EXCLUSIVE); | |
48e1cab1 WN |
602 | #else |
603 | # define set_nobuild(s, l, c) set_option_nobuild(options, s, l, "NO_DWARF=1", c) | |
604 | set_nobuild('L', "line", false); | |
605 | set_nobuild('V', "vars", false); | |
606 | set_nobuild('\0', "externs", false); | |
607 | set_nobuild('\0', "range", false); | |
608 | set_nobuild('k', "vmlinux", true); | |
609 | set_nobuild('s', "source", true); | |
610 | set_nobuild('\0', "no-inlines", true); | |
611 | # undef set_nobuild | |
13dcbbc0 | 612 | #endif |
b3ac032b | 613 | set_option_flag(options, 'F', "funcs", PARSE_OPT_EXCLUSIVE); |
13dcbbc0 | 614 | |
4ea42b18 | 615 | argc = parse_options(argc, argv, options, probe_usage, |
46ab4926 | 616 | PARSE_OPT_STOP_AT_NON_OPTION); |
ce11a603 MH |
617 | if (argc > 0) { |
618 | if (strcmp(argv[0], "-") == 0) { | |
c7118369 NK |
619 | usage_with_options_msg(probe_usage, options, |
620 | "'-' is not supported.\n"); | |
ce11a603 | 621 | } |
b1019d5e | 622 | if (params.command && params.command != 'a') { |
c7118369 NK |
623 | usage_with_options_msg(probe_usage, options, |
624 | "another command except --add is set.\n"); | |
b1019d5e | 625 | } |
146a1439 MH |
626 | ret = parse_probe_event_argv(argc, argv); |
627 | if (ret < 0) { | |
b4bf1130 | 628 | pr_err_with_code(" Error: Command Parse Error.", ret); |
146a1439 MH |
629 | return ret; |
630 | } | |
b1019d5e | 631 | params.command = 'a'; |
ce11a603 | 632 | } |
46ab4926 | 633 | |
5e17b28f MH |
634 | if (params.quiet) { |
635 | if (verbose != 0) { | |
636 | pr_err(" Error: -v and -q are exclusive.\n"); | |
637 | return -EINVAL; | |
638 | } | |
639 | verbose = -1; | |
640 | } | |
641 | ||
ddb2f58f MH |
642 | if (probe_conf.max_probes == 0) |
643 | probe_conf.max_probes = MAX_PROBES; | |
ef4a3565 | 644 | |
fd930ff9 FBH |
645 | /* |
646 | * Only consider the user's kernel image path if given. | |
647 | */ | |
648 | symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL); | |
649 | ||
e50243bb MH |
650 | /* |
651 | * Except for --list, --del and --add, other command doesn't depend | |
652 | * nor change running kernel. So if user gives offline vmlinux, | |
653 | * ignore its buildid. | |
654 | */ | |
655 | if (!strchr("lda", params.command) && symbol_conf.vmlinux_name) | |
656 | symbol_conf.ignore_vmlinux_buildid = true; | |
657 | ||
b1019d5e MH |
658 | switch (params.command) { |
659 | case 'l': | |
225466f1 | 660 | if (params.uprobes) { |
c7118369 NK |
661 | pr_err(" Error: Don't use --list with --exec.\n"); |
662 | parse_options_usage(probe_usage, options, "l", true); | |
663 | parse_options_usage(NULL, options, "x", true); | |
664 | return -EINVAL; | |
225466f1 | 665 | } |
b6a89643 | 666 | ret = show_perf_probe_events(params.filter); |
146a1439 | 667 | if (ret < 0) |
b4bf1130 | 668 | pr_err_with_code(" Error: Failed to show event list.", ret); |
146a1439 | 669 | return ret; |
b1019d5e | 670 | case 'F': |
544abd44 KJ |
671 | ret = show_available_funcs(params.target, params.nsi, |
672 | params.filter, params.uprobes); | |
e80711ca | 673 | if (ret < 0) |
b4bf1130 | 674 | pr_err_with_code(" Error: Failed to show functions.", ret); |
e80711ca | 675 | return ret; |
89fe808a | 676 | #ifdef HAVE_DWARF_SUPPORT |
b1019d5e | 677 | case 'L': |
2b394bc4 | 678 | ret = show_line_range(¶ms.line_range, params.target, |
544abd44 | 679 | params.nsi, params.uprobes); |
146a1439 | 680 | if (ret < 0) |
b4bf1130 | 681 | pr_err_with_code(" Error: Failed to show lines.", ret); |
146a1439 | 682 | return ret; |
b1019d5e | 683 | case 'V': |
bd09d7b5 MH |
684 | if (!params.filter) |
685 | params.filter = strfilter__new(DEFAULT_VAR_FILTER, | |
686 | NULL); | |
687 | ||
cf6eb489 | 688 | ret = show_available_vars(params.events, params.nevents, |
ddb2f58f | 689 | params.filter); |
cf6eb489 | 690 | if (ret < 0) |
b4bf1130 | 691 | pr_err_with_code(" Error: Failed to show vars.", ret); |
cf6eb489 | 692 | return ret; |
631c9def | 693 | #endif |
b1019d5e | 694 | case 'd': |
e607f142 | 695 | ret = perf_del_probe_events(params.filter); |
146a1439 | 696 | if (ret < 0) { |
b4bf1130 | 697 | pr_err_with_code(" Error: Failed to delete events.", ret); |
146a1439 MH |
698 | return ret; |
699 | } | |
b1019d5e | 700 | break; |
1c20b1d1 | 701 | case 'D': |
428aff82 MH |
702 | case 'a': |
703 | ||
8cb0aa4c MH |
704 | /* Ensure the last given target is used */ |
705 | if (params.target && !params.target_used) { | |
c7118369 NK |
706 | pr_err(" Error: -x/-m must follow the probe definitions.\n"); |
707 | parse_options_usage(probe_usage, options, "m", true); | |
708 | parse_options_usage(NULL, options, "x", true); | |
709 | return -EINVAL; | |
8cb0aa4c MH |
710 | } |
711 | ||
b02137cc | 712 | ret = perf_add_probe_events(params.events, params.nevents); |
146a1439 | 713 | if (ret < 0) { |
b4bf1130 | 714 | pr_err_with_code(" Error: Failed to add events.", ret); |
146a1439 MH |
715 | return ret; |
716 | } | |
b1019d5e MH |
717 | break; |
718 | default: | |
719 | usage_with_options(probe_usage, options); | |
146a1439 | 720 | } |
4ea42b18 MH |
721 | return 0; |
722 | } | |
e53b00d3 | 723 | |
b0ad8ea6 | 724 | int cmd_probe(int argc, const char **argv) |
e53b00d3 MH |
725 | { |
726 | int ret; | |
727 | ||
5a62257a MH |
728 | ret = init_params(); |
729 | if (!ret) { | |
b0ad8ea6 | 730 | ret = __cmd_probe(argc, argv); |
5a62257a MH |
731 | cleanup_params(); |
732 | } | |
e53b00d3 | 733 | |
9bc9f3b6 | 734 | return ret < 0 ? ret : 0; |
e53b00d3 | 735 | } |