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.
25 #include <sys/types.h>
30 #include <src/common/sessiond-comm/sessiond-comm.h>
33 #include <common/mi-lttng.h>
35 #include "../command.h"
37 #if (LTTNG_SYMBOL_NAME_LEN == 256)
38 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
41 static char *opt_event_list
;
42 static int opt_event_type
;
43 static const char *opt_loglevel
;
44 static int opt_loglevel_type
;
45 static int opt_kernel
;
46 static char *opt_session_name
;
47 static int opt_userspace
;
49 static int opt_enable_all
;
50 static char *opt_probe
;
51 static char *opt_function
;
52 static char *opt_function_entry_symbol
;
53 static char *opt_channel_name
;
54 static char *opt_filter
;
55 static char *opt_exclude
;
57 /* Not implemented yet */
58 static char *opt_cmd_name
;
77 static struct lttng_handle
*handle
;
78 static struct mi_writer
*writer
;
80 static struct poptOption long_options
[] = {
81 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
82 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
83 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
84 {"all", 'a', POPT_ARG_VAL
, &opt_enable_all
, 1, 0, 0},
85 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
86 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
87 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
88 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
89 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TRACEPOINT
, 0, 0},
90 {"probe", 0, POPT_ARG_STRING
, &opt_probe
, OPT_PROBE
, 0, 0},
91 {"function", 0, POPT_ARG_STRING
, &opt_function
, OPT_FUNCTION
, 0, 0},
94 * Currently removed from lttng kernel tracer. Removed from
95 * lttng UI to discourage its use.
97 {"function:entry", 0, POPT_ARG_STRING
, &opt_function_entry_symbol
, OPT_FUNCTION_ENTRY
, 0, 0},
99 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_SYSCALL
, 0, 0},
100 {"loglevel", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL
, 0, 0},
101 {"loglevel-only", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL_ONLY
, 0, 0},
102 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
103 {"filter", 'f', POPT_ARG_STRING
, &opt_filter
, OPT_FILTER
, 0, 0},
104 {"exclude", 'x', POPT_ARG_STRING
, &opt_exclude
, OPT_EXCLUDE
, 0, 0},
105 {0, 0, 0, 0, 0, 0, 0}
111 static void usage(FILE *ofp
)
113 fprintf(ofp
, "usage: lttng enable-event NAME[,NAME2,...] [-k|-u] [OPTIONS] \n");
115 fprintf(ofp
, "Options:\n");
116 fprintf(ofp
, " -h, --help Show this help\n");
117 fprintf(ofp
, " --list-options Simple listing of options\n");
118 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
119 fprintf(ofp
, " -c, --channel NAME Apply to this channel\n");
120 fprintf(ofp
, " -a, --all Enable all tracepoints and syscalls\n");
121 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
122 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
123 fprintf(ofp
, " -j, --jul Apply for Java application using JUL\n");
125 fprintf(ofp
, "Event options:\n");
126 fprintf(ofp
, " --tracepoint Tracepoint event (default)\n");
127 fprintf(ofp
, " - userspace tracer supports wildcards at end of string.\n");
128 fprintf(ofp
, " Don't forget to quote to deal with bash expansion.\n");
129 fprintf(ofp
, " e.g.:\n");
130 fprintf(ofp
, " \"*\"\n");
131 fprintf(ofp
, " \"app_component:na*\"\n");
132 fprintf(ofp
, " --probe (addr | symbol | symbol+offset)\n");
133 fprintf(ofp
, " Dynamic probe.\n");
134 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
135 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
136 fprintf(ofp
, " --function (addr | symbol | symbol+offset)\n");
137 fprintf(ofp
, " Dynamic function entry/return probe.\n");
138 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
139 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
141 fprintf(ofp
, " --function:entry symbol\n");
142 fprintf(ofp
, " Function tracer event\n");
144 fprintf(ofp
, " --syscall System call event\n");
146 fprintf(ofp
, " --loglevel name\n");
147 fprintf(ofp
, " Tracepoint loglevel range from 0 to loglevel.\n");
148 fprintf(ofp
, " For JUL domain, see the table below for the range values.\n");
149 fprintf(ofp
, " --loglevel-only name\n");
150 fprintf(ofp
, " Tracepoint loglevel (only this loglevel)\n");
152 fprintf(ofp
, " The loglevel or loglevel-only options should be\n");
153 fprintf(ofp
, " combined with a tracepoint name or tracepoint\n");
154 fprintf(ofp
, " wildcard.\n");
155 fprintf(ofp
, " Available loglevels:\n");
156 fprintf(ofp
, " (higher value is more verbose)\n");
157 fprintf(ofp
, " TRACE_EMERG = 0\n");
158 fprintf(ofp
, " TRACE_ALERT = 1\n");
159 fprintf(ofp
, " TRACE_CRIT = 2\n");
160 fprintf(ofp
, " TRACE_ERR = 3\n");
161 fprintf(ofp
, " TRACE_WARNING = 4\n");
162 fprintf(ofp
, " TRACE_NOTICE = 5\n");
163 fprintf(ofp
, " TRACE_INFO = 6\n");
164 fprintf(ofp
, " TRACE_DEBUG_SYSTEM = 7\n");
165 fprintf(ofp
, " TRACE_DEBUG_PROGRAM = 8\n");
166 fprintf(ofp
, " TRACE_DEBUG_PROCESS = 9\n");
167 fprintf(ofp
, " TRACE_DEBUG_MODULE = 10\n");
168 fprintf(ofp
, " TRACE_DEBUG_UNIT = 11\n");
169 fprintf(ofp
, " TRACE_DEBUG_FUNCTION = 12\n");
170 fprintf(ofp
, " TRACE_DEBUG_LINE = 13\n");
171 fprintf(ofp
, " TRACE_DEBUG = 14\n");
172 fprintf(ofp
, " (shortcuts such as \"system\" are allowed)\n");
174 fprintf(ofp
, " Available JUL domain loglevels:\n");
175 fprintf(ofp
, " JUL_OFF = INT32_MAX\n");
176 fprintf(ofp
, " JUL_SEVERE = %d\n", LTTNG_LOGLEVEL_JUL_SEVERE
);
177 fprintf(ofp
, " JUL_WARNING = %d\n", LTTNG_LOGLEVEL_JUL_WARNING
);
178 fprintf(ofp
, " JUL_INFO = %d\n", LTTNG_LOGLEVEL_JUL_INFO
);
179 fprintf(ofp
, " JUL_CONFIG = %d\n", LTTNG_LOGLEVEL_JUL_CONFIG
);
180 fprintf(ofp
, " JUL_FINE = %d\n", LTTNG_LOGLEVEL_JUL_FINE
);
181 fprintf(ofp
, " JUL_FINER = %d\n", LTTNG_LOGLEVEL_JUL_FINER
);
182 fprintf(ofp
, " JUL_FINEST = %d\n", LTTNG_LOGLEVEL_JUL_FINEST
);
183 fprintf(ofp
, " JUL_ALL = INT32_MIN\n");
184 fprintf(ofp
, " (shortcuts such as \"severe\" are allowed)\n");
186 fprintf(ofp
, " -f, --filter \'expression\'\n");
187 fprintf(ofp
, " Filter expression on event fields and context.\n");
188 fprintf(ofp
, " Event recording depends on evaluation.\n");
189 fprintf(ofp
, " Only specify on first activation of\n");
190 fprintf(ofp
, " a given event within a session.\n");
191 fprintf(ofp
, " Filter only allowed when enabling\n");
192 fprintf(ofp
, " events within a session before tracing\n");
193 fprintf(ofp
, " is started. If the filter fails to link\n");
194 fprintf(ofp
, " with the event within the traced domain,\n");
195 fprintf(ofp
, " the event will be discarded. Currently,\n");
196 fprintf(ofp
, " filter is only implemented for the user-space\n");
197 fprintf(ofp
, " tracer.\n");
198 fprintf(ofp
, " Expression examples:.\n");
200 fprintf(ofp
, " 'intfield > 500 && intfield < 503'\n");
201 fprintf(ofp
, " '(strfield == \"test\" || intfield != 10) && intfield > 33'\n");
202 fprintf(ofp
, " 'doublefield > 1.1 && intfield < 5.3'\n");
204 fprintf(ofp
, " Wildcards are allowed at the end of strings:\n");
205 fprintf(ofp
, " 'seqfield1 == \"te*\"'\n");
206 fprintf(ofp
, " In string literals, the escape character is '\\'.\n");
207 fprintf(ofp
, " Use '\\*' for the '*' character, and '\\\\' for\n");
208 fprintf(ofp
, " the '\\' character. Wildcard match any sequence of,\n");
209 fprintf(ofp
, " characters including an empty sub-string (match 0 or\n");
210 fprintf(ofp
, " more characters).\n");
212 fprintf(ofp
, " Context information can be used for filtering. The\n");
213 fprintf(ofp
, " examples below show usage of context filtering on\n");
214 fprintf(ofp
, " process name (with a wildcard), process ID range, and\n");
215 fprintf(ofp
, " unique thread ID for filtering. The process and\n");
216 fprintf(ofp
, " thread ID of running applications can be found under\n");
217 fprintf(ofp
, " columns \"PID\" and \"LWP\" of the \"ps -eLf\" command.\n");
219 fprintf(ofp
, " '$ctx.procname == \"demo*\"'\n");
220 fprintf(ofp
, " '$ctx.vpid >= 4433 && $ctx.vpid < 4455'\n");
221 fprintf(ofp
, " '$ctx.vtid == 1234'\n");
222 fprintf(ofp
, " -x, --exclude LIST\n");
223 fprintf(ofp
, " Add exclusions to UST tracepoints:\n");
224 fprintf(ofp
, " Events that match any of the items\n");
225 fprintf(ofp
, " in the comma-separated LIST are not\n");
226 fprintf(ofp
, " enabled, even if they match a wildcard\n");
227 fprintf(ofp
, " definition of the event.\n");
232 * Parse probe options.
234 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
238 #define S_HEX_LEN_SCANF_IS_A_BROKEN_API "18" /* 18 is (19 - 1) (\0 is extra) */
239 char name
[LTTNG_SYMBOL_NAME_LEN
];
246 /* Check for symbol+offset */
247 ret
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
248 "[^'+']+%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", name
, s_hex
);
250 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
251 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
252 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
253 if (*s_hex
== '\0') {
254 ERR("Invalid probe offset %s", s_hex
);
258 ev
->attr
.probe
.offset
= strtoul(s_hex
, NULL
, 0);
259 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
260 ev
->attr
.probe
.addr
= 0;
264 /* Check for symbol */
265 if (isalpha(name
[0])) {
266 ret
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
"s",
269 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
270 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
271 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
272 ev
->attr
.probe
.offset
= 0;
273 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
274 ev
->attr
.probe
.addr
= 0;
279 /* Check for address */
280 ret
= sscanf(opt
, "%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", s_hex
);
282 if (*s_hex
== '\0') {
283 ERR("Invalid probe address %s", s_hex
);
287 ev
->attr
.probe
.addr
= strtoul(s_hex
, NULL
, 0);
288 DBG("probe addr %" PRIu64
, ev
->attr
.probe
.addr
);
289 ev
->attr
.probe
.offset
= 0;
290 memset(ev
->attr
.probe
.symbol_name
, 0, LTTNG_SYMBOL_NAME_LEN
);
302 * Maps JUL loglevel from string to value
304 static int loglevel_jul_str_to_value(const char *inputstr
)
307 char str
[LTTNG_SYMBOL_NAME_LEN
];
310 * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
311 * added at the end of the loop so a the upper bound we avoid the overflow.
313 while (i
< (LTTNG_SYMBOL_NAME_LEN
- 1) && inputstr
[i
] != '\0') {
314 str
[i
] = toupper(inputstr
[i
]);
319 if (!strcmp(str
, "JUL_OFF") || !strcmp(str
, "OFF")) {
320 return LTTNG_LOGLEVEL_JUL_OFF
;
321 } else if (!strcmp(str
, "JUL_SEVERE") || !strcmp(str
, "SEVERE")) {
322 return LTTNG_LOGLEVEL_JUL_SEVERE
;
323 } else if (!strcmp(str
, "JUL_WARNING") || !strcmp(str
, "WARNING")) {
324 return LTTNG_LOGLEVEL_JUL_WARNING
;
325 } else if (!strcmp(str
, "JUL_INFO") || !strcmp(str
, "INFO")) {
326 return LTTNG_LOGLEVEL_JUL_INFO
;
327 } else if (!strcmp(str
, "JUL_CONFIG") || !strcmp(str
, "CONFIG")) {
328 return LTTNG_LOGLEVEL_JUL_CONFIG
;
329 } else if (!strcmp(str
, "JUL_FINE") || !strcmp(str
, "FINE")) {
330 return LTTNG_LOGLEVEL_JUL_FINE
;
331 } else if (!strcmp(str
, "JUL_FINER") || !strcmp(str
, "FINER")) {
332 return LTTNG_LOGLEVEL_JUL_FINER
;
333 } else if (!strcmp(str
, "JUL_FINEST") || !strcmp(str
, "FINEST")) {
334 return LTTNG_LOGLEVEL_JUL_FINEST
;
335 } else if (!strcmp(str
, "JUL_ALL") || !strcmp(str
, "ALL")) {
336 return LTTNG_LOGLEVEL_JUL_ALL
;
343 * Maps loglevel from string to value
346 int loglevel_str_to_value(const char *inputstr
)
349 char str
[LTTNG_SYMBOL_NAME_LEN
];
352 * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
353 * added at the end of the loop so a the upper bound we avoid the overflow.
355 while (i
< (LTTNG_SYMBOL_NAME_LEN
- 1) && inputstr
[i
] != '\0') {
356 str
[i
] = toupper(inputstr
[i
]);
360 if (!strcmp(str
, "TRACE_EMERG") || !strcmp(str
, "EMERG")) {
361 return LTTNG_LOGLEVEL_EMERG
;
362 } else if (!strcmp(str
, "TRACE_ALERT") || !strcmp(str
, "ALERT")) {
363 return LTTNG_LOGLEVEL_ALERT
;
364 } else if (!strcmp(str
, "TRACE_CRIT") || !strcmp(str
, "CRIT")) {
365 return LTTNG_LOGLEVEL_CRIT
;
366 } else if (!strcmp(str
, "TRACE_ERR") || !strcmp(str
, "ERR")) {
367 return LTTNG_LOGLEVEL_ERR
;
368 } else if (!strcmp(str
, "TRACE_WARNING") || !strcmp(str
, "WARNING")) {
369 return LTTNG_LOGLEVEL_WARNING
;
370 } else if (!strcmp(str
, "TRACE_NOTICE") || !strcmp(str
, "NOTICE")) {
371 return LTTNG_LOGLEVEL_NOTICE
;
372 } else if (!strcmp(str
, "TRACE_INFO") || !strcmp(str
, "INFO")) {
373 return LTTNG_LOGLEVEL_INFO
;
374 } else if (!strcmp(str
, "TRACE_DEBUG_SYSTEM") || !strcmp(str
, "DEBUG_SYSTEM") || !strcmp(str
, "SYSTEM")) {
375 return LTTNG_LOGLEVEL_DEBUG_SYSTEM
;
376 } else if (!strcmp(str
, "TRACE_DEBUG_PROGRAM") || !strcmp(str
, "DEBUG_PROGRAM") || !strcmp(str
, "PROGRAM")) {
377 return LTTNG_LOGLEVEL_DEBUG_PROGRAM
;
378 } else if (!strcmp(str
, "TRACE_DEBUG_PROCESS") || !strcmp(str
, "DEBUG_PROCESS") || !strcmp(str
, "PROCESS")) {
379 return LTTNG_LOGLEVEL_DEBUG_PROCESS
;
380 } else if (!strcmp(str
, "TRACE_DEBUG_MODULE") || !strcmp(str
, "DEBUG_MODULE") || !strcmp(str
, "MODULE")) {
381 return LTTNG_LOGLEVEL_DEBUG_MODULE
;
382 } else if (!strcmp(str
, "TRACE_DEBUG_UNIT") || !strcmp(str
, "DEBUG_UNIT") || !strcmp(str
, "UNIT")) {
383 return LTTNG_LOGLEVEL_DEBUG_UNIT
;
384 } else if (!strcmp(str
, "TRACE_DEBUG_FUNCTION") || !strcmp(str
, "DEBUG_FUNCTION") || !strcmp(str
, "FUNCTION")) {
385 return LTTNG_LOGLEVEL_DEBUG_FUNCTION
;
386 } else if (!strcmp(str
, "TRACE_DEBUG_LINE") || !strcmp(str
, "DEBUG_LINE") || !strcmp(str
, "LINE")) {
387 return LTTNG_LOGLEVEL_DEBUG_LINE
;
388 } else if (!strcmp(str
, "TRACE_DEBUG") || !strcmp(str
, "DEBUG")) {
389 return LTTNG_LOGLEVEL_DEBUG
;
396 const char *print_channel_name(const char *name
)
398 return name
? : DEFAULT_CHANNEL_NAME
;
402 const char *print_raw_channel_name(const char *name
)
404 return name
? : "<default>";
408 * Mi print exlcusion list
411 int mi_print_exclusion(int count
, char **names
)
421 ret
= mi_lttng_writer_open_element(writer
, config_element_exclusions
);
426 for (i
= 0; i
< count
; i
++) {
427 ret
= mi_lttng_writer_write_element_string(writer
,
428 config_element_exclusion
, names
[i
]);
434 /* Close exclusions element */
435 ret
= mi_lttng_writer_close_element(writer
);
442 * Return allocated string for pretty-printing exclusion names.
445 char *print_exclusions(int count
, char **names
)
449 const char *preamble
= " excluding ";
456 /* calculate total required length */
457 for (i
= 0; i
< count
; i
++) {
458 length
+= strlen(names
[i
]) + 1;
461 /* add length of preamble + one for NUL - one for last (missing) comma */
462 length
+= strlen(preamble
);
463 ret
= malloc(length
);
464 strncpy(ret
, preamble
, length
);
465 for (i
= 0; i
< count
; i
++) {
466 strcat(ret
, names
[i
]);
467 if (i
!= count
- 1) {
476 * Compare list of exclusions against an event name.
477 * Return a list of legal exclusion names.
478 * Produce an error or a warning about others (depending on the situation)
481 int check_exclusion_subsets(const char *event_name
,
482 const char *exclusions
,
483 int *exclusion_count_ptr
,
484 char ***exclusion_list_ptr
)
486 const char *excluder_ptr
;
487 const char *event_ptr
;
488 const char *next_excluder
;
490 int exclusion_count
= 0;
491 char **exclusion_list
= NULL
;
492 int ret
= CMD_SUCCESS
;
494 if (event_name
[strlen(event_name
) - 1] != '*') {
495 ERR("Event %s: Excluders can only be used with wildcarded events", event_name
);
499 next_excluder
= exclusions
;
500 while (*next_excluder
!= 0) {
501 event_ptr
= event_name
;
502 excluder_ptr
= next_excluder
;
503 excluder_length
= strcspn(next_excluder
, ",");
505 /* Scan both the excluder and the event letter by letter */
513 /* Event is a subset of the excluder */
514 ERR("Event %s: %.*s excludes all events from %s",
522 /* Excluder is a proper subset of event */
524 exclusion_list
= realloc(exclusion_list
, sizeof(char **) * exclusion_count
);
525 exclusion_list
[exclusion_count
- 1] = strndup(next_excluder
, excluder_length
);
530 /* Excluder and event sets have no common elements */
531 WARN("Event %s: %.*s does not exclude any events from %s",
542 next_excluder
+= excluder_length
;
543 if (*next_excluder
== ',') {
549 while (exclusion_count
--) {
550 free(exclusion_list
[exclusion_count
]);
552 if (exclusion_list
!= NULL
) {
553 free(exclusion_list
);
555 exclusion_list
= NULL
;
559 *exclusion_count_ptr
= exclusion_count
;
560 *exclusion_list_ptr
= exclusion_list
;
564 * Enabling event using the lttng API.
565 * Note: in case of error only the last error code will be return.
567 static int enable_events(char *session_name
)
569 int ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
;
570 int error_holder
= CMD_SUCCESS
, warn
= 0, error
= 0, success
= 1;
571 char *event_name
, *channel_name
= NULL
;
572 struct lttng_event ev
;
573 struct lttng_domain dom
;
574 int exclusion_count
= 0;
575 char **exclusion_list
= NULL
;
577 memset(&ev
, 0, sizeof(ev
));
578 memset(&dom
, 0, sizeof(dom
));
582 ERR("Filter not implement for kernel tracing yet");
587 WARN("Kernel loglevels are not supported.");
591 /* Create lttng domain */
593 dom
.type
= LTTNG_DOMAIN_KERNEL
;
594 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
595 } else if (opt_userspace
) {
596 dom
.type
= LTTNG_DOMAIN_UST
;
598 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
599 } else if (opt_jul
) {
600 dom
.type
= LTTNG_DOMAIN_JUL
;
602 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
604 print_missing_domain();
609 if (opt_kernel
&& opt_exclude
) {
610 ERR("Event name exclusions are not yet implemented for kernel events");
615 channel_name
= opt_channel_name
;
617 handle
= lttng_create_handle(session_name
, &dom
);
618 if (handle
== NULL
) {
625 /* Open a events element */
626 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
633 if (opt_enable_all
) {
634 /* Default setup for enable all */
636 ev
.type
= opt_event_type
;
638 /* kernel loglevels not implemented */
639 ev
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
641 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
642 strcpy(ev
.name
, "*");
643 ev
.loglevel_type
= opt_loglevel_type
;
645 assert(opt_userspace
|| opt_jul
);
647 ev
.loglevel
= loglevel_str_to_value(opt_loglevel
);
648 } else if (opt_jul
) {
649 ev
.loglevel
= loglevel_jul_str_to_value(opt_loglevel
);
651 if (ev
.loglevel
== -1) {
652 ERR("Unknown loglevel %s", opt_loglevel
);
653 ret
= -LTTNG_ERR_INVALID
;
657 assert(opt_userspace
|| opt_jul
);
660 } else if (opt_jul
) {
661 ev
.loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
667 ret
= check_exclusion_subsets("*", opt_exclude
,
668 &exclusion_count
, &exclusion_list
);
669 if (ret
== CMD_ERROR
) {
675 ret
= lttng_enable_event_with_exclusions(handle
,
678 exclusion_count
, exclusion_list
);
681 case LTTNG_ERR_KERN_EVENT_EXIST
:
682 WARN("Kernel events already enabled (channel %s, session %s)",
683 print_channel_name(channel_name
), session_name
);
687 ERR("Events: %s (channel %s, session %s)",
689 ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
690 ? print_raw_channel_name(channel_name
)
691 : print_channel_name(channel_name
),
699 switch (opt_event_type
) {
700 case LTTNG_EVENT_TRACEPOINT
:
701 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
702 char *exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
703 MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
704 get_domain_str(dom
.type
),
706 print_channel_name(channel_name
),
708 free(exclusion_string
);
710 char *exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
711 MSG("All %s tracepoints%s are enabled in channel %s",
712 get_domain_str(dom
.type
),
714 print_channel_name(channel_name
));
715 free(exclusion_string
);
718 case LTTNG_EVENT_SYSCALL
:
720 MSG("All kernel system calls are enabled in channel %s",
721 print_channel_name(channel_name
));
724 case LTTNG_EVENT_ALL
:
725 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
726 char *exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
727 MSG("All %s events%s are enabled in channel %s for loglevel %s",
728 get_domain_str(dom
.type
),
730 print_channel_name(channel_name
),
732 free(exclusion_string
);
734 char *exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
735 MSG("All %s events%s are enabled in channel %s",
736 get_domain_str(dom
.type
),
738 print_channel_name(channel_name
));
739 free(exclusion_string
);
744 * We should not be here since lttng_enable_event should have
745 * failed on the event type.
752 command_ret
= lttng_enable_event_with_exclusions(handle
, &ev
, channel_name
,
753 opt_filter
, exclusion_count
, exclusion_list
);
754 if (command_ret
< 0) {
755 switch (-command_ret
) {
756 case LTTNG_ERR_FILTER_EXIST
:
757 WARN("Filter on all events is already enabled"
758 " (channel %s, session %s)",
759 print_channel_name(channel_name
), session_name
);
763 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
765 ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
766 ? print_raw_channel_name(channel_name
)
767 : print_channel_name(channel_name
),
768 session_name
, opt_filter
);
772 error_holder
= command_ret
;
775 MSG("Filter '%s' successfully set", opt_filter
);
780 /* The wildcard * is used for kernel and ust domain to
781 * represent ALL. We copy * in event name to force the wildcard use
784 * Note: this is strictly for semantic and printing while in
785 * machine interface mode.
787 strcpy(ev
.name
, "*");
789 /* If we reach here the events are enabled */
790 if (!error
&& !warn
) {
796 ret
= mi_lttng_event(writer
, &ev
, 1);
802 /* print exclusion */
803 ret
= mi_print_exclusion(exclusion_count
, exclusion_list
);
810 ret
= mi_lttng_writer_write_element_bool(writer
,
811 mi_lttng_element_command_success
, success
);
817 /* Close event element */
818 ret
= mi_lttng_writer_close_element(writer
);
828 /* Strip event list */
829 event_name
= strtok(opt_event_list
, ",");
830 while (event_name
!= NULL
) {
831 /* Copy name and type of the event */
832 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
833 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
834 ev
.type
= opt_event_type
;
836 /* Kernel tracer action */
838 DBG("Enabling kernel event %s for channel %s",
840 print_channel_name(channel_name
));
842 switch (opt_event_type
) {
843 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
844 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
846 case LTTNG_EVENT_TRACEPOINT
:
848 case LTTNG_EVENT_PROBE
:
849 ret
= parse_probe_opts(&ev
, opt_probe
);
851 ERR("Unable to parse probe options");
856 case LTTNG_EVENT_FUNCTION
:
857 ret
= parse_probe_opts(&ev
, opt_function
);
859 ERR("Unable to parse function probe options");
864 case LTTNG_EVENT_FUNCTION_ENTRY
:
865 strncpy(ev
.attr
.ftrace
.symbol_name
, opt_function_entry_symbol
,
866 LTTNG_SYMBOL_NAME_LEN
);
867 ev
.attr
.ftrace
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
869 case LTTNG_EVENT_SYSCALL
:
870 MSG("per-syscall selection not supported yet. Use \"-a\" "
871 "for all syscalls.");
877 /* kernel loglevels not implemented */
878 ev
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
879 } else if (opt_userspace
) { /* User-space tracer action */
881 if (opt_cmd_name
!= NULL
|| opt_pid
) {
882 MSG("Only supporting tracing all UST processes (-u) for now.");
888 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name
,
889 print_channel_name(channel_name
), opt_loglevel
? : "<all>");
891 switch (opt_event_type
) {
892 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
894 case LTTNG_EVENT_TRACEPOINT
:
895 /* Copy name and type of the event */
896 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
897 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
898 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
900 case LTTNG_EVENT_PROBE
:
901 case LTTNG_EVENT_FUNCTION
:
902 case LTTNG_EVENT_FUNCTION_ENTRY
:
903 case LTTNG_EVENT_SYSCALL
:
905 ERR("Event type not available for user-space tracing");
906 ret
= CMD_UNSUPPORTED
;
912 if (opt_event_type
!= LTTNG_EVENT_ALL
&& opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
913 ERR("Exclusion option can only be used with tracepoint events");
917 /* Free previously allocated items */
918 if (exclusion_list
!= NULL
) {
919 while (exclusion_count
--) {
920 free(exclusion_list
[exclusion_count
]);
922 free(exclusion_list
);
923 exclusion_list
= NULL
;
925 /* Check for proper subsets */
926 ret
= check_exclusion_subsets(event_name
, opt_exclude
,
927 &exclusion_count
, &exclusion_list
);
928 if (ret
== CMD_ERROR
) {
933 ev
.loglevel_type
= opt_loglevel_type
;
935 ev
.loglevel
= loglevel_str_to_value(opt_loglevel
);
936 if (ev
.loglevel
== -1) {
937 ERR("Unknown loglevel %s", opt_loglevel
);
938 ret
= -LTTNG_ERR_INVALID
;
944 } else if (opt_jul
) {
945 if (opt_event_type
!= LTTNG_EVENT_ALL
&&
946 opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
947 ERR("Event type not supported for JUL domain.");
948 ret
= CMD_UNSUPPORTED
;
952 ev
.loglevel_type
= opt_loglevel_type
;
954 ev
.loglevel
= loglevel_jul_str_to_value(opt_loglevel
);
955 if (ev
.loglevel
== -1) {
956 ERR("Unknown loglevel %s", opt_loglevel
);
957 ret
= -LTTNG_ERR_INVALID
;
961 ev
.loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
963 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
964 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
965 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
967 print_missing_domain();
973 char *exclusion_string
;
975 command_ret
= lttng_enable_event_with_exclusions(handle
,
977 NULL
, exclusion_count
, exclusion_list
);
978 exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
979 if (command_ret
< 0) {
980 /* Turn ret to positive value to handle the positive error code */
981 switch (-command_ret
) {
982 case LTTNG_ERR_KERN_EVENT_EXIST
:
983 WARN("Kernel event %s%s already enabled (channel %s, session %s)",
986 print_channel_name(channel_name
), session_name
);
990 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
993 ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
994 ? print_raw_channel_name(channel_name
)
995 : print_channel_name(channel_name
),
1000 error_holder
= command_ret
;
1002 /* So we don't print the default channel name for JUL. */
1003 if (dom
.type
== LTTNG_DOMAIN_JUL
) {
1004 MSG("%s event %s%s enabled.",
1005 get_domain_str(dom
.type
), event_name
,
1008 MSG("%s event %s%s created in channel %s",
1009 get_domain_str(dom
.type
), event_name
,
1011 print_channel_name(channel_name
));
1014 free(exclusion_string
);
1018 char *exclusion_string
;
1020 /* Filter present */
1023 command_ret
= lttng_enable_event_with_exclusions(handle
, &ev
, channel_name
,
1024 opt_filter
, exclusion_count
, exclusion_list
);
1025 exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
1027 if (command_ret
< 0) {
1028 switch (-command_ret
) {
1029 case LTTNG_ERR_FILTER_EXIST
:
1030 WARN("Filter on event %s%s is already enabled"
1031 " (channel %s, session %s)",
1034 print_channel_name(channel_name
), session_name
);
1038 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
.name
,
1040 lttng_strerror(ret
),
1041 ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1042 ? print_raw_channel_name(channel_name
)
1043 : print_channel_name(channel_name
),
1044 session_name
, opt_filter
);
1048 error_holder
= command_ret
;
1051 MSG("Event %s%s: Filter '%s' successfully set",
1052 event_name
, exclusion_string
,
1055 free(exclusion_string
);
1066 ret
= mi_lttng_event(writer
, &ev
, 1);
1072 /* print exclusion */
1073 ret
= mi_print_exclusion(exclusion_count
, exclusion_list
);
1080 ret
= mi_lttng_writer_write_element_bool(writer
,
1081 mi_lttng_element_command_success
, success
);
1087 /* Close event element */
1088 ret
= mi_lttng_writer_close_element(writer
);
1096 event_name
= strtok(NULL
, ",");
1097 /* Reset warn, error and success */
1104 /* Close events element */
1105 ret
= mi_lttng_writer_close_element(writer
);
1118 lttng_destroy_handle(handle
);
1120 if (exclusion_list
!= NULL
) {
1121 while (exclusion_count
--) {
1122 free(exclusion_list
[exclusion_count
]);
1124 free(exclusion_list
);
1127 /* Overwrite ret with error_holder if there was an actual error with
1128 * enabling an event.
1130 ret
= error_holder
? error_holder
: ret
;
1136 * Add event to trace session
1138 int cmd_enable_events(int argc
, const char **argv
)
1140 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
1141 static poptContext pc
;
1142 char *session_name
= NULL
;
1143 int event_type
= -1;
1145 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1146 poptReadDefaultConfig(pc
, 0);
1148 /* Default event type */
1149 opt_event_type
= LTTNG_EVENT_ALL
;
1151 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1156 case OPT_TRACEPOINT
:
1157 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
1160 opt_event_type
= LTTNG_EVENT_PROBE
;
1163 opt_event_type
= LTTNG_EVENT_FUNCTION
;
1165 case OPT_FUNCTION_ENTRY
:
1166 opt_event_type
= LTTNG_EVENT_FUNCTION_ENTRY
;
1169 opt_event_type
= LTTNG_EVENT_SYSCALL
;
1175 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
1176 opt_loglevel
= poptGetOptArg(pc
);
1178 case OPT_LOGLEVEL_ONLY
:
1179 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
1180 opt_loglevel
= poptGetOptArg(pc
);
1182 case OPT_LIST_OPTIONS
:
1183 list_cmd_options(stdout
, long_options
);
1191 ret
= CMD_UNDEFINED
;
1195 /* Validate event type. Multiple event type are not supported. */
1196 if (event_type
== -1) {
1197 event_type
= opt_event_type
;
1199 if (event_type
!= opt_event_type
) {
1200 ERR("Multiple event type not supported.");
1209 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1211 ret
= -LTTNG_ERR_NOMEM
;
1215 /* Open command element */
1216 ret
= mi_lttng_writer_command_open(writer
,
1217 mi_lttng_element_command_enable_event
);
1223 /* Open output element */
1224 ret
= mi_lttng_writer_open_element(writer
,
1225 mi_lttng_element_command_output
);
1232 opt_event_list
= (char*) poptGetArg(pc
);
1233 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
1234 ERR("Missing event name(s).\n");
1240 if (!opt_session_name
) {
1241 session_name
= get_session_name();
1242 if (session_name
== NULL
) {
1243 command_ret
= CMD_ERROR
;
1248 session_name
= opt_session_name
;
1251 command_ret
= enable_events(session_name
);
1260 /* Close output element */
1261 ret
= mi_lttng_writer_close_element(writer
);
1267 ret
= mi_lttng_writer_write_element_bool(writer
,
1268 mi_lttng_element_command_success
, success
);
1274 /* Command element close */
1275 ret
= mi_lttng_writer_command_close(writer
);
1284 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1285 /* Preserve original error code */
1286 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
1289 if (opt_session_name
== NULL
) {
1293 /* Overwrite ret if an error occurred in enable_events */
1294 ret
= command_ret
? command_ret
: ret
;
1296 poptFreeContext(pc
);