2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #include <sys/types.h>
29 #include "../command.h"
30 #include <src/common/sessiond-comm/sessiond-comm.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
;
44 static char *opt_filter
;
46 /* Not implemented yet */
47 static char *opt_cmd_name
;
65 static struct lttng_handle
*handle
;
67 static struct poptOption long_options
[] = {
68 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
69 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
70 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
71 {"all", 'a', POPT_ARG_VAL
, &opt_enable_all
, 1, 0, 0},
72 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
73 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
74 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
75 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TRACEPOINT
, 0, 0},
76 {"probe", 0, POPT_ARG_STRING
, &opt_probe
, OPT_PROBE
, 0, 0},
77 {"function", 0, POPT_ARG_STRING
, &opt_function
, OPT_FUNCTION
, 0, 0},
80 * Currently removed from lttng kernel tracer. Removed from
81 * lttng UI to discourage its use.
83 {"function:entry", 0, POPT_ARG_STRING
, &opt_function_entry_symbol
, OPT_FUNCTION_ENTRY
, 0, 0},
85 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_SYSCALL
, 0, 0},
86 {"loglevel", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL
, 0, 0},
87 {"loglevel-only", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL_ONLY
, 0, 0},
88 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
89 {"filter", 'f', POPT_ARG_STRING
, &opt_filter
, OPT_FILTER
, 0, 0},
96 static void usage(FILE *ofp
)
98 fprintf(ofp
, "usage: lttng enable-event NAME[,NAME2,...] [-k|-u] [OPTIONS] \n");
100 fprintf(ofp
, "Options:\n");
101 fprintf(ofp
, " -h, --help Show this help\n");
102 fprintf(ofp
, " --list-options Simple listing of options\n");
103 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
104 fprintf(ofp
, " -c, --channel NAME Apply to this channel\n");
105 fprintf(ofp
, " -a, --all Enable all tracepoints and syscalls\n");
106 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
107 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
109 fprintf(ofp
, "Event options:\n");
110 fprintf(ofp
, " --tracepoint Tracepoint event (default)\n");
111 fprintf(ofp
, " - userspace tracer supports wildcards at end of string.\n");
112 fprintf(ofp
, " Don't forget to quote to deal with bash expansion.\n");
113 fprintf(ofp
, " e.g.:\n");
114 fprintf(ofp
, " \"*\"\n");
115 fprintf(ofp
, " \"app_component:na*\"\n");
116 fprintf(ofp
, " --probe [addr | symbol | symbol+offset]\n");
117 fprintf(ofp
, " Dynamic probe.\n");
118 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
119 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
120 fprintf(ofp
, " --function [addr | symbol | symbol+offset]\n");
121 fprintf(ofp
, " Dynamic function entry/return probe.\n");
122 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
123 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
125 fprintf(ofp
, " --function:entry symbol\n");
126 fprintf(ofp
, " Function tracer event\n");
128 fprintf(ofp
, " --syscall System call event\n");
130 fprintf(ofp
, " --loglevel name\n");
131 fprintf(ofp
, " Tracepoint loglevel range from 0 to loglevel\n");
132 fprintf(ofp
, " --loglevel-only name\n");
133 fprintf(ofp
, " Tracepoint loglevel (only this loglevel)\n");
135 fprintf(ofp
, " The loglevel or loglevel-only options should be\n");
136 fprintf(ofp
, " combined with a tracepoint name or tracepoint\n");
137 fprintf(ofp
, " wildcard.\n");
138 fprintf(ofp
, " Available loglevels:\n");
139 fprintf(ofp
, " (higher value is more verbose)\n");
140 fprintf(ofp
, " TRACE_EMERG = 0\n");
141 fprintf(ofp
, " TRACE_ALERT = 1\n");
142 fprintf(ofp
, " TRACE_CRIT = 2\n");
143 fprintf(ofp
, " TRACE_ERR = 3\n");
144 fprintf(ofp
, " TRACE_WARNING = 4\n");
145 fprintf(ofp
, " TRACE_NOTICE = 5\n");
146 fprintf(ofp
, " TRACE_INFO = 6\n");
147 fprintf(ofp
, " TRACE_DEBUG_SYSTEM = 7\n");
148 fprintf(ofp
, " TRACE_DEBUG_PROGRAM = 8\n");
149 fprintf(ofp
, " TRACE_DEBUG_PROCESS = 9\n");
150 fprintf(ofp
, " TRACE_DEBUG_MODULE = 10\n");
151 fprintf(ofp
, " TRACE_DEBUG_UNIT = 11\n");
152 fprintf(ofp
, " TRACE_DEBUG_FUNCTION = 12\n");
153 fprintf(ofp
, " TRACE_DEBUG_LINE = 13\n");
154 fprintf(ofp
, " TRACE_DEBUG = 14\n");
155 fprintf(ofp
, " (shortcuts such as \"system\" are allowed)\n");
156 fprintf(ofp
, " --filter \'expression\'\n");
157 fprintf(ofp
, " Filter expression on event fields,\n");
158 fprintf(ofp
, " event recording depends on evaluation.\n");
159 fprintf(ofp
, " Only specify on first activation of\n");
160 fprintf(ofp
, " a given event within a session.\n");
161 fprintf(ofp
, " Filter only allowed when enabling\n");
162 fprintf(ofp
, " events within a session before tracing\n");
163 fprintf(ofp
, " is started. If the filter fails to link\n");
164 fprintf(ofp
, " with the event within the traced domain,\n");
165 fprintf(ofp
, " the event will be discarded. Currently,\n");
166 fprintf(ofp
, " filter is only implemented for the user-space\n");
167 fprintf(ofp
, " tracer.\n");
168 fprintf(ofp
, " Expression examples:.\n");
170 fprintf(ofp
, " 'intfield > 500 && intfield < 503'\n");
171 fprintf(ofp
, " '(stringfield == \"test\" || intfield != 10) && intfield > 33'\n");
172 fprintf(ofp
, " 'doublefield > 1.1 && intfield < 5.3'\n");
174 fprintf(ofp
, " Wildcards are allowed at the end of strings:\n");
175 fprintf(ofp
, " 'seqfield1 == \"te*\"'\n");
176 fprintf(ofp
, " In string literals, the escape character is '\\'.\n");
177 fprintf(ofp
, " Use '\\*' for the '*' character, and '\\\\' for\n");
178 fprintf(ofp
, " the '\\' character.\n");
183 * Parse probe options.
185 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
189 char name
[LTTNG_SYMBOL_NAME_LEN
];
196 /* Check for symbol+offset */
197 ret
= sscanf(opt
, "%[^'+']+%s", name
, s_hex
);
199 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
200 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
201 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
202 if (*s_hex
== '\0') {
203 ERR("Invalid probe offset %s", s_hex
);
207 ev
->attr
.probe
.offset
= strtoul(s_hex
, NULL
, 0);
208 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
209 ev
->attr
.probe
.addr
= 0;
213 /* Check for symbol */
214 if (isalpha(name
[0])) {
215 ret
= sscanf(opt
, "%s", name
);
217 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
218 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
219 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
220 ev
->attr
.probe
.offset
= 0;
221 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
222 ev
->attr
.probe
.addr
= 0;
227 /* Check for address */
228 ret
= sscanf(opt
, "%s", s_hex
);
230 if (*s_hex
== '\0') {
231 ERR("Invalid probe address %s", s_hex
);
235 ev
->attr
.probe
.addr
= strtoul(s_hex
, NULL
, 0);
236 DBG("probe addr %" PRIu64
, ev
->attr
.probe
.addr
);
237 ev
->attr
.probe
.offset
= 0;
238 memset(ev
->attr
.probe
.symbol_name
, 0, LTTNG_SYMBOL_NAME_LEN
);
250 * Maps loglevel from string to value
253 int loglevel_str_to_value(const char *inputstr
)
256 char str
[LTTNG_SYMBOL_NAME_LEN
];
258 while (i
< LTTNG_SYMBOL_NAME_LEN
&& inputstr
[i
] != '\0') {
259 str
[i
] = toupper(inputstr
[i
]);
263 if (!strcmp(str
, "TRACE_EMERG") || !strcmp(str
, "EMERG")) {
264 return LTTNG_LOGLEVEL_EMERG
;
265 } else if (!strcmp(str
, "TRACE_ALERT") || !strcmp(str
, "ALERT")) {
266 return LTTNG_LOGLEVEL_ALERT
;
267 } else if (!strcmp(str
, "TRACE_CRIT") || !strcmp(str
, "CRIT")) {
268 return LTTNG_LOGLEVEL_CRIT
;
269 } else if (!strcmp(str
, "TRACE_ERR") || !strcmp(str
, "ERR")) {
270 return LTTNG_LOGLEVEL_ERR
;
271 } else if (!strcmp(str
, "TRACE_WARNING") || !strcmp(str
, "WARNING")) {
272 return LTTNG_LOGLEVEL_WARNING
;
273 } else if (!strcmp(str
, "TRACE_NOTICE") || !strcmp(str
, "NOTICE")) {
274 return LTTNG_LOGLEVEL_NOTICE
;
275 } else if (!strcmp(str
, "TRACE_INFO") || !strcmp(str
, "INFO")) {
276 return LTTNG_LOGLEVEL_INFO
;
277 } else if (!strcmp(str
, "TRACE_DEBUG_SYSTEM") || !strcmp(str
, "DEBUG_SYSTEM") || !strcmp(str
, "SYSTEM")) {
278 return LTTNG_LOGLEVEL_DEBUG_SYSTEM
;
279 } else if (!strcmp(str
, "TRACE_DEBUG_PROGRAM") || !strcmp(str
, "DEBUG_PROGRAM") || !strcmp(str
, "PROGRAM")) {
280 return LTTNG_LOGLEVEL_DEBUG_PROGRAM
;
281 } else if (!strcmp(str
, "TRACE_DEBUG_PROCESS") || !strcmp(str
, "DEBUG_PROCESS") || !strcmp(str
, "PROCESS")) {
282 return LTTNG_LOGLEVEL_DEBUG_PROCESS
;
283 } else if (!strcmp(str
, "TRACE_DEBUG_MODULE") || !strcmp(str
, "DEBUG_MODULE") || !strcmp(str
, "MODULE")) {
284 return LTTNG_LOGLEVEL_DEBUG_MODULE
;
285 } else if (!strcmp(str
, "TRACE_DEBUG_UNIT") || !strcmp(str
, "DEBUG_UNIT") || !strcmp(str
, "UNIT")) {
286 return LTTNG_LOGLEVEL_DEBUG_UNIT
;
287 } else if (!strcmp(str
, "TRACE_DEBUG_FUNCTION") || !strcmp(str
, "DEBUG_FUNCTION") || !strcmp(str
, "FUNCTION")) {
288 return LTTNG_LOGLEVEL_DEBUG_FUNCTION
;
289 } else if (!strcmp(str
, "TRACE_DEBUG_LINE") || !strcmp(str
, "DEBUG_LINE") || !strcmp(str
, "LINE")) {
290 return LTTNG_LOGLEVEL_DEBUG_LINE
;
291 } else if (!strcmp(str
, "TRACE_DEBUG") || !strcmp(str
, "DEBUG")) {
292 return LTTNG_LOGLEVEL_DEBUG
;
299 * Enabling event using the lttng API.
301 static int enable_events(char *session_name
)
303 int err
, ret
= CMD_SUCCESS
, warn
= 0;
304 char *event_name
, *channel_name
= NULL
;
305 struct lttng_event ev
;
306 struct lttng_domain dom
;
308 memset(&ev
, 0, sizeof(ev
));
309 memset(&dom
, 0, sizeof(dom
));
313 ERR("Filter not implement for kernel tracing yet");
319 /* Create lttng domain */
321 dom
.type
= LTTNG_DOMAIN_KERNEL
;
322 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
323 } else if (opt_userspace
) {
324 dom
.type
= LTTNG_DOMAIN_UST
;
326 dom
.buf_type
= LTTNG_BUFFER_PER_PID
;
328 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
333 if (opt_channel_name
== NULL
) {
334 err
= asprintf(&channel_name
, DEFAULT_CHANNEL_NAME
);
340 channel_name
= opt_channel_name
;
343 handle
= lttng_create_handle(session_name
, &dom
);
344 if (handle
== NULL
) {
349 if (opt_enable_all
) {
350 /* Default setup for enable all */
352 ev
.type
= opt_event_type
;
354 /* kernel loglevels not implemented */
355 ev
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
357 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
358 strcpy(ev
.name
, "*");
359 ev
.loglevel_type
= opt_loglevel_type
;
361 ev
.loglevel
= loglevel_str_to_value(opt_loglevel
);
362 if (ev
.loglevel
== -1) {
363 ERR("Unknown loglevel %s", opt_loglevel
);
364 ret
= -LTTNG_ERR_INVALID
;
373 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
376 case LTTNG_ERR_KERN_EVENT_EXIST
:
377 WARN("Kernel events already enabled (channel %s, session %s)",
378 channel_name
, session_name
);
381 ERR("Events: %s (channel %s, session %s)",
382 lttng_strerror(ret
), channel_name
, session_name
);
388 switch (opt_event_type
) {
389 case LTTNG_EVENT_TRACEPOINT
:
391 MSG("All %s tracepoints are enabled in channel %s for loglevel %s",
392 opt_kernel
? "kernel" : "UST", channel_name
,
395 MSG("All %s tracepoints are enabled in channel %s",
396 opt_kernel
? "kernel" : "UST", channel_name
);
400 case LTTNG_EVENT_SYSCALL
:
402 MSG("All kernel system calls are enabled in channel %s",
406 case LTTNG_EVENT_ALL
:
408 MSG("All %s events are enabled in channel %s for loglevel %s",
409 opt_kernel
? "kernel" : "UST", channel_name
,
412 MSG("All %s events are enabled in channel %s",
413 opt_kernel
? "kernel" : "UST", channel_name
);
418 * We should not be here since lttng_enable_event should have
419 * failed on the event type.
425 ret
= lttng_enable_event_with_filter(handle
, &ev
, channel_name
,
428 fprintf(stderr
, "Ret filter: %d\n", ret
);
430 case LTTNG_ERR_FILTER_EXIST
:
431 WARN("Filter on events is already enabled"
432 " (channel %s, session %s)",
433 channel_name
, session_name
);
435 case LTTNG_ERR_FILTER_INVAL
:
436 case LTTNG_ERR_FILTER_NOMEM
:
437 ERR("%s", lttng_strerror(ret
));
439 ERR("Setting filter: '%s'", opt_filter
);
444 MSG("Filter '%s' successfully set", opt_filter
);
450 /* Strip event list */
451 event_name
= strtok(opt_event_list
, ",");
452 while (event_name
!= NULL
) {
453 /* Copy name and type of the event */
454 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
455 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
456 ev
.type
= opt_event_type
;
458 /* Kernel tracer action */
460 DBG("Enabling kernel event %s for channel %s",
461 event_name
, channel_name
);
463 switch (opt_event_type
) {
464 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
465 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
467 case LTTNG_EVENT_TRACEPOINT
:
469 case LTTNG_EVENT_PROBE
:
470 ret
= parse_probe_opts(&ev
, opt_probe
);
472 ERR("Unable to parse probe options");
477 case LTTNG_EVENT_FUNCTION
:
478 ret
= parse_probe_opts(&ev
, opt_function
);
480 ERR("Unable to parse function probe options");
485 case LTTNG_EVENT_FUNCTION_ENTRY
:
486 strncpy(ev
.attr
.ftrace
.symbol_name
, opt_function_entry_symbol
,
487 LTTNG_SYMBOL_NAME_LEN
);
488 ev
.attr
.ftrace
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
490 case LTTNG_EVENT_SYSCALL
:
491 MSG("per-syscall selection not supported yet. Use \"-a\" "
492 "for all syscalls.");
499 MSG("Kernel loglevels are not supported.");
500 ret
= CMD_UNSUPPORTED
;
504 /* kernel loglevels not implemented */
505 ev
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
506 } else if (opt_userspace
) { /* User-space tracer action */
508 if (opt_cmd_name
!= NULL
|| opt_pid
) {
509 MSG("Only supporting tracing all UST processes (-u) for now.");
515 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name
,
516 channel_name
, opt_loglevel
? : "<all>");
518 switch (opt_event_type
) {
519 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
521 case LTTNG_EVENT_TRACEPOINT
:
522 /* Copy name and type of the event */
523 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
524 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
525 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
527 case LTTNG_EVENT_PROBE
:
528 case LTTNG_EVENT_FUNCTION
:
529 case LTTNG_EVENT_FUNCTION_ENTRY
:
530 case LTTNG_EVENT_SYSCALL
:
532 ERR("Event type not available for user-space tracing");
533 ret
= CMD_UNSUPPORTED
;
537 ev
.loglevel_type
= opt_loglevel_type
;
539 ev
.loglevel
= loglevel_str_to_value(opt_loglevel
);
540 if (ev
.loglevel
== -1) {
541 ERR("Unknown loglevel %s", opt_loglevel
);
542 ret
= -LTTNG_ERR_INVALID
;
549 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
555 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
557 /* Turn ret to positive value to handle the positive error code */
559 case LTTNG_ERR_KERN_EVENT_EXIST
:
560 WARN("Kernel event %s already enabled (channel %s, session %s)",
561 event_name
, channel_name
, session_name
);
564 ERR("Event %s: %s (channel %s, session %s)", event_name
,
565 lttng_strerror(ret
), channel_name
, session_name
);
570 MSG("%s event %s created in channel %s",
571 opt_kernel
? "kernel": "UST", event_name
, channel_name
);
576 ret
= lttng_enable_event_with_filter(handle
, &ev
, channel_name
,
580 case LTTNG_ERR_FILTER_EXIST
:
581 WARN("Filter on event %s is already enabled"
582 " (channel %s, session %s)",
583 event_name
, channel_name
, session_name
);
585 case LTTNG_ERR_FILTER_INVAL
:
586 case LTTNG_ERR_FILTER_NOMEM
:
587 ERR("%s", lttng_strerror(ret
));
589 ERR("Setting filter for event %s: '%s'", ev
.name
,
595 MSG("Filter '%s' successfully set", opt_filter
);
600 event_name
= strtok(NULL
, ",");
608 if (opt_channel_name
== NULL
) {
611 lttng_destroy_handle(handle
);
617 * Add event to trace session
619 int cmd_enable_events(int argc
, const char **argv
)
621 int opt
, ret
= CMD_SUCCESS
;
622 static poptContext pc
;
623 char *session_name
= NULL
;
625 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
626 poptReadDefaultConfig(pc
, 0);
628 /* Default event type */
629 opt_event_type
= LTTNG_EVENT_ALL
;
631 while ((opt
= poptGetNextOpt(pc
)) != -1) {
637 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
640 opt_event_type
= LTTNG_EVENT_PROBE
;
643 opt_event_type
= LTTNG_EVENT_FUNCTION
;
645 case OPT_FUNCTION_ENTRY
:
646 opt_event_type
= LTTNG_EVENT_FUNCTION_ENTRY
;
649 opt_event_type
= LTTNG_EVENT_SYSCALL
;
655 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
656 opt_loglevel
= poptGetOptArg(pc
);
658 case OPT_LOGLEVEL_ONLY
:
659 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
660 opt_loglevel
= poptGetOptArg(pc
);
662 case OPT_LIST_OPTIONS
:
663 list_cmd_options(stdout
, long_options
);
674 opt_event_list
= (char*) poptGetArg(pc
);
675 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
676 ERR("Missing event name(s).\n");
682 if (!opt_session_name
) {
683 session_name
= get_session_name();
684 if (session_name
== NULL
) {
689 session_name
= opt_session_name
;
692 ret
= enable_events(session_name
);
695 if (opt_session_name
== NULL
) {