4 * Builtin probe command: Set up probe events by C expression
6 * Written by Masami Hiramatsu <mhiramat@redhat.com>
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.
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.
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.
24 #include <sys/utsname.h>
25 #include <sys/types.h>
37 #include "util/util.h"
38 #include "util/strlist.h"
39 #include "util/symbol.h"
40 #include "util/debug.h"
41 #include "util/debugfs.h"
42 #include "util/parse-options.h"
43 #include "util/parse-events.h" /* For debugfs_path */
44 #include "util/probe-finder.h"
45 #include "util/probe-event.h"
47 #define MAX_PATH_LEN 256
49 /* Session management structure */
55 struct perf_probe_event events[MAX_PROBES];
56 struct strlist *dellist;
57 struct line_range line_range;
61 /* Parse an event definition. Note that any error must die. */
62 static void parse_probe_event(const char *str)
64 struct perf_probe_event *pev = ¶ms.events[params.nevents];
66 pr_debug("probe-definition(%d): %s\n", params.nevents, str);
67 if (++params.nevents == MAX_PROBES)
68 die("Too many probes (> %d) are specified.", MAX_PROBES);
70 /* Parse a perf-probe command into event */
71 parse_perf_probe_command(str, pev);
73 pr_debug("%d arguments\n", pev->nargs);
76 static void parse_probe_event_argv(int argc, const char **argv)
81 /* Bind up rest arguments */
83 for (i = 0; i < argc; i++)
84 len += strlen(argv[i]) + 1;
85 buf = xzalloc(len + 1);
87 for (i = 0; i < argc; i++)
88 len += sprintf(&buf[len], "%s ", argv[i]);
89 parse_probe_event(buf);
93 static int opt_add_probe_event(const struct option *opt __used,
94 const char *str, int unset __used)
97 parse_probe_event(str);
101 static int opt_del_probe_event(const struct option *opt __used,
102 const char *str, int unset __used)
106 params.dellist = strlist__new(true, NULL);
107 strlist__add(params.dellist, str);
112 #ifndef NO_DWARF_SUPPORT
113 static int opt_show_lines(const struct option *opt __used,
114 const char *str, int unset __used)
117 parse_line_range_desc(str, ¶ms.line_range);
118 INIT_LIST_HEAD(¶ms.line_range.line_list);
119 params.show_lines = true;
124 static const char * const probe_usage[] = {
125 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
126 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
127 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
129 #ifndef NO_DWARF_SUPPORT
130 "perf probe --line 'LINEDESC'",
135 static const struct option options[] = {
136 OPT_BOOLEAN('v', "verbose", &verbose,
137 "be more verbose (show parsed arguments, etc)"),
138 #ifndef NO_DWARF_SUPPORT
139 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
140 "file", "vmlinux pathname"),
142 OPT_BOOLEAN('l', "list", ¶ms.list_events,
143 "list up current probe events"),
144 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
145 opt_del_probe_event),
146 OPT_CALLBACK('a', "add", NULL,
147 #ifdef NO_DWARF_SUPPORT
148 "[EVENT=]FUNC[+OFF|%return] [ARG ...]",
150 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
153 "probe point definition, where\n"
154 "\t\tGROUP:\tGroup name (optional)\n"
155 "\t\tEVENT:\tEvent name\n"
156 "\t\tFUNC:\tFunction name\n"
157 "\t\tOFF:\tOffset from function entry (in byte)\n"
158 "\t\t%return:\tPut the probe at function return\n"
159 #ifdef NO_DWARF_SUPPORT
160 "\t\tARG:\tProbe argument (only \n"
162 "\t\tSRC:\tSource code path\n"
163 "\t\tRL:\tRelative line number from function entry.\n"
164 "\t\tAL:\tAbsolute line number in file.\n"
165 "\t\tPT:\tLazy expression of line code.\n"
166 "\t\tARG:\tProbe argument (local variable name or\n"
168 "\t\t\tkprobe-tracer argument format.)\n",
169 opt_add_probe_event),
170 OPT_BOOLEAN('f', "force", ¶ms.force_add, "forcibly add events"
171 " with existing name"),
172 #ifndef NO_DWARF_SUPPORT
173 OPT_CALLBACK('L', "line", NULL,
174 "FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]",
175 "Show source code lines.", opt_show_lines),
177 OPT__DRY_RUN(&probe_event_dry_run),
181 int cmd_probe(int argc, const char **argv, const char *prefix __used)
183 argc = parse_options(argc, argv, options, probe_usage,
184 PARSE_OPT_STOP_AT_NON_OPTION);
186 if (strcmp(argv[0], "-") == 0) {
187 pr_warning(" Error: '-' is not supported.\n");
188 usage_with_options(probe_usage, options);
190 parse_probe_event_argv(argc, argv);
193 if ((!params.nevents && !params.dellist && !params.list_events &&
195 usage_with_options(probe_usage, options);
197 if (debugfs_valid_mountpoint(debugfs_path) < 0)
198 die("Failed to find debugfs path.");
200 if (params.list_events) {
201 if (params.nevents != 0 || params.dellist) {
202 pr_warning(" Error: Don't use --list with"
204 usage_with_options(probe_usage, options);
206 if (params.show_lines) {
207 pr_warning(" Error: Don't use --list with --line.\n");
208 usage_with_options(probe_usage, options);
210 show_perf_probe_events();
214 #ifndef NO_DWARF_SUPPORT
215 if (params.show_lines) {
216 if (params.nevents != 0 || params.dellist) {
217 pr_warning(" Error: Don't use --line with"
219 usage_with_options(probe_usage, options);
222 show_line_range(¶ms.line_range);
227 if (params.dellist) {
228 del_perf_probe_events(params.dellist);
229 strlist__delete(params.dellist);
230 if (params.nevents == 0)
234 add_perf_probe_events(params.events, params.nevents, params.force_add);