2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; only version 2
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <sys/types.h>
34 static char *opt_event_list
;
35 static int opt_event_type
;
36 static char *opt_kernel
;
37 static char *opt_cmd_name
;
38 static char *opt_session_name
;
39 static int opt_pid_all
;
40 static int opt_userspace
;
41 static int opt_enable_all
;
43 static char *opt_probe
;
44 static char *opt_function
;
45 static char *opt_function_entry_symbol
;
46 static char *opt_channel_name
;
58 static struct lttng_handle
*handle
;
60 static struct poptOption long_options
[] = {
61 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
62 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
63 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
64 {"all-events", 'a', POPT_ARG_VAL
, &opt_enable_all
, 1, 0, 0},
65 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
66 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
67 {"userspace", 'u', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, 0, OPT_USERSPACE
, 0, 0},
68 {"all", 0, POPT_ARG_VAL
, &opt_pid_all
, 1, 0, 0},
69 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
70 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TRACEPOINT
, 0, 0},
71 {"marker", 0, POPT_ARG_NONE
, 0, OPT_MARKER
, 0, 0},
72 {"probe", 0, POPT_ARG_STRING
, 0, OPT_PROBE
, 0, 0},
73 {"function", 0, POPT_ARG_STRING
, 0, OPT_FUNCTION
, 0, 0},
74 {"function:entry", 0, POPT_ARG_STRING
, 0, OPT_FUNCTION_ENTRY
, 0, 0},
81 static void usage(FILE *ofp
)
83 fprintf(ofp
, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
85 fprintf(ofp
, " -h, --help Show this help\n");
86 fprintf(ofp
, " -s, --session Apply on session name\n");
87 fprintf(ofp
, " -c, --channel Apply on this channel\n");
88 fprintf(ofp
, " -a, --all-events Enable all tracepoints\n");
89 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
90 fprintf(ofp
, " -u, --userspace [CMD] Apply for the user-space tracer\n");
91 fprintf(ofp
, " --all If -u, apply on all traceable apps\n");
92 fprintf(ofp
, " -p, --pid PID If -u, apply on a specific PID\n");
94 fprintf(ofp
, "Event options:\n");
95 fprintf(ofp
, " --tracepoint Tracepoint event (default)\n");
96 fprintf(ofp
, " --probe [addr | symbol | symbol+offset]\n");
97 fprintf(ofp
, " Dynamic probe.\n");
98 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
99 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
100 fprintf(ofp
, " --function [addr | symbol | symbol+offset]\n");
101 fprintf(ofp
, " Dynamic function entry/return probe.\n");
102 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
103 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
104 fprintf(ofp
, " --function:entry symbol\n");
105 fprintf(ofp
, " Function tracer event\n");
106 fprintf(ofp
, " --marker User-space marker (deprecated)\n");
113 * Parse probe options.
115 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
119 char name
[LTTNG_SYMBOL_NAME_LEN
];
126 /* Check for symbol+offset */
127 ret
= sscanf(opt
, "%[^'+']+%s", name
, s_hex
);
129 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
130 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
131 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
132 if (strlen(s_hex
) == 0) {
133 ERR("Invalid probe offset %s", s_hex
);
137 ev
->attr
.probe
.offset
= strtoul(s_hex
, NULL
, 0);
138 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
139 ev
->attr
.probe
.addr
= 0;
143 /* Check for symbol */
144 if (isalpha(name
[0])) {
145 ret
= sscanf(opt
, "%s", name
);
147 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
148 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
149 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
150 ev
->attr
.probe
.offset
= 0;
151 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
152 ev
->attr
.probe
.addr
= 0;
157 /* Check for address */
158 ret
= sscanf(opt
, "%s", s_hex
);
160 if (strlen(s_hex
) == 0) {
161 ERR("Invalid probe address %s", s_hex
);
165 ev
->attr
.probe
.addr
= strtoul(s_hex
, NULL
, 0);
166 DBG("probe addr %" PRIu64
, ev
->attr
.probe
.addr
);
167 ev
->attr
.probe
.offset
= 0;
168 memset(ev
->attr
.probe
.symbol_name
, 0, LTTNG_SYMBOL_NAME_LEN
);
182 * Enabling event using the lttng API.
184 static int enable_events(char *session_name
)
186 int err
, ret
= CMD_SUCCESS
;
187 char *event_name
, *channel_name
= NULL
;
188 struct lttng_event ev
;
189 struct lttng_domain dom
;
191 if (opt_channel_name
== NULL
) {
192 err
= asprintf(&channel_name
, DEFAULT_CHANNEL_NAME
);
198 channel_name
= opt_channel_name
;
201 /* Create lttng domain */
203 dom
.type
= LTTNG_DOMAIN_KERNEL
;
206 handle
= lttng_create_handle(session_name
, &dom
);
207 if (handle
== NULL
) {
212 if (opt_enable_all
) {
214 ret
= lttng_enable_event(handle
, NULL
, channel_name
);
216 MSG("All kernel events are enabled in channel %s", channel_name
);
221 /* TODO: User-space tracer */
224 /* Strip event list */
225 event_name
= strtok(opt_event_list
, ",");
226 while (event_name
!= NULL
) {
227 /* Kernel tracer action */
229 DBG("Enabling kernel event %s for channel %s",
230 event_name
, channel_name
);
231 /* Copy name and type of the event */
232 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
233 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
234 ev
.type
= opt_event_type
;
236 switch (opt_event_type
) {
237 case LTTNG_EVENT_TRACEPOINT
:
239 case LTTNG_EVENT_PROBE
:
240 ret
= parse_probe_opts(&ev
, opt_probe
);
242 ERR("Unable to parse probe options");
247 case LTTNG_EVENT_FUNCTION
:
248 ret
= parse_probe_opts(&ev
, opt_function
);
250 ERR("Unable to parse function probe options");
255 case LTTNG_EVENT_FUNCTION_ENTRY
:
256 strncpy(ev
.attr
.ftrace
.symbol_name
,
257 opt_function_entry_symbol
,
258 LTTNG_SYMBOL_NAME_LEN
);
259 ev
.attr
.ftrace
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
262 ret
= CMD_NOT_IMPLEMENTED
;
266 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
268 MSG("Kernel event %s created in channel %s", event_name
, channel_name
);
270 } else if (opt_userspace
) { /* User-space tracer action */
272 * TODO: Waiting on lttng UST 2.0
275 } else if (opt_pid
!= 0) {
277 ret
= CMD_NOT_IMPLEMENTED
;
280 ERR("Please specify a tracer (--kernel or --userspace)");
285 event_name
= strtok(NULL
, ",");
289 if (opt_channel_name
== NULL
) {
292 lttng_destroy_handle(handle
);
300 * Add event to trace session
302 int cmd_enable_events(int argc
, const char **argv
)
305 static poptContext pc
;
306 char *session_name
= NULL
;
308 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
309 poptReadDefaultConfig(pc
, 0);
311 /* Default event type */
312 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
314 while ((opt
= poptGetNextOpt(pc
)) != -1) {
322 opt_cmd_name
= poptGetOptArg(pc
);
325 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
328 ret
= CMD_NOT_IMPLEMENTED
;
331 opt_event_type
= LTTNG_EVENT_PROBE
;
332 opt_probe
= poptGetOptArg(pc
);
335 opt_event_type
= LTTNG_EVENT_FUNCTION
;
336 opt_function
= poptGetOptArg(pc
);
338 case OPT_FUNCTION_ENTRY
:
339 opt_event_type
= LTTNG_EVENT_FUNCTION_ENTRY
;
340 opt_function_entry_symbol
= poptGetOptArg(pc
);
349 opt_event_list
= (char*) poptGetArg(pc
);
350 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
351 ERR("Missing event name(s).\n");
357 if (!opt_session_name
) {
358 session_name
= get_session_name();
359 if (session_name
== NULL
) {
364 session_name
= opt_session_name
;
367 ret
= enable_events(session_name
);
370 if (opt_session_name
== NULL
) {