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_session_name
;
38 static int opt_pid_all
;
39 static int opt_userspace
;
40 static char *opt_cmd_name
;
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
;
59 static struct lttng_handle
*handle
;
61 static struct poptOption long_options
[] = {
62 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
63 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
64 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
65 {"all-events", 'a', POPT_ARG_VAL
, &opt_enable_all
, 1, 0, 0},
66 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
67 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
68 {"userspace", 'u', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_cmd_name
, OPT_USERSPACE
, 0, 0},
69 {"all", 0, POPT_ARG_VAL
, &opt_pid_all
, 1, 0, 0},
70 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
71 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TRACEPOINT
, 0, 0},
72 {"marker", 0, POPT_ARG_NONE
, 0, OPT_MARKER
, 0, 0},
73 {"probe", 0, POPT_ARG_STRING
, &opt_probe
, OPT_PROBE
, 0, 0},
74 {"function", 0, POPT_ARG_STRING
, &opt_function
, OPT_FUNCTION
, 0, 0},
75 {"function:entry", 0, POPT_ARG_STRING
, &opt_function_entry_symbol
, OPT_FUNCTION_ENTRY
, 0, 0},
76 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_SYSCALL
, 0, 0},
83 static void usage(FILE *ofp
)
85 fprintf(ofp
, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
87 fprintf(ofp
, " -h, --help Show this help\n");
88 fprintf(ofp
, " -s, --session Apply on session name\n");
89 fprintf(ofp
, " -c, --channel Apply on this channel\n");
90 fprintf(ofp
, " -a, --all-events Enable all tracepoints\n");
91 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
92 fprintf(ofp
, " -u, --userspace [CMD] Apply for the user-space tracer\n");
93 fprintf(ofp
, " --all If -u, apply on all traceable apps\n");
94 fprintf(ofp
, " -p, --pid PID If -u, apply on a specific PID\n");
96 fprintf(ofp
, "Event options:\n");
97 fprintf(ofp
, " --tracepoint Tracepoint event (default)\n");
98 fprintf(ofp
, " --probe [addr | symbol | symbol+offset]\n");
99 fprintf(ofp
, " Dynamic probe.\n");
100 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
101 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
102 fprintf(ofp
, " --function [addr | symbol | symbol+offset]\n");
103 fprintf(ofp
, " Dynamic function entry/return probe.\n");
104 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
105 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
106 fprintf(ofp
, " --function:entry symbol\n");
107 fprintf(ofp
, " Function tracer event\n");
108 fprintf(ofp
, " --syscall System call event\n");
109 fprintf(ofp
, " --marker User-space marker (deprecated)\n");
116 * Parse probe options.
118 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
122 char name
[LTTNG_SYMBOL_NAME_LEN
];
129 /* Check for symbol+offset */
130 ret
= sscanf(opt
, "%[^'+']+%s", name
, s_hex
);
132 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
133 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
134 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
135 if (strlen(s_hex
) == 0) {
136 ERR("Invalid probe offset %s", s_hex
);
140 ev
->attr
.probe
.offset
= strtoul(s_hex
, NULL
, 0);
141 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
142 ev
->attr
.probe
.addr
= 0;
146 /* Check for symbol */
147 if (isalpha(name
[0])) {
148 ret
= sscanf(opt
, "%s", name
);
150 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
151 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
152 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
153 ev
->attr
.probe
.offset
= 0;
154 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
155 ev
->attr
.probe
.addr
= 0;
160 /* Check for address */
161 ret
= sscanf(opt
, "%s", s_hex
);
163 if (strlen(s_hex
) == 0) {
164 ERR("Invalid probe address %s", s_hex
);
168 ev
->attr
.probe
.addr
= strtoul(s_hex
, NULL
, 0);
169 DBG("probe addr %" PRIu64
, ev
->attr
.probe
.addr
);
170 ev
->attr
.probe
.offset
= 0;
171 memset(ev
->attr
.probe
.symbol_name
, 0, LTTNG_SYMBOL_NAME_LEN
);
185 * Enabling event using the lttng API.
187 static int enable_events(char *session_name
)
189 int err
, ret
= CMD_SUCCESS
;
190 char *event_name
, *channel_name
= NULL
;
191 struct lttng_event ev
;
192 struct lttng_domain dom
;
194 if (opt_channel_name
== NULL
) {
195 err
= asprintf(&channel_name
, DEFAULT_CHANNEL_NAME
);
201 channel_name
= opt_channel_name
;
204 if (opt_kernel
&& opt_userspace
) {
205 MSG("Choose only one of --kernel or --userspace");
209 /* Create lttng domain */
211 dom
.type
= LTTNG_DOMAIN_KERNEL
;
215 * LTTNG_DOMAIN_UST_EXEC_NAME,
216 * LTTNG_DOMAIN_UST_PID,
217 * LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
219 dom
.type
= LTTNG_DOMAIN_UST
;
222 handle
= lttng_create_handle(session_name
, &dom
);
223 if (handle
== NULL
) {
228 if (opt_enable_all
) {
229 /* Default setup for enable all */
231 ev
.type
= opt_event_type
;
233 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
238 switch (opt_event_type
) {
239 case LTTNG_EVENT_TRACEPOINT
:
240 MSG("All %s tracepoints are enabled in channel %s",
241 opt_kernel
? "kernel" : "UST", channel_name
);
243 case LTTNG_EVENT_SYSCALL
:
245 MSG("All kernel system calls are enabled in channel %s",
249 case LTTNG_EVENT_ALL
:
250 MSG("All %s events are enabled in channel %s",
251 opt_kernel
? "kernel" : "UST", channel_name
);
255 * We should not be here since
256 * lttng_enable_event should have failed on the
264 /* Strip event list */
265 event_name
= strtok(opt_event_list
, ",");
266 while (event_name
!= NULL
) {
267 /* Kernel tracer action */
269 DBG("Enabling kernel event %s for channel %s",
270 event_name
, channel_name
);
271 /* Copy name and type of the event */
272 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
273 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
274 ev
.type
= opt_event_type
;
276 switch (opt_event_type
) {
277 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
278 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
280 case LTTNG_EVENT_TRACEPOINT
:
282 case LTTNG_EVENT_PROBE
:
283 ret
= parse_probe_opts(&ev
, opt_probe
);
285 ERR("Unable to parse probe options");
290 case LTTNG_EVENT_FUNCTION
:
291 ret
= parse_probe_opts(&ev
, opt_function
);
293 ERR("Unable to parse function probe options");
298 case LTTNG_EVENT_FUNCTION_ENTRY
:
299 strncpy(ev
.attr
.ftrace
.symbol_name
,
300 opt_function_entry_symbol
,
301 LTTNG_SYMBOL_NAME_LEN
);
302 ev
.attr
.ftrace
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
304 case LTTNG_EVENT_SYSCALL
:
305 MSG("per-syscall selection not supported yet. Use \"-a\" for all syscalls.");
306 ret
= CMD_NOT_IMPLEMENTED
;
309 ret
= CMD_NOT_IMPLEMENTED
;
313 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
315 MSG("Kernel event %s created in channel %s", event_name
, channel_name
);
317 } else if (opt_userspace
) { /* User-space tracer action */
319 * TODO: only supporting pid_all tracing for
320 * now. Should have different domain based on
324 MSG("Only supporting tracing all UST processes (-u --all) for now.");
325 ret
= CMD_NOT_IMPLEMENTED
;
328 DBG("Enabling UST event %s for channel %s",
329 event_name
, channel_name
);
330 /* Copy name and type of the event */
331 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
332 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
333 ev
.type
= opt_event_type
;
335 switch (opt_event_type
) {
336 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
337 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
339 case LTTNG_EVENT_TRACEPOINT
:
341 case LTTNG_EVENT_PROBE
:
342 case LTTNG_EVENT_FUNCTION
:
343 case LTTNG_EVENT_FUNCTION_ENTRY
:
344 case LTTNG_EVENT_SYSCALL
:
346 ret
= CMD_NOT_IMPLEMENTED
;
350 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
352 MSG("UST event %s created in channel %s", event_name
, channel_name
);
355 ERR("Please specify a tracer (--kernel or --userspace)");
360 event_name
= strtok(NULL
, ",");
365 if (opt_channel_name
== NULL
) {
368 lttng_destroy_handle(handle
);
376 * Add event to trace session
378 int cmd_enable_events(int argc
, const char **argv
)
381 static poptContext pc
;
382 char *session_name
= NULL
;
384 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
385 poptReadDefaultConfig(pc
, 0);
387 /* Default event type */
388 opt_event_type
= LTTNG_EVENT_ALL
;
390 while ((opt
= poptGetNextOpt(pc
)) != -1) {
397 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
400 ret
= CMD_NOT_IMPLEMENTED
;
403 opt_event_type
= LTTNG_EVENT_PROBE
;
406 opt_event_type
= LTTNG_EVENT_FUNCTION
;
408 case OPT_FUNCTION_ENTRY
:
409 opt_event_type
= LTTNG_EVENT_FUNCTION_ENTRY
;
412 opt_event_type
= LTTNG_EVENT_SYSCALL
;
424 opt_event_list
= (char*) poptGetArg(pc
);
425 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
426 ERR("Missing event name(s).\n");
432 if (!opt_session_name
) {
433 session_name
= get_session_name();
434 if (session_name
== NULL
) {
439 session_name
= opt_session_name
;
442 ret
= enable_events(session_name
);
445 if (opt_session_name
== NULL
) {