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>
30 #include "../command.h"
32 static char *opt_event_list
;
33 static int opt_event_type
;
34 static const char *opt_loglevel
;
35 static int opt_loglevel_type
;
36 static int opt_kernel
;
37 static char *opt_session_name
;
38 static int opt_userspace
;
39 static int opt_enable_all
;
40 static char *opt_probe
;
41 static char *opt_function
;
42 static char *opt_function_entry_symbol
;
43 static char *opt_channel_name
;
45 /* Not implemented yet */
46 static char *opt_cmd_name
;
63 static struct lttng_handle
*handle
;
65 static struct poptOption long_options
[] = {
66 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
67 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
68 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
69 {"all", 'a', POPT_ARG_VAL
, &opt_enable_all
, 1, 0, 0},
70 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
71 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
73 /* Not implemented yet */
74 {"userspace", 'u', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_cmd_name
, OPT_USERSPACE
, 0, 0},
75 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
77 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
79 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TRACEPOINT
, 0, 0},
80 {"probe", 0, POPT_ARG_STRING
, &opt_probe
, OPT_PROBE
, 0, 0},
81 {"function", 0, POPT_ARG_STRING
, &opt_function
, OPT_FUNCTION
, 0, 0},
84 * Currently removed from lttng kernel tracer. Removed from
85 * lttng UI to discourage its use.
87 {"function:entry", 0, POPT_ARG_STRING
, &opt_function_entry_symbol
, OPT_FUNCTION_ENTRY
, 0, 0},
89 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_SYSCALL
, 0, 0},
90 {"loglevel", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL
, 0, 0},
91 {"loglevel-only", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL_ONLY
, 0, 0},
92 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
99 static void usage(FILE *ofp
)
101 fprintf(ofp
, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
103 fprintf(ofp
, " -h, --help Show this help\n");
104 fprintf(ofp
, " --list-options Simple listing of options\n");
105 fprintf(ofp
, " -s, --session Apply to session name\n");
106 fprintf(ofp
, " -c, --channel Apply to this channel\n");
107 fprintf(ofp
, " -a, --all Enable all tracepoints\n");
108 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
110 fprintf(ofp
, " -u, --userspace [CMD] Apply to the user-space tracer\n");
111 fprintf(ofp
, " If no CMD, the domain used is UST global\n");
112 fprintf(ofp
, " or else the domain is UST EXEC_NAME\n");
113 fprintf(ofp
, " -p, --pid PID If -u, apply to specific PID (domain: UST PID)\n");
115 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
118 fprintf(ofp
, "Event options:\n");
119 fprintf(ofp
, " --tracepoint Tracepoint event (default)\n");
120 fprintf(ofp
, " - userspace tracer supports wildcards at end of string.\n");
121 fprintf(ofp
, " Don't forget to quote to deal with bash expansion.\n");
122 fprintf(ofp
, " e.g.:\n");
123 fprintf(ofp
, " \"*\"\n");
124 fprintf(ofp
, " \"app_component:na*\"\n");
125 fprintf(ofp
, " --probe [addr | symbol | symbol+offset]\n");
126 fprintf(ofp
, " Dynamic probe.\n");
127 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
128 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
129 fprintf(ofp
, " --function [addr | symbol | symbol+offset]\n");
130 fprintf(ofp
, " Dynamic function entry/return probe.\n");
131 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
132 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
134 fprintf(ofp
, " --function:entry symbol\n");
135 fprintf(ofp
, " Function tracer event\n");
137 fprintf(ofp
, " --syscall System call event\n");
139 fprintf(ofp
, " --loglevel name\n");
140 fprintf(ofp
, " Tracepoint loglevel range from 0 to loglevel\n");
141 fprintf(ofp
, " --loglevel-only name\n");
142 fprintf(ofp
, " Tracepoint loglevel (only this loglevel)\n");
144 fprintf(ofp
, " The loglevel or loglevel-only options should be combined\n");
145 fprintf(ofp
, " with a tracepoint name (or tracepoint wildcard).\n");
146 fprintf(ofp
, " Available loglevels: (higher value means more verbose)\n");
147 fprintf(ofp
, " TRACE_EMERG = 0\n");
148 fprintf(ofp
, " TRACE_ALERT = 1\n");
149 fprintf(ofp
, " TRACE_CRIT = 2\n");
150 fprintf(ofp
, " TRACE_ERR = 3\n");
151 fprintf(ofp
, " TRACE_WARNING = 4\n");
152 fprintf(ofp
, " TRACE_NOTICE = 5\n");
153 fprintf(ofp
, " TRACE_INFO = 6\n");
154 fprintf(ofp
, " TRACE_SYSTEM = 7\n");
155 fprintf(ofp
, " TRACE_PROCESS = 8\n");
156 fprintf(ofp
, " TRACE_MODULE = 9\n");
157 fprintf(ofp
, " TRACE_UNIT = 10\n");
158 fprintf(ofp
, " TRACE_CLASS = 11\n");
159 fprintf(ofp
, " TRACE_OBJECT = 12\n");
160 fprintf(ofp
, " TRACE_FUNCTION = 13\n");
161 fprintf(ofp
, " TRACE_PRINTF = 14\n");
162 fprintf(ofp
, " TRACE_DEBUG = 15\n");
167 * Parse probe options.
169 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
173 char name
[LTTNG_SYMBOL_NAME_LEN
];
180 /* Check for symbol+offset */
181 ret
= sscanf(opt
, "%[^'+']+%s", name
, s_hex
);
183 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
184 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
185 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
186 if (strlen(s_hex
) == 0) {
187 ERR("Invalid probe offset %s", s_hex
);
191 ev
->attr
.probe
.offset
= strtoul(s_hex
, NULL
, 0);
192 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
193 ev
->attr
.probe
.addr
= 0;
197 /* Check for symbol */
198 if (isalpha(name
[0])) {
199 ret
= sscanf(opt
, "%s", name
);
201 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
202 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
203 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
204 ev
->attr
.probe
.offset
= 0;
205 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
206 ev
->attr
.probe
.addr
= 0;
211 /* Check for address */
212 ret
= sscanf(opt
, "%s", s_hex
);
214 if (strlen(s_hex
) == 0) {
215 ERR("Invalid probe address %s", s_hex
);
219 ev
->attr
.probe
.addr
= strtoul(s_hex
, NULL
, 0);
220 DBG("probe addr %" PRIu64
, ev
->attr
.probe
.addr
);
221 ev
->attr
.probe
.offset
= 0;
222 memset(ev
->attr
.probe
.symbol_name
, 0, LTTNG_SYMBOL_NAME_LEN
);
234 * Maps this from string to value
249 * TRACE_FUNCTION = 13,
254 int loglevel_str_to_value(const char *str
)
256 if (!strcmp(str
, "TRACE_EMERG")) {
258 } else if (!strcmp(str
, "TRACE_ALERT")) {
260 } else if (!strcmp(str
, "TRACE_CRIT")) {
262 } else if (!strcmp(str
, "TRACE_ERR")) {
264 } else if (!strcmp(str
, "TRACE_WARNING")) {
266 } else if (!strcmp(str
, "TRACE_NOTICE")) {
268 } else if (!strcmp(str
, "TRACE_INFO")) {
270 } else if (!strcmp(str
, "TRACE_SYSTEM")) {
272 } else if (!strcmp(str
, "TRACE_PROCESS")) {
274 } else if (!strcmp(str
, "TRACE_MODULE")) {
276 } else if (!strcmp(str
, "TRACE_UNIT")) {
278 } else if (!strcmp(str
, "TRACE_CLASS")) {
280 } else if (!strcmp(str
, "TRACE_OBJECT")) {
282 } else if (!strcmp(str
, "TRACE_FUNCTION")) {
284 } else if (!strcmp(str
, "TRACE_PRINTF")) {
286 } else if (!strcmp(str
, "TRACE_DEBUG")) {
294 * Enabling event using the lttng API.
296 static int enable_events(char *session_name
)
298 int err
, ret
= CMD_SUCCESS
, warn
= 0;
299 char *event_name
, *channel_name
= NULL
;
300 struct lttng_event ev
;
301 struct lttng_domain dom
;
303 /* Create lttng domain */
305 dom
.type
= LTTNG_DOMAIN_KERNEL
;
306 } else if (opt_userspace
) {
307 dom
.type
= LTTNG_DOMAIN_UST
;
309 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
314 if (opt_channel_name
== NULL
) {
315 err
= asprintf(&channel_name
, DEFAULT_CHANNEL_NAME
);
321 channel_name
= opt_channel_name
;
324 handle
= lttng_create_handle(session_name
, &dom
);
325 if (handle
== NULL
) {
330 if (opt_enable_all
) {
331 /* Default setup for enable all */
333 ev
.type
= opt_event_type
;
335 /* kernel loglevels not implemented */
336 ev
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
338 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
339 strcpy(ev
.name
, "*");
340 ev
.loglevel_type
= opt_loglevel_type
;
342 ev
.loglevel
= loglevel_str_to_value(opt_loglevel
);
343 if (ev
.loglevel
== -1) {
344 ERR("Unknown loglevel %s", opt_loglevel
);
351 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
356 switch (opt_event_type
) {
357 case LTTNG_EVENT_TRACEPOINT
:
358 MSG("All %s tracepoints are enabled in channel %s for loglevel %s",
359 opt_kernel
? "kernel" : "UST", channel_name
,
360 opt_loglevel
? : "<all>");
362 case LTTNG_EVENT_SYSCALL
:
364 MSG("All kernel system calls are enabled in channel %s",
368 case LTTNG_EVENT_ALL
:
369 MSG("All %s events are enabled in channel %s for loglevel %s",
370 opt_kernel
? "kernel" : "UST", channel_name
,
371 opt_loglevel
? : "<all>");
375 * We should not be here since lttng_enable_event should have
376 * failed on the event type.
383 /* Strip event list */
384 event_name
= strtok(opt_event_list
, ",");
385 while (event_name
!= NULL
) {
386 /* Copy name and type of the event */
387 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
388 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
389 ev
.type
= opt_event_type
;
391 /* Kernel tracer action */
393 DBG("Enabling kernel event %s for channel %s",
394 event_name
, channel_name
);
396 switch (opt_event_type
) {
397 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
398 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
400 case LTTNG_EVENT_TRACEPOINT
:
402 case LTTNG_EVENT_PROBE
:
403 ret
= parse_probe_opts(&ev
, opt_probe
);
405 ERR("Unable to parse probe options");
410 case LTTNG_EVENT_FUNCTION
:
411 ret
= parse_probe_opts(&ev
, opt_function
);
413 ERR("Unable to parse function probe options");
418 case LTTNG_EVENT_FUNCTION_ENTRY
:
419 strncpy(ev
.attr
.ftrace
.symbol_name
, opt_function_entry_symbol
,
420 LTTNG_SYMBOL_NAME_LEN
);
421 ev
.attr
.ftrace
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
423 case LTTNG_EVENT_SYSCALL
:
424 MSG("per-syscall selection not supported yet. Use \"-a\" "
425 "for all syscalls.");
432 MSG("Kernel loglevels are not supported.");
437 /* kernel loglevels not implemented */
438 ev
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
439 } else if (opt_userspace
) { /* User-space tracer action */
441 if (opt_cmd_name
!= NULL
|| opt_pid
) {
442 MSG("Only supporting tracing all UST processes (-u) for now.");
448 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name
,
449 channel_name
, opt_loglevel
? : "<all>");
451 switch (opt_event_type
) {
452 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
454 case LTTNG_EVENT_TRACEPOINT
:
455 /* Copy name and type of the event */
456 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
457 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
458 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
460 case LTTNG_EVENT_PROBE
:
461 case LTTNG_EVENT_FUNCTION
:
462 case LTTNG_EVENT_FUNCTION_ENTRY
:
463 case LTTNG_EVENT_SYSCALL
:
465 ERR("Event type not available for user-space tracing");
470 ev
.loglevel_type
= opt_loglevel_type
;
472 ev
.loglevel
= loglevel_str_to_value(opt_loglevel
);
473 if (ev
.loglevel
== -1) {
474 ERR("Unknown loglevel %s", opt_loglevel
);
480 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
485 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
487 ERR("Event %s: %s (channel %s, session %s)", event_name
,
488 lttng_strerror(ret
), channel_name
, session_name
);
491 MSG("%s event %s created in channel %s",
492 opt_kernel
? "kernel": "UST", event_name
, channel_name
);
496 event_name
= strtok(NULL
, ",");
504 if (opt_channel_name
== NULL
) {
507 lttng_destroy_handle(handle
);
513 * Add event to trace session
515 int cmd_enable_events(int argc
, const char **argv
)
517 int opt
, ret
= CMD_SUCCESS
;
518 static poptContext pc
;
519 char *session_name
= NULL
;
521 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
522 poptReadDefaultConfig(pc
, 0);
524 /* Default event type */
525 opt_event_type
= LTTNG_EVENT_ALL
;
527 while ((opt
= poptGetNextOpt(pc
)) != -1) {
533 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
536 opt_event_type
= LTTNG_EVENT_PROBE
;
539 opt_event_type
= LTTNG_EVENT_FUNCTION
;
541 case OPT_FUNCTION_ENTRY
:
542 opt_event_type
= LTTNG_EVENT_FUNCTION_ENTRY
;
545 opt_event_type
= LTTNG_EVENT_SYSCALL
;
551 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
552 opt_loglevel
= poptGetOptArg(pc
);
554 case OPT_LOGLEVEL_ONLY
:
555 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
556 opt_loglevel
= poptGetOptArg(pc
);
558 case OPT_LIST_OPTIONS
:
559 list_cmd_options(stdout
, long_options
);
568 opt_event_list
= (char*) poptGetArg(pc
);
569 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
570 ERR("Missing event name(s).\n");
576 if (!opt_session_name
) {
577 session_name
= get_session_name();
578 if (session_name
== NULL
) {
583 session_name
= opt_session_name
;
586 ret
= enable_events(session_name
);
589 if (opt_session_name
== NULL
) {