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 MH |
51 | bool need_dwarf; |
52 | bool list_events; | |
d761b08b | 53 | bool force_add; |
631c9def | 54 | bool show_lines; |
4ea42b18 MH |
55 | int nr_probe; |
56 | struct probe_point probes[MAX_PROBES]; | |
fa28244d | 57 | struct strlist *dellist; |
631c9def | 58 | struct line_range line_range; |
4ea42b18 MH |
59 | } session; |
60 | ||
4de189fe | 61 | |
253977b0 MH |
62 | /* Parse an event definition. Note that any error must die. */ |
63 | static void parse_probe_event(const char *str) | |
4ea42b18 | 64 | { |
4ea42b18 | 65 | struct probe_point *pp = &session.probes[session.nr_probe]; |
4ea42b18 | 66 | |
b7cb10e7 | 67 | pr_debug("probe-definition(%d): %s\n", session.nr_probe, str); |
4ea42b18 | 68 | if (++session.nr_probe == MAX_PROBES) |
50656eec | 69 | die("Too many probes (> %d) are specified.", MAX_PROBES); |
4ea42b18 | 70 | |
50656eec | 71 | /* Parse perf-probe event into probe_point */ |
fac13fd5 | 72 | parse_perf_probe_event(str, pp, &session.need_dwarf); |
23e8ec0d | 73 | |
b7cb10e7 | 74 | pr_debug("%d arguments\n", pp->nr_args); |
46ab4926 MH |
75 | } |
76 | ||
d1bde3f7 MH |
77 | static void parse_probe_event_argv(int argc, const char **argv) |
78 | { | |
79 | int i, len; | |
80 | char *buf; | |
81 | ||
82 | /* Bind up rest arguments */ | |
83 | len = 0; | |
84 | for (i = 0; i < argc; i++) | |
85 | len += strlen(argv[i]) + 1; | |
31facc5f | 86 | buf = xzalloc(len + 1); |
d1bde3f7 MH |
87 | len = 0; |
88 | for (i = 0; i < argc; i++) | |
89 | len += sprintf(&buf[len], "%s ", argv[i]); | |
90 | parse_probe_event(buf); | |
91 | free(buf); | |
92 | } | |
93 | ||
253977b0 | 94 | static int opt_add_probe_event(const struct option *opt __used, |
46ab4926 MH |
95 | const char *str, int unset __used) |
96 | { | |
97 | if (str) | |
253977b0 | 98 | parse_probe_event(str); |
4ea42b18 MH |
99 | return 0; |
100 | } | |
101 | ||
fa28244d MH |
102 | static int opt_del_probe_event(const struct option *opt __used, |
103 | const char *str, int unset __used) | |
104 | { | |
105 | if (str) { | |
106 | if (!session.dellist) | |
107 | session.dellist = strlist__new(true, NULL); | |
108 | strlist__add(session.dellist, str); | |
109 | } | |
110 | return 0; | |
111 | } | |
112 | ||
804b3606 | 113 | #ifndef NO_DWARF_SUPPORT |
0eda7385 HM |
114 | static int opt_show_lines(const struct option *opt __used, |
115 | const char *str, int unset __used) | |
116 | { | |
117 | if (str) | |
118 | parse_line_range_desc(str, &session.line_range); | |
119 | INIT_LIST_HEAD(&session.line_range.line_list); | |
120 | session.show_lines = true; | |
121 | return 0; | |
122 | } | |
23e8ec0d | 123 | #endif |
4ea42b18 MH |
124 | |
125 | static const char * const probe_usage[] = { | |
46ab4926 MH |
126 | "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]", |
127 | "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]", | |
fa28244d | 128 | "perf probe [<options>] --del '[GROUP:]EVENT' ...", |
4de189fe | 129 | "perf probe --list", |
804b3606 | 130 | #ifndef NO_DWARF_SUPPORT |
631c9def | 131 | "perf probe --line 'LINEDESC'", |
f3ab481c | 132 | #endif |
4ea42b18 MH |
133 | NULL |
134 | }; | |
135 | ||
136 | static const struct option options[] = { | |
89c69c0e MH |
137 | OPT_BOOLEAN('v', "verbose", &verbose, |
138 | "be more verbose (show parsed arguments, etc)"), | |
804b3606 | 139 | #ifndef NO_DWARF_SUPPORT |
75be6cf4 | 140 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
a128168d | 141 | "file", "vmlinux pathname"), |
23e8ec0d | 142 | #endif |
fac13fd5 MH |
143 | OPT_BOOLEAN('l', "list", &session.list_events, |
144 | "list up current probe events"), | |
fa28244d MH |
145 | OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.", |
146 | opt_del_probe_event), | |
46ab4926 | 147 | OPT_CALLBACK('a', "add", NULL, |
804b3606 | 148 | #ifdef NO_DWARF_SUPPORT |
2a9c8c36 | 149 | "[EVENT=]FUNC[+OFF|%return] [ARG ...]", |
23e8ec0d | 150 | #else |
32cb0dd5 | 151 | "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT" |
2a9c8c36 | 152 | " [ARG ...]", |
23e8ec0d | 153 | #endif |
4ea42b18 | 154 | "probe point definition, where\n" |
af663d75 MH |
155 | "\t\tGROUP:\tGroup name (optional)\n" |
156 | "\t\tEVENT:\tEvent name\n" | |
4ea42b18 | 157 | "\t\tFUNC:\tFunction name\n" |
2a9c8c36 | 158 | "\t\tOFF:\tOffset from function entry (in byte)\n" |
253977b0 | 159 | "\t\t%return:\tPut the probe at function return\n" |
804b3606 | 160 | #ifdef NO_DWARF_SUPPORT |
23e8ec0d MH |
161 | "\t\tARG:\tProbe argument (only \n" |
162 | #else | |
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" |
23e8ec0d | 168 | #endif |
50656eec | 169 | "\t\t\tkprobe-tracer argument format.)\n", |
253977b0 | 170 | opt_add_probe_event), |
d761b08b MH |
171 | OPT_BOOLEAN('f', "force", &session.force_add, "forcibly add events" |
172 | " with existing name"), | |
804b3606 | 173 | #ifndef NO_DWARF_SUPPORT |
631c9def MH |
174 | OPT_CALLBACK('L', "line", NULL, |
175 | "FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]", | |
176 | "Show source code lines.", opt_show_lines), | |
177 | #endif | |
4ea42b18 MH |
178 | OPT_END() |
179 | }; | |
180 | ||
4ea42b18 MH |
181 | int cmd_probe(int argc, const char **argv, const char *prefix __used) |
182 | { | |
4ea42b18 | 183 | argc = parse_options(argc, argv, options, probe_usage, |
46ab4926 | 184 | PARSE_OPT_STOP_AT_NON_OPTION); |
ce11a603 MH |
185 | if (argc > 0) { |
186 | if (strcmp(argv[0], "-") == 0) { | |
187 | pr_warning(" Error: '-' is not supported.\n"); | |
188 | usage_with_options(probe_usage, options); | |
189 | } | |
d1bde3f7 | 190 | parse_probe_event_argv(argc, argv); |
ce11a603 | 191 | } |
46ab4926 | 192 | |
631c9def MH |
193 | if ((!session.nr_probe && !session.dellist && !session.list_events && |
194 | !session.show_lines)) | |
4ea42b18 MH |
195 | usage_with_options(probe_usage, options); |
196 | ||
96c96612 MH |
197 | if (debugfs_valid_mountpoint(debugfs_path) < 0) |
198 | die("Failed to find debugfs path."); | |
199 | ||
fac13fd5 | 200 | if (session.list_events) { |
fa28244d MH |
201 | if (session.nr_probe != 0 || session.dellist) { |
202 | pr_warning(" Error: Don't use --list with" | |
203 | " --add/--del.\n"); | |
204 | usage_with_options(probe_usage, options); | |
205 | } | |
631c9def MH |
206 | if (session.show_lines) { |
207 | pr_warning(" Error: Don't use --list with --line.\n"); | |
208 | usage_with_options(probe_usage, options); | |
209 | } | |
4de189fe MH |
210 | show_perf_probe_events(); |
211 | return 0; | |
212 | } | |
213 | ||
804b3606 | 214 | #ifndef NO_DWARF_SUPPORT |
631c9def MH |
215 | if (session.show_lines) { |
216 | if (session.nr_probe != 0 || session.dellist) { | |
217 | pr_warning(" Error: Don't use --line with" | |
218 | " --add/--del.\n"); | |
219 | usage_with_options(probe_usage, options); | |
220 | } | |
e0faa8d3 | 221 | |
631c9def MH |
222 | show_line_range(&session.line_range); |
223 | return 0; | |
224 | } | |
225 | #endif | |
226 | ||
fa28244d MH |
227 | if (session.dellist) { |
228 | del_trace_kprobe_events(session.dellist); | |
229 | strlist__delete(session.dellist); | |
230 | if (session.nr_probe == 0) | |
231 | return 0; | |
232 | } | |
233 | ||
d761b08b | 234 | add_trace_kprobe_events(session.probes, session.nr_probe, |
e0faa8d3 | 235 | session.force_add, session.need_dwarf); |
4ea42b18 MH |
236 | return 0; |
237 | } | |
238 |