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 int 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
;
56 OPT_TRACEPOINT_LOGLEVEL
,
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 {"probe", 0, POPT_ARG_STRING
, &opt_probe
, OPT_PROBE
, 0, 0},
73 {"function", 0, POPT_ARG_STRING
, &opt_function
, OPT_FUNCTION
, 0, 0},
76 * Currently removed from lttng kernel tracer. Removed from
77 * lttng UI to discourage its use.
79 {"function:entry", 0, POPT_ARG_STRING
, &opt_function_entry_symbol
, OPT_FUNCTION_ENTRY
, 0, 0},
81 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_SYSCALL
, 0, 0},
82 {"loglevel", 0, POPT_ARG_NONE
, 0, OPT_TRACEPOINT_LOGLEVEL
, 0, 0},
89 static void usage(FILE *ofp
)
91 fprintf(ofp
, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
93 fprintf(ofp
, " -h, --help Show this help\n");
94 fprintf(ofp
, " -s, --session Apply on session name\n");
95 fprintf(ofp
, " -c, --channel Apply on this channel\n");
96 fprintf(ofp
, " -a, --all-events Enable all tracepoints\n");
97 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
98 fprintf(ofp
, " -u, --userspace [CMD] Apply for the user-space tracer\n");
99 fprintf(ofp
, " --all If -u, apply on all traceable apps\n");
100 fprintf(ofp
, " -p, --pid PID If -u, apply on a specific PID\n");
102 fprintf(ofp
, "Event options:\n");
103 fprintf(ofp
, " --tracepoint Tracepoint event (default)\n");
104 fprintf(ofp
, " --loglevel Tracepoint loglevel\n");
105 fprintf(ofp
, " --probe [addr | symbol | symbol+offset]\n");
106 fprintf(ofp
, " Dynamic probe.\n");
107 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
108 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
109 fprintf(ofp
, " --function [addr | symbol | symbol+offset]\n");
110 fprintf(ofp
, " Dynamic function entry/return probe.\n");
111 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
112 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
114 fprintf(ofp
, " --function:entry symbol\n");
115 fprintf(ofp
, " Function tracer event\n");
117 fprintf(ofp
, " --syscall System call event\n");
122 * Parse probe options.
124 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
128 char name
[LTTNG_SYMBOL_NAME_LEN
];
135 /* Check for symbol+offset */
136 ret
= sscanf(opt
, "%[^'+']+%s", name
, s_hex
);
138 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
139 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
140 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
141 if (strlen(s_hex
) == 0) {
142 ERR("Invalid probe offset %s", s_hex
);
146 ev
->attr
.probe
.offset
= strtoul(s_hex
, NULL
, 0);
147 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
148 ev
->attr
.probe
.addr
= 0;
152 /* Check for symbol */
153 if (isalpha(name
[0])) {
154 ret
= sscanf(opt
, "%s", name
);
156 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
157 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
158 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
159 ev
->attr
.probe
.offset
= 0;
160 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
161 ev
->attr
.probe
.addr
= 0;
166 /* Check for address */
167 ret
= sscanf(opt
, "%s", s_hex
);
169 if (strlen(s_hex
) == 0) {
170 ERR("Invalid probe address %s", s_hex
);
174 ev
->attr
.probe
.addr
= strtoul(s_hex
, NULL
, 0);
175 DBG("probe addr %" PRIu64
, ev
->attr
.probe
.addr
);
176 ev
->attr
.probe
.offset
= 0;
177 memset(ev
->attr
.probe
.symbol_name
, 0, LTTNG_SYMBOL_NAME_LEN
);
189 * Enabling event using the lttng API.
191 static int enable_events(char *session_name
)
193 int err
, ret
= CMD_SUCCESS
;
194 char *event_name
, *channel_name
= NULL
;
195 struct lttng_event ev
;
196 struct lttng_domain dom
;
198 if (opt_channel_name
== NULL
) {
199 err
= asprintf(&channel_name
, DEFAULT_CHANNEL_NAME
);
205 channel_name
= opt_channel_name
;
208 if (opt_kernel
&& opt_userspace
) {
209 MSG("Choose only one of --kernel or --userspace");
214 /* Create lttng domain */
216 dom
.type
= LTTNG_DOMAIN_KERNEL
;
217 } else if (opt_pid
!= 0) {
218 dom
.type
= LTTNG_DOMAIN_UST_PID
;
219 dom
.attr
.pid
= opt_pid
;
220 DBG("PID %d set to lttng handle", opt_pid
);
221 } else if (opt_userspace
&& opt_cmd_name
== NULL
) {
222 dom
.type
= LTTNG_DOMAIN_UST
;
223 } else if (opt_userspace
&& opt_cmd_name
!= NULL
) {
224 dom
.type
= LTTNG_DOMAIN_UST_EXEC_NAME
;
225 strncpy(dom
.attr
.exec_name
, opt_cmd_name
, NAME_MAX
);
227 ERR("Please specify a tracer (--kernel or --userspace)");
228 ret
= CMD_NOT_IMPLEMENTED
;
232 handle
= lttng_create_handle(session_name
, &dom
);
233 if (handle
== NULL
) {
238 if (opt_enable_all
) {
239 /* Default setup for enable all */
241 ev
.type
= opt_event_type
;
243 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
248 switch (opt_event_type
) {
249 case LTTNG_EVENT_TRACEPOINT
:
250 MSG("All %s tracepoints are enabled in channel %s",
251 opt_kernel
? "kernel" : "UST", channel_name
);
253 case LTTNG_EVENT_SYSCALL
:
255 MSG("All kernel system calls are enabled in channel %s",
259 case LTTNG_EVENT_ALL
:
260 MSG("All %s events are enabled in channel %s",
261 opt_kernel
? "kernel" : "UST", channel_name
);
265 * We should not be here since lttng_enable_event should have
266 * failed on the event type.
273 /* Strip event list */
274 event_name
= strtok(opt_event_list
, ",");
275 while (event_name
!= NULL
) {
276 /* Copy name and type of the event */
277 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
278 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
279 ev
.type
= opt_event_type
;
281 /* Kernel tracer action */
283 DBG("Enabling kernel event %s for channel %s",
284 event_name
, channel_name
);
286 switch (opt_event_type
) {
287 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
288 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
290 case LTTNG_EVENT_TRACEPOINT
:
292 case LTTNG_EVENT_PROBE
:
293 ret
= parse_probe_opts(&ev
, opt_probe
);
295 ERR("Unable to parse probe options");
300 case LTTNG_EVENT_FUNCTION
:
301 ret
= parse_probe_opts(&ev
, opt_function
);
303 ERR("Unable to parse function probe options");
308 case LTTNG_EVENT_FUNCTION_ENTRY
:
309 strncpy(ev
.attr
.ftrace
.symbol_name
, opt_function_entry_symbol
,
310 LTTNG_SYMBOL_NAME_LEN
);
311 ev
.attr
.ftrace
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
313 case LTTNG_EVENT_SYSCALL
:
314 MSG("per-syscall selection not supported yet. Use \"-a\" "
315 "for all syscalls.");
317 ret
= CMD_NOT_IMPLEMENTED
;
320 } else if (opt_userspace
) { /* User-space tracer action */
322 MSG("Only supporting tracing all UST processes "
323 "(-u --all) for now.");
324 ret
= CMD_NOT_IMPLEMENTED
;
328 DBG("Enabling UST event %s for channel %s", event_name
,
331 switch (opt_event_type
) {
332 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
334 case LTTNG_EVENT_TRACEPOINT
:
335 /* Copy name and type of the event */
336 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
337 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
338 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
340 case LTTNG_EVENT_TRACEPOINT_LOGLEVEL
:
341 /* Copy name and type of the event */
342 ev
.type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
343 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
344 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
346 case LTTNG_EVENT_PROBE
:
347 case LTTNG_EVENT_FUNCTION
:
348 case LTTNG_EVENT_FUNCTION_ENTRY
:
349 case LTTNG_EVENT_SYSCALL
:
351 ret
= CMD_NOT_IMPLEMENTED
;
355 ERR("Please specify a tracer (--kernel or --userspace)");
359 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
361 MSG("%s event %s created in channel %s",
362 opt_kernel
? "kernel": "UST", event_name
, channel_name
);
366 event_name
= strtok(NULL
, ",");
371 if (opt_channel_name
== NULL
) {
374 lttng_destroy_handle(handle
);
380 * Add event to trace session
382 int cmd_enable_events(int argc
, const char **argv
)
385 static poptContext pc
;
386 char *session_name
= NULL
;
388 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
389 poptReadDefaultConfig(pc
, 0);
391 /* Default event type */
392 opt_event_type
= LTTNG_EVENT_ALL
;
394 while ((opt
= poptGetNextOpt(pc
)) != -1) {
401 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
404 opt_event_type
= LTTNG_EVENT_PROBE
;
407 opt_event_type
= LTTNG_EVENT_FUNCTION
;
409 case OPT_FUNCTION_ENTRY
:
410 opt_event_type
= LTTNG_EVENT_FUNCTION_ENTRY
;
413 opt_event_type
= LTTNG_EVENT_SYSCALL
;
418 case OPT_TRACEPOINT_LOGLEVEL
:
419 opt_event_type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
428 opt_event_list
= (char*) poptGetArg(pc
);
429 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
430 ERR("Missing event name(s).\n");
436 if (!opt_session_name
) {
437 session_name
= get_session_name();
438 if (session_name
== NULL
) {
443 session_name
= opt_session_name
;
446 ret
= enable_events(session_name
);
449 if (opt_session_name
== NULL
) {