blob: 1272559fa22d9eb60367f34594ebd18a7e76e8d3 [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"
Borislav Petkov553873e2013-12-09 17:14:23 +010040#include <api/fs/debugfs.h>
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040041#include "util/parse-options.h"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040042#include "util/probe-finder.h"
Masami Hiramatsu50656ee2009-11-30 19:19:58 -050043#include "util/probe-event.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 Hiramatsub6a89642015-04-24 18:47:50 +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;
Ingo Molnar89fe8082013-09-30 12:07:11 +0200185#ifdef HAVE_DWARF_SUPPORT
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530186 else if (!strcmp(opt->long_name, "module"))
187 params.uprobes = false;
188#endif
189 else
190 return ret;
191
Masami Hiramatsu8a613d42013-12-26 05:41:50 +0000192 /* Expand given path to absolute path, except for modulename */
193 if (params.uprobes || strchr(str, '/')) {
194 tmp = realpath(str, NULL);
195 if (!tmp) {
196 pr_warning("Failed to get the absolute path of %s: %m\n", str);
197 return ret;
198 }
199 } else {
200 tmp = strdup(str);
201 if (!tmp)
202 return -ENOMEM;
203 }
Masami Hiramatsu7afb3fa2015-04-01 19:25:39 +0900204 free(params.target);
Masami Hiramatsu8a613d42013-12-26 05:41:50 +0000205 params.target = tmp;
Masami Hiramatsu8cb0aa42015-04-01 19:25:42 +0900206 params.target_used = false;
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530207 ret = 0;
208 }
209
210 return ret;
211}
212
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900213/* Command option callbacks */
214
Ingo Molnar89fe8082013-09-30 12:07:11 +0200215#ifdef HAVE_DWARF_SUPPORT
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900216static int opt_show_lines(const struct option *opt,
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300217 const char *str, int unset __maybe_unused)
Hitoshi Mitake0eda7382010-01-16 21:31:16 +0900218{
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400219 int ret = 0;
220
Masami Hiramatsu13e27d72011-08-11 20:02:53 +0900221 if (!str)
222 return 0;
223
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900224 if (params.command == 'L') {
Masami Hiramatsu13e27d72011-08-11 20:02:53 +0900225 pr_warning("Warning: more than one --line options are"
226 " detected. Only the first one is valid.\n");
227 return 0;
228 }
229
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900230 params.command = opt->short_name;
Masami Hiramatsu13e27d72011-08-11 20:02:53 +0900231 ret = parse_line_range_desc(str, &params.line_range);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400232
233 return ret;
Hitoshi Mitake0eda7382010-01-16 21:31:16 +0900234}
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900235
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900236static int opt_show_vars(const struct option *opt,
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300237 const char *str, int unset __maybe_unused)
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900238{
239 struct perf_probe_event *pev = &params.events[params.nevents];
240 int ret;
241
242 if (!str)
243 return 0;
244
245 ret = parse_probe_event(str);
246 if (!ret && pev->nargs != 0) {
247 pr_err(" Error: '--vars' doesn't accept arguments.\n");
248 return -EINVAL;
249 }
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900250 params.command = opt->short_name;
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900251
252 return ret;
253}
Masami Hiramatsu3c422582011-01-20 23:15:45 +0900254#endif
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900255static int opt_add_probe_event(const struct option *opt,
256 const char *str, int unset __maybe_unused)
257{
258 if (str) {
259 params.command = opt->short_name;
260 return parse_probe_event(str);
261 }
262
263 return 0;
264}
265
266static int opt_set_filter_with_command(const struct option *opt,
267 const char *str, int unset)
Masami Hiramatsu9f7811d2015-05-05 11:29:50 +0900268{
269 if (!unset)
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900270 params.command = opt->short_name;
Masami Hiramatsu9f7811d2015-05-05 11:29:50 +0900271
272 if (str)
273 return params_add_filter(str);
274
275 return 0;
276}
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900277
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300278static int opt_set_filter(const struct option *opt __maybe_unused,
279 const char *str, int unset __maybe_unused)
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900280{
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900281 if (str)
282 return params_add_filter(str);
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900283
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900284 return 0;
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900285}
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400286
Masami Hiramatsu5a622572014-02-06 05:32:09 +0000287static int init_params(void)
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000288{
Masami Hiramatsu5a622572014-02-06 05:32:09 +0000289 return line_range__init(&params.line_range);
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000290}
291
292static void cleanup_params(void)
293{
294 int i;
295
296 for (i = 0; i < params.nevents; i++)
297 clear_perf_probe_event(params.events + i);
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000298 line_range__clear(&params.line_range);
299 free(params.target);
300 if (params.filter)
301 strfilter__delete(params.filter);
302 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)",
311 strerror_r(-err, sbuf, sizeof(sbuf)), err);
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000312 pr_err("\n");
313}
314
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000315static int
316__cmd_probe(int argc, const char **argv, const char *prefix __maybe_unused)
Arnaldo Carvalho de Melo11c4e4a2012-10-01 15:20:58 -0300317{
318 const char * const probe_usage[] = {
319 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
320 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
321 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900322 "perf probe --list [GROUP:]EVENT ...",
Ingo Molnar89fe8082013-09-30 12:07:11 +0200323#ifdef HAVE_DWARF_SUPPORT
Arnaldo Carvalho de Melo11c4e4a2012-10-01 15:20:58 -0300324 "perf probe [<options>] --line 'LINEDESC'",
325 "perf probe [<options>] --vars 'PROBEPOINT'",
Masami Hiramatsuf3ab4812010-02-25 08:35:12 -0500326#endif
Masami Hiramatsub3ac0322015-04-23 22:46:12 +0900327 "perf probe [<options>] --funcs",
Arnaldo Carvalho de Melo11c4e4a2012-10-01 15:20:58 -0300328 NULL
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900329 };
Namhyung Kim13dcbbc2014-10-23 00:15:49 +0900330 struct option options[] = {
Ian Munsiec0555642010-04-13 18:37:33 +1000331 OPT_INCR('v', "verbose", &verbose,
Masami Hiramatsu89c69c02009-10-16 20:08:10 -0400332 "be more verbose (show parsed arguments, etc)"),
Masami Hiramatsu5e17b282014-10-27 16:31:31 -0400333 OPT_BOOLEAN('q', "quiet", &params.quiet,
334 "be quiet (do not show any mesages)"),
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900335 OPT_CALLBACK_DEFAULT('l', "list", NULL, "[GROUP:]EVENT",
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900336 "list up probe events",
337 opt_set_filter_with_command, DEFAULT_LIST_FILTER),
Masami Hiramatsufa282442009-12-08 17:03:23 -0500338 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900339 opt_set_filter_with_command),
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400340 OPT_CALLBACK('a', "add", NULL,
Ingo Molnar89fe8082013-09-30 12:07:11 +0200341#ifdef HAVE_DWARF_SUPPORT
Masami Hiramatsu32cb0dd2010-03-03 22:38:43 -0500342 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
Masami Hiramatsu48481932010-04-12 13:16:53 -0400343 " [[NAME=]ARG ...]",
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300344#else
Masami Hiramatsu48481932010-04-12 13:16:53 -0400345 "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]",
Masami Hiramatsu23e8ec02009-10-07 18:28:30 -0400346#endif
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400347 "probe point definition, where\n"
Masami Hiramatsuaf663d72009-12-15 10:32:18 -0500348 "\t\tGROUP:\tGroup name (optional)\n"
349 "\t\tEVENT:\tEvent name\n"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400350 "\t\tFUNC:\tFunction name\n"
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500351 "\t\tOFF:\tOffset from function entry (in byte)\n"
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400352 "\t\t%return:\tPut the probe at function return\n"
Ingo Molnar89fe8082013-09-30 12:07:11 +0200353#ifdef HAVE_DWARF_SUPPORT
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400354 "\t\tSRC:\tSource code path\n"
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500355 "\t\tRL:\tRelative line number from function entry.\n"
356 "\t\tAL:\tAbsolute line number in file.\n"
357 "\t\tPT:\tLazy expression of line code.\n"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400358 "\t\tARG:\tProbe argument (local variable name or\n"
Masami Hiramatsu50656ee2009-11-30 19:19:58 -0500359 "\t\t\tkprobe-tracer argument format.)\n",
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300360#else
361 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
362#endif
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400363 opt_add_probe_event),
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900364 OPT_BOOLEAN('f', "force", &probe_conf.force_add, "forcibly add events"
Masami Hiramatsud761b082009-12-15 10:32:25 -0500365 " with existing name"),
Ingo Molnar89fe8082013-09-30 12:07:11 +0200366#ifdef HAVE_DWARF_SUPPORT
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500367 OPT_CALLBACK('L', "line", NULL,
Masami Hiramatsu085ea732010-04-02 12:50:39 -0400368 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500369 "Show source code lines.", opt_show_lines),
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900370 OPT_CALLBACK('V', "vars", NULL,
371 "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
372 "Show accessible variables on PROBEDEF", opt_show_vars),
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900373 OPT_BOOLEAN('\0', "externs", &probe_conf.show_ext_vars,
Masami Hiramatsufb8c5a52010-10-21 19:13:35 +0900374 "Show external variables too (with --vars only)"),
He Kuang349e8d22015-05-11 09:25:03 +0000375 OPT_BOOLEAN('\0', "range", &probe_conf.show_location_range,
376 "Show variables location range in scope (with --vars only)"),
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300377 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
378 "file", "vmlinux pathname"),
Chase Douglas9ed7e1b2010-06-14 15:26:30 -0400379 OPT_STRING('s', "source", &symbol_conf.source_prefix,
380 "directory", "path to kernel source"),
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530381 OPT_CALLBACK('m', "module", NULL, "modname|path",
382 "target module name (for online) or path (for offline)",
383 opt_set_target),
Masami Hiramatsu6cfd1f62015-05-08 10:03:33 +0900384 OPT_BOOLEAN('\0', "no-inlines", &probe_conf.no_inlines,
385 "Don't search inlined functions"),
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500386#endif
Masami Hiramatsuf4d7da42010-03-16 18:06:05 -0400387 OPT__DRY_RUN(&probe_event_dry_run),
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900388 OPT_INTEGER('\0', "max-probes", &probe_conf.max_probes,
Masami Hiramatsuef4a3562010-04-21 15:56:40 -0400389 "Set how many probe points can be found for a probe."),
Masami Hiramatsu9f7811d2015-05-05 11:29:50 +0900390 OPT_CALLBACK_DEFAULT('F', "funcs", NULL, "[FILTER]",
391 "Show potential probe-able functions.",
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900392 opt_set_filter_with_command, DEFAULT_FUNC_FILTER),
Masami Hiramatsu3c422582011-01-20 23:15:45 +0900393 OPT_CALLBACK('\0', "filter", NULL,
394 "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
395 "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
396 "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
397 opt_set_filter),
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530398 OPT_CALLBACK('x', "exec", NULL, "executable|path",
399 "target executable name or path", opt_set_target),
Azat Khuzhin35e17b22013-10-28 12:04:24 +0400400 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
Masami Hiramatsu4cdcc332014-10-27 16:31:24 -0400401 "Enable symbol demangling"),
Avi Kivity763122a2014-09-13 07:15:05 +0300402 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
403 "Enable kernel symbol demangling"),
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400404 OPT_END()
Arnaldo Carvalho de Melo11c4e4a2012-10-01 15:20:58 -0300405 };
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400406 int ret;
407
Namhyung Kim13dcbbc2014-10-23 00:15:49 +0900408 set_option_flag(options, 'a', "add", PARSE_OPT_EXCLUSIVE);
409 set_option_flag(options, 'd', "del", PARSE_OPT_EXCLUSIVE);
410 set_option_flag(options, 'l', "list", PARSE_OPT_EXCLUSIVE);
411#ifdef HAVE_DWARF_SUPPORT
412 set_option_flag(options, 'L', "line", PARSE_OPT_EXCLUSIVE);
413 set_option_flag(options, 'V', "vars", PARSE_OPT_EXCLUSIVE);
414#endif
Masami Hiramatsub3ac0322015-04-23 22:46:12 +0900415 set_option_flag(options, 'F', "funcs", PARSE_OPT_EXCLUSIVE);
Namhyung Kim13dcbbc2014-10-23 00:15:49 +0900416
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400417 argc = parse_options(argc, argv, options, probe_usage,
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400418 PARSE_OPT_STOP_AT_NON_OPTION);
Masami Hiramatsuce11a602009-12-15 10:31:28 -0500419 if (argc > 0) {
420 if (strcmp(argv[0], "-") == 0) {
421 pr_warning(" Error: '-' is not supported.\n");
422 usage_with_options(probe_usage, options);
423 }
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900424 if (params.command && params.command != 'a') {
425 pr_warning(" Error: another command except --add is set.\n");
426 usage_with_options(probe_usage, options);
427 }
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400428 ret = parse_probe_event_argv(argc, argv);
429 if (ret < 0) {
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000430 pr_err_with_code(" Error: Command Parse Error.", ret);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400431 return ret;
432 }
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900433 params.command = 'a';
Masami Hiramatsuce11a602009-12-15 10:31:28 -0500434 }
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400435
Masami Hiramatsu5e17b282014-10-27 16:31:31 -0400436 if (params.quiet) {
437 if (verbose != 0) {
438 pr_err(" Error: -v and -q are exclusive.\n");
439 return -EINVAL;
440 }
441 verbose = -1;
442 }
443
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900444 if (probe_conf.max_probes == 0)
445 probe_conf.max_probes = MAX_PROBES;
Masami Hiramatsuef4a3562010-04-21 15:56:40 -0400446
Franck Bui-Huufd930ff2010-12-10 14:06:03 +0100447 /*
448 * Only consider the user's kernel image path if given.
449 */
450 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
451
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900452 switch (params.command) {
453 case 'l':
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530454 if (params.uprobes) {
455 pr_warning(" Error: Don't use --list with --exec.\n");
456 usage_with_options(probe_usage, options);
457 }
Masami Hiramatsub6a89642015-04-24 18:47:50 +0900458 ret = show_perf_probe_events(params.filter);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400459 if (ret < 0)
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000460 pr_err_with_code(" Error: Failed to show event list.", ret);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400461 return ret;
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900462 case 'F':
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530463 ret = show_available_funcs(params.target, params.filter,
464 params.uprobes);
Masami Hiramatsue80711c2011-01-13 21:46:11 +0900465 if (ret < 0)
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000466 pr_err_with_code(" Error: Failed to show functions.", ret);
Masami Hiramatsue80711c2011-01-13 21:46:11 +0900467 return ret;
Ingo Molnar89fe8082013-09-30 12:07:11 +0200468#ifdef HAVE_DWARF_SUPPORT
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900469 case 'L':
Masami Hiramatsu2b394bc2014-09-17 08:40:54 +0000470 ret = show_line_range(&params.line_range, params.target,
471 params.uprobes);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400472 if (ret < 0)
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000473 pr_err_with_code(" Error: Failed to show lines.", ret);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400474 return ret;
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900475 case 'V':
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900476 if (!params.filter)
477 params.filter = strfilter__new(DEFAULT_VAR_FILTER,
478 NULL);
479
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900480 ret = show_available_vars(params.events, params.nevents,
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900481 params.filter);
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900482 if (ret < 0)
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000483 pr_err_with_code(" Error: Failed to show vars.", ret);
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900484 return ret;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500485#endif
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900486 case 'd':
Masami Hiramatsu307a4642015-05-05 11:29:48 +0900487 ret = del_perf_probe_events(params.filter);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400488 if (ret < 0) {
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000489 pr_err_with_code(" Error: Failed to delete events.", ret);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400490 return ret;
491 }
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900492 break;
493 case 'a':
Masami Hiramatsu8cb0aa42015-04-01 19:25:42 +0900494 /* Ensure the last given target is used */
495 if (params.target && !params.target_used) {
496 pr_warning(" Error: -x/-m must follow the probe definitions.\n");
497 usage_with_options(probe_usage, options);
498 }
499
Masami Hiramatsuddb2f582015-05-08 10:03:31 +0900500 ret = add_perf_probe_events(params.events, params.nevents);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400501 if (ret < 0) {
Masami Hiramatsub4bf1132014-06-06 07:13:52 +0000502 pr_err_with_code(" Error: Failed to add events.", ret);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400503 return ret;
504 }
Masami Hiramatsub1019d52015-05-06 00:22:57 +0900505 break;
506 default:
507 usage_with_options(probe_usage, options);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400508 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400509 return 0;
510}
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000511
512int cmd_probe(int argc, const char **argv, const char *prefix)
513{
514 int ret;
515
Masami Hiramatsu5a622572014-02-06 05:32:09 +0000516 ret = init_params();
517 if (!ret) {
518 ret = __cmd_probe(argc, argv, prefix);
519 cleanup_params();
520 }
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000521
Masami Hiramatsu9bc9f3b2015-05-06 21:46:45 +0900522 return ret < 0 ? ret : 0;
Masami Hiramatsue53b00d2014-01-16 09:39:47 +0000523}