blob: f87996b0cb299636e5803a699710be944d3924e3 [file] [log] [blame]
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -04001/*
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 */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040023#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
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040033#include "perf.h"
34#include "builtin.h"
35#include "util/util.h"
Masami Hiramatsufa282442009-12-08 17:03:23 -050036#include "util/strlist.h"
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +090037#include "util/strfilter.h"
Masami Hiramatsue0faa8d2010-03-16 18:05:37 -040038#include "util/symbol.h"
Masami Hiramatsu89c69c02009-10-16 20:08:10 -040039#include "util/debug.h"
Josh Poimboeuf4b6ab942015-12-15 09:39:39 -060040#include <subcmd/parse-options.h>
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040041#include "util/probe-finder.h"
Masami Hiramatsu50656ee2009-11-30 19:19:58 -050042#include "util/probe-event.h"
Namhyung Kime607f142015-09-04 21:16:03 +090043#include "util/probe-file.h"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040044
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +090045#define DEFAULT_VAR_FILTER "!__k???tab_* & !__crc_*"
Masami Hiramatsu3c422582011-01-20 23:15:45 +090046#define DEFAULT_FUNC_FILTER "!_*"
Masami Hiramatsu1f3736c2016-07-01 17:03:26 +090047#define DEFAULT_LIST_FILTER "*"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040048
49/* Session management structure */
50static struct {
Masami Hiramatsub1019d52015-05-06 00:22:57 +090051 int command; /* Command short_name */
Masami Hiramatsufac13fd2009-12-15 10:31:14 -050052 bool list_events;
Srikar Dronamraju225466f2012-04-16 17:39:09 +053053 bool uprobes;
Masami Hiramatsu5e17b282014-10-27 16:31:31 -040054 bool quiet;
Masami Hiramatsu8cb0aa42015-04-01 19:25:42 +090055 bool target_used;
Masami Hiramatsu4235b042010-03-16 18:06:12 -040056 int nevents;
57 struct perf_probe_event events[MAX_PROBES];
Masami Hiramatsu631c9de2010-01-06 09:45:34 -050058 struct line_range line_range;
Masami Hiramatsue53b00d2014-01-16 09:39:47 +000059 char *target;
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +090060 struct strfilter *filter;
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -040061} params;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040062
Masami Hiramatsu253977b2009-10-27 16:43:10 -040063/* Parse an event definition. Note that any error must die. */
Masami Hiramatsu146a1432010-04-12 13:17:42 -040064static int parse_probe_event(const char *str)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040065{
Masami Hiramatsu4235b042010-03-16 18:06:12 -040066 struct perf_probe_event *pev = &params.events[params.nevents];
Masami Hiramatsu146a1432010-04-12 13:17:42 -040067 int ret;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040068
Masami Hiramatsu4235b042010-03-16 18:06:12 -040069 pr_debug("probe-definition(%d): %s\n", params.nevents, str);
Arnaldo Carvalho de Melo8a7ddad2010-05-18 22:57:27 -030070 if (++params.nevents == MAX_PROBES) {
71 pr_err("Too many probes (> %d) were specified.", MAX_PROBES);
72 return -1;
73 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040074
Srikar Dronamraju225466f2012-04-16 17:39:09 +053075 pev->uprobes = params.uprobes;
Masami Hiramatsu7afb3fa2015-04-01 19:25:39 +090076 if (params.target) {
77 pev->target = strdup(params.target);
78 if (!pev->target)
79 return -ENOMEM;
Masami Hiramatsu8cb0aa42015-04-01 19:25:42 +090080 params.target_used = true;
Masami Hiramatsu7afb3fa2015-04-01 19:25:39 +090081 }
Srikar Dronamraju225466f2012-04-16 17:39:09 +053082
Masami Hiramatsu4235b042010-03-16 18:06:12 -040083 /* Parse a perf-probe command into event */
Masami Hiramatsu146a1432010-04-12 13:17:42 -040084 ret = parse_perf_probe_command(str, pev);
Masami Hiramatsu4235b042010-03-16 18:06:12 -040085 pr_debug("%d arguments\n", pev->nargs);
Masami Hiramatsu146a1432010-04-12 13:17:42 -040086
87 return ret;
Masami Hiramatsu46ab4922009-10-27 16:43:02 -040088}
89
Masami Hiramatsub6a89642015-04-24 18:47:50 +090090static int params_add_filter(const char *str)
91{
92 const char *err = NULL;
93 int ret = 0;
94
95 pr_debug2("Add filter: %s\n", str);
96 if (!params.filter) {
97 params.filter = strfilter__new(str, &err);
98 if (!params.filter)
99 ret = err ? -EINVAL : -ENOMEM;
100 } else
101 ret = strfilter__or(params.filter, str, &err);
102
103 if (ret == -EINVAL) {
104 pr_err("Filter parse error at %td.\n", err - str + 1);
105 pr_err("Source: \"%s\"\n", str);
106 pr_err(" %*c\n", (int)(err - str + 1), '^');
107 }
108
109 return ret;
110}
111
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530112static int set_target(const char *ptr)
113{
114 int found = 0;
115 const char *buf;
116
117 /*
118 * The first argument after options can be an absolute path
119 * to an executable / library or kernel module.
120 *
121 * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
122 * short module name.
123 */
124 if (!params.target && ptr && *ptr == '/') {
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000125 params.target = strdup(ptr);
126 if (!params.target)
127 return -ENOMEM;
Masami Hiramatsu8cb0aa42015-04-01 19:25:42 +0900128 params.target_used = false;
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000129
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530130 found = 1;
131 buf = ptr + (strlen(ptr) - 3);
132
133 if (strcmp(buf, ".ko"))
134 params.uprobes = true;
135
136 }
137
138 return found;
139}
140
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400141static int parse_probe_event_argv(int argc, const char **argv)
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500142{
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530143 int i, len, ret, found_target;
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500144 char *buf;
145
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530146 found_target = set_target(argv[0]);
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000147 if (found_target < 0)
148 return found_target;
149
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530150 if (found_target && argc == 1)
151 return 0;
152
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500153 /* Bind up rest arguments */
154 len = 0;
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530155 for (i = 0; i < argc; i++) {
156 if (i == 0 && found_target)
157 continue;
158
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500159 len += strlen(argv[i]) + 1;
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530160 }
Arnaldo Carvalho de Melo8a7ddad2010-05-18 22:57:27 -0300161 buf = zalloc(len + 1);
162 if (buf == NULL)
163 return -ENOMEM;
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500164 len = 0;
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530165 for (i = 0; i < argc; i++) {
166 if (i == 0 && found_target)
167 continue;
168
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500169 len += sprintf(&buf[len], "%s ", argv[i]);
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530170 }
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400171 ret = parse_probe_event(buf);
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500172 free(buf);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400173 return ret;
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500174}
175
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530176static int opt_set_target(const struct option *opt, const char *str,
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300177 int unset __maybe_unused)
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530178{
179 int ret = -ENOENT;
Masami Hiramatsu8a613d42013-12-26 05:41:50 +0000180 char *tmp;
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530181
Masami Hiramatsu7afb3fa2015-04-01 19:25:39 +0900182 if (str) {
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530183 if (!strcmp(opt->long_name, "exec"))
184 params.uprobes = true;
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530185 else if (!strcmp(opt->long_name, "module"))
186 params.uprobes = false;
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530187 else
188 return ret;
189
Masami Hiramatsu8a613d42013-12-26 05:41:50 +0000190 /* Expand given path to absolute path, except for modulename */
191 if (params.uprobes || strchr(str, '/')) {
192 tmp = realpath(str, NULL);
193 if (!tmp) {
194 pr_warning("Failed to get the absolute path of %s: %m\n", str);
195 return ret;
196 }
197 } else {
198 tmp = strdup(str);
199 if (!tmp)
200 return -ENOMEM;
201 }
Masami Hiramatsu7afb3fa2015-04-01 19:25:39 +0900202 free(params.target);
Masami Hiramatsu8a613d42013-12-26 05:41:50 +0000203 params.target = tmp;
Masami Hiramatsu8cb0aa42015-04-01 19:25:42 +0900204 params.target_used = false;
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530205 ret = 0;
206 }
207
208 return ret;
209}
210
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900211/* Command option callbacks */
212
Ingo Molnar89fe8082013-09-30 12:07:11 +0200213#ifdef HAVE_DWARF_SUPPORT
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900214static int opt_show_lines(const struct option *opt,
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300215 const char *str, int unset __maybe_unused)
Hitoshi Mitake0eda7382010-01-16 21:31:16 +0900216{
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400217 int ret = 0;
218
Masami Hiramatsu13e27d72011-08-11 20:02:53 +0900219 if (!str)
220 return 0;
221
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900222 if (params.command == 'L') {
Masami Hiramatsu13e27d72011-08-11 20:02:53 +0900223 pr_warning("Warning: more than one --line options are"
224 " detected. Only the first one is valid.\n");
225 return 0;
226 }
227
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900228 params.command = opt->short_name;
Masami Hiramatsu13e27d72011-08-11 20:02:53 +0900229 ret = parse_line_range_desc(str, &params.line_range);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400230
231 return ret;
Hitoshi Mitake0eda7382010-01-16 21:31:16 +0900232}
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900233
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900234static int opt_show_vars(const struct option *opt,
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300235 const char *str, int unset __maybe_unused)
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900236{
237 struct perf_probe_event *pev = &params.events[params.nevents];
238 int ret;
239
240 if (!str)
241 return 0;
242
243 ret = parse_probe_event(str);
244 if (!ret && pev->nargs != 0) {
245 pr_err(" Error: '--vars' doesn't accept arguments.\n");
246 return -EINVAL;
247 }
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900248 params.command = opt->short_name;
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900249
250 return ret;
251}
Wang Nan48e1cab2015-12-14 10:39:22 +0000252#else
253# define opt_show_lines NULL
254# define opt_show_vars NULL
Masami Hiramatsu3c422582011-01-20 23:15:45 +0900255#endif
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900256static int opt_add_probe_event(const struct option *opt,
257 const char *str, int unset __maybe_unused)
258{
259 if (str) {
260 params.command = opt->short_name;
261 return parse_probe_event(str);
262 }
263
264 return 0;
265}
266
267static int opt_set_filter_with_command(const struct option *opt,
268 const char *str, int unset)
Masami Hiramatsu9f7811d2015-05-05 11:29:50 +0900269{
270 if (!unset)
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900271 params.command = opt->short_name;
Masami Hiramatsu9f7811d2015-05-05 11:29:50 +0900272
273 if (str)
274 return params_add_filter(str);
275
276 return 0;
277}
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900278
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300279static int opt_set_filter(const struct option *opt __maybe_unused,
280 const char *str, int unset __maybe_unused)
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900281{
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900282 if (str)
283 return params_add_filter(str);
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900284
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900285 return 0;
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900286}
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400287
Masami Hiramatsu5a622572014-02-06 05:32:09 +0000288static int init_params(void)
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000289{
Masami Hiramatsu5a622572014-02-06 05:32:09 +0000290 return line_range__init(&params.line_range);
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000291}
292
293static void cleanup_params(void)
294{
295 int i;
296
297 for (i = 0; i < params.nevents; i++)
298 clear_perf_probe_event(params.events + i);
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000299 line_range__clear(&params.line_range);
300 free(params.target);
Markus Elfring200802a2015-07-04 07:44:22 +0200301 strfilter__delete(params.filter);
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000302 memset(&params, 0, sizeof(params));
303}
304
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000305static void pr_err_with_code(const char *msg, int err)
306{
Masami Hiramatsu5f03cba2014-08-14 02:22:34 +0000307 char sbuf[STRERR_BUFSIZE];
308
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000309 pr_err("%s", msg);
Masami Hiramatsu5f03cba2014-08-14 02:22:34 +0000310 pr_debug(" Reason: %s (Code: %d)",
Arnaldo Carvalho de Meloc8b5f2c2016-07-06 11:56:20 -0300311 str_error_r(-err, sbuf, sizeof(sbuf)), err);
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000312 pr_err("\n");
313}
314
Namhyung Kimb02137c2015-09-04 21:16:01 +0900315static int perf_add_probe_events(struct perf_probe_event *pevs, int npevs)
316{
317 int ret;
318 int i, k;
319 const char *event = NULL, *group = NULL;
320
Namhyung Kim9bae1e82015-09-10 11:27:05 +0900321 ret = init_probe_symbol_maps(pevs->uprobes);
322 if (ret < 0)
323 return ret;
324
Namhyung Kimb02137c2015-09-04 21:16:01 +0900325 ret = convert_perf_probe_events(pevs, npevs);
326 if (ret < 0)
327 goto out_cleanup;
328
Masami Hiramatsu1c20b1d2016-08-26 01:24:27 +0900329 if (params.command == 'D') { /* it shows definition */
330 ret = show_probe_trace_events(pevs, npevs);
331 goto out_cleanup;
332 }
333
Namhyung Kimb02137c2015-09-04 21:16:01 +0900334 ret = apply_perf_probe_events(pevs, npevs);
335 if (ret < 0)
336 goto out_cleanup;
337
338 for (i = k = 0; i < npevs; i++)
339 k += pevs[i].ntevs;
340
341 pr_info("Added new event%s\n", (k > 1) ? "s:" : ":");
342 for (i = 0; i < npevs; i++) {
343 struct perf_probe_event *pev = &pevs[i];
344
345 for (k = 0; k < pev->ntevs; k++) {
346 struct probe_trace_event *tev = &pev->tevs[k];
347
348 /* We use tev's name for showing new events */
349 show_perf_probe_event(tev->group, tev->event, pev,
350 tev->point.module, false);
351
352 /* Save the last valid name */
353 event = tev->event;
354 group = tev->group;
355 }
356 }
357
358 /* Note that it is possible to skip all events because of blacklist */
359 if (event) {
360 /* Show how to use the event. */
361 pr_info("\nYou can now use it in all perf tools, such as:\n\n");
362 pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", group, event);
363 }
364
365out_cleanup:
366 cleanup_perf_probe_events(pevs, npevs);
Namhyung Kim9bae1e82015-09-10 11:27:05 +0900367 exit_probe_symbol_maps();
Namhyung Kimb02137c2015-09-04 21:16:01 +0900368 return ret;
369}
370
Masami Hiramatsu4a0f65c2016-07-01 17:03:36 +0900371static int del_perf_probe_caches(struct strfilter *filter)
372{
373 struct probe_cache *cache;
374 struct strlist *bidlist;
375 struct str_node *nd;
376 int ret;
377
Masami Hiramatsuc3492a32016-07-12 19:04:54 +0900378 bidlist = build_id_cache__list_all(false);
Masami Hiramatsu4a0f65c2016-07-01 17:03:36 +0900379 if (!bidlist) {
380 ret = -errno;
381 pr_debug("Failed to get buildids: %d\n", ret);
382 return ret ?: -ENOMEM;
383 }
384
385 strlist__for_each_entry(nd, bidlist) {
386 cache = probe_cache__new(nd->s);
387 if (!cache)
388 continue;
389 if (probe_cache__filter_purge(cache, filter) < 0 ||
390 probe_cache__commit(cache) < 0)
391 pr_warning("Failed to remove entries for %s\n", nd->s);
392 probe_cache__delete(cache);
393 }
394 return 0;
395}
396
Namhyung Kime607f142015-09-04 21:16:03 +0900397static int perf_del_probe_events(struct strfilter *filter)
398{
399 int ret, ret2, ufd = -1, kfd = -1;
400 char *str = strfilter__string(filter);
401 struct strlist *klist = NULL, *ulist = NULL;
402 struct str_node *ent;
403
404 if (!str)
405 return -EINVAL;
406
407 pr_debug("Delete filter: \'%s\'\n", str);
408
Masami Hiramatsu4a0f65c2016-07-01 17:03:36 +0900409 if (probe_conf.cache)
410 return del_perf_probe_caches(filter);
411
Namhyung Kime607f142015-09-04 21:16:03 +0900412 /* Get current event names */
413 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
414 if (ret < 0)
415 goto out;
416
417 klist = strlist__new(NULL, NULL);
Masami Hiramatsu0fb18552015-09-16 21:52:42 +0900418 ulist = strlist__new(NULL, NULL);
419 if (!klist || !ulist) {
420 ret = -ENOMEM;
421 goto out;
422 }
Namhyung Kime607f142015-09-04 21:16:03 +0900423
424 ret = probe_file__get_events(kfd, filter, klist);
425 if (ret == 0) {
Arnaldo Carvalho de Melo602a1f42016-06-23 11:31:20 -0300426 strlist__for_each_entry(ent, klist)
Namhyung Kime607f142015-09-04 21:16:03 +0900427 pr_info("Removed event: %s\n", ent->s);
428
429 ret = probe_file__del_strlist(kfd, klist);
430 if (ret < 0)
431 goto error;
432 }
433
434 ret2 = probe_file__get_events(ufd, filter, ulist);
435 if (ret2 == 0) {
Arnaldo Carvalho de Melo602a1f42016-06-23 11:31:20 -0300436 strlist__for_each_entry(ent, ulist)
Namhyung Kime607f142015-09-04 21:16:03 +0900437 pr_info("Removed event: %s\n", ent->s);
438
439 ret2 = probe_file__del_strlist(ufd, ulist);
440 if (ret2 < 0)
441 goto error;
442 }
443
444 if (ret == -ENOENT && ret2 == -ENOENT)
445 pr_debug("\"%s\" does not hit any event.\n", str);
446 /* Note that this is silently ignored */
447 ret = 0;
448
449error:
450 if (kfd >= 0)
451 close(kfd);
452 if (ufd >= 0)
453 close(ufd);
454out:
455 strlist__delete(klist);
456 strlist__delete(ulist);
457 free(str);
458
459 return ret;
460}
461
Masami Hiramatsu1c20b1d2016-08-26 01:24:27 +0900462#ifdef HAVE_DWARF_SUPPORT
463#define PROBEDEF_STR \
464 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT [[NAME=]ARG ...]"
465#else
466#define PROBEDEF_STR "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]"
467#endif
468
469
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000470static int
471__cmd_probe(int argc, const char **argv, const char *prefix __maybe_unused)
Arnaldo Carvalho de Melo11c4e4a2012-10-01 15:20:58 -0300472{
473 const char * const probe_usage[] = {
474 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
475 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
476 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900477 "perf probe --list [GROUP:]EVENT ...",
Ingo Molnar89fe8082013-09-30 12:07:11 +0200478#ifdef HAVE_DWARF_SUPPORT
Arnaldo Carvalho de Melo11c4e4a2012-10-01 15:20:58 -0300479 "perf probe [<options>] --line 'LINEDESC'",
480 "perf probe [<options>] --vars 'PROBEPOINT'",
Masami Hiramatsuf3ab4812010-02-25 08:35:12 -0500481#endif
Masami Hiramatsub3ac0322015-04-23 22:46:12 +0900482 "perf probe [<options>] --funcs",
Arnaldo Carvalho de Melo11c4e4a2012-10-01 15:20:58 -0300483 NULL
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900484 };
Namhyung Kim13dcbbc2014-10-23 00:15:49 +0900485 struct option options[] = {
Ian Munsiec0555642010-04-13 18:37:33 +1000486 OPT_INCR('v', "verbose", &verbose,
Masami Hiramatsu89c69c02009-10-16 20:08:10 -0400487 "be more verbose (show parsed arguments, etc)"),
Masami Hiramatsu5e17b282014-10-27 16:31:31 -0400488 OPT_BOOLEAN('q', "quiet", &params.quiet,
489 "be quiet (do not show any mesages)"),
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900490 OPT_CALLBACK_DEFAULT('l', "list", NULL, "[GROUP:]EVENT",
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900491 "list up probe events",
492 opt_set_filter_with_command, DEFAULT_LIST_FILTER),
Masami Hiramatsufa282442009-12-08 17:03:23 -0500493 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900494 opt_set_filter_with_command),
Masami Hiramatsu1c20b1d2016-08-26 01:24:27 +0900495 OPT_CALLBACK('a', "add", NULL, PROBEDEF_STR,
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400496 "probe point definition, where\n"
Masami Hiramatsuaf663d72009-12-15 10:32:18 -0500497 "\t\tGROUP:\tGroup name (optional)\n"
498 "\t\tEVENT:\tEvent name\n"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400499 "\t\tFUNC:\tFunction name\n"
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500500 "\t\tOFF:\tOffset from function entry (in byte)\n"
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400501 "\t\t%return:\tPut the probe at function return\n"
Ingo Molnar89fe8082013-09-30 12:07:11 +0200502#ifdef HAVE_DWARF_SUPPORT
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400503 "\t\tSRC:\tSource code path\n"
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500504 "\t\tRL:\tRelative line number from function entry.\n"
505 "\t\tAL:\tAbsolute line number in file.\n"
506 "\t\tPT:\tLazy expression of line code.\n"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400507 "\t\tARG:\tProbe argument (local variable name or\n"
Masami Hiramatsu50656ee2009-11-30 19:19:58 -0500508 "\t\t\tkprobe-tracer argument format.)\n",
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300509#else
510 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
511#endif
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400512 opt_add_probe_event),
Masami Hiramatsu1c20b1d2016-08-26 01:24:27 +0900513 OPT_CALLBACK('D', "definition", NULL, PROBEDEF_STR,
514 "Show trace event definition of given traceevent for k/uprobe_events.",
515 opt_add_probe_event),
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900516 OPT_BOOLEAN('f', "force", &probe_conf.force_add, "forcibly add events"
Masami Hiramatsud761b082009-12-15 10:32:25 -0500517 " with existing name"),
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500518 OPT_CALLBACK('L', "line", NULL,
Masami Hiramatsu085ea732010-04-02 12:50:39 -0400519 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500520 "Show source code lines.", opt_show_lines),
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900521 OPT_CALLBACK('V', "vars", NULL,
522 "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
523 "Show accessible variables on PROBEDEF", opt_show_vars),
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900524 OPT_BOOLEAN('\0', "externs", &probe_conf.show_ext_vars,
Masami Hiramatsufb8c5a52010-10-21 19:13:35 +0900525 "Show external variables too (with --vars only)"),
He Kuang349e8d22015-05-11 09:25:03 +0000526 OPT_BOOLEAN('\0', "range", &probe_conf.show_location_range,
527 "Show variables location range in scope (with --vars only)"),
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300528 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
529 "file", "vmlinux pathname"),
Chase Douglas9ed7e1b2010-06-14 15:26:30 -0400530 OPT_STRING('s', "source", &symbol_conf.source_prefix,
531 "directory", "path to kernel source"),
Masami Hiramatsu6cfd1f62015-05-08 10:03:33 +0900532 OPT_BOOLEAN('\0', "no-inlines", &probe_conf.no_inlines,
533 "Don't search inlined functions"),
Masami Hiramatsuf4d7da42010-03-16 18:06:05 -0400534 OPT__DRY_RUN(&probe_event_dry_run),
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900535 OPT_INTEGER('\0', "max-probes", &probe_conf.max_probes,
Masami Hiramatsuef4a3562010-04-21 15:56:40 -0400536 "Set how many probe points can be found for a probe."),
Masami Hiramatsu9f7811d2015-05-05 11:29:50 +0900537 OPT_CALLBACK_DEFAULT('F', "funcs", NULL, "[FILTER]",
538 "Show potential probe-able functions.",
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900539 opt_set_filter_with_command, DEFAULT_FUNC_FILTER),
Masami Hiramatsu3c422582011-01-20 23:15:45 +0900540 OPT_CALLBACK('\0', "filter", NULL,
541 "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
542 "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
543 "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
544 opt_set_filter),
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530545 OPT_CALLBACK('x', "exec", NULL, "executable|path",
546 "target executable name or path", opt_set_target),
Masami Hiramatsu1a8ac292015-10-02 21:58:32 +0900547 OPT_CALLBACK('m', "module", NULL, "modname|path",
548 "target module name (for online) or path (for offline)",
549 opt_set_target),
Azat Khuzhin35e17b22013-10-28 12:04:24 +0400550 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
Masami Hiramatsu4cdcc332014-10-27 16:31:24 -0400551 "Enable symbol demangling"),
Avi Kivity763122a2014-09-13 07:15:05 +0300552 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
553 "Enable kernel symbol demangling"),
Masami Hiramatsu2fd457a2016-06-15 12:28:40 +0900554 OPT_BOOLEAN(0, "cache", &probe_conf.cache, "Manipulate probe cache"),
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400555 OPT_END()
Arnaldo Carvalho de Melo11c4e4a2012-10-01 15:20:58 -0300556 };
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400557 int ret;
558
Namhyung Kim13dcbbc2014-10-23 00:15:49 +0900559 set_option_flag(options, 'a', "add", PARSE_OPT_EXCLUSIVE);
560 set_option_flag(options, 'd', "del", PARSE_OPT_EXCLUSIVE);
Masami Hiramatsu1c20b1d2016-08-26 01:24:27 +0900561 set_option_flag(options, 'D', "definition", PARSE_OPT_EXCLUSIVE);
Namhyung Kim13dcbbc2014-10-23 00:15:49 +0900562 set_option_flag(options, 'l', "list", PARSE_OPT_EXCLUSIVE);
563#ifdef HAVE_DWARF_SUPPORT
564 set_option_flag(options, 'L', "line", PARSE_OPT_EXCLUSIVE);
565 set_option_flag(options, 'V', "vars", PARSE_OPT_EXCLUSIVE);
Wang Nan48e1cab2015-12-14 10:39:22 +0000566#else
567# define set_nobuild(s, l, c) set_option_nobuild(options, s, l, "NO_DWARF=1", c)
568 set_nobuild('L', "line", false);
569 set_nobuild('V', "vars", false);
570 set_nobuild('\0', "externs", false);
571 set_nobuild('\0', "range", false);
572 set_nobuild('k', "vmlinux", true);
573 set_nobuild('s', "source", true);
574 set_nobuild('\0', "no-inlines", true);
575# undef set_nobuild
Namhyung Kim13dcbbc2014-10-23 00:15:49 +0900576#endif
Masami Hiramatsub3ac0322015-04-23 22:46:12 +0900577 set_option_flag(options, 'F', "funcs", PARSE_OPT_EXCLUSIVE);
Namhyung Kim13dcbbc2014-10-23 00:15:49 +0900578
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400579 argc = parse_options(argc, argv, options, probe_usage,
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400580 PARSE_OPT_STOP_AT_NON_OPTION);
Masami Hiramatsuce11a602009-12-15 10:31:28 -0500581 if (argc > 0) {
582 if (strcmp(argv[0], "-") == 0) {
Namhyung Kimc7118362015-10-25 00:49:27 +0900583 usage_with_options_msg(probe_usage, options,
584 "'-' is not supported.\n");
Masami Hiramatsuce11a602009-12-15 10:31:28 -0500585 }
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900586 if (params.command && params.command != 'a') {
Namhyung Kimc7118362015-10-25 00:49:27 +0900587 usage_with_options_msg(probe_usage, options,
588 "another command except --add is set.\n");
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900589 }
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400590 ret = parse_probe_event_argv(argc, argv);
591 if (ret < 0) {
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000592 pr_err_with_code(" Error: Command Parse Error.", ret);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400593 return ret;
594 }
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900595 params.command = 'a';
Masami Hiramatsuce11a602009-12-15 10:31:28 -0500596 }
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400597
Masami Hiramatsu5e17b282014-10-27 16:31:31 -0400598 if (params.quiet) {
599 if (verbose != 0) {
600 pr_err(" Error: -v and -q are exclusive.\n");
601 return -EINVAL;
602 }
603 verbose = -1;
604 }
605
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900606 if (probe_conf.max_probes == 0)
607 probe_conf.max_probes = MAX_PROBES;
Masami Hiramatsuef4a3562010-04-21 15:56:40 -0400608
Franck Bui-Huufd930ff2010-12-10 14:06:03 +0100609 /*
610 * Only consider the user's kernel image path if given.
611 */
612 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
613
Masami Hiramatsue50243b2016-08-26 23:57:58 +0900614 /*
615 * Except for --list, --del and --add, other command doesn't depend
616 * nor change running kernel. So if user gives offline vmlinux,
617 * ignore its buildid.
618 */
619 if (!strchr("lda", params.command) && symbol_conf.vmlinux_name)
620 symbol_conf.ignore_vmlinux_buildid = true;
621
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900622 switch (params.command) {
623 case 'l':
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530624 if (params.uprobes) {
Namhyung Kimc7118362015-10-25 00:49:27 +0900625 pr_err(" Error: Don't use --list with --exec.\n");
626 parse_options_usage(probe_usage, options, "l", true);
627 parse_options_usage(NULL, options, "x", true);
628 return -EINVAL;
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530629 }
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900630 ret = show_perf_probe_events(params.filter);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400631 if (ret < 0)
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000632 pr_err_with_code(" Error: Failed to show event list.", ret);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400633 return ret;
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900634 case 'F':
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530635 ret = show_available_funcs(params.target, params.filter,
636 params.uprobes);
Masami Hiramatsue80711c2011-01-13 21:46:11 +0900637 if (ret < 0)
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000638 pr_err_with_code(" Error: Failed to show functions.", ret);
Masami Hiramatsue80711c2011-01-13 21:46:11 +0900639 return ret;
Ingo Molnar89fe8082013-09-30 12:07:11 +0200640#ifdef HAVE_DWARF_SUPPORT
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900641 case 'L':
Masami Hiramatsu2b394bc2014-09-17 08:40:54 +0000642 ret = show_line_range(&params.line_range, params.target,
643 params.uprobes);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400644 if (ret < 0)
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000645 pr_err_with_code(" Error: Failed to show lines.", ret);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400646 return ret;
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900647 case 'V':
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900648 if (!params.filter)
649 params.filter = strfilter__new(DEFAULT_VAR_FILTER,
650 NULL);
651
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900652 ret = show_available_vars(params.events, params.nevents,
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900653 params.filter);
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900654 if (ret < 0)
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000655 pr_err_with_code(" Error: Failed to show vars.", ret);
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900656 return ret;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500657#endif
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900658 case 'd':
Namhyung Kime607f142015-09-04 21:16:03 +0900659 ret = perf_del_probe_events(params.filter);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400660 if (ret < 0) {
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000661 pr_err_with_code(" Error: Failed to delete events.", ret);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400662 return ret;
663 }
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900664 break;
Masami Hiramatsu1c20b1d2016-08-26 01:24:27 +0900665 case 'D':
Masami Hiramatsu428aff82016-08-26 01:24:42 +0900666 case 'a':
667
Masami Hiramatsu8cb0aa42015-04-01 19:25:42 +0900668 /* Ensure the last given target is used */
669 if (params.target && !params.target_used) {
Namhyung Kimc7118362015-10-25 00:49:27 +0900670 pr_err(" Error: -x/-m must follow the probe definitions.\n");
671 parse_options_usage(probe_usage, options, "m", true);
672 parse_options_usage(NULL, options, "x", true);
673 return -EINVAL;
Masami Hiramatsu8cb0aa42015-04-01 19:25:42 +0900674 }
675
Namhyung Kimb02137c2015-09-04 21:16:01 +0900676 ret = perf_add_probe_events(params.events, params.nevents);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400677 if (ret < 0) {
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000678 pr_err_with_code(" Error: Failed to add events.", ret);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400679 return ret;
680 }
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900681 break;
682 default:
683 usage_with_options(probe_usage, options);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400684 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400685 return 0;
686}
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000687
688int cmd_probe(int argc, const char **argv, const char *prefix)
689{
690 int ret;
691
Masami Hiramatsu5a622572014-02-06 05:32:09 +0000692 ret = init_params();
693 if (!ret) {
694 ret = __cmd_probe(argc, argv, prefix);
695 cleanup_params();
696 }
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000697
Masami Hiramatsu9bc9f3b2015-05-06 21:46:45 +0900698 return ret < 0 ? ret : 0;
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000699}