blob: add163c9f0e7d4db3fe01afe704a72c5a923597b [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 */
23#define _GNU_SOURCE
24#include <sys/utsname.h>
25#include <sys/types.h>
26#include <sys/stat.h>
27#include <fcntl.h>
28#include <errno.h>
29#include <stdio.h>
30#include <unistd.h>
31#include <stdlib.h>
32#include <string.h>
33
34#undef _GNU_SOURCE
35#include "perf.h"
36#include "builtin.h"
37#include "util/util.h"
Masami Hiramatsufa282442009-12-08 17:03:23 -050038#include "util/strlist.h"
Masami Hiramatsue0faa8d2010-03-16 18:05:37 -040039#include "util/symbol.h"
Masami Hiramatsu89c69c02009-10-16 20:08:10 -040040#include "util/debug.h"
Masami Hiramatsu96c96612009-12-16 17:24:00 -050041#include "util/debugfs.h"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040042#include "util/parse-options.h"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040043#include "util/probe-finder.h"
Masami Hiramatsu50656ee2009-11-30 19:19:58 -050044#include "util/probe-event.h"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040045
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040046#define MAX_PATH_LEN 256
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040047
48/* Session management structure */
49static struct {
Masami Hiramatsufac13fd2009-12-15 10:31:14 -050050 bool list_events;
Masami Hiramatsud761b082009-12-15 10:32:25 -050051 bool force_add;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -050052 bool show_lines;
Masami Hiramatsucf6eb482010-10-21 19:13:23 +090053 bool show_vars;
Masami Hiramatsufb8c5a52010-10-21 19:13:35 +090054 bool show_ext_vars;
Masami Hiramatsucf6eb482010-10-21 19:13:23 +090055 bool mod_events;
Masami Hiramatsu4235b042010-03-16 18:06:12 -040056 int nevents;
57 struct perf_probe_event events[MAX_PROBES];
Masami Hiramatsufa282442009-12-08 17:03:23 -050058 struct strlist *dellist;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -050059 struct line_range line_range;
Masami Hiramatsu469b9b82010-10-21 19:13:41 +090060 const char *target_module;
Masami Hiramatsuef4a3562010-04-21 15:56:40 -040061 int max_probe_points;
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -040062} params;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040063
Masami Hiramatsu253977b2009-10-27 16:43:10 -040064/* Parse an event definition. Note that any error must die. */
Masami Hiramatsu146a1432010-04-12 13:17:42 -040065static int parse_probe_event(const char *str)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040066{
Masami Hiramatsu4235b042010-03-16 18:06:12 -040067 struct perf_probe_event *pev = &params.events[params.nevents];
Masami Hiramatsu146a1432010-04-12 13:17:42 -040068 int ret;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040069
Masami Hiramatsu4235b042010-03-16 18:06:12 -040070 pr_debug("probe-definition(%d): %s\n", params.nevents, str);
Arnaldo Carvalho de Melo8a7ddad2010-05-18 22:57:27 -030071 if (++params.nevents == MAX_PROBES) {
72 pr_err("Too many probes (> %d) were specified.", MAX_PROBES);
73 return -1;
74 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040075
Masami Hiramatsu4235b042010-03-16 18:06:12 -040076 /* Parse a perf-probe command into event */
Masami Hiramatsu146a1432010-04-12 13:17:42 -040077 ret = parse_perf_probe_command(str, pev);
Masami Hiramatsu4235b042010-03-16 18:06:12 -040078 pr_debug("%d arguments\n", pev->nargs);
Masami Hiramatsu146a1432010-04-12 13:17:42 -040079
80 return ret;
Masami Hiramatsu46ab4922009-10-27 16:43:02 -040081}
82
Masami Hiramatsu146a1432010-04-12 13:17:42 -040083static int parse_probe_event_argv(int argc, const char **argv)
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -050084{
Masami Hiramatsu146a1432010-04-12 13:17:42 -040085 int i, len, ret;
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -050086 char *buf;
87
88 /* Bind up rest arguments */
89 len = 0;
90 for (i = 0; i < argc; i++)
91 len += strlen(argv[i]) + 1;
Arnaldo Carvalho de Melo8a7ddad2010-05-18 22:57:27 -030092 buf = zalloc(len + 1);
93 if (buf == NULL)
94 return -ENOMEM;
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -050095 len = 0;
96 for (i = 0; i < argc; i++)
97 len += sprintf(&buf[len], "%s ", argv[i]);
Masami Hiramatsucf6eb482010-10-21 19:13:23 +090098 params.mod_events = true;
Masami Hiramatsu146a1432010-04-12 13:17:42 -040099 ret = parse_probe_event(buf);
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500100 free(buf);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400101 return ret;
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500102}
103
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400104static int opt_add_probe_event(const struct option *opt __used,
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400105 const char *str, int unset __used)
106{
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900107 if (str) {
108 params.mod_events = true;
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400109 return parse_probe_event(str);
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900110 } else
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400111 return 0;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400112}
113
Masami Hiramatsufa282442009-12-08 17:03:23 -0500114static int opt_del_probe_event(const struct option *opt __used,
115 const char *str, int unset __used)
116{
117 if (str) {
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900118 params.mod_events = true;
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400119 if (!params.dellist)
120 params.dellist = strlist__new(true, NULL);
121 strlist__add(params.dellist, str);
Masami Hiramatsufa282442009-12-08 17:03:23 -0500122 }
123 return 0;
124}
125
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300126#ifdef DWARF_SUPPORT
Hitoshi Mitake0eda7382010-01-16 21:31:16 +0900127static int opt_show_lines(const struct option *opt __used,
128 const char *str, int unset __used)
129{
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400130 int ret = 0;
131
Hitoshi Mitake0eda7382010-01-16 21:31:16 +0900132 if (str)
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400133 ret = parse_line_range_desc(str, &params.line_range);
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400134 INIT_LIST_HEAD(&params.line_range.line_list);
135 params.show_lines = true;
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400136
137 return ret;
Hitoshi Mitake0eda7382010-01-16 21:31:16 +0900138}
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900139
140static int opt_show_vars(const struct option *opt __used,
141 const char *str, int unset __used)
142{
143 struct perf_probe_event *pev = &params.events[params.nevents];
144 int ret;
145
146 if (!str)
147 return 0;
148
149 ret = parse_probe_event(str);
150 if (!ret && pev->nargs != 0) {
151 pr_err(" Error: '--vars' doesn't accept arguments.\n");
152 return -EINVAL;
153 }
154 params.show_vars = true;
155
156 return ret;
157}
Masami Hiramatsu23e8ec02009-10-07 18:28:30 -0400158#endif
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400159
160static const char * const probe_usage[] = {
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400161 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
162 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
Masami Hiramatsufa282442009-12-08 17:03:23 -0500163 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
Masami Hiramatsu4de189f2009-11-30 19:20:17 -0500164 "perf probe --list",
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300165#ifdef DWARF_SUPPORT
Masami Hiramatsu469b9b82010-10-21 19:13:41 +0900166 "perf probe [<options>] --line 'LINEDESC'",
167 "perf probe [<options>] --vars 'PROBEPOINT'",
Masami Hiramatsuf3ab4812010-02-25 08:35:12 -0500168#endif
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400169 NULL
170};
171
172static const struct option options[] = {
Ian Munsiec0555642010-04-13 18:37:33 +1000173 OPT_INCR('v', "verbose", &verbose,
Masami Hiramatsu89c69c02009-10-16 20:08:10 -0400174 "be more verbose (show parsed arguments, etc)"),
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400175 OPT_BOOLEAN('l', "list", &params.list_events,
Masami Hiramatsufac13fd2009-12-15 10:31:14 -0500176 "list up current probe events"),
Masami Hiramatsufa282442009-12-08 17:03:23 -0500177 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
178 opt_del_probe_event),
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400179 OPT_CALLBACK('a', "add", NULL,
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300180#ifdef DWARF_SUPPORT
Masami Hiramatsu32cb0dd2010-03-03 22:38:43 -0500181 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
Masami Hiramatsu48481932010-04-12 13:16:53 -0400182 " [[NAME=]ARG ...]",
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300183#else
Masami Hiramatsu48481932010-04-12 13:16:53 -0400184 "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]",
Masami Hiramatsu23e8ec02009-10-07 18:28:30 -0400185#endif
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400186 "probe point definition, where\n"
Masami Hiramatsuaf663d72009-12-15 10:32:18 -0500187 "\t\tGROUP:\tGroup name (optional)\n"
188 "\t\tEVENT:\tEvent name\n"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400189 "\t\tFUNC:\tFunction name\n"
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500190 "\t\tOFF:\tOffset from function entry (in byte)\n"
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400191 "\t\t%return:\tPut the probe at function return\n"
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300192#ifdef DWARF_SUPPORT
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400193 "\t\tSRC:\tSource code path\n"
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500194 "\t\tRL:\tRelative line number from function entry.\n"
195 "\t\tAL:\tAbsolute line number in file.\n"
196 "\t\tPT:\tLazy expression of line code.\n"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400197 "\t\tARG:\tProbe argument (local variable name or\n"
Masami Hiramatsu50656ee2009-11-30 19:19:58 -0500198 "\t\t\tkprobe-tracer argument format.)\n",
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300199#else
200 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
201#endif
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400202 opt_add_probe_event),
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400203 OPT_BOOLEAN('f', "force", &params.force_add, "forcibly add events"
Masami Hiramatsud761b082009-12-15 10:32:25 -0500204 " with existing name"),
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300205#ifdef DWARF_SUPPORT
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500206 OPT_CALLBACK('L', "line", NULL,
Masami Hiramatsu085ea732010-04-02 12:50:39 -0400207 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500208 "Show source code lines.", opt_show_lines),
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900209 OPT_CALLBACK('V', "vars", NULL,
210 "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
211 "Show accessible variables on PROBEDEF", opt_show_vars),
Masami Hiramatsufb8c5a52010-10-21 19:13:35 +0900212 OPT_BOOLEAN('\0', "externs", &params.show_ext_vars,
213 "Show external variables too (with --vars only)"),
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300214 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
215 "file", "vmlinux pathname"),
Chase Douglas9ed7e1b2010-06-14 15:26:30 -0400216 OPT_STRING('s', "source", &symbol_conf.source_prefix,
217 "directory", "path to kernel source"),
Masami Hiramatsu469b9b82010-10-21 19:13:41 +0900218 OPT_STRING('m', "module", &params.target_module,
219 "modname", "target module name"),
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500220#endif
Masami Hiramatsuf4d7da42010-03-16 18:06:05 -0400221 OPT__DRY_RUN(&probe_event_dry_run),
Masami Hiramatsuef4a3562010-04-21 15:56:40 -0400222 OPT_INTEGER('\0', "max-probes", &params.max_probe_points,
223 "Set how many probe points can be found for a probe."),
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400224 OPT_END()
225};
226
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400227int cmd_probe(int argc, const char **argv, const char *prefix __used)
228{
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400229 int ret;
230
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400231 argc = parse_options(argc, argv, options, probe_usage,
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400232 PARSE_OPT_STOP_AT_NON_OPTION);
Masami Hiramatsuce11a602009-12-15 10:31:28 -0500233 if (argc > 0) {
234 if (strcmp(argv[0], "-") == 0) {
235 pr_warning(" Error: '-' is not supported.\n");
236 usage_with_options(probe_usage, options);
237 }
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400238 ret = parse_probe_event_argv(argc, argv);
239 if (ret < 0) {
240 pr_err(" Error: Parse Error. (%d)\n", ret);
241 return ret;
242 }
Masami Hiramatsuce11a602009-12-15 10:31:28 -0500243 }
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400244
Masami Hiramatsuef4a3562010-04-21 15:56:40 -0400245 if (params.max_probe_points == 0)
246 params.max_probe_points = MAX_PROBES;
247
Masami Hiramatsu4235b042010-03-16 18:06:12 -0400248 if ((!params.nevents && !params.dellist && !params.list_events &&
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400249 !params.show_lines))
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400250 usage_with_options(probe_usage, options);
251
Franck Bui-Huufd930ff2010-12-10 14:06:03 +0100252 /*
253 * Only consider the user's kernel image path if given.
254 */
255 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
256
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400257 if (params.list_events) {
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900258 if (params.mod_events) {
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400259 pr_err(" Error: Don't use --list with --add/--del.\n");
Masami Hiramatsufa282442009-12-08 17:03:23 -0500260 usage_with_options(probe_usage, options);
261 }
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400262 if (params.show_lines) {
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400263 pr_err(" Error: Don't use --list with --line.\n");
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500264 usage_with_options(probe_usage, options);
265 }
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900266 if (params.show_vars) {
267 pr_err(" Error: Don't use --list with --vars.\n");
268 usage_with_options(probe_usage, options);
269 }
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400270 ret = show_perf_probe_events();
271 if (ret < 0)
272 pr_err(" Error: Failed to show event list. (%d)\n",
273 ret);
274 return ret;
Masami Hiramatsu4de189f2009-11-30 19:20:17 -0500275 }
276
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300277#ifdef DWARF_SUPPORT
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400278 if (params.show_lines) {
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900279 if (params.mod_events) {
280 pr_err(" Error: Don't use --line with"
281 " --add/--del.\n");
282 usage_with_options(probe_usage, options);
283 }
284 if (params.show_vars) {
285 pr_err(" Error: Don't use --line with --vars.\n");
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500286 usage_with_options(probe_usage, options);
287 }
Masami Hiramatsue0faa8d2010-03-16 18:05:37 -0400288
Masami Hiramatsu469b9b82010-10-21 19:13:41 +0900289 ret = show_line_range(&params.line_range, params.target_module);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400290 if (ret < 0)
291 pr_err(" Error: Failed to show lines. (%d)\n", ret);
292 return ret;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500293 }
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900294 if (params.show_vars) {
295 if (params.mod_events) {
296 pr_err(" Error: Don't use --vars with"
297 " --add/--del.\n");
298 usage_with_options(probe_usage, options);
299 }
300 ret = show_available_vars(params.events, params.nevents,
Masami Hiramatsufb8c5a52010-10-21 19:13:35 +0900301 params.max_probe_points,
Masami Hiramatsu469b9b82010-10-21 19:13:41 +0900302 params.target_module,
Masami Hiramatsufb8c5a52010-10-21 19:13:35 +0900303 params.show_ext_vars);
Masami Hiramatsucf6eb482010-10-21 19:13:23 +0900304 if (ret < 0)
305 pr_err(" Error: Failed to show vars. (%d)\n", ret);
306 return ret;
307 }
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500308#endif
309
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400310 if (params.dellist) {
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400311 ret = del_perf_probe_events(params.dellist);
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400312 strlist__delete(params.dellist);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400313 if (ret < 0) {
314 pr_err(" Error: Failed to delete events. (%d)\n", ret);
315 return ret;
316 }
Masami Hiramatsufa282442009-12-08 17:03:23 -0500317 }
318
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400319 if (params.nevents) {
320 ret = add_perf_probe_events(params.events, params.nevents,
Masami Hiramatsuc82ec0a2010-10-21 19:13:29 +0900321 params.max_probe_points,
Masami Hiramatsu469b9b82010-10-21 19:13:41 +0900322 params.target_module,
Masami Hiramatsuc82ec0a2010-10-21 19:13:29 +0900323 params.force_add);
Masami Hiramatsu146a1432010-04-12 13:17:42 -0400324 if (ret < 0) {
325 pr_err(" Error: Failed to add events. (%d)\n", ret);
326 return ret;
327 }
328 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400329 return 0;
330}