Detect and report exclusion option errors
[lttng-tools.git] / src / bin / lttng / commands / enable_events.c
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
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.
7 *
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.
12 *
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.
16 */
17
18 #define _GNU_SOURCE
19 #include <popt.h>
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <sys/stat.h>
24 #include <sys/types.h>
25 #include <unistd.h>
26 #include <inttypes.h>
27 #include <ctype.h>
28
29 #include "../command.h"
30 #include <src/common/sessiond-comm/sessiond-comm.h>
31
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_jul;
40 static int opt_enable_all;
41 static char *opt_probe;
42 static char *opt_function;
43 static char *opt_function_entry_symbol;
44 static char *opt_channel_name;
45 static char *opt_filter;
46 static char *opt_exclude;
47 #if 0
48 /* Not implemented yet */
49 static char *opt_cmd_name;
50 static pid_t opt_pid;
51 #endif
52
53 enum {
54 OPT_HELP = 1,
55 OPT_TRACEPOINT,
56 OPT_PROBE,
57 OPT_FUNCTION,
58 OPT_FUNCTION_ENTRY,
59 OPT_SYSCALL,
60 OPT_USERSPACE,
61 OPT_LOGLEVEL,
62 OPT_LOGLEVEL_ONLY,
63 OPT_LIST_OPTIONS,
64 OPT_FILTER,
65 OPT_EXCLUDE,
66 };
67
68 static struct lttng_handle *handle;
69
70 static struct poptOption long_options[] = {
71 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
72 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
73 {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
74 {"all", 'a', POPT_ARG_VAL, &opt_enable_all, 1, 0, 0},
75 {"channel", 'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
76 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
77 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
78 {"jul", 'j', POPT_ARG_VAL, &opt_jul, 1, 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},
82 #if 0
83 /*
84 * Currently removed from lttng kernel tracer. Removed from
85 * lttng UI to discourage its use.
86 */
87 {"function:entry", 0, POPT_ARG_STRING, &opt_function_entry_symbol, OPT_FUNCTION_ENTRY, 0, 0},
88 #endif
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},
93 {"filter", 'f', POPT_ARG_STRING, &opt_filter, OPT_FILTER, 0, 0},
94 {"exclude", 'x', POPT_ARG_STRING, &opt_exclude, OPT_EXCLUDE, 0, 0},
95 {0, 0, 0, 0, 0, 0, 0}
96 };
97
98 /*
99 * usage
100 */
101 static void usage(FILE *ofp)
102 {
103 fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [-k|-u] [OPTIONS] \n");
104 fprintf(ofp, "\n");
105 fprintf(ofp, "Options:\n");
106 fprintf(ofp, " -h, --help Show this help\n");
107 fprintf(ofp, " --list-options Simple listing of options\n");
108 fprintf(ofp, " -s, --session NAME Apply to session name\n");
109 fprintf(ofp, " -c, --channel NAME Apply to this channel\n");
110 fprintf(ofp, " -a, --all Enable all tracepoints and syscalls\n");
111 fprintf(ofp, " -k, --kernel Apply for the kernel tracer\n");
112 fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
113 fprintf(ofp, " -j, --jul Apply for Java application using JUL\n");
114 fprintf(ofp, "\n");
115 fprintf(ofp, "Event options:\n");
116 fprintf(ofp, " --tracepoint Tracepoint event (default)\n");
117 fprintf(ofp, " - userspace tracer supports wildcards at end of string.\n");
118 fprintf(ofp, " Don't forget to quote to deal with bash expansion.\n");
119 fprintf(ofp, " e.g.:\n");
120 fprintf(ofp, " \"*\"\n");
121 fprintf(ofp, " \"app_component:na*\"\n");
122 fprintf(ofp, " --probe (addr | symbol | symbol+offset)\n");
123 fprintf(ofp, " Dynamic probe.\n");
124 fprintf(ofp, " Addr and offset can be octal (0NNN...),\n");
125 fprintf(ofp, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
126 fprintf(ofp, " --function (addr | symbol | symbol+offset)\n");
127 fprintf(ofp, " Dynamic function entry/return probe.\n");
128 fprintf(ofp, " Addr and offset can be octal (0NNN...),\n");
129 fprintf(ofp, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
130 #if 0
131 fprintf(ofp, " --function:entry symbol\n");
132 fprintf(ofp, " Function tracer event\n");
133 #endif
134 fprintf(ofp, " --syscall System call event\n");
135 fprintf(ofp, "\n");
136 fprintf(ofp, " --loglevel name\n");
137 fprintf(ofp, " Tracepoint loglevel range from 0 to loglevel\n");
138 fprintf(ofp, " --loglevel-only name\n");
139 fprintf(ofp, " Tracepoint loglevel (only this loglevel)\n");
140 fprintf(ofp, "\n");
141 fprintf(ofp, " The loglevel or loglevel-only options should be\n");
142 fprintf(ofp, " combined with a tracepoint name or tracepoint\n");
143 fprintf(ofp, " wildcard.\n");
144 fprintf(ofp, " Available loglevels:\n");
145 fprintf(ofp, " (higher value is more verbose)\n");
146 fprintf(ofp, " TRACE_EMERG = 0\n");
147 fprintf(ofp, " TRACE_ALERT = 1\n");
148 fprintf(ofp, " TRACE_CRIT = 2\n");
149 fprintf(ofp, " TRACE_ERR = 3\n");
150 fprintf(ofp, " TRACE_WARNING = 4\n");
151 fprintf(ofp, " TRACE_NOTICE = 5\n");
152 fprintf(ofp, " TRACE_INFO = 6\n");
153 fprintf(ofp, " TRACE_DEBUG_SYSTEM = 7\n");
154 fprintf(ofp, " TRACE_DEBUG_PROGRAM = 8\n");
155 fprintf(ofp, " TRACE_DEBUG_PROCESS = 9\n");
156 fprintf(ofp, " TRACE_DEBUG_MODULE = 10\n");
157 fprintf(ofp, " TRACE_DEBUG_UNIT = 11\n");
158 fprintf(ofp, " TRACE_DEBUG_FUNCTION = 12\n");
159 fprintf(ofp, " TRACE_DEBUG_LINE = 13\n");
160 fprintf(ofp, " TRACE_DEBUG = 14\n");
161 fprintf(ofp, " (shortcuts such as \"system\" are allowed)\n");
162 fprintf(ofp, " -f, --filter \'expression\'\n");
163 fprintf(ofp, " Filter expression on event fields and context.\n");
164 fprintf(ofp, " Event recording depends on evaluation.\n");
165 fprintf(ofp, " Only specify on first activation of\n");
166 fprintf(ofp, " a given event within a session.\n");
167 fprintf(ofp, " Filter only allowed when enabling\n");
168 fprintf(ofp, " events within a session before tracing\n");
169 fprintf(ofp, " is started. If the filter fails to link\n");
170 fprintf(ofp, " with the event within the traced domain,\n");
171 fprintf(ofp, " the event will be discarded. Currently,\n");
172 fprintf(ofp, " filter is only implemented for the user-space\n");
173 fprintf(ofp, " tracer.\n");
174 fprintf(ofp, " Expression examples:.\n");
175 fprintf(ofp, " \n");
176 fprintf(ofp, " 'intfield > 500 && intfield < 503'\n");
177 fprintf(ofp, " '(strfield == \"test\" || intfield != 10) && intfield > 33'\n");
178 fprintf(ofp, " 'doublefield > 1.1 && intfield < 5.3'\n");
179 fprintf(ofp, " \n");
180 fprintf(ofp, " Wildcards are allowed at the end of strings:\n");
181 fprintf(ofp, " 'seqfield1 == \"te*\"'\n");
182 fprintf(ofp, " In string literals, the escape character is '\\'.\n");
183 fprintf(ofp, " Use '\\*' for the '*' character, and '\\\\' for\n");
184 fprintf(ofp, " the '\\' character. Wildcard match any sequence of,\n");
185 fprintf(ofp, " characters including an empty sub-string (match 0 or\n");
186 fprintf(ofp, " more characters).\n");
187 fprintf(ofp, "\n");
188 fprintf(ofp, " Context information can be used for filtering. The\n");
189 fprintf(ofp, " examples below show usage of context filtering on\n");
190 fprintf(ofp, " process name (with a wildcard), process ID range, and\n");
191 fprintf(ofp, " unique thread ID for filtering. The process and\n");
192 fprintf(ofp, " thread ID of running applications can be found under\n");
193 fprintf(ofp, " columns \"PID\" and \"LWP\" of the \"ps -eLf\" command.\n");
194 fprintf(ofp, "\n");
195 fprintf(ofp, " '$ctx.procname == \"demo*\"'\n");
196 fprintf(ofp, " '$ctx.vpid >= 4433 && $ctx.vpid < 4455'\n");
197 fprintf(ofp, " '$ctx.vtid == 1234'\n");
198 fprintf(ofp, " -x, --exclude LIST\n");
199 fprintf(ofp, " Add exclusions to UST tracepoints:\n");
200 fprintf(ofp, " Events that match any of the items\n");
201 fprintf(ofp, " in the comma-separated LIST are not\n");
202 fprintf(ofp, " enabled, even if they match a wildcard\n");
203 fprintf(ofp, " definition of the event.\n");
204 fprintf(ofp, "\n");
205 }
206
207 /*
208 * Parse probe options.
209 */
210 static int parse_probe_opts(struct lttng_event *ev, char *opt)
211 {
212 int ret;
213 char s_hex[19];
214 char name[LTTNG_SYMBOL_NAME_LEN];
215
216 if (opt == NULL) {
217 ret = -1;
218 goto end;
219 }
220
221 /* Check for symbol+offset */
222 ret = sscanf(opt, "%[^'+']+%s", name, s_hex);
223 if (ret == 2) {
224 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
225 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
226 DBG("probe symbol %s", ev->attr.probe.symbol_name);
227 if (*s_hex == '\0') {
228 ERR("Invalid probe offset %s", s_hex);
229 ret = -1;
230 goto end;
231 }
232 ev->attr.probe.offset = strtoul(s_hex, NULL, 0);
233 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
234 ev->attr.probe.addr = 0;
235 goto end;
236 }
237
238 /* Check for symbol */
239 if (isalpha(name[0])) {
240 ret = sscanf(opt, "%s", name);
241 if (ret == 1) {
242 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
243 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
244 DBG("probe symbol %s", ev->attr.probe.symbol_name);
245 ev->attr.probe.offset = 0;
246 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
247 ev->attr.probe.addr = 0;
248 goto end;
249 }
250 }
251
252 /* Check for address */
253 ret = sscanf(opt, "%s", s_hex);
254 if (ret > 0) {
255 if (*s_hex == '\0') {
256 ERR("Invalid probe address %s", s_hex);
257 ret = -1;
258 goto end;
259 }
260 ev->attr.probe.addr = strtoul(s_hex, NULL, 0);
261 DBG("probe addr %" PRIu64, ev->attr.probe.addr);
262 ev->attr.probe.offset = 0;
263 memset(ev->attr.probe.symbol_name, 0, LTTNG_SYMBOL_NAME_LEN);
264 goto end;
265 }
266
267 /* No match */
268 ret = -1;
269
270 end:
271 return ret;
272 }
273
274 /*
275 * Maps loglevel from string to value
276 */
277 static
278 int loglevel_str_to_value(const char *inputstr)
279 {
280 int i = 0;
281 char str[LTTNG_SYMBOL_NAME_LEN];
282
283 /*
284 * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
285 * added at the end of the loop so a the upper bound we avoid the overflow.
286 */
287 while (i < (LTTNG_SYMBOL_NAME_LEN - 1) && inputstr[i] != '\0') {
288 str[i] = toupper(inputstr[i]);
289 i++;
290 }
291 str[i] = '\0';
292 if (!strcmp(str, "TRACE_EMERG") || !strcmp(str, "EMERG")) {
293 return LTTNG_LOGLEVEL_EMERG;
294 } else if (!strcmp(str, "TRACE_ALERT") || !strcmp(str, "ALERT")) {
295 return LTTNG_LOGLEVEL_ALERT;
296 } else if (!strcmp(str, "TRACE_CRIT") || !strcmp(str, "CRIT")) {
297 return LTTNG_LOGLEVEL_CRIT;
298 } else if (!strcmp(str, "TRACE_ERR") || !strcmp(str, "ERR")) {
299 return LTTNG_LOGLEVEL_ERR;
300 } else if (!strcmp(str, "TRACE_WARNING") || !strcmp(str, "WARNING")) {
301 return LTTNG_LOGLEVEL_WARNING;
302 } else if (!strcmp(str, "TRACE_NOTICE") || !strcmp(str, "NOTICE")) {
303 return LTTNG_LOGLEVEL_NOTICE;
304 } else if (!strcmp(str, "TRACE_INFO") || !strcmp(str, "INFO")) {
305 return LTTNG_LOGLEVEL_INFO;
306 } else if (!strcmp(str, "TRACE_DEBUG_SYSTEM") || !strcmp(str, "DEBUG_SYSTEM") || !strcmp(str, "SYSTEM")) {
307 return LTTNG_LOGLEVEL_DEBUG_SYSTEM;
308 } else if (!strcmp(str, "TRACE_DEBUG_PROGRAM") || !strcmp(str, "DEBUG_PROGRAM") || !strcmp(str, "PROGRAM")) {
309 return LTTNG_LOGLEVEL_DEBUG_PROGRAM;
310 } else if (!strcmp(str, "TRACE_DEBUG_PROCESS") || !strcmp(str, "DEBUG_PROCESS") || !strcmp(str, "PROCESS")) {
311 return LTTNG_LOGLEVEL_DEBUG_PROCESS;
312 } else if (!strcmp(str, "TRACE_DEBUG_MODULE") || !strcmp(str, "DEBUG_MODULE") || !strcmp(str, "MODULE")) {
313 return LTTNG_LOGLEVEL_DEBUG_MODULE;
314 } else if (!strcmp(str, "TRACE_DEBUG_UNIT") || !strcmp(str, "DEBUG_UNIT") || !strcmp(str, "UNIT")) {
315 return LTTNG_LOGLEVEL_DEBUG_UNIT;
316 } else if (!strcmp(str, "TRACE_DEBUG_FUNCTION") || !strcmp(str, "DEBUG_FUNCTION") || !strcmp(str, "FUNCTION")) {
317 return LTTNG_LOGLEVEL_DEBUG_FUNCTION;
318 } else if (!strcmp(str, "TRACE_DEBUG_LINE") || !strcmp(str, "DEBUG_LINE") || !strcmp(str, "LINE")) {
319 return LTTNG_LOGLEVEL_DEBUG_LINE;
320 } else if (!strcmp(str, "TRACE_DEBUG") || !strcmp(str, "DEBUG")) {
321 return LTTNG_LOGLEVEL_DEBUG;
322 } else {
323 return -1;
324 }
325 }
326
327 static
328 const char *print_channel_name(const char *name)
329 {
330 return name ? : DEFAULT_CHANNEL_NAME;
331 }
332
333 static
334 const char *print_raw_channel_name(const char *name)
335 {
336 return name ? : "<default>";
337 }
338
339 /*
340 * Compare list of exclusions against an event name.
341 * Return a list of legal exclusion names.
342 * Produce an error or a warning about others (depending on the situation)
343 */
344 static
345 int check_exclusion_subsets(const char *event_name,
346 const char *exclusions,
347 int *exclusion_count_ptr,
348 char ***exclusion_list_ptr)
349 {
350 const char *excluder_ptr;
351 const char *event_ptr;
352 const char *next_excluder;
353 int excluder_length;
354 int exclusion_count = 0;
355 char **exclusion_list = NULL;
356 int ret = CMD_SUCCESS;
357
358 if (event_name[strlen(event_name) - 1] != '*') {
359 ERR("Event %s: Excluders can only be used with wildcarded events", event_name);
360 goto error;
361 }
362
363 next_excluder = exclusions;
364 while (*next_excluder != 0) {
365 event_ptr = event_name;
366 excluder_ptr = next_excluder;
367 excluder_length = strcspn(next_excluder, ",");
368
369 /* Scan both the excluder and the event letter by letter */
370 while (1) {
371 char e, x;
372
373 e = *event_ptr;
374 x = *excluder_ptr;
375
376 if (x == '*') {
377 /* Event is a subset of the excluder */
378 ERR("Event %s: %.*s excludes all events from %s",
379 event_name,
380 excluder_length,
381 next_excluder,
382 event_name);
383 goto error;
384 }
385 if (e == '*') {
386 /* Excluder is a proper subset of event */
387 exclusion_count++;
388 exclusion_list = realloc(exclusion_list, sizeof(char **) * exclusion_count);
389 exclusion_list[exclusion_count - 1] = strndup(next_excluder, excluder_length);
390
391 break;
392 }
393 if (x != e) {
394 /* Excluder and event sets have no common elements */
395 WARN("Event %s: %.*s does not exclude any events from %s",
396 event_name,
397 excluder_length,
398 next_excluder,
399 event_name);
400 break;
401 }
402 excluder_ptr++;
403 event_ptr++;
404 }
405 /* next excluder */
406 next_excluder += excluder_length;
407 if (*next_excluder == ',') {
408 next_excluder++;
409 }
410 }
411 goto end;
412 error:
413 while (exclusion_count--) {
414 free(exclusion_list[exclusion_count]);
415 }
416 if (exclusion_list != NULL) {
417 free(exclusion_list);
418 }
419 exclusion_list = NULL;
420 exclusion_count = 0;
421 ret = CMD_ERROR;
422 end:
423 *exclusion_count_ptr = exclusion_count;
424 *exclusion_list_ptr = exclusion_list;
425 return ret;
426 }
427 /*
428 * Enabling event using the lttng API.
429 */
430 static int enable_events(char *session_name)
431 {
432 int ret = CMD_SUCCESS, warn = 0;
433 char *event_name, *channel_name = NULL;
434 struct lttng_event ev;
435 struct lttng_domain dom;
436 int exclusion_count = 0;
437 char **exclusion_list = NULL;
438
439 memset(&ev, 0, sizeof(ev));
440 memset(&dom, 0, sizeof(dom));
441
442 if (opt_kernel) {
443 if (opt_filter) {
444 ERR("Filter not implement for kernel tracing yet");
445 ret = CMD_ERROR;
446 goto error;
447 }
448 if (opt_loglevel) {
449 WARN("Kernel loglevels are not supported.");
450 }
451 }
452
453 /* Create lttng domain */
454 if (opt_kernel) {
455 dom.type = LTTNG_DOMAIN_KERNEL;
456 dom.buf_type = LTTNG_BUFFER_GLOBAL;
457 } else if (opt_userspace) {
458 dom.type = LTTNG_DOMAIN_UST;
459 /* Default. */
460 dom.buf_type = LTTNG_BUFFER_PER_UID;
461 } else if (opt_jul) {
462 dom.type = LTTNG_DOMAIN_JUL;
463 /* Default. */
464 dom.buf_type = LTTNG_BUFFER_PER_UID;
465 } else {
466 print_missing_domain();
467 ret = CMD_ERROR;
468 goto error;
469 }
470
471 if (opt_kernel && opt_exclude) {
472 ERR("Event name exclusions are not yet implemented for kernel events");
473 ret = CMD_ERROR;
474 goto error;
475 }
476
477 channel_name = opt_channel_name;
478
479 handle = lttng_create_handle(session_name, &dom);
480 if (handle == NULL) {
481 ret = -1;
482 goto error;
483 }
484
485 if (opt_enable_all) {
486 /* Default setup for enable all */
487 if (opt_kernel) {
488 ev.type = opt_event_type;
489 ev.name[0] = '\0';
490 /* kernel loglevels not implemented */
491 ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
492 } else {
493 ev.type = LTTNG_EVENT_TRACEPOINT;
494 strcpy(ev.name, "*");
495 ev.loglevel_type = opt_loglevel_type;
496 if (opt_loglevel) {
497 ev.loglevel = loglevel_str_to_value(opt_loglevel);
498 if (ev.loglevel == -1) {
499 ERR("Unknown loglevel %s", opt_loglevel);
500 ret = -LTTNG_ERR_INVALID;
501 goto error;
502 }
503 } else {
504 ev.loglevel = -1;
505 }
506 }
507
508 if (opt_exclude) {
509 ret = check_exclusion_subsets("*", opt_exclude,
510 &exclusion_count, &exclusion_list);
511 if (ret == CMD_ERROR) {
512 goto error;
513 }
514 }
515 if (!opt_filter) {
516 ret = lttng_enable_event_with_exclusions(handle,
517 &ev, channel_name,
518 NULL,
519 exclusion_count, exclusion_list);
520 if (ret < 0) {
521 switch (-ret) {
522 case LTTNG_ERR_KERN_EVENT_EXIST:
523 WARN("Kernel events already enabled (channel %s, session %s)",
524 print_channel_name(channel_name), session_name);
525 break;
526 default:
527 ERR("Events: %s (channel %s, session %s)",
528 lttng_strerror(ret),
529 ret == -LTTNG_ERR_NEED_CHANNEL_NAME
530 ? print_raw_channel_name(channel_name)
531 : print_channel_name(channel_name),
532 session_name);
533 break;
534 }
535 goto end;
536 }
537
538 switch (opt_event_type) {
539 case LTTNG_EVENT_TRACEPOINT:
540 if (opt_loglevel && dom.type != LTTNG_DOMAIN_KERNEL) {
541 MSG("All %s tracepoints are enabled in channel %s for loglevel %s",
542 get_domain_str(dom.type),
543 print_channel_name(channel_name),
544 opt_loglevel);
545 } else {
546 MSG("All %s tracepoints are enabled in channel %s",
547 get_domain_str(dom.type),
548 print_channel_name(channel_name));
549 }
550 break;
551 case LTTNG_EVENT_SYSCALL:
552 if (opt_kernel) {
553 MSG("All kernel system calls are enabled in channel %s",
554 print_channel_name(channel_name));
555 }
556 break;
557 case LTTNG_EVENT_ALL:
558 if (opt_loglevel && dom.type != LTTNG_DOMAIN_KERNEL) {
559 MSG("All %s events are enabled in channel %s for loglevel %s",
560 get_domain_str(dom.type),
561 print_channel_name(channel_name),
562 opt_loglevel);
563 } else {
564 MSG("All %s events are enabled in channel %s",
565 get_domain_str(dom.type),
566 print_channel_name(channel_name));
567 }
568 break;
569 default:
570 /*
571 * We should not be here since lttng_enable_event should have
572 * failed on the event type.
573 */
574 goto error;
575 }
576 }
577 if (opt_filter) {
578 ret = lttng_enable_event_with_exclusions(handle, &ev, channel_name,
579 opt_filter, exclusion_count, exclusion_list);
580 if (ret < 0) {
581 switch (-ret) {
582 case LTTNG_ERR_FILTER_EXIST:
583 WARN("Filter on all events is already enabled"
584 " (channel %s, session %s)",
585 print_channel_name(channel_name), session_name);
586 break;
587 default:
588 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
589 lttng_strerror(ret),
590 ret == -LTTNG_ERR_NEED_CHANNEL_NAME
591 ? print_raw_channel_name(channel_name)
592 : print_channel_name(channel_name),
593 session_name, opt_filter);
594 break;
595 }
596 goto error;
597 } else {
598 MSG("Filter '%s' successfully set", opt_filter);
599 }
600 }
601 goto end;
602 }
603
604 /* Strip event list */
605 event_name = strtok(opt_event_list, ",");
606 while (event_name != NULL) {
607 /* Copy name and type of the event */
608 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
609 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
610 ev.type = opt_event_type;
611
612 /* Kernel tracer action */
613 if (opt_kernel) {
614 DBG("Enabling kernel event %s for channel %s",
615 event_name,
616 print_channel_name(channel_name));
617
618 switch (opt_event_type) {
619 case LTTNG_EVENT_ALL: /* Default behavior is tracepoint */
620 ev.type = LTTNG_EVENT_TRACEPOINT;
621 /* Fall-through */
622 case LTTNG_EVENT_TRACEPOINT:
623 break;
624 case LTTNG_EVENT_PROBE:
625 ret = parse_probe_opts(&ev, opt_probe);
626 if (ret < 0) {
627 ERR("Unable to parse probe options");
628 ret = 0;
629 goto error;
630 }
631 break;
632 case LTTNG_EVENT_FUNCTION:
633 ret = parse_probe_opts(&ev, opt_function);
634 if (ret < 0) {
635 ERR("Unable to parse function probe options");
636 ret = 0;
637 goto error;
638 }
639 break;
640 case LTTNG_EVENT_FUNCTION_ENTRY:
641 strncpy(ev.attr.ftrace.symbol_name, opt_function_entry_symbol,
642 LTTNG_SYMBOL_NAME_LEN);
643 ev.attr.ftrace.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
644 break;
645 case LTTNG_EVENT_SYSCALL:
646 MSG("per-syscall selection not supported yet. Use \"-a\" "
647 "for all syscalls.");
648 default:
649 ret = CMD_UNDEFINED;
650 goto error;
651 }
652
653 /* kernel loglevels not implemented */
654 ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
655 } else if (opt_userspace) { /* User-space tracer action */
656 #if 0
657 if (opt_cmd_name != NULL || opt_pid) {
658 MSG("Only supporting tracing all UST processes (-u) for now.");
659 ret = CMD_UNDEFINED;
660 goto error;
661 }
662 #endif
663
664 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name,
665 print_channel_name(channel_name), opt_loglevel ? : "<all>");
666
667 switch (opt_event_type) {
668 case LTTNG_EVENT_ALL: /* Default behavior is tracepoint */
669 /* Fall-through */
670 case LTTNG_EVENT_TRACEPOINT:
671 /* Copy name and type of the event */
672 ev.type = LTTNG_EVENT_TRACEPOINT;
673 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
674 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
675 break;
676 case LTTNG_EVENT_PROBE:
677 case LTTNG_EVENT_FUNCTION:
678 case LTTNG_EVENT_FUNCTION_ENTRY:
679 case LTTNG_EVENT_SYSCALL:
680 default:
681 ERR("Event type not available for user-space tracing");
682 ret = CMD_UNSUPPORTED;
683 goto error;
684 }
685
686 if (opt_exclude) {
687 if (opt_event_type != LTTNG_EVENT_ALL && opt_event_type != LTTNG_EVENT_TRACEPOINT) {
688 ERR("Exclusion option can only be used with tracepoint events");
689 ret = CMD_ERROR;
690 goto error;
691 }
692 /* Free previously allocated items */
693 if (exclusion_list != NULL) {
694 while (exclusion_count--) {
695 free(exclusion_list[exclusion_count]);
696 }
697 free(exclusion_list);
698 exclusion_list = NULL;
699 }
700 /* Check for proper subsets */
701 ret = check_exclusion_subsets(event_name, opt_exclude,
702 &exclusion_count, &exclusion_list);
703 if (ret == CMD_ERROR) {
704 goto error;
705 }
706 }
707
708 ev.loglevel_type = opt_loglevel_type;
709 if (opt_loglevel) {
710 ev.loglevel = loglevel_str_to_value(opt_loglevel);
711 if (ev.loglevel == -1) {
712 ERR("Unknown loglevel %s", opt_loglevel);
713 ret = -LTTNG_ERR_INVALID;
714 goto error;
715 }
716 } else {
717 ev.loglevel = -1;
718 }
719 } else if (opt_jul) {
720 if (opt_event_type != LTTNG_EVENT_ALL &&
721 opt_event_type != LTTNG_EVENT_TRACEPOINT) {
722 ERR("Event type not supported for JUL domain.");
723 ret = CMD_UNSUPPORTED;
724 goto error;
725 }
726 ev.type = LTTNG_EVENT_TRACEPOINT;
727 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
728 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
729 } else {
730 print_missing_domain();
731 ret = CMD_ERROR;
732 goto error;
733 }
734
735 if (!opt_filter) {
736 ret = lttng_enable_event_with_exclusions(handle,
737 &ev, channel_name,
738 NULL, exclusion_count, exclusion_list);
739 if (ret < 0) {
740 /* Turn ret to positive value to handle the positive error code */
741 switch (-ret) {
742 case LTTNG_ERR_KERN_EVENT_EXIST:
743 WARN("Kernel event %s already enabled (channel %s, session %s)",
744 event_name,
745 print_channel_name(channel_name), session_name);
746 break;
747 default:
748 ERR("Event %s: %s (channel %s, session %s)", event_name,
749 lttng_strerror(ret),
750 ret == -LTTNG_ERR_NEED_CHANNEL_NAME
751 ? print_raw_channel_name(channel_name)
752 : print_channel_name(channel_name),
753 session_name);
754 break;
755 }
756 warn = 1;
757 } else {
758 MSG("%s event %s created in channel %s",
759 get_domain_str(dom.type), event_name,
760 print_channel_name(channel_name));
761 }
762 }
763
764 if (opt_filter) {
765 ret = lttng_enable_event_with_exclusions(handle, &ev, channel_name,
766 opt_filter, exclusion_count, exclusion_list);
767 if (ret < 0) {
768 switch (-ret) {
769 case LTTNG_ERR_FILTER_EXIST:
770 WARN("Filter on event %s is already enabled"
771 " (channel %s, session %s)",
772 event_name,
773 print_channel_name(channel_name), session_name);
774 break;
775 default:
776 ERR("Event %s: %s (channel %s, session %s, filter \'%s\')", ev.name,
777 lttng_strerror(ret),
778 ret == -LTTNG_ERR_NEED_CHANNEL_NAME
779 ? print_raw_channel_name(channel_name)
780 : print_channel_name(channel_name),
781 session_name, opt_filter);
782 break;
783 }
784 goto error;
785 } else {
786 MSG("Filter '%s' successfully set", opt_filter);
787 }
788 }
789
790 /* Next event */
791 event_name = strtok(NULL, ",");
792 }
793
794 end:
795 error:
796 if (warn) {
797 ret = CMD_WARNING;
798 }
799 lttng_destroy_handle(handle);
800
801 if (exclusion_list != NULL) {
802 while (exclusion_count--) {
803 free(exclusion_list[exclusion_count]);
804 }
805 free(exclusion_list);
806 }
807
808 return ret;
809 }
810
811 /*
812 * Add event to trace session
813 */
814 int cmd_enable_events(int argc, const char **argv)
815 {
816 int opt, ret = CMD_SUCCESS;
817 static poptContext pc;
818 char *session_name = NULL;
819 int event_type = -1;
820
821 pc = poptGetContext(NULL, argc, argv, long_options, 0);
822 poptReadDefaultConfig(pc, 0);
823
824 /* Default event type */
825 opt_event_type = LTTNG_EVENT_ALL;
826
827 while ((opt = poptGetNextOpt(pc)) != -1) {
828 switch (opt) {
829 case OPT_HELP:
830 usage(stdout);
831 goto end;
832 case OPT_TRACEPOINT:
833 opt_event_type = LTTNG_EVENT_TRACEPOINT;
834 break;
835 case OPT_PROBE:
836 opt_event_type = LTTNG_EVENT_PROBE;
837 break;
838 case OPT_FUNCTION:
839 opt_event_type = LTTNG_EVENT_FUNCTION;
840 break;
841 case OPT_FUNCTION_ENTRY:
842 opt_event_type = LTTNG_EVENT_FUNCTION_ENTRY;
843 break;
844 case OPT_SYSCALL:
845 opt_event_type = LTTNG_EVENT_SYSCALL;
846 break;
847 case OPT_USERSPACE:
848 opt_userspace = 1;
849 break;
850 case OPT_LOGLEVEL:
851 opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_RANGE;
852 opt_loglevel = poptGetOptArg(pc);
853 break;
854 case OPT_LOGLEVEL_ONLY:
855 opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_SINGLE;
856 opt_loglevel = poptGetOptArg(pc);
857 break;
858 case OPT_LIST_OPTIONS:
859 list_cmd_options(stdout, long_options);
860 goto end;
861 case OPT_FILTER:
862 break;
863 case OPT_EXCLUDE:
864 break;
865 default:
866 usage(stderr);
867 ret = CMD_UNDEFINED;
868 goto end;
869 }
870
871 /* Validate event type. Multiple event type are not supported. */
872 if (event_type == -1) {
873 event_type = opt_event_type;
874 } else {
875 if (event_type != opt_event_type) {
876 ERR("Multiple event type not supported.");
877 ret = CMD_ERROR;
878 goto end;
879 }
880 }
881 }
882
883 opt_event_list = (char*) poptGetArg(pc);
884 if (opt_event_list == NULL && opt_enable_all == 0) {
885 ERR("Missing event name(s).\n");
886 usage(stderr);
887 ret = CMD_ERROR;
888 goto end;
889 }
890
891 if (!opt_session_name) {
892 session_name = get_session_name();
893 if (session_name == NULL) {
894 ret = CMD_ERROR;
895 goto end;
896 }
897 } else {
898 session_name = opt_session_name;
899 }
900
901 ret = enable_events(session_name);
902
903 end:
904 if (opt_session_name == NULL) {
905 free(session_name);
906 }
907
908 poptFreeContext(pc);
909 return ret;
910 }
This page took 0.081081 seconds and 4 git commands to generate.