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 | */ | |
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" | |
fa28244d | 38 | #include "util/strlist.h" |
e0faa8d3 | 39 | #include "util/symbol.h" |
89c69c0e | 40 | #include "util/debug.h" |
96c96612 | 41 | #include "util/debugfs.h" |
4ea42b18 | 42 | #include "util/parse-options.h" |
4ea42b18 | 43 | #include "util/probe-finder.h" |
50656eec | 44 | #include "util/probe-event.h" |
4ea42b18 | 45 | |
4ea42b18 | 46 | #define MAX_PATH_LEN 256 |
4ea42b18 MH |
47 | |
48 | /* Session management structure */ | |
49 | static struct { | |
fac13fd5 | 50 | bool list_events; |
d761b08b | 51 | bool force_add; |
631c9def | 52 | bool show_lines; |
4235b045 MH |
53 | int nevents; |
54 | struct perf_probe_event events[MAX_PROBES]; | |
fa28244d | 55 | struct strlist *dellist; |
631c9def | 56 | struct line_range line_range; |
ef4a3565 | 57 | int max_probe_points; |
12a1fadb | 58 | } params; |
4ea42b18 | 59 | |
4de189fe | 60 | |
253977b0 | 61 | /* Parse an event definition. Note that any error must die. */ |
146a1439 | 62 | static int parse_probe_event(const char *str) |
4ea42b18 | 63 | { |
4235b045 | 64 | struct perf_probe_event *pev = ¶ms.events[params.nevents]; |
146a1439 | 65 | int ret; |
4ea42b18 | 66 | |
4235b045 | 67 | pr_debug("probe-definition(%d): %s\n", params.nevents, str); |
8a7ddad8 ACM |
68 | if (++params.nevents == MAX_PROBES) { |
69 | pr_err("Too many probes (> %d) were specified.", MAX_PROBES); | |
70 | return -1; | |
71 | } | |
4ea42b18 | 72 | |
4235b045 | 73 | /* Parse a perf-probe command into event */ |
146a1439 | 74 | ret = parse_perf_probe_command(str, pev); |
4235b045 | 75 | pr_debug("%d arguments\n", pev->nargs); |
146a1439 MH |
76 | |
77 | return ret; | |
46ab4926 MH |
78 | } |
79 | ||
146a1439 | 80 | static int parse_probe_event_argv(int argc, const char **argv) |
d1bde3f7 | 81 | { |
146a1439 | 82 | int i, len, ret; |
d1bde3f7 MH |
83 | char *buf; |
84 | ||
85 | /* Bind up rest arguments */ | |
86 | len = 0; | |
87 | for (i = 0; i < argc; i++) | |
88 | len += strlen(argv[i]) + 1; | |
8a7ddad8 ACM |
89 | buf = zalloc(len + 1); |
90 | if (buf == NULL) | |
91 | return -ENOMEM; | |
d1bde3f7 MH |
92 | len = 0; |
93 | for (i = 0; i < argc; i++) | |
94 | len += sprintf(&buf[len], "%s ", argv[i]); | |
146a1439 | 95 | ret = parse_probe_event(buf); |
d1bde3f7 | 96 | free(buf); |
146a1439 | 97 | return ret; |
d1bde3f7 MH |
98 | } |
99 | ||
253977b0 | 100 | static int opt_add_probe_event(const struct option *opt __used, |
46ab4926 MH |
101 | const char *str, int unset __used) |
102 | { | |
103 | if (str) | |
146a1439 MH |
104 | return parse_probe_event(str); |
105 | else | |
106 | return 0; | |
4ea42b18 MH |
107 | } |
108 | ||
fa28244d MH |
109 | static int opt_del_probe_event(const struct option *opt __used, |
110 | const char *str, int unset __used) | |
111 | { | |
112 | if (str) { | |
12a1fadb MH |
113 | if (!params.dellist) |
114 | params.dellist = strlist__new(true, NULL); | |
115 | strlist__add(params.dellist, str); | |
fa28244d MH |
116 | } |
117 | return 0; | |
118 | } | |
119 | ||
4b4da7f7 | 120 | #ifdef DWARF_SUPPORT |
0eda7385 HM |
121 | static int opt_show_lines(const struct option *opt __used, |
122 | const char *str, int unset __used) | |
123 | { | |
146a1439 MH |
124 | int ret = 0; |
125 | ||
0eda7385 | 126 | if (str) |
146a1439 | 127 | ret = parse_line_range_desc(str, ¶ms.line_range); |
12a1fadb MH |
128 | INIT_LIST_HEAD(¶ms.line_range.line_list); |
129 | params.show_lines = true; | |
146a1439 MH |
130 | |
131 | return ret; | |
0eda7385 | 132 | } |
23e8ec0d | 133 | #endif |
4ea42b18 MH |
134 | |
135 | static const char * const probe_usage[] = { | |
46ab4926 MH |
136 | "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]", |
137 | "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]", | |
fa28244d | 138 | "perf probe [<options>] --del '[GROUP:]EVENT' ...", |
4de189fe | 139 | "perf probe --list", |
4b4da7f7 | 140 | #ifdef DWARF_SUPPORT |
631c9def | 141 | "perf probe --line 'LINEDESC'", |
f3ab481c | 142 | #endif |
4ea42b18 MH |
143 | NULL |
144 | }; | |
145 | ||
146 | static const struct option options[] = { | |
c0555642 | 147 | OPT_INCR('v', "verbose", &verbose, |
89c69c0e | 148 | "be more verbose (show parsed arguments, etc)"), |
12a1fadb | 149 | OPT_BOOLEAN('l', "list", ¶ms.list_events, |
fac13fd5 | 150 | "list up current probe events"), |
fa28244d MH |
151 | OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.", |
152 | opt_del_probe_event), | |
46ab4926 | 153 | OPT_CALLBACK('a', "add", NULL, |
4b4da7f7 | 154 | #ifdef DWARF_SUPPORT |
32cb0dd5 | 155 | "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT" |
48481938 | 156 | " [[NAME=]ARG ...]", |
4b4da7f7 | 157 | #else |
48481938 | 158 | "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]", |
23e8ec0d | 159 | #endif |
4ea42b18 | 160 | "probe point definition, where\n" |
af663d75 MH |
161 | "\t\tGROUP:\tGroup name (optional)\n" |
162 | "\t\tEVENT:\tEvent name\n" | |
4ea42b18 | 163 | "\t\tFUNC:\tFunction name\n" |
2a9c8c36 | 164 | "\t\tOFF:\tOffset from function entry (in byte)\n" |
253977b0 | 165 | "\t\t%return:\tPut the probe at function return\n" |
4b4da7f7 | 166 | #ifdef DWARF_SUPPORT |
4ea42b18 | 167 | "\t\tSRC:\tSource code path\n" |
2a9c8c36 MH |
168 | "\t\tRL:\tRelative line number from function entry.\n" |
169 | "\t\tAL:\tAbsolute line number in file.\n" | |
170 | "\t\tPT:\tLazy expression of line code.\n" | |
4ea42b18 | 171 | "\t\tARG:\tProbe argument (local variable name or\n" |
50656eec | 172 | "\t\t\tkprobe-tracer argument format.)\n", |
4b4da7f7 MH |
173 | #else |
174 | "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n", | |
175 | #endif | |
253977b0 | 176 | opt_add_probe_event), |
12a1fadb | 177 | OPT_BOOLEAN('f', "force", ¶ms.force_add, "forcibly add events" |
d761b08b | 178 | " with existing name"), |
4b4da7f7 | 179 | #ifdef DWARF_SUPPORT |
631c9def | 180 | OPT_CALLBACK('L', "line", NULL, |
085ea739 | 181 | "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]", |
631c9def | 182 | "Show source code lines.", opt_show_lines), |
4b4da7f7 MH |
183 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
184 | "file", "vmlinux pathname"), | |
9ed7e1b8 CD |
185 | OPT_STRING('s', "source", &symbol_conf.source_prefix, |
186 | "directory", "path to kernel source"), | |
631c9def | 187 | #endif |
f4d7da49 | 188 | OPT__DRY_RUN(&probe_event_dry_run), |
ef4a3565 MH |
189 | OPT_INTEGER('\0', "max-probes", ¶ms.max_probe_points, |
190 | "Set how many probe points can be found for a probe."), | |
4ea42b18 MH |
191 | OPT_END() |
192 | }; | |
193 | ||
4ea42b18 MH |
194 | int cmd_probe(int argc, const char **argv, const char *prefix __used) |
195 | { | |
146a1439 MH |
196 | int ret; |
197 | ||
4ea42b18 | 198 | argc = parse_options(argc, argv, options, probe_usage, |
46ab4926 | 199 | PARSE_OPT_STOP_AT_NON_OPTION); |
ce11a603 MH |
200 | if (argc > 0) { |
201 | if (strcmp(argv[0], "-") == 0) { | |
202 | pr_warning(" Error: '-' is not supported.\n"); | |
203 | usage_with_options(probe_usage, options); | |
204 | } | |
146a1439 MH |
205 | ret = parse_probe_event_argv(argc, argv); |
206 | if (ret < 0) { | |
207 | pr_err(" Error: Parse Error. (%d)\n", ret); | |
208 | return ret; | |
209 | } | |
ce11a603 | 210 | } |
46ab4926 | 211 | |
ef4a3565 MH |
212 | if (params.max_probe_points == 0) |
213 | params.max_probe_points = MAX_PROBES; | |
214 | ||
4235b045 | 215 | if ((!params.nevents && !params.dellist && !params.list_events && |
12a1fadb | 216 | !params.show_lines)) |
4ea42b18 MH |
217 | usage_with_options(probe_usage, options); |
218 | ||
12a1fadb | 219 | if (params.list_events) { |
4235b045 | 220 | if (params.nevents != 0 || params.dellist) { |
146a1439 | 221 | pr_err(" Error: Don't use --list with --add/--del.\n"); |
fa28244d MH |
222 | usage_with_options(probe_usage, options); |
223 | } | |
12a1fadb | 224 | if (params.show_lines) { |
146a1439 | 225 | pr_err(" Error: Don't use --list with --line.\n"); |
631c9def MH |
226 | usage_with_options(probe_usage, options); |
227 | } | |
146a1439 MH |
228 | ret = show_perf_probe_events(); |
229 | if (ret < 0) | |
230 | pr_err(" Error: Failed to show event list. (%d)\n", | |
231 | ret); | |
232 | return ret; | |
4de189fe MH |
233 | } |
234 | ||
4b4da7f7 | 235 | #ifdef DWARF_SUPPORT |
12a1fadb | 236 | if (params.show_lines) { |
4235b045 | 237 | if (params.nevents != 0 || params.dellist) { |
631c9def MH |
238 | pr_warning(" Error: Don't use --line with" |
239 | " --add/--del.\n"); | |
240 | usage_with_options(probe_usage, options); | |
241 | } | |
e0faa8d3 | 242 | |
146a1439 MH |
243 | ret = show_line_range(¶ms.line_range); |
244 | if (ret < 0) | |
245 | pr_err(" Error: Failed to show lines. (%d)\n", ret); | |
246 | return ret; | |
631c9def MH |
247 | } |
248 | #endif | |
249 | ||
12a1fadb | 250 | if (params.dellist) { |
146a1439 | 251 | ret = del_perf_probe_events(params.dellist); |
12a1fadb | 252 | strlist__delete(params.dellist); |
146a1439 MH |
253 | if (ret < 0) { |
254 | pr_err(" Error: Failed to delete events. (%d)\n", ret); | |
255 | return ret; | |
256 | } | |
fa28244d MH |
257 | } |
258 | ||
146a1439 MH |
259 | if (params.nevents) { |
260 | ret = add_perf_probe_events(params.events, params.nevents, | |
ef4a3565 MH |
261 | params.force_add, |
262 | params.max_probe_points); | |
146a1439 MH |
263 | if (ret < 0) { |
264 | pr_err(" Error: Failed to add events. (%d)\n", ret); | |
265 | return ret; | |
266 | } | |
267 | } | |
4ea42b18 MH |
268 | return 0; |
269 | } |