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
;
50 static int opt_enable_all
;
51 static char *opt_probe
;
52 static char *opt_function
;
53 static char *opt_function_entry_symbol
;
54 static char *opt_channel_name
;
55 static char *opt_filter
;
56 static char *opt_exclude
;
58 /* Not implemented yet */
59 static char *opt_cmd_name
;
78 static struct lttng_handle
*handle
;
79 static struct mi_writer
*writer
;
81 static struct poptOption long_options
[] = {
82 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
83 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
84 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
85 {"all", 'a', POPT_ARG_VAL
, &opt_enable_all
, 1, 0, 0},
86 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
87 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
88 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
89 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
90 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
91 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TRACEPOINT
, 0, 0},
92 {"probe", 0, POPT_ARG_STRING
, &opt_probe
, OPT_PROBE
, 0, 0},
93 {"function", 0, POPT_ARG_STRING
, &opt_function
, OPT_FUNCTION
, 0, 0},
96 * Currently removed from lttng kernel tracer. Removed from
97 * lttng UI to discourage its use.
99 {"function:entry", 0, POPT_ARG_STRING
, &opt_function_entry_symbol
, OPT_FUNCTION_ENTRY
, 0, 0},
101 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_SYSCALL
, 0, 0},
102 {"loglevel", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL
, 0, 0},
103 {"loglevel-only", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL_ONLY
, 0, 0},
104 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
105 {"filter", 'f', POPT_ARG_STRING
, &opt_filter
, OPT_FILTER
, 0, 0},
106 {"exclude", 'x', POPT_ARG_STRING
, &opt_exclude
, OPT_EXCLUDE
, 0, 0},
107 {0, 0, 0, 0, 0, 0, 0}
113 static void usage(FILE *ofp
)
115 fprintf(ofp
, "usage: lttng enable-event NAME[,NAME2,...] [-k|-u] [OPTIONS] \n");
117 fprintf(ofp
, "Options:\n");
118 fprintf(ofp
, " -h, --help Show this help\n");
119 fprintf(ofp
, " --list-options Simple listing of options\n");
120 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
121 fprintf(ofp
, " -c, --channel NAME Apply to this channel\n");
122 fprintf(ofp
, " -a, --all Enable all tracepoints and syscalls\n");
123 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
124 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
125 fprintf(ofp
, " -j, --jul Apply for Java application using JUL\n");
126 fprintf(ofp
, " -l, --log4j Apply for Java application using LOG4j\n");
128 fprintf(ofp
, "Event options:\n");
129 fprintf(ofp
, " --tracepoint Tracepoint event (default)\n");
130 fprintf(ofp
, " - userspace tracer supports wildcards at end of string.\n");
131 fprintf(ofp
, " Don't forget to quote to deal with bash expansion.\n");
132 fprintf(ofp
, " e.g.:\n");
133 fprintf(ofp
, " \"*\"\n");
134 fprintf(ofp
, " \"app_component:na*\"\n");
135 fprintf(ofp
, " --probe (addr | symbol | symbol+offset)\n");
136 fprintf(ofp
, " Dynamic probe.\n");
137 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
138 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
139 fprintf(ofp
, " --function (addr | symbol | symbol+offset)\n");
140 fprintf(ofp
, " Dynamic function entry/return probe.\n");
141 fprintf(ofp
, " Addr and offset can be octal (0NNN...),\n");
142 fprintf(ofp
, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
144 fprintf(ofp
, " --function:entry symbol\n");
145 fprintf(ofp
, " Function tracer event\n");
147 fprintf(ofp
, " --syscall System call event\n");
149 fprintf(ofp
, " --loglevel name\n");
150 fprintf(ofp
, " Tracepoint loglevel range from 0 to loglevel.\n");
151 fprintf(ofp
, " For JUL/LOG4j domain, see the table below for the range values.\n");
152 fprintf(ofp
, " --loglevel-only name\n");
153 fprintf(ofp
, " Tracepoint loglevel (only this loglevel)\n");
155 fprintf(ofp
, " The loglevel or loglevel-only options should be\n");
156 fprintf(ofp
, " combined with a tracepoint name or tracepoint\n");
157 fprintf(ofp
, " wildcard.\n");
158 fprintf(ofp
, " Available loglevels:\n");
159 fprintf(ofp
, " (higher value is more verbose)\n");
160 fprintf(ofp
, " TRACE_EMERG = 0\n");
161 fprintf(ofp
, " TRACE_ALERT = 1\n");
162 fprintf(ofp
, " TRACE_CRIT = 2\n");
163 fprintf(ofp
, " TRACE_ERR = 3\n");
164 fprintf(ofp
, " TRACE_WARNING = 4\n");
165 fprintf(ofp
, " TRACE_NOTICE = 5\n");
166 fprintf(ofp
, " TRACE_INFO = 6\n");
167 fprintf(ofp
, " TRACE_DEBUG_SYSTEM = 7\n");
168 fprintf(ofp
, " TRACE_DEBUG_PROGRAM = 8\n");
169 fprintf(ofp
, " TRACE_DEBUG_PROCESS = 9\n");
170 fprintf(ofp
, " TRACE_DEBUG_MODULE = 10\n");
171 fprintf(ofp
, " TRACE_DEBUG_UNIT = 11\n");
172 fprintf(ofp
, " TRACE_DEBUG_FUNCTION = 12\n");
173 fprintf(ofp
, " TRACE_DEBUG_LINE = 13\n");
174 fprintf(ofp
, " TRACE_DEBUG = 14\n");
175 fprintf(ofp
, " (shortcuts such as \"system\" are allowed)\n");
177 fprintf(ofp
, " Available JUL domain loglevels:\n");
178 fprintf(ofp
, " JUL_OFF = INT32_MAX\n");
179 fprintf(ofp
, " JUL_SEVERE = %d\n", LTTNG_LOGLEVEL_JUL_SEVERE
);
180 fprintf(ofp
, " JUL_WARNING = %d\n", LTTNG_LOGLEVEL_JUL_WARNING
);
181 fprintf(ofp
, " JUL_INFO = %d\n", LTTNG_LOGLEVEL_JUL_INFO
);
182 fprintf(ofp
, " JUL_CONFIG = %d\n", LTTNG_LOGLEVEL_JUL_CONFIG
);
183 fprintf(ofp
, " JUL_FINE = %d\n", LTTNG_LOGLEVEL_JUL_FINE
);
184 fprintf(ofp
, " JUL_FINER = %d\n", LTTNG_LOGLEVEL_JUL_FINER
);
185 fprintf(ofp
, " JUL_FINEST = %d\n", LTTNG_LOGLEVEL_JUL_FINEST
);
186 fprintf(ofp
, " JUL_ALL = INT32_MIN\n");
187 fprintf(ofp
, " (shortcuts such as \"severe\" are allowed)\n");
189 fprintf(ofp
, " Available LOG4j domain loglevels:\n");
190 fprintf(ofp
, " LOG4J_OFF = INT32_MAX\n");
191 fprintf(ofp
, " LOG4J_FATAL = %d\n", LTTNG_LOGLEVEL_LOG4J_FATAL
);
192 fprintf(ofp
, " LOG4J_ERROR = %d\n", LTTNG_LOGLEVEL_LOG4J_ERROR
);
193 fprintf(ofp
, " LOG4J_WARN = %d\n", LTTNG_LOGLEVEL_LOG4J_WARN
);
194 fprintf(ofp
, " LOG4J_INFO = %d\n", LTTNG_LOGLEVEL_LOG4J_INFO
);
195 fprintf(ofp
, " LOG4J_DEBUG = %d\n", LTTNG_LOGLEVEL_LOG4J_DEBUG
);
196 fprintf(ofp
, " LOG4J_TRACE = %d\n", LTTNG_LOGLEVEL_LOG4J_TRACE
);
197 fprintf(ofp
, " LOG4J_ALL = INT32_MIN\n");
198 fprintf(ofp
, " (shortcuts such as \"severe\" are allowed)\n");
200 fprintf(ofp
, " -f, --filter \'expression\'\n");
201 fprintf(ofp
, " Filter expression on event fields and context.\n");
202 fprintf(ofp
, " Event recording depends on evaluation.\n");
203 fprintf(ofp
, " Only specify on first activation of\n");
204 fprintf(ofp
, " a given event within a session.\n");
205 fprintf(ofp
, " Filter only allowed when enabling\n");
206 fprintf(ofp
, " events within a session before tracing\n");
207 fprintf(ofp
, " is started. If the filter fails to link\n");
208 fprintf(ofp
, " with the event within the traced domain,\n");
209 fprintf(ofp
, " the event will be discarded. Currently,\n");
210 fprintf(ofp
, " filter is only implemented for the user-space\n");
211 fprintf(ofp
, " tracer.\n");
212 fprintf(ofp
, " Expression examples:.\n");
214 fprintf(ofp
, " 'intfield > 500 && intfield < 503'\n");
215 fprintf(ofp
, " '(strfield == \"test\" || intfield != 10) && intfield > 33'\n");
216 fprintf(ofp
, " 'doublefield > 1.1 && intfield < 5.3'\n");
218 fprintf(ofp
, " Wildcards are allowed at the end of strings:\n");
219 fprintf(ofp
, " 'seqfield1 == \"te*\"'\n");
220 fprintf(ofp
, " In string literals, the escape character is '\\'.\n");
221 fprintf(ofp
, " Use '\\*' for the '*' character, and '\\\\' for\n");
222 fprintf(ofp
, " the '\\' character. Wildcard match any sequence of,\n");
223 fprintf(ofp
, " characters including an empty sub-string (match 0 or\n");
224 fprintf(ofp
, " more characters).\n");
226 fprintf(ofp
, " Context information can be used for filtering. The\n");
227 fprintf(ofp
, " examples below show usage of context filtering on\n");
228 fprintf(ofp
, " process name (with a wildcard), process ID range, and\n");
229 fprintf(ofp
, " unique thread ID for filtering. The process and\n");
230 fprintf(ofp
, " thread ID of running applications can be found under\n");
231 fprintf(ofp
, " columns \"PID\" and \"LWP\" of the \"ps -eLf\" command.\n");
233 fprintf(ofp
, " '$ctx.procname == \"demo*\"'\n");
234 fprintf(ofp
, " '$ctx.vpid >= 4433 && $ctx.vpid < 4455'\n");
235 fprintf(ofp
, " '$ctx.vtid == 1234'\n");
236 fprintf(ofp
, " -x, --exclude LIST\n");
237 fprintf(ofp
, " Add exclusions to UST tracepoints:\n");
238 fprintf(ofp
, " Events that match any of the items\n");
239 fprintf(ofp
, " in the comma-separated LIST are not\n");
240 fprintf(ofp
, " enabled, even if they match a wildcard\n");
241 fprintf(ofp
, " definition of the event.\n");
246 * Parse probe options.
248 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
250 int ret
= CMD_SUCCESS
;
253 #define S_HEX_LEN_SCANF_IS_A_BROKEN_API "18" /* 18 is (19 - 1) (\0 is extra) */
254 char name
[LTTNG_SYMBOL_NAME_LEN
];
261 /* Check for symbol+offset */
262 match
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
263 "[^'+']+%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", name
, s_hex
);
265 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
266 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
267 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
268 if (*s_hex
== '\0') {
269 ERR("Invalid probe offset %s", s_hex
);
273 ev
->attr
.probe
.offset
= strtoul(s_hex
, NULL
, 0);
274 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
275 ev
->attr
.probe
.addr
= 0;
279 /* Check for symbol */
280 if (isalpha(name
[0])) {
281 match
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
"s",
284 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
285 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
286 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
287 ev
->attr
.probe
.offset
= 0;
288 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
289 ev
->attr
.probe
.addr
= 0;
294 /* Check for address */
295 match
= sscanf(opt
, "%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", s_hex
);
297 if (*s_hex
== '\0') {
298 ERR("Invalid probe address %s", s_hex
);
302 ev
->attr
.probe
.addr
= strtoul(s_hex
, NULL
, 0);
303 DBG("probe addr %" PRIu64
, ev
->attr
.probe
.addr
);
304 ev
->attr
.probe
.offset
= 0;
305 memset(ev
->attr
.probe
.symbol_name
, 0, LTTNG_SYMBOL_NAME_LEN
);
317 * Maps LOG4j loglevel from string to value
319 static int loglevel_log4j_str_to_value(const char *inputstr
)
322 char str
[LTTNG_SYMBOL_NAME_LEN
];
325 * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
326 * added at the end of the loop so a the upper bound we avoid the overflow.
328 while (i
< (LTTNG_SYMBOL_NAME_LEN
- 1) && inputstr
[i
] != '\0') {
329 str
[i
] = toupper(inputstr
[i
]);
334 if (!strcmp(str
, "LOG4J_OFF") || !strcmp(str
, "OFF")) {
335 return LTTNG_LOGLEVEL_LOG4J_OFF
;
336 } else if (!strcmp(str
, "LOG4J_FATAL") || !strcmp(str
, "FATAL")) {
337 return LTTNG_LOGLEVEL_LOG4J_FATAL
;
338 } else if (!strcmp(str
, "LOG4J_ERROR") || !strcmp(str
, "ERROR")) {
339 return LTTNG_LOGLEVEL_LOG4J_ERROR
;
340 } else if (!strcmp(str
, "LOG4J_WARN") || !strcmp(str
, "WARN")) {
341 return LTTNG_LOGLEVEL_LOG4J_WARN
;
342 } else if (!strcmp(str
, "LOG4J_INFO") || !strcmp(str
, "INFO")) {
343 return LTTNG_LOGLEVEL_LOG4J_INFO
;
344 } else if (!strcmp(str
, "LOG4J_DEBUG") || !strcmp(str
, "DEBUG")) {
345 return LTTNG_LOGLEVEL_LOG4J_DEBUG
;
346 } else if (!strcmp(str
, "LOG4J_TRACE") || !strcmp(str
, "TRACE")) {
347 return LTTNG_LOGLEVEL_LOG4J_TRACE
;
348 } else if (!strcmp(str
, "LOG4J_ALL") || !strcmp(str
, "ALL")) {
349 return LTTNG_LOGLEVEL_LOG4J_ALL
;
356 * Maps JUL loglevel from string to value
358 static int loglevel_jul_str_to_value(const char *inputstr
)
361 char str
[LTTNG_SYMBOL_NAME_LEN
];
364 * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
365 * added at the end of the loop so a the upper bound we avoid the overflow.
367 while (i
< (LTTNG_SYMBOL_NAME_LEN
- 1) && inputstr
[i
] != '\0') {
368 str
[i
] = toupper(inputstr
[i
]);
373 if (!strcmp(str
, "JUL_OFF") || !strcmp(str
, "OFF")) {
374 return LTTNG_LOGLEVEL_JUL_OFF
;
375 } else if (!strcmp(str
, "JUL_SEVERE") || !strcmp(str
, "SEVERE")) {
376 return LTTNG_LOGLEVEL_JUL_SEVERE
;
377 } else if (!strcmp(str
, "JUL_WARNING") || !strcmp(str
, "WARNING")) {
378 return LTTNG_LOGLEVEL_JUL_WARNING
;
379 } else if (!strcmp(str
, "JUL_INFO") || !strcmp(str
, "INFO")) {
380 return LTTNG_LOGLEVEL_JUL_INFO
;
381 } else if (!strcmp(str
, "JUL_CONFIG") || !strcmp(str
, "CONFIG")) {
382 return LTTNG_LOGLEVEL_JUL_CONFIG
;
383 } else if (!strcmp(str
, "JUL_FINE") || !strcmp(str
, "FINE")) {
384 return LTTNG_LOGLEVEL_JUL_FINE
;
385 } else if (!strcmp(str
, "JUL_FINER") || !strcmp(str
, "FINER")) {
386 return LTTNG_LOGLEVEL_JUL_FINER
;
387 } else if (!strcmp(str
, "JUL_FINEST") || !strcmp(str
, "FINEST")) {
388 return LTTNG_LOGLEVEL_JUL_FINEST
;
389 } else if (!strcmp(str
, "JUL_ALL") || !strcmp(str
, "ALL")) {
390 return LTTNG_LOGLEVEL_JUL_ALL
;
397 * Maps loglevel from string to value
400 int loglevel_str_to_value(const char *inputstr
)
403 char str
[LTTNG_SYMBOL_NAME_LEN
];
406 * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
407 * added at the end of the loop so a the upper bound we avoid the overflow.
409 while (i
< (LTTNG_SYMBOL_NAME_LEN
- 1) && inputstr
[i
] != '\0') {
410 str
[i
] = toupper(inputstr
[i
]);
414 if (!strcmp(str
, "TRACE_EMERG") || !strcmp(str
, "EMERG")) {
415 return LTTNG_LOGLEVEL_EMERG
;
416 } else if (!strcmp(str
, "TRACE_ALERT") || !strcmp(str
, "ALERT")) {
417 return LTTNG_LOGLEVEL_ALERT
;
418 } else if (!strcmp(str
, "TRACE_CRIT") || !strcmp(str
, "CRIT")) {
419 return LTTNG_LOGLEVEL_CRIT
;
420 } else if (!strcmp(str
, "TRACE_ERR") || !strcmp(str
, "ERR")) {
421 return LTTNG_LOGLEVEL_ERR
;
422 } else if (!strcmp(str
, "TRACE_WARNING") || !strcmp(str
, "WARNING")) {
423 return LTTNG_LOGLEVEL_WARNING
;
424 } else if (!strcmp(str
, "TRACE_NOTICE") || !strcmp(str
, "NOTICE")) {
425 return LTTNG_LOGLEVEL_NOTICE
;
426 } else if (!strcmp(str
, "TRACE_INFO") || !strcmp(str
, "INFO")) {
427 return LTTNG_LOGLEVEL_INFO
;
428 } else if (!strcmp(str
, "TRACE_DEBUG_SYSTEM") || !strcmp(str
, "DEBUG_SYSTEM") || !strcmp(str
, "SYSTEM")) {
429 return LTTNG_LOGLEVEL_DEBUG_SYSTEM
;
430 } else if (!strcmp(str
, "TRACE_DEBUG_PROGRAM") || !strcmp(str
, "DEBUG_PROGRAM") || !strcmp(str
, "PROGRAM")) {
431 return LTTNG_LOGLEVEL_DEBUG_PROGRAM
;
432 } else if (!strcmp(str
, "TRACE_DEBUG_PROCESS") || !strcmp(str
, "DEBUG_PROCESS") || !strcmp(str
, "PROCESS")) {
433 return LTTNG_LOGLEVEL_DEBUG_PROCESS
;
434 } else if (!strcmp(str
, "TRACE_DEBUG_MODULE") || !strcmp(str
, "DEBUG_MODULE") || !strcmp(str
, "MODULE")) {
435 return LTTNG_LOGLEVEL_DEBUG_MODULE
;
436 } else if (!strcmp(str
, "TRACE_DEBUG_UNIT") || !strcmp(str
, "DEBUG_UNIT") || !strcmp(str
, "UNIT")) {
437 return LTTNG_LOGLEVEL_DEBUG_UNIT
;
438 } else if (!strcmp(str
, "TRACE_DEBUG_FUNCTION") || !strcmp(str
, "DEBUG_FUNCTION") || !strcmp(str
, "FUNCTION")) {
439 return LTTNG_LOGLEVEL_DEBUG_FUNCTION
;
440 } else if (!strcmp(str
, "TRACE_DEBUG_LINE") || !strcmp(str
, "DEBUG_LINE") || !strcmp(str
, "LINE")) {
441 return LTTNG_LOGLEVEL_DEBUG_LINE
;
442 } else if (!strcmp(str
, "TRACE_DEBUG") || !strcmp(str
, "DEBUG")) {
443 return LTTNG_LOGLEVEL_DEBUG
;
450 const char *print_channel_name(const char *name
)
452 return name
? : DEFAULT_CHANNEL_NAME
;
456 const char *print_raw_channel_name(const char *name
)
458 return name
? : "<default>";
462 * Mi print exlcusion list
465 int mi_print_exclusion(int count
, char **names
)
475 ret
= mi_lttng_writer_open_element(writer
, config_element_exclusions
);
480 for (i
= 0; i
< count
; i
++) {
481 ret
= mi_lttng_writer_write_element_string(writer
,
482 config_element_exclusion
, names
[i
]);
488 /* Close exclusions element */
489 ret
= mi_lttng_writer_close_element(writer
);
496 * Return allocated string for pretty-printing exclusion names.
499 char *print_exclusions(int count
, char **names
)
503 const char *preamble
= " excluding ";
510 /* calculate total required length */
511 for (i
= 0; i
< count
; i
++) {
512 length
+= strlen(names
[i
]) + 1;
515 /* add length of preamble + one for NUL - one for last (missing) comma */
516 length
+= strlen(preamble
);
517 ret
= malloc(length
);
518 strncpy(ret
, preamble
, length
);
519 for (i
= 0; i
< count
; i
++) {
520 strcat(ret
, names
[i
]);
521 if (i
!= count
- 1) {
530 * Compare list of exclusions against an event name.
531 * Return a list of legal exclusion names.
532 * Produce an error or a warning about others (depending on the situation)
535 int check_exclusion_subsets(const char *event_name
,
536 const char *exclusions
,
537 int *exclusion_count_ptr
,
538 char ***exclusion_list_ptr
)
540 const char *excluder_ptr
;
541 const char *event_ptr
;
542 const char *next_excluder
;
544 int exclusion_count
= 0;
545 char **exclusion_list
= NULL
;
546 int ret
= CMD_SUCCESS
;
548 if (event_name
[strlen(event_name
) - 1] != '*') {
549 ERR("Event %s: Excluders can only be used with wildcarded events", event_name
);
553 next_excluder
= exclusions
;
554 while (*next_excluder
!= 0) {
555 event_ptr
= event_name
;
556 excluder_ptr
= next_excluder
;
557 excluder_length
= strcspn(next_excluder
, ",");
559 /* Scan both the excluder and the event letter by letter */
567 /* Event is a subset of the excluder */
568 ERR("Event %s: %.*s excludes all events from %s",
576 /* Excluder is a proper subset of event */
578 exclusion_list
= realloc(exclusion_list
, sizeof(char **) * exclusion_count
);
579 exclusion_list
[exclusion_count
- 1] = strndup(next_excluder
, excluder_length
);
584 /* Excluder and event sets have no common elements */
585 WARN("Event %s: %.*s does not exclude any events from %s",
596 next_excluder
+= excluder_length
;
597 if (*next_excluder
== ',') {
603 while (exclusion_count
--) {
604 free(exclusion_list
[exclusion_count
]);
606 if (exclusion_list
!= NULL
) {
607 free(exclusion_list
);
609 exclusion_list
= NULL
;
613 *exclusion_count_ptr
= exclusion_count
;
614 *exclusion_list_ptr
= exclusion_list
;
618 * Enabling event using the lttng API.
619 * Note: in case of error only the last error code will be return.
621 static int enable_events(char *session_name
)
623 int ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
;
624 int error_holder
= CMD_SUCCESS
, warn
= 0, error
= 0, success
= 1;
625 char *event_name
, *channel_name
= NULL
;
626 struct lttng_event ev
;
627 struct lttng_domain dom
;
628 int exclusion_count
= 0;
629 char **exclusion_list
= NULL
;
631 memset(&ev
, 0, sizeof(ev
));
632 memset(&dom
, 0, sizeof(dom
));
636 ERR("Filter not implement for kernel tracing yet");
641 WARN("Kernel loglevels are not supported.");
645 /* Create lttng domain */
647 dom
.type
= LTTNG_DOMAIN_KERNEL
;
648 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
649 } else if (opt_userspace
) {
650 dom
.type
= LTTNG_DOMAIN_UST
;
652 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
653 } else if (opt_jul
) {
654 dom
.type
= LTTNG_DOMAIN_JUL
;
656 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
657 } else if (opt_log4j
) {
658 dom
.type
= LTTNG_DOMAIN_LOG4J
;
660 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
662 print_missing_domain();
667 if (opt_kernel
&& opt_exclude
) {
668 ERR("Event name exclusions are not yet implemented for kernel events");
673 channel_name
= opt_channel_name
;
675 handle
= lttng_create_handle(session_name
, &dom
);
676 if (handle
== NULL
) {
683 /* Open a events element */
684 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
691 if (opt_enable_all
) {
692 /* Default setup for enable all */
694 ev
.type
= opt_event_type
;
696 /* kernel loglevels not implemented */
697 ev
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
699 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
700 strcpy(ev
.name
, "*");
701 ev
.loglevel_type
= opt_loglevel_type
;
703 assert(opt_userspace
|| opt_jul
|| opt_log4j
);
705 ev
.loglevel
= loglevel_str_to_value(opt_loglevel
);
706 } else if (opt_jul
) {
707 ev
.loglevel
= loglevel_jul_str_to_value(opt_loglevel
);
708 } else if (opt_log4j
) {
709 ev
.loglevel
= loglevel_log4j_str_to_value(opt_loglevel
);
711 if (ev
.loglevel
== -1) {
712 ERR("Unknown loglevel %s", opt_loglevel
);
713 ret
= -LTTNG_ERR_INVALID
;
717 assert(opt_userspace
|| opt_jul
|| opt_log4j
);
720 } else if (opt_jul
|| opt_log4j
) {
721 ev
.loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
727 ret
= check_exclusion_subsets("*", opt_exclude
,
728 &exclusion_count
, &exclusion_list
);
729 if (ret
== CMD_ERROR
) {
735 ret
= lttng_enable_event_with_exclusions(handle
,
738 exclusion_count
, exclusion_list
);
741 case LTTNG_ERR_KERN_EVENT_EXIST
:
742 WARN("Kernel events already enabled (channel %s, session %s)",
743 print_channel_name(channel_name
), session_name
);
746 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
748 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
749 ERR("Events: %s (channel %s, session %s)",
751 print_channel_name(channel_name
),
757 ERR("Events: %s (channel %s, session %s)",
759 ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
760 ? print_raw_channel_name(channel_name
)
761 : print_channel_name(channel_name
),
769 switch (opt_event_type
) {
770 case LTTNG_EVENT_TRACEPOINT
:
771 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
772 char *exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
773 MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
774 get_domain_str(dom
.type
),
776 print_channel_name(channel_name
),
778 free(exclusion_string
);
780 char *exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
781 MSG("All %s tracepoints%s are enabled in channel %s",
782 get_domain_str(dom
.type
),
784 print_channel_name(channel_name
));
785 free(exclusion_string
);
788 case LTTNG_EVENT_SYSCALL
:
790 MSG("All %s system calls are enabled in channel %s",
791 get_domain_str(dom
.type
),
792 print_channel_name(channel_name
));
795 case LTTNG_EVENT_ALL
:
796 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
797 char *exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
798 MSG("All %s events%s are enabled in channel %s for loglevel %s",
799 get_domain_str(dom
.type
),
801 print_channel_name(channel_name
),
803 free(exclusion_string
);
805 char *exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
806 MSG("All %s events%s are enabled in channel %s",
807 get_domain_str(dom
.type
),
809 print_channel_name(channel_name
));
810 free(exclusion_string
);
815 * We should not be here since lttng_enable_event should have
816 * failed on the event type.
823 command_ret
= lttng_enable_event_with_exclusions(handle
, &ev
, channel_name
,
824 opt_filter
, exclusion_count
, exclusion_list
);
825 if (command_ret
< 0) {
826 switch (-command_ret
) {
827 case LTTNG_ERR_FILTER_EXIST
:
828 WARN("Filter on all events is already enabled"
829 " (channel %s, session %s)",
830 print_channel_name(channel_name
), session_name
);
833 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
835 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
836 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
838 print_channel_name(channel_name
),
839 session_name
, opt_filter
);
844 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
845 lttng_strerror(command_ret
),
846 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
847 ? print_raw_channel_name(channel_name
)
848 : print_channel_name(channel_name
),
849 session_name
, opt_filter
);
853 error_holder
= command_ret
;
856 MSG("Filter '%s' successfully set", opt_filter
);
861 /* The wildcard * is used for kernel and ust domain to
862 * represent ALL. We copy * in event name to force the wildcard use
865 * Note: this is strictly for semantic and printing while in
866 * machine interface mode.
868 strcpy(ev
.name
, "*");
870 /* If we reach here the events are enabled */
871 if (!error
&& !warn
) {
877 ret
= mi_lttng_event(writer
, &ev
, 1, handle
->domain
.type
);
883 /* print exclusion */
884 ret
= mi_print_exclusion(exclusion_count
, exclusion_list
);
891 ret
= mi_lttng_writer_write_element_bool(writer
,
892 mi_lttng_element_command_success
, success
);
898 /* Close event element */
899 ret
= mi_lttng_writer_close_element(writer
);
909 /* Strip event list */
910 event_name
= strtok(opt_event_list
, ",");
911 while (event_name
!= NULL
) {
912 /* Copy name and type of the event */
913 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
914 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
915 ev
.type
= opt_event_type
;
917 /* Kernel tracer action */
919 DBG("Enabling kernel event %s for channel %s",
921 print_channel_name(channel_name
));
923 switch (opt_event_type
) {
924 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
925 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
927 case LTTNG_EVENT_TRACEPOINT
:
929 case LTTNG_EVENT_PROBE
:
930 ret
= parse_probe_opts(&ev
, opt_probe
);
932 ERR("Unable to parse probe options");
937 case LTTNG_EVENT_FUNCTION
:
938 ret
= parse_probe_opts(&ev
, opt_function
);
940 ERR("Unable to parse function probe options");
945 case LTTNG_EVENT_FUNCTION_ENTRY
:
946 strncpy(ev
.attr
.ftrace
.symbol_name
, opt_function_entry_symbol
,
947 LTTNG_SYMBOL_NAME_LEN
);
948 ev
.attr
.ftrace
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
950 case LTTNG_EVENT_SYSCALL
:
951 ev
.type
= LTTNG_EVENT_SYSCALL
;
958 /* kernel loglevels not implemented */
959 ev
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
960 } else if (opt_userspace
) { /* User-space tracer action */
962 if (opt_cmd_name
!= NULL
|| opt_pid
) {
963 MSG("Only supporting tracing all UST processes (-u) for now.");
969 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name
,
970 print_channel_name(channel_name
), opt_loglevel
? : "<all>");
972 switch (opt_event_type
) {
973 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
975 case LTTNG_EVENT_TRACEPOINT
:
976 /* Copy name and type of the event */
977 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
978 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
979 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
981 case LTTNG_EVENT_PROBE
:
982 case LTTNG_EVENT_FUNCTION
:
983 case LTTNG_EVENT_FUNCTION_ENTRY
:
984 case LTTNG_EVENT_SYSCALL
:
986 ERR("Event type not available for user-space tracing");
987 ret
= CMD_UNSUPPORTED
;
993 if (opt_event_type
!= LTTNG_EVENT_ALL
&& opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
994 ERR("Exclusion option can only be used with tracepoint events");
998 /* Free previously allocated items */
999 if (exclusion_list
!= NULL
) {
1000 while (exclusion_count
--) {
1001 free(exclusion_list
[exclusion_count
]);
1003 free(exclusion_list
);
1004 exclusion_list
= NULL
;
1006 /* Check for proper subsets */
1007 ret
= check_exclusion_subsets(event_name
, opt_exclude
,
1008 &exclusion_count
, &exclusion_list
);
1009 if (ret
== CMD_ERROR
) {
1014 ev
.loglevel_type
= opt_loglevel_type
;
1016 ev
.loglevel
= loglevel_str_to_value(opt_loglevel
);
1017 if (ev
.loglevel
== -1) {
1018 ERR("Unknown loglevel %s", opt_loglevel
);
1019 ret
= -LTTNG_ERR_INVALID
;
1025 } else if (opt_jul
|| opt_log4j
) {
1026 if (opt_event_type
!= LTTNG_EVENT_ALL
&&
1027 opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
1028 ERR("Event type not supported for domain.");
1029 ret
= CMD_UNSUPPORTED
;
1033 ev
.loglevel_type
= opt_loglevel_type
;
1036 ev
.loglevel
= loglevel_jul_str_to_value(opt_loglevel
);
1037 } else if (opt_log4j
) {
1038 ev
.loglevel
= loglevel_log4j_str_to_value(opt_loglevel
);
1040 if (ev
.loglevel
== -1) {
1041 ERR("Unknown loglevel %s", opt_loglevel
);
1042 ret
= -LTTNG_ERR_INVALID
;
1047 ev
.loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
1048 } else if (opt_log4j
) {
1049 ev
.loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
1052 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
1053 strncpy(ev
.name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
1054 ev
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1056 print_missing_domain();
1062 char *exclusion_string
;
1064 command_ret
= lttng_enable_event_with_exclusions(handle
,
1066 NULL
, exclusion_count
, exclusion_list
);
1067 exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
1068 if (command_ret
< 0) {
1069 /* Turn ret to positive value to handle the positive error code */
1070 switch (-command_ret
) {
1071 case LTTNG_ERR_KERN_EVENT_EXIST
:
1072 WARN("Kernel event %s%s already enabled (channel %s, session %s)",
1075 print_channel_name(channel_name
), session_name
);
1078 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
1080 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
1081 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
1084 print_channel_name(channel_name
),
1090 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
1092 lttng_strerror(command_ret
),
1093 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1094 ? print_raw_channel_name(channel_name
)
1095 : print_channel_name(channel_name
),
1100 error_holder
= command_ret
;
1102 /* So we don't print the default channel name for agent domain. */
1103 if (dom
.type
== LTTNG_DOMAIN_JUL
||
1104 dom
.type
== LTTNG_DOMAIN_LOG4J
) {
1105 MSG("%s event %s%s enabled.",
1106 get_domain_str(dom
.type
), event_name
,
1109 MSG("%s event %s%s created in channel %s",
1110 get_domain_str(dom
.type
), event_name
,
1112 print_channel_name(channel_name
));
1115 free(exclusion_string
);
1119 char *exclusion_string
;
1121 /* Filter present */
1124 command_ret
= lttng_enable_event_with_exclusions(handle
, &ev
, channel_name
,
1125 opt_filter
, exclusion_count
, exclusion_list
);
1126 exclusion_string
= print_exclusions(exclusion_count
, exclusion_list
);
1128 if (command_ret
< 0) {
1129 switch (-command_ret
) {
1130 case LTTNG_ERR_FILTER_EXIST
:
1131 WARN("Filter on event %s%s is already enabled"
1132 " (channel %s, session %s)",
1135 print_channel_name(channel_name
), session_name
);
1138 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
1140 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
1141 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
.name
,
1144 print_channel_name(channel_name
),
1145 session_name
, opt_filter
);
1150 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
.name
,
1152 lttng_strerror(command_ret
),
1153 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1154 ? print_raw_channel_name(channel_name
)
1155 : print_channel_name(channel_name
),
1156 session_name
, opt_filter
);
1160 error_holder
= command_ret
;
1163 MSG("Event %s%s: Filter '%s' successfully set",
1164 event_name
, exclusion_string
,
1167 free(exclusion_string
);
1178 ret
= mi_lttng_event(writer
, &ev
, 1, handle
->domain
.type
);
1184 /* print exclusion */
1185 ret
= mi_print_exclusion(exclusion_count
, exclusion_list
);
1192 ret
= mi_lttng_writer_write_element_bool(writer
,
1193 mi_lttng_element_command_success
, success
);
1199 /* Close event element */
1200 ret
= mi_lttng_writer_close_element(writer
);
1208 event_name
= strtok(NULL
, ",");
1209 /* Reset warn, error and success */
1216 /* Close events element */
1217 ret
= mi_lttng_writer_close_element(writer
);
1230 lttng_destroy_handle(handle
);
1232 if (exclusion_list
!= NULL
) {
1233 while (exclusion_count
--) {
1234 free(exclusion_list
[exclusion_count
]);
1236 free(exclusion_list
);
1239 /* Overwrite ret with error_holder if there was an actual error with
1240 * enabling an event.
1242 ret
= error_holder
? error_holder
: ret
;
1248 * Add event to trace session
1250 int cmd_enable_events(int argc
, const char **argv
)
1252 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
1253 static poptContext pc
;
1254 char *session_name
= NULL
;
1255 int event_type
= -1;
1257 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1258 poptReadDefaultConfig(pc
, 0);
1260 /* Default event type */
1261 opt_event_type
= LTTNG_EVENT_ALL
;
1263 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1268 case OPT_TRACEPOINT
:
1269 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
1272 opt_event_type
= LTTNG_EVENT_PROBE
;
1275 opt_event_type
= LTTNG_EVENT_FUNCTION
;
1277 case OPT_FUNCTION_ENTRY
:
1278 opt_event_type
= LTTNG_EVENT_FUNCTION_ENTRY
;
1281 opt_event_type
= LTTNG_EVENT_SYSCALL
;
1287 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
1288 opt_loglevel
= poptGetOptArg(pc
);
1290 case OPT_LOGLEVEL_ONLY
:
1291 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
1292 opt_loglevel
= poptGetOptArg(pc
);
1294 case OPT_LIST_OPTIONS
:
1295 list_cmd_options(stdout
, long_options
);
1303 ret
= CMD_UNDEFINED
;
1307 /* Validate event type. Multiple event type are not supported. */
1308 if (event_type
== -1) {
1309 event_type
= opt_event_type
;
1311 if (event_type
!= opt_event_type
) {
1312 ERR("Multiple event type not supported.");
1321 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1323 ret
= -LTTNG_ERR_NOMEM
;
1327 /* Open command element */
1328 ret
= mi_lttng_writer_command_open(writer
,
1329 mi_lttng_element_command_enable_event
);
1335 /* Open output element */
1336 ret
= mi_lttng_writer_open_element(writer
,
1337 mi_lttng_element_command_output
);
1344 opt_event_list
= (char*) poptGetArg(pc
);
1345 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
1346 ERR("Missing event name(s).\n");
1352 if (!opt_session_name
) {
1353 session_name
= get_session_name();
1354 if (session_name
== NULL
) {
1355 command_ret
= CMD_ERROR
;
1360 session_name
= opt_session_name
;
1363 command_ret
= enable_events(session_name
);
1372 /* Close output element */
1373 ret
= mi_lttng_writer_close_element(writer
);
1379 ret
= mi_lttng_writer_write_element_bool(writer
,
1380 mi_lttng_element_command_success
, success
);
1386 /* Command element close */
1387 ret
= mi_lttng_writer_command_close(writer
);
1396 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1397 /* Preserve original error code */
1398 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
1401 if (opt_session_name
== NULL
) {
1405 /* Overwrite ret if an error occurred in enable_events */
1406 ret
= command_ret
? command_ret
: ret
;
1408 poptFreeContext(pc
);