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