blob: b3ba25a910fa8096c203c3a9c1e8424051c56119 [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"
43#include "util/parse-events.h" /* For debugfs_path */
44#include "util/probe-finder.h"
Masami Hiramatsu50656ee2009-11-30 19:19:58 -050045#include "util/probe-event.h"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040046
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040047#define MAX_PATH_LEN 256
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040048
49/* Session management structure */
50static struct {
Masami Hiramatsufac13fd2009-12-15 10:31:14 -050051 bool list_events;
Masami Hiramatsud761b082009-12-15 10:32:25 -050052 bool force_add;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -050053 bool show_lines;
Masami Hiramatsu4235b042010-03-16 18:06:12 -040054 int nevents;
55 struct perf_probe_event events[MAX_PROBES];
Masami Hiramatsufa282442009-12-08 17:03:23 -050056 struct strlist *dellist;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -050057 struct line_range line_range;
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -040058} params;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040059
Masami Hiramatsu4de189f2009-11-30 19:20:17 -050060
Masami Hiramatsu253977b2009-10-27 16:43:10 -040061/* Parse an event definition. Note that any error must die. */
62static void parse_probe_event(const char *str)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040063{
Masami Hiramatsu4235b042010-03-16 18:06:12 -040064 struct perf_probe_event *pev = &params.events[params.nevents];
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040065
Masami Hiramatsu4235b042010-03-16 18:06:12 -040066 pr_debug("probe-definition(%d): %s\n", params.nevents, str);
67 if (++params.nevents == MAX_PROBES)
Masami Hiramatsu50656ee2009-11-30 19:19:58 -050068 die("Too many probes (> %d) are specified.", MAX_PROBES);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040069
Masami Hiramatsu4235b042010-03-16 18:06:12 -040070 /* Parse a perf-probe command into event */
71 parse_perf_probe_command(str, pev);
Masami Hiramatsu23e8ec02009-10-07 18:28:30 -040072
Masami Hiramatsu4235b042010-03-16 18:06:12 -040073 pr_debug("%d arguments\n", pev->nargs);
Masami Hiramatsu46ab4922009-10-27 16:43:02 -040074}
75
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -050076static void parse_probe_event_argv(int argc, const char **argv)
77{
78 int i, len;
79 char *buf;
80
81 /* Bind up rest arguments */
82 len = 0;
83 for (i = 0; i < argc; i++)
84 len += strlen(argv[i]) + 1;
Masami Hiramatsu31facc52010-03-16 18:05:30 -040085 buf = xzalloc(len + 1);
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -050086 len = 0;
87 for (i = 0; i < argc; i++)
88 len += sprintf(&buf[len], "%s ", argv[i]);
89 parse_probe_event(buf);
90 free(buf);
91}
92
Masami Hiramatsu253977b2009-10-27 16:43:10 -040093static int opt_add_probe_event(const struct option *opt __used,
Masami Hiramatsu46ab4922009-10-27 16:43:02 -040094 const char *str, int unset __used)
95{
96 if (str)
Masami Hiramatsu253977b2009-10-27 16:43:10 -040097 parse_probe_event(str);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040098 return 0;
99}
100
Masami Hiramatsufa282442009-12-08 17:03:23 -0500101static int opt_del_probe_event(const struct option *opt __used,
102 const char *str, int unset __used)
103{
104 if (str) {
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400105 if (!params.dellist)
106 params.dellist = strlist__new(true, NULL);
107 strlist__add(params.dellist, str);
Masami Hiramatsufa282442009-12-08 17:03:23 -0500108 }
109 return 0;
110}
111
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300112#ifdef DWARF_SUPPORT
Hitoshi Mitake0eda7382010-01-16 21:31:16 +0900113static int opt_show_lines(const struct option *opt __used,
114 const char *str, int unset __used)
115{
116 if (str)
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400117 parse_line_range_desc(str, &params.line_range);
118 INIT_LIST_HEAD(&params.line_range.line_list);
119 params.show_lines = true;
Hitoshi Mitake0eda7382010-01-16 21:31:16 +0900120 return 0;
121}
Masami Hiramatsu23e8ec02009-10-07 18:28:30 -0400122#endif
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400123
124static const char * const probe_usage[] = {
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400125 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
126 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
Masami Hiramatsufa282442009-12-08 17:03:23 -0500127 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
Masami Hiramatsu4de189f2009-11-30 19:20:17 -0500128 "perf probe --list",
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300129#ifdef DWARF_SUPPORT
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500130 "perf probe --line 'LINEDESC'",
Masami Hiramatsuf3ab4812010-02-25 08:35:12 -0500131#endif
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400132 NULL
133};
134
135static const struct option options[] = {
Masami Hiramatsu89c69c02009-10-16 20:08:10 -0400136 OPT_BOOLEAN('v', "verbose", &verbose,
137 "be more verbose (show parsed arguments, etc)"),
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400138 OPT_BOOLEAN('l', "list", &params.list_events,
Masami Hiramatsufac13fd2009-12-15 10:31:14 -0500139 "list up current probe events"),
Masami Hiramatsufa282442009-12-08 17:03:23 -0500140 OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
141 opt_del_probe_event),
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400142 OPT_CALLBACK('a', "add", NULL,
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300143#ifdef DWARF_SUPPORT
Masami Hiramatsu32cb0dd2010-03-03 22:38:43 -0500144 "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500145 " [ARG ...]",
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300146#else
147 "[EVENT=]FUNC[+OFF|%return] [ARG ...]",
Masami Hiramatsu23e8ec02009-10-07 18:28:30 -0400148#endif
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400149 "probe point definition, where\n"
Masami Hiramatsuaf663d72009-12-15 10:32:18 -0500150 "\t\tGROUP:\tGroup name (optional)\n"
151 "\t\tEVENT:\tEvent name\n"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400152 "\t\tFUNC:\tFunction name\n"
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500153 "\t\tOFF:\tOffset from function entry (in byte)\n"
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400154 "\t\t%return:\tPut the probe at function return\n"
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300155#ifdef DWARF_SUPPORT
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400156 "\t\tSRC:\tSource code path\n"
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500157 "\t\tRL:\tRelative line number from function entry.\n"
158 "\t\tAL:\tAbsolute line number in file.\n"
159 "\t\tPT:\tLazy expression of line code.\n"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400160 "\t\tARG:\tProbe argument (local variable name or\n"
Masami Hiramatsu50656ee2009-11-30 19:19:58 -0500161 "\t\t\tkprobe-tracer argument format.)\n",
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300162#else
163 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
164#endif
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400165 opt_add_probe_event),
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400166 OPT_BOOLEAN('f', "force", &params.force_add, "forcibly add events"
Masami Hiramatsud761b082009-12-15 10:32:25 -0500167 " with existing name"),
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300168#ifdef DWARF_SUPPORT
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500169 OPT_CALLBACK('L', "line", NULL,
Masami Hiramatsu085ea732010-04-02 12:50:39 -0400170 "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500171 "Show source code lines.", opt_show_lines),
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300172 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
173 "file", "vmlinux pathname"),
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500174#endif
Masami Hiramatsuf4d7da42010-03-16 18:06:05 -0400175 OPT__DRY_RUN(&probe_event_dry_run),
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400176 OPT_END()
177};
178
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400179int cmd_probe(int argc, const char **argv, const char *prefix __used)
180{
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400181 argc = parse_options(argc, argv, options, probe_usage,
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400182 PARSE_OPT_STOP_AT_NON_OPTION);
Masami Hiramatsuce11a602009-12-15 10:31:28 -0500183 if (argc > 0) {
184 if (strcmp(argv[0], "-") == 0) {
185 pr_warning(" Error: '-' is not supported.\n");
186 usage_with_options(probe_usage, options);
187 }
Masami Hiramatsud1bde3f2009-12-08 17:02:54 -0500188 parse_probe_event_argv(argc, argv);
Masami Hiramatsuce11a602009-12-15 10:31:28 -0500189 }
Masami Hiramatsu46ab4922009-10-27 16:43:02 -0400190
Masami Hiramatsu4235b042010-03-16 18:06:12 -0400191 if ((!params.nevents && !params.dellist && !params.list_events &&
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400192 !params.show_lines))
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400193 usage_with_options(probe_usage, options);
194
Masami Hiramatsu96c96612009-12-16 17:24:00 -0500195 if (debugfs_valid_mountpoint(debugfs_path) < 0)
196 die("Failed to find debugfs path.");
197
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400198 if (params.list_events) {
Masami Hiramatsu4235b042010-03-16 18:06:12 -0400199 if (params.nevents != 0 || params.dellist) {
Masami Hiramatsufa282442009-12-08 17:03:23 -0500200 pr_warning(" Error: Don't use --list with"
201 " --add/--del.\n");
202 usage_with_options(probe_usage, options);
203 }
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400204 if (params.show_lines) {
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500205 pr_warning(" Error: Don't use --list with --line.\n");
206 usage_with_options(probe_usage, options);
207 }
Masami Hiramatsu4de189f2009-11-30 19:20:17 -0500208 show_perf_probe_events();
209 return 0;
210 }
211
Masami Hiramatsu4b4da7f2010-03-22 13:10:26 -0300212#ifdef DWARF_SUPPORT
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400213 if (params.show_lines) {
Masami Hiramatsu4235b042010-03-16 18:06:12 -0400214 if (params.nevents != 0 || params.dellist) {
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500215 pr_warning(" Error: Don't use --line with"
216 " --add/--del.\n");
217 usage_with_options(probe_usage, options);
218 }
Masami Hiramatsue0faa8d2010-03-16 18:05:37 -0400219
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400220 show_line_range(&params.line_range);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500221 return 0;
222 }
223#endif
224
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400225 if (params.dellist) {
Masami Hiramatsu4235b042010-03-16 18:06:12 -0400226 del_perf_probe_events(params.dellist);
Masami Hiramatsu12a1fad2010-03-16 18:05:44 -0400227 strlist__delete(params.dellist);
Masami Hiramatsu4235b042010-03-16 18:06:12 -0400228 if (params.nevents == 0)
Masami Hiramatsufa282442009-12-08 17:03:23 -0500229 return 0;
230 }
231
Masami Hiramatsu4235b042010-03-16 18:06:12 -0400232 add_perf_probe_events(params.events, params.nevents, params.force_add);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400233 return 0;
234}
235