projects / lttng-tools.git / blob
? search:


78cc0ea8b88f6ef8d31723312248fd7cefb0d1be
[lttng-tools.git] / src / bin / lttng / commands / enable_events.cpp
1 /*
2 * Copyright (C) 2011 EfficiOS Inc.
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 */
7
8 #define _LGPL_SOURCE
9 #include <common/compat/getenv.hpp>
10 #include <common/compat/string.hpp>
11 #include <common/make-unique-wrapper.hpp>
12 #include <common/scope-exit.hpp>
13 #include <common/sessiond-comm/sessiond-comm.hpp>
14 #include <common/string-utils/string-utils.hpp>
15 #include <common/utils.hpp>
16
17 #include <ctype.h>
18 #include <inttypes.h>
19 #include <popt.h>
20 #include <sstream>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string>
24 #include <sys/stat.h>
25 #include <sys/types.h>
26 #include <unistd.h>
27 #include <vector>
28
29 /* Mi dependancy */
30 #include "../command.hpp"
31 #include "../loglevel.hpp"
32 #include "../uprobe.hpp"
33
34 #include <common/mi-lttng.hpp>
35
36 #include <lttng/domain-internal.hpp>
37 #include <lttng/event-internal.hpp>
38
39 #if (LTTNG_SYMBOL_NAME_LEN == 256)
40 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
41 #endif
42
43 namespace {
44 void _mi_lttng_writer_deleter_func(mi_writer *writer)
45 {
46 if (writer && mi_lttng_writer_destroy(writer)) {
47 LTTNG_THROW_ERROR("Failed to destroy mi_writer instance");
48 }
49 }
50
51 using mi_writer_uptr = std::unique_ptr<
52 mi_writer,
53 lttng::memory::create_deleter_class<mi_writer, _mi_lttng_writer_deleter_func>::deleter>;
54 using event_rule_patterns = std::vector<std::string>;
55
56 int opt_event_type;
57 const char *opt_loglevel;
58 int opt_loglevel_type;
59 int opt_kernel;
60 char *opt_session_name;
61 int opt_userspace;
62 int opt_jul;
63 int opt_log4j;
64 int opt_python;
65 int opt_enable_all;
66 char *opt_probe;
67 char *opt_userspace_probe;
68 char *opt_function;
69 char *opt_channel_name;
70 char *opt_filter;
71 char *opt_exclude;
72
73 struct lttng_handle *handle;
74 mi_writer_uptr writer;
75
76 #ifdef LTTNG_EMBED_HELP
77 static const char help_msg[] =
78 #include <lttng-enable-event.1.h>
79 ;
80 #endif
81
82 enum {
83 OPT_HELP = 1,
84 OPT_TRACEPOINT,
85 OPT_PROBE,
86 OPT_USERSPACE_PROBE,
87 OPT_FUNCTION,
88 OPT_SYSCALL,
89 OPT_USERSPACE,
90 OPT_LOGLEVEL,
91 OPT_LOGLEVEL_ONLY,
92 OPT_LIST_OPTIONS,
93 OPT_FILTER,
94 OPT_EXCLUDE,
95 };
96
97 struct poptOption long_options[] = {
98 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
99 { "help", 'h', POPT_ARG_NONE, nullptr, OPT_HELP, nullptr, nullptr },
100 { "session", 's', POPT_ARG_STRING, &opt_session_name, 0, nullptr, nullptr },
101 { "all", 'a', POPT_ARG_VAL, &opt_enable_all, 1, nullptr, nullptr },
102 { "channel", 'c', POPT_ARG_STRING, &opt_channel_name, 0, nullptr, nullptr },
103 { "kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, nullptr, nullptr },
104 { "userspace", 'u', POPT_ARG_NONE, nullptr, OPT_USERSPACE, nullptr, nullptr },
105 { "jul", 'j', POPT_ARG_VAL, &opt_jul, 1, nullptr, nullptr },
106 { "log4j", 'l', POPT_ARG_VAL, &opt_log4j, 1, nullptr, nullptr },
107 { "python", 'p', POPT_ARG_VAL, &opt_python, 1, nullptr, nullptr },
108 { "tracepoint", 0, POPT_ARG_NONE, nullptr, OPT_TRACEPOINT, nullptr, nullptr },
109 { "probe", 0, POPT_ARG_STRING, &opt_probe, OPT_PROBE, nullptr, nullptr },
110 { "userspace-probe",
111 0,
112 POPT_ARG_STRING,
113 &opt_userspace_probe,
114 OPT_USERSPACE_PROBE,
115 nullptr,
116 nullptr },
117 { "function", 0, POPT_ARG_STRING, &opt_function, OPT_FUNCTION, nullptr, nullptr },
118 { "syscall", 0, POPT_ARG_NONE, nullptr, OPT_SYSCALL, nullptr, nullptr },
119 { "loglevel", 0, POPT_ARG_STRING, nullptr, OPT_LOGLEVEL, nullptr, nullptr },
120 { "loglevel-only", 0, POPT_ARG_STRING, nullptr, OPT_LOGLEVEL_ONLY, nullptr, nullptr },
121 { "list-options", 0, POPT_ARG_NONE, nullptr, OPT_LIST_OPTIONS, nullptr, nullptr },
122 { "filter", 'f', POPT_ARG_STRING, &opt_filter, OPT_FILTER, nullptr, nullptr },
123 { "exclude", 'x', POPT_ARG_STRING, &opt_exclude, OPT_EXCLUDE, nullptr, nullptr },
124 { nullptr, 0, 0, nullptr, 0, nullptr, nullptr }
125 };
126
127 /*
128 * Parse probe options.
129 */
130 int parse_probe_opts(struct lttng_event *ev, char *opt)
131 {
132 int ret = CMD_SUCCESS;
133 int match;
134 char s_hex[19];
135 #define S_HEX_LEN_SCANF_IS_A_BROKEN_API "18" /* 18 is (19 - 1) (\0 is extra) */
136 char name[LTTNG_SYMBOL_NAME_LEN];
137
138 if (opt == nullptr) {
139 ret = CMD_ERROR;
140 goto end;
141 }
142
143 /* Check for symbol+offset */
144 match = sscanf(opt,
145 "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
146 "[^'+']+%" S_HEX_LEN_SCANF_IS_A_BROKEN_API "s",
147 name,
148 s_hex);
149 if (match == 2) {
150 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
151 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
152 DBG("probe symbol %s", ev->attr.probe.symbol_name);
153 if (*s_hex == '\0') {
154 ERR("Invalid probe offset %s", s_hex);
155 ret = CMD_ERROR;
156 goto end;
157 }
158 ev->attr.probe.offset = strtoull(s_hex, nullptr, 0);
159 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
160 ev->attr.probe.addr = 0;
161 goto end;
162 }
163
164 /* Check for symbol */
165 if (isalpha(name[0]) || name[0] == '_') {
166 match = sscanf(opt, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "s", name);
167 if (match == 1) {
168 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
169 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
170 DBG("probe symbol %s", ev->attr.probe.symbol_name);
171 ev->attr.probe.offset = 0;
172 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
173 ev->attr.probe.addr = 0;
174 goto end;
175 }
176 }
177
178 /* Check for address */
179 match = sscanf(opt, "%" S_HEX_LEN_SCANF_IS_A_BROKEN_API "s", s_hex);
180 if (match > 0) {
181 /*
182 * Return an error if the first character of the tentative
183 * address is NULL or not a digit. It can be "0" if the address
184 * is in hexadecimal and can be 1 to 9 if it's in decimal.
185 */
186 if (*s_hex == '\0' || !isdigit(*s_hex)) {
187 ERR("Invalid probe description %s", s_hex);
188 ret = CMD_ERROR;
189 goto end;
190 }
191 ev->attr.probe.addr = strtoull(s_hex, nullptr, 0);
192 DBG("probe addr %" PRIu64, ev->attr.probe.addr);
193 ev->attr.probe.offset = 0;
194 memset(ev->attr.probe.symbol_name, 0, LTTNG_SYMBOL_NAME_LEN);
195 goto end;
196 }
197
198 /* No match */
199 ret = CMD_ERROR;
200
201 end:
202 return ret;
203 }
204
205 const char *print_channel_name(const char *name)
206 {
207 return name ?: DEFAULT_CHANNEL_NAME;
208 }
209
210 const char *print_raw_channel_name(const char *name)
211 {
212 return name ?: "<default>";
213 }
214
215 /*
216 * Mi print exlcusion list
217 */
218 int mi_print_exclusion(const struct lttng_dynamic_pointer_array *exclusions)
219 {
220 int ret;
221 size_t i;
222 const size_t count = lttng_dynamic_pointer_array_get_count(exclusions);
223
224 LTTNG_ASSERT(writer);
225
226 if (count == 0) {
227 ret = 0;
228 goto end;
229 }
230
231 ret = mi_lttng_writer_open_element(writer.get(), config_element_exclusions);
232 if (ret) {
233 goto end;
234 }
235
236 for (i = 0; i < count; i++) {
237 const char *exclusion =
238 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions, i);
239
240 ret = mi_lttng_writer_write_element_string(
241 writer.get(), config_element_exclusion, exclusion);
242 if (ret) {
243 goto end;
244 }
245 }
246
247 /* Close exclusions element */
248 ret = mi_lttng_writer_close_element(writer.get());
249
250 end:
251 return ret;
252 }
253
254 /*
255 * Return allocated string for pretty-printing exclusion names.
256 */
257 char *print_exclusions(const struct lttng_dynamic_pointer_array *exclusions)
258 {
259 int length = 0;
260 size_t i;
261 const char preamble[] = " excluding ";
262 char *ret;
263 const size_t count = lttng_dynamic_pointer_array_get_count(exclusions);
264
265 if (count == 0) {
266 return strdup("");
267 }
268
269 /* Calculate total required length. */
270 for (i = 0; i < count; i++) {
271 const char *exclusion =
272 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions, i);
273
274 length += strlen(exclusion) + 4;
275 }
276
277 length += sizeof(preamble);
278 ret = calloc<char>(length);
279 if (!ret) {
280 return nullptr;
281 }
282
283 strncpy(ret, preamble, length);
284 for (i = 0; i < count; i++) {
285 const char *exclusion =
286 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions, i);
287
288 strcat(ret, "\"");
289 strcat(ret, exclusion);
290 strcat(ret, "\"");
291 if (i != count - 1) {
292 strcat(ret, ", ");
293 }
294 }
295
296 return ret;
297 }
298
299 int check_exclusion_subsets(const char *pattern, const char *exclusion)
300 {
301 bool warn = false;
302 int ret = 0;
303 const char *e = pattern;
304 const char *x = exclusion;
305
306 /* Scan both the excluder and the event letter by letter */
307 while (true) {
308 if (*e == '\\') {
309 if (*x != *e) {
310 warn = true;
311 goto end;
312 }
313
314 e++;
315 x++;
316 goto cmp_chars;
317 }
318
319 if (*x == '*') {
320 /* Event is a subset of the excluder */
321 ERR("Event %s: %s excludes all events from %s", pattern, exclusion, pattern);
322 goto error;
323 }
324
325 if (*e == '*') {
326 /*
327 * Reached the end of the event name before the
328 * end of the exclusion: this is valid.
329 */
330 goto end;
331 }
332
333 cmp_chars:
334 if (*x != *e) {
335 warn = true;
336 break;
337 }
338
339 x++;
340 e++;
341 }
342
343 goto end;
344
345 error:
346 ret = -1;
347
348 end:
349 if (warn) {
350 WARN("Event %s: %s does not exclude any events from %s",
351 pattern,
352 exclusion,
353 pattern);
354 }
355
356 return ret;
357 }
358
359 int create_exclusion_list_and_validate(const char *pattern,
360 const char *exclusions_arg,
361 struct lttng_dynamic_pointer_array *exclusions)
362 {
363 int ret = 0;
364
365 /* Split exclusions. */
366 ret = strutils_split(exclusions_arg, ',', true, exclusions);
367 if (ret < 0) {
368 goto error;
369 }
370
371 if (validate_exclusion_list(pattern, exclusions) != 0) {
372 goto error;
373 }
374
375 goto end;
376
377 error:
378 ret = -1;
379 lttng_dynamic_pointer_array_reset(exclusions);
380
381 end:
382 return ret;
383 }
384
385 void warn_on_truncated_exclusion_names(const struct lttng_dynamic_pointer_array *exclusions,
386 int *warn)
387 {
388 size_t i;
389 const size_t num_exclusions = lttng_dynamic_pointer_array_get_count(exclusions);
390
391 for (i = 0; i < num_exclusions; i++) {
392 const char *const exclusion =
393 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions, i);
394
395 if (strlen(exclusion) >= LTTNG_SYMBOL_NAME_LEN) {
396 WARN("Event exclusion \"%s\" will be truncated", exclusion);
397 *warn = 1;
398 }
399 }
400 }
401
402 /*
403 * Enabling event using the lttng API.
404 * Note: in case of error only the last error code will be return.
405 */
406 int enable_events(const std::string& session_name, const event_rule_patterns& patterns)
407 {
408 int ret = CMD_SUCCESS, command_ret = CMD_SUCCESS;
409 int error_holder = CMD_SUCCESS, warn = 0, error = 0, success = 1;
410 char *channel_name = nullptr;
411 struct lttng_event *ev;
412 struct lttng_domain dom = {};
413 struct lttng_dynamic_pointer_array exclusions;
414 struct lttng_userspace_probe_location *uprobe_loc = nullptr;
415
416 lttng_dynamic_pointer_array_init(&exclusions, nullptr);
417
418 ev = lttng_event_create();
419 if (!ev) {
420 ret = CMD_ERROR;
421 goto error;
422 }
423
424 if (opt_kernel) {
425 if (opt_loglevel) {
426 WARN("Kernel loglevels are not supported.");
427 }
428 }
429
430 /* Create lttng domain */
431 if (opt_kernel) {
432 dom.type = LTTNG_DOMAIN_KERNEL;
433 dom.buf_type = LTTNG_BUFFER_GLOBAL;
434 } else if (opt_userspace) {
435 dom.type = LTTNG_DOMAIN_UST;
436 /* Default. */
437 dom.buf_type = LTTNG_BUFFER_PER_UID;
438 } else if (opt_jul) {
439 dom.type = LTTNG_DOMAIN_JUL;
440 /* Default. */
441 dom.buf_type = LTTNG_BUFFER_PER_UID;
442 } else if (opt_log4j) {
443 dom.type = LTTNG_DOMAIN_LOG4J;
444 /* Default. */
445 dom.buf_type = LTTNG_BUFFER_PER_UID;
446 } else if (opt_python) {
447 dom.type = LTTNG_DOMAIN_PYTHON;
448 /* Default. */
449 dom.buf_type = LTTNG_BUFFER_PER_UID;
450 } else {
451 /* Checked by the caller. */
452 abort();
453 }
454
455 if (opt_exclude) {
456 switch (dom.type) {
457 case LTTNG_DOMAIN_KERNEL:
458 case LTTNG_DOMAIN_JUL:
459 case LTTNG_DOMAIN_LOG4J:
460 case LTTNG_DOMAIN_PYTHON:
461 ERR("Event name exclusions are not yet implemented for %s events",
462 lttng_domain_type_str(dom.type));
463 ret = CMD_ERROR;
464 goto error;
465 case LTTNG_DOMAIN_UST:
466 /* Exclusions supported */
467 break;
468 default:
469 abort();
470 }
471 }
472
473 /*
474 * Adding a filter to a probe, function or userspace-probe would be
475 * denied by the kernel tracer as it's not supported at the moment. We
476 * do an early check here to warn the user.
477 */
478 if (opt_filter && opt_kernel) {
479 switch (opt_event_type) {
480 case LTTNG_EVENT_ALL:
481 case LTTNG_EVENT_TRACEPOINT:
482 case LTTNG_EVENT_SYSCALL:
483 break;
484 case LTTNG_EVENT_PROBE:
485 case LTTNG_EVENT_USERSPACE_PROBE:
486 case LTTNG_EVENT_FUNCTION:
487 ERR("Filter expressions are not supported for %s events",
488 get_event_type_str((lttng_event_type) opt_event_type));
489 ret = CMD_ERROR;
490 goto error;
491 default:
492 ret = CMD_UNDEFINED;
493 goto error;
494 }
495 }
496
497 channel_name = opt_channel_name;
498
499 handle = lttng_create_handle(session_name.c_str(), &dom);
500 if (handle == nullptr) {
501 ret = -1;
502 goto error;
503 }
504
505 /* Prepare Mi */
506 if (lttng_opt_mi) {
507 /* Open a events element */
508 ret = mi_lttng_writer_open_element(writer.get(), config_element_events);
509 if (ret) {
510 ret = CMD_ERROR;
511 goto error;
512 }
513 }
514
515 if (opt_enable_all) {
516 /* Default setup for enable all */
517 if (opt_kernel) {
518 ev->type = (lttng_event_type) opt_event_type;
519 strcpy(ev->name, "*");
520 /* kernel loglevels not implemented */
521 ev->loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
522 } else {
523 ev->type = LTTNG_EVENT_TRACEPOINT;
524 strcpy(ev->name, "*");
525 ev->loglevel_type = (lttng_loglevel_type) opt_loglevel_type;
526 if (opt_loglevel) {
527 int name_search_ret;
528
529 LTTNG_ASSERT(opt_userspace || opt_jul || opt_log4j || opt_python);
530
531 if (opt_userspace) {
532 enum lttng_loglevel loglevel;
533
534 name_search_ret =
535 loglevel_name_to_value(opt_loglevel, &loglevel);
536 ev->loglevel = (int) loglevel;
537 } else if (opt_jul) {
538 enum lttng_loglevel_jul loglevel;
539
540 name_search_ret =
541 loglevel_jul_name_to_value(opt_loglevel, &loglevel);
542 ev->loglevel = (int) loglevel;
543 } else if (opt_log4j) {
544 enum lttng_loglevel_log4j loglevel;
545
546 name_search_ret = loglevel_log4j_name_to_value(opt_loglevel,
547 &loglevel);
548 ev->loglevel = (int) loglevel;
549 } else {
550 /* python domain. */
551 enum lttng_loglevel_python loglevel;
552
553 name_search_ret = loglevel_python_name_to_value(
554 opt_loglevel, &loglevel);
555 ev->loglevel = (int) loglevel;
556 }
557
558 if (name_search_ret == -1) {
559 ERR("Unknown loglevel %s", opt_loglevel);
560 ret = -LTTNG_ERR_INVALID;
561 goto error;
562 }
563 } else {
564 LTTNG_ASSERT(opt_userspace || opt_jul || opt_log4j || opt_python);
565 if (opt_userspace) {
566 ev->loglevel = -1;
567 } else if (opt_jul) {
568 ev->loglevel = LTTNG_LOGLEVEL_JUL_ALL;
569 } else if (opt_log4j) {
570 ev->loglevel = LTTNG_LOGLEVEL_LOG4J_ALL;
571 } else if (opt_python) {
572 ev->loglevel = LTTNG_LOGLEVEL_PYTHON_DEBUG;
573 }
574 }
575 }
576
577 if (opt_exclude) {
578 ret = create_exclusion_list_and_validate("*", opt_exclude, &exclusions);
579 if (ret) {
580 ret = CMD_ERROR;
581 goto error;
582 }
583
584 ev->exclusion = 1;
585 warn_on_truncated_exclusion_names(&exclusions, &warn);
586 }
587 if (!opt_filter) {
588 ret = lttng_enable_event_with_exclusions(
589 handle,
590 ev,
591 channel_name,
592 nullptr,
593 lttng_dynamic_pointer_array_get_count(&exclusions),
594 (char **) exclusions.array.buffer.data);
595 if (ret < 0) {
596 switch (-ret) {
597 case LTTNG_ERR_KERN_EVENT_EXIST:
598 WARN("Kernel events already enabled (channel %s, session %s)",
599 print_channel_name(channel_name),
600 session_name.c_str());
601 warn = 1;
602 break;
603 case LTTNG_ERR_TRACE_ALREADY_STARTED:
604 {
605 const char *msg =
606 "The command tried to enable an event in a new domain for a session that has already been started once.";
607 ERR("Events: %s (channel %s, session %s)",
608 msg,
609 print_channel_name(channel_name),
610 session_name.c_str());
611 error = 1;
612 break;
613 }
614 default:
615 ERR("Events: %s (channel %s, session %s)",
616 lttng_strerror(ret),
617 ret == -LTTNG_ERR_NEED_CHANNEL_NAME ?
618 print_raw_channel_name(channel_name) :
619 print_channel_name(channel_name),
620 session_name.c_str());
621 error = 1;
622 break;
623 }
624 goto end;
625 }
626
627 switch (opt_event_type) {
628 case LTTNG_EVENT_TRACEPOINT:
629 if (opt_loglevel && dom.type != LTTNG_DOMAIN_KERNEL) {
630 char *exclusion_string = print_exclusions(&exclusions);
631
632 if (!exclusion_string) {
633 PERROR("Cannot allocate exclusion_string");
634 error = 1;
635 goto end;
636 }
637 MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
638 lttng_domain_type_str(dom.type),
639 exclusion_string,
640 print_channel_name(channel_name),
641 opt_loglevel);
642 free(exclusion_string);
643 } else {
644 char *exclusion_string = print_exclusions(&exclusions);
645
646 if (!exclusion_string) {
647 PERROR("Cannot allocate exclusion_string");
648 error = 1;
649 goto end;
650 }
651 MSG("All %s tracepoints%s are enabled in channel %s",
652 lttng_domain_type_str(dom.type),
653 exclusion_string,
654 print_channel_name(channel_name));
655 free(exclusion_string);
656 }
657 break;
658 case LTTNG_EVENT_SYSCALL:
659 if (opt_kernel) {
660 MSG("All %s system calls are enabled in channel %s",
661 lttng_domain_type_str(dom.type),
662 print_channel_name(channel_name));
663 }
664 break;
665 case LTTNG_EVENT_ALL:
666 if (opt_loglevel && dom.type != LTTNG_DOMAIN_KERNEL) {
667 char *exclusion_string = print_exclusions(&exclusions);
668
669 if (!exclusion_string) {
670 PERROR("Cannot allocate exclusion_string");
671 error = 1;
672 goto end;
673 }
674 MSG("All %s events%s are enabled in channel %s for loglevel %s",
675 lttng_domain_type_str(dom.type),
676 exclusion_string,
677 print_channel_name(channel_name),
678 opt_loglevel);
679 free(exclusion_string);
680 } else {
681 char *exclusion_string = print_exclusions(&exclusions);
682
683 if (!exclusion_string) {
684 PERROR("Cannot allocate exclusion_string");
685 error = 1;
686 goto end;
687 }
688 MSG("All %s events%s are enabled in channel %s",
689 lttng_domain_type_str(dom.type),
690 exclusion_string,
691 print_channel_name(channel_name));
692 free(exclusion_string);
693 }
694 break;
695 default:
696 /*
697 * We should not be here since lttng_enable_event should have
698 * failed on the event type.
699 */
700 goto error;
701 }
702 }
703
704 if (opt_filter) {
705 command_ret = lttng_enable_event_with_exclusions(
706 handle,
707 ev,
708 channel_name,
709 opt_filter,
710 lttng_dynamic_pointer_array_get_count(&exclusions),
711 (char **) exclusions.array.buffer.data);
712 if (command_ret < 0) {
713 switch (-command_ret) {
714 case LTTNG_ERR_FILTER_EXIST:
715 WARN("Filter on all events is already enabled"
716 " (channel %s, session %s)",
717 print_channel_name(channel_name),
718 session_name.c_str());
719 warn = 1;
720 break;
721 case LTTNG_ERR_TRACE_ALREADY_STARTED:
722 {
723 const char *msg =
724 "The command tried to enable an event in a new domain for a session that has already been started once.";
725 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
726 msg,
727 print_channel_name(channel_name),
728 session_name.c_str(),
729 opt_filter);
730 error = 1;
731 break;
732 }
733 default:
734 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
735 lttng_strerror(command_ret),
736 command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME ?
737 print_raw_channel_name(channel_name) :
738 print_channel_name(channel_name),
739 session_name.c_str(),
740 opt_filter);
741 error = 1;
742 break;
743 }
744 error_holder = command_ret;
745 } else {
746 ev->filter = 1;
747 MSG("Filter '%s' successfully set", opt_filter);
748 }
749 }
750
751 if (lttng_opt_mi) {
752 /* The wildcard * is used for kernel and ust domain to
753 * represent ALL. We copy * in event name to force the wildcard use
754 * for kernel domain
755 *
756 * Note: this is strictly for semantic and printing while in
757 * machine interface mode.
758 */
759 strcpy(ev->name, "*");
760
761 /* If we reach here the events are enabled */
762 if (!error && !warn) {
763 ev->enabled = 1;
764 } else {
765 ev->enabled = 0;
766 success = 0;
767 }
768 ret = mi_lttng_event(writer.get(), ev, 1, handle->domain.type);
769 if (ret) {
770 ret = CMD_ERROR;
771 goto error;
772 }
773
774 /* print exclusion */
775 ret = mi_print_exclusion(&exclusions);
776 if (ret) {
777 ret = CMD_ERROR;
778 goto error;
779 }
780
781 /* Success ? */
782 ret = mi_lttng_writer_write_element_bool(
783 writer.get(), mi_lttng_element_command_success, success);
784 if (ret) {
785 ret = CMD_ERROR;
786 goto error;
787 }
788
789 /* Close event element */
790 ret = mi_lttng_writer_close_element(writer.get());
791 if (ret) {
792 ret = CMD_ERROR;
793 goto error;
794 }
795 }
796
797 goto end;
798 }
799
800 /* Strip event list */
801 for (const auto& pattern : patterns) {
802 /* Copy name and type of the event */
803 strncpy(ev->name, pattern.c_str(), LTTNG_SYMBOL_NAME_LEN);
804 ev->name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
805 ev->type = (lttng_event_type) opt_event_type;
806
807 /* Kernel tracer action */
808 if (opt_kernel) {
809 DBG_FMT("Enabling kernel event: pattern=`{}`, channel_name=`{}`",
810 pattern,
811 print_channel_name(channel_name));
812
813 switch (opt_event_type) {
814 case LTTNG_EVENT_ALL: /* Enable tracepoints and syscalls */
815 /* If event name differs from *, select tracepoint. */
816 if (strcmp(ev->name, "*") != 0) {
817 ev->type = LTTNG_EVENT_TRACEPOINT;
818 }
819 break;
820 case LTTNG_EVENT_TRACEPOINT:
821 break;
822 case LTTNG_EVENT_PROBE:
823 ret = parse_probe_opts(ev, opt_probe);
824 if (ret) {
825 ERR("Unable to parse probe options");
826 ret = CMD_ERROR;
827 goto error;
828 }
829 break;
830 case LTTNG_EVENT_USERSPACE_PROBE:
831 LTTNG_ASSERT(ev->type == LTTNG_EVENT_USERSPACE_PROBE);
832
833 ret = parse_userspace_probe_opts(opt_userspace_probe, &uprobe_loc);
834 if (ret) {
835 switch (ret) {
836 case CMD_UNSUPPORTED:
837 /*
838 * Error message describing
839 * what is not supported was
840 * printed in the function.
841 */
842 break;
843 case CMD_ERROR:
844 default:
845 ERR("Unable to parse userspace probe options");
846 break;
847 }
848 goto error;
849 }
850
851 ret = lttng_event_set_userspace_probe_location(ev, uprobe_loc);
852 if (ret) {
853 WARN("Failed to set probe location on event");
854 ret = CMD_ERROR;
855 goto error;
856 }
857
858 /* Ownership of the uprobe location was transferred to the event. */
859 uprobe_loc = nullptr;
860 break;
861 case LTTNG_EVENT_FUNCTION:
862 ret = parse_probe_opts(ev, opt_function);
863 if (ret) {
864 ERR("Unable to parse function probe options");
865 ret = CMD_ERROR;
866 goto error;
867 }
868 break;
869 case LTTNG_EVENT_SYSCALL:
870 ev->type = LTTNG_EVENT_SYSCALL;
871 break;
872 default:
873 ret = CMD_UNDEFINED;
874 goto error;
875 }
876
877 /* kernel loglevels not implemented */
878 ev->loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
879 } else if (opt_userspace) { /* User-space tracer action */
880 DBG("Enabling UST event %s for channel %s, loglevel %s",
881 pattern.c_str(),
882 print_channel_name(channel_name),
883 opt_loglevel ?: "<all>");
884
885 switch (opt_event_type) {
886 case LTTNG_EVENT_ALL: /* Default behavior is tracepoint */
887 /* Fall-through */
888 case LTTNG_EVENT_TRACEPOINT:
889 /* Copy name and type of the event */
890 ev->type = LTTNG_EVENT_TRACEPOINT;
891 strncpy(ev->name, pattern.c_str(), LTTNG_SYMBOL_NAME_LEN);
892 ev->name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
893 break;
894 case LTTNG_EVENT_PROBE:
895 case LTTNG_EVENT_FUNCTION:
896 case LTTNG_EVENT_SYSCALL:
897 case LTTNG_EVENT_USERSPACE_PROBE:
898 default:
899 ERR("Event type not available for user-space tracing");
900 ret = CMD_UNSUPPORTED;
901 goto error;
902 }
903
904 if (opt_exclude) {
905 ev->exclusion = 1;
906 if (opt_event_type != LTTNG_EVENT_ALL &&
907 opt_event_type != LTTNG_EVENT_TRACEPOINT) {
908 ERR("Exclusion option can only be used with tracepoint events");
909 ret = CMD_ERROR;
910 goto error;
911 }
912 /* Free previously allocated items. */
913 lttng_dynamic_pointer_array_reset(&exclusions);
914 ret = create_exclusion_list_and_validate(
915 pattern.c_str(), opt_exclude, &exclusions);
916 if (ret) {
917 ret = CMD_ERROR;
918 goto error;
919 }
920
921 warn_on_truncated_exclusion_names(&exclusions, &warn);
922 }
923
924 ev->loglevel_type = (lttng_loglevel_type) opt_loglevel_type;
925 if (opt_loglevel) {
926 enum lttng_loglevel loglevel;
927 const int name_search_ret =
928 loglevel_name_to_value(opt_loglevel, &loglevel);
929
930 if (name_search_ret == -1) {
931 ERR("Unknown loglevel %s", opt_loglevel);
932 ret = -LTTNG_ERR_INVALID;
933 goto error;
934 }
935
936 ev->loglevel = (int) loglevel;
937 } else {
938 ev->loglevel = -1;
939 }
940 } else if (opt_jul || opt_log4j || opt_python) {
941 if (opt_event_type != LTTNG_EVENT_ALL &&
942 opt_event_type != LTTNG_EVENT_TRACEPOINT) {
943 ERR("Event type not supported for domain.");
944 ret = CMD_UNSUPPORTED;
945 goto error;
946 }
947
948 ev->loglevel_type = (lttng_loglevel_type) opt_loglevel_type;
949 if (opt_loglevel) {
950 int name_search_ret;
951
952 if (opt_jul) {
953 enum lttng_loglevel_jul loglevel;
954
955 name_search_ret =
956 loglevel_jul_name_to_value(opt_loglevel, &loglevel);
957 ev->loglevel = (int) loglevel;
958 } else if (opt_log4j) {
959 enum lttng_loglevel_log4j loglevel;
960
961 name_search_ret = loglevel_log4j_name_to_value(opt_loglevel,
962 &loglevel);
963 ev->loglevel = (int) loglevel;
964 } else {
965 /* python domain. */
966 enum lttng_loglevel_python loglevel;
967
968 name_search_ret = loglevel_python_name_to_value(
969 opt_loglevel, &loglevel);
970 ev->loglevel = (int) loglevel;
971 }
972
973 if (name_search_ret) {
974 ERR("Unknown loglevel %s", opt_loglevel);
975 ret = -LTTNG_ERR_INVALID;
976 goto error;
977 }
978 } else {
979 if (opt_jul) {
980 ev->loglevel = LTTNG_LOGLEVEL_JUL_ALL;
981 } else if (opt_log4j) {
982 ev->loglevel = LTTNG_LOGLEVEL_LOG4J_ALL;
983 } else if (opt_python) {
984 ev->loglevel = LTTNG_LOGLEVEL_PYTHON_DEBUG;
985 }
986 }
987 ev->type = LTTNG_EVENT_TRACEPOINT;
988 strncpy(ev->name, pattern.c_str(), LTTNG_SYMBOL_NAME_LEN);
989 ev->name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
990 } else {
991 abort();
992 }
993
994 if (!opt_filter) {
995 char *exclusion_string;
996
997 command_ret = lttng_enable_event_with_exclusions(
998 handle,
999 ev,
1000 channel_name,
1001 nullptr,
1002 lttng_dynamic_pointer_array_get_count(&exclusions),
1003 (char **) exclusions.array.buffer.data);
1004 exclusion_string = print_exclusions(&exclusions);
1005 if (!exclusion_string) {
1006 PERROR("Cannot allocate exclusion_string");
1007 error = 1;
1008 goto end;
1009 }
1010 if (command_ret < 0) {
1011 /* Turn ret to positive value to handle the positive error code */
1012 switch (-command_ret) {
1013 case LTTNG_ERR_KERN_EVENT_EXIST:
1014 WARN("Kernel event %s%s already enabled (channel %s, session %s)",
1015 pattern.c_str(),
1016 exclusion_string,
1017 print_channel_name(channel_name),
1018 session_name.c_str());
1019 warn = 1;
1020 break;
1021 case LTTNG_ERR_TRACE_ALREADY_STARTED:
1022 {
1023 const char *msg =
1024 "The command tried to enable an event in a new domain for a session that has already been started once.";
1025 ERR("Event %s%s: %s (channel %s, session %s)",
1026 pattern.c_str(),
1027 exclusion_string,
1028 msg,
1029 print_channel_name(channel_name),
1030 session_name.c_str());
1031 error = 1;
1032 break;
1033 }
1034 case LTTNG_ERR_SDT_PROBE_SEMAPHORE:
1035 ERR("SDT probes %s guarded by semaphores are not supported (channel %s, session %s)",
1036 pattern.c_str(),
1037 print_channel_name(channel_name),
1038 session_name.c_str());
1039 error = 1;
1040 break;
1041 default:
1042 ERR("Event %s%s: %s (channel %s, session %s)",
1043 pattern.c_str(),
1044 exclusion_string,
1045 lttng_strerror(command_ret),
1046 command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME ?
1047 print_raw_channel_name(channel_name) :
1048 print_channel_name(channel_name),
1049 session_name.c_str());
1050 error = 1;
1051 break;
1052 }
1053 error_holder = command_ret;
1054 } else {
1055 switch (dom.type) {
1056 case LTTNG_DOMAIN_KERNEL:
1057 case LTTNG_DOMAIN_UST:
1058 MSG("%s event %s%s created in channel %s",
1059 lttng_domain_type_str(dom.type),
1060 pattern.c_str(),
1061 exclusion_string,
1062 print_channel_name(channel_name));
1063 break;
1064 case LTTNG_DOMAIN_JUL:
1065 case LTTNG_DOMAIN_LOG4J:
1066 case LTTNG_DOMAIN_PYTHON:
1067 /*
1068 * Don't print the default channel
1069 * name for agent domains.
1070 */
1071 MSG("%s event %s%s enabled",
1072 lttng_domain_type_str(dom.type),
1073 pattern.c_str(),
1074 exclusion_string);
1075 break;
1076 default:
1077 abort();
1078 }
1079 }
1080 free(exclusion_string);
1081 }
1082
1083 if (opt_filter) {
1084 char *exclusion_string;
1085
1086 /* Filter present */
1087 ev->filter = 1;
1088
1089 command_ret = lttng_enable_event_with_exclusions(
1090 handle,
1091 ev,
1092 channel_name,
1093 opt_filter,
1094 lttng_dynamic_pointer_array_get_count(&exclusions),
1095 (char **) exclusions.array.buffer.data);
1096 exclusion_string = print_exclusions(&exclusions);
1097 if (!exclusion_string) {
1098 PERROR("Cannot allocate exclusion_string");
1099 error = 1;
1100 goto end;
1101 }
1102 if (command_ret < 0) {
1103 switch (-command_ret) {
1104 case LTTNG_ERR_FILTER_EXIST:
1105 WARN("Filter on event %s%s is already enabled"
1106 " (channel %s, session %s)",
1107 pattern.c_str(),
1108 exclusion_string,
1109 print_channel_name(channel_name),
1110 session_name.c_str());
1111 warn = 1;
1112 break;
1113 case LTTNG_ERR_TRACE_ALREADY_STARTED:
1114 {
1115 const char *msg =
1116 "The command tried to enable an event in a new domain for a session that has already been started once.";
1117 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')",
1118 ev->name,
1119 exclusion_string,
1120 msg,
1121 print_channel_name(channel_name),
1122 session_name.c_str(),
1123 opt_filter);
1124 error = 1;
1125 break;
1126 }
1127 default:
1128 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')",
1129 ev->name,
1130 exclusion_string,
1131 lttng_strerror(command_ret),
1132 command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME ?
1133 print_raw_channel_name(channel_name) :
1134 print_channel_name(channel_name),
1135 session_name.c_str(),
1136 opt_filter);
1137 error = 1;
1138 break;
1139 }
1140 error_holder = command_ret;
1141
1142 } else {
1143 MSG("Event %s%s: Filter '%s' successfully set",
1144 pattern.c_str(),
1145 exclusion_string,
1146 opt_filter);
1147 }
1148 free(exclusion_string);
1149 }
1150
1151 if (lttng_opt_mi) {
1152 if (command_ret) {
1153 success = 0;
1154 ev->enabled = 0;
1155 } else {
1156 ev->enabled = 1;
1157 }
1158
1159 ret = mi_lttng_event(writer.get(), ev, 1, handle->domain.type);
1160 if (ret) {
1161 ret = CMD_ERROR;
1162 goto error;
1163 }
1164
1165 /* print exclusion */
1166 ret = mi_print_exclusion(&exclusions);
1167 if (ret) {
1168 ret = CMD_ERROR;
1169 goto error;
1170 }
1171
1172 /* Success ? */
1173 ret = mi_lttng_writer_write_element_bool(
1174 writer.get(), mi_lttng_element_command_success, success);
1175 if (ret) {
1176 ret = CMD_ERROR;
1177 goto end;
1178 }
1179
1180 /* Close event element */
1181 ret = mi_lttng_writer_close_element(writer.get());
1182 if (ret) {
1183 ret = CMD_ERROR;
1184 goto end;
1185 }
1186 }
1187
1188 /* Reset warn, error and success */
1189 success = 1;
1190 }
1191
1192 end:
1193 /* Close Mi */
1194 if (lttng_opt_mi) {
1195 /* Close events element */
1196 ret = mi_lttng_writer_close_element(writer.get());
1197 if (ret) {
1198 ret = CMD_ERROR;
1199 goto error;
1200 }
1201 }
1202 error:
1203 if (warn) {
1204 ret = CMD_WARNING;
1205 }
1206 if (error) {
1207 ret = CMD_ERROR;
1208 }
1209 lttng_destroy_handle(handle);
1210 lttng_dynamic_pointer_array_reset(&exclusions);
1211 lttng_userspace_probe_location_destroy(uprobe_loc);
1212
1213 /* Overwrite ret with error_holder if there was an actual error with
1214 * enabling an event.
1215 */
1216 ret = error_holder ? error_holder : ret;
1217
1218 lttng_event_destroy(ev);
1219 return ret;
1220 }
1221
1222 void _poptContextFree_deleter_func(poptContext ctx)
1223 {
1224 poptFreeContext(ctx);
1225 }
1226
1227 } /* namespace */
1228
1229 int validate_exclusion_list(const char *pattern,
1230 const struct lttng_dynamic_pointer_array *exclusions)
1231 {
1232 int ret;
1233
1234 /* Event name must be a valid globbing pattern to allow exclusions. */
1235 if (!strutils_is_star_glob_pattern(pattern)) {
1236 ERR("Event %s: Exclusions can only be used with a globbing pattern", pattern);
1237 goto error;
1238 }
1239
1240 /*
1241 * If the event name is a star-at-end only globbing pattern,
1242 * then we can validate the individual exclusions. Otherwise
1243 * all exclusions are passed to the session daemon.
1244 */
1245 if (strutils_is_star_at_the_end_only_glob_pattern(pattern)) {
1246 size_t i, num_exclusions;
1247
1248 num_exclusions = lttng_dynamic_pointer_array_get_count(exclusions);
1249
1250 for (i = 0; i < num_exclusions; i++) {
1251 const char *exclusion =
1252 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions,
1253 i);
1254
1255 if (!strutils_is_star_glob_pattern(exclusion) ||
1256 strutils_is_star_at_the_end_only_glob_pattern(exclusion)) {
1257 ret = check_exclusion_subsets(pattern, exclusion);
1258 if (ret) {
1259 goto error;
1260 }
1261 }
1262 }
1263 }
1264
1265 ret = 0;
1266 goto end;
1267
1268 error:
1269 ret = -1;
1270
1271 end:
1272 return ret;
1273 }
1274
1275 /*
1276 * Add event to trace session
1277 */
1278 int cmd_enable_events(int argc, const char **argv)
1279 {
1280 int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1;
1281 std::string session_name;
1282 const char *arg_event_list = nullptr;
1283 const char *leftover = nullptr;
1284 int event_type = -1;
1285 event_rule_patterns patterns;
1286 std::stringstream event_list_arg_stream(arg_event_list);
1287
1288 auto pc = lttng::make_unique_wrapper<poptContext_s, _poptContextFree_deleter_func>(
1289 poptGetContext(nullptr, argc, argv, long_options, 0));
1290 poptReadDefaultConfig(pc.get(), 0);
1291
1292 /* Default event type */
1293 opt_event_type = LTTNG_EVENT_ALL;
1294
1295 while ((opt = poptGetNextOpt(pc.get())) != -1) {
1296 switch (opt) {
1297 case OPT_HELP:
1298 SHOW_HELP();
1299 return CMD_SUCCESS;
1300 case OPT_TRACEPOINT:
1301 opt_event_type = LTTNG_EVENT_TRACEPOINT;
1302 break;
1303 case OPT_PROBE:
1304 opt_event_type = LTTNG_EVENT_PROBE;
1305 break;
1306 case OPT_USERSPACE_PROBE:
1307 opt_event_type = LTTNG_EVENT_USERSPACE_PROBE;
1308 break;
1309 case OPT_FUNCTION:
1310 opt_event_type = LTTNG_EVENT_FUNCTION;
1311 break;
1312 case OPT_SYSCALL:
1313 opt_event_type = LTTNG_EVENT_SYSCALL;
1314 break;
1315 case OPT_USERSPACE:
1316 opt_userspace = 1;
1317 break;
1318 case OPT_LOGLEVEL:
1319 opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_RANGE;
1320 opt_loglevel = poptGetOptArg(pc.get());
1321 break;
1322 case OPT_LOGLEVEL_ONLY:
1323 opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_SINGLE;
1324 opt_loglevel = poptGetOptArg(pc.get());
1325 break;
1326 case OPT_LIST_OPTIONS:
1327 list_cmd_options(stdout, long_options);
1328 return CMD_SUCCESS;
1329 case OPT_FILTER:
1330 break;
1331 case OPT_EXCLUDE:
1332 break;
1333 default:
1334 return CMD_UNDEFINED;
1335 }
1336
1337 /* Validate event type. Multiple event type are not supported. */
1338 if (event_type == -1) {
1339 event_type = opt_event_type;
1340 } else {
1341 if (event_type != opt_event_type) {
1342 ERR("Multiple event type not supported.");
1343 return CMD_ERROR;
1344 }
1345 }
1346 }
1347
1348 ret = print_missing_or_multiple_domains(
1349 opt_kernel + opt_userspace + opt_jul + opt_log4j + opt_python, true);
1350 if (ret) {
1351 return CMD_ERROR;
1352 }
1353
1354 /* Mi check */
1355 if (lttng_opt_mi) {
1356 writer = mi_writer_uptr(mi_lttng_writer_create(fileno(stdout), lttng_opt_mi));
1357 if (!writer) {
1358 LTTNG_THROW_ERROR(lttng::format(
1359 "Failed to create MI writer: format_code={}", lttng_opt_mi));
1360 }
1361
1362 /* Open command element */
1363 ret = mi_lttng_writer_command_open(writer.get(),
1364 mi_lttng_element_command_enable_event);
1365 if (ret) {
1366 LTTNG_THROW_ERROR(lttng::format(
1367 "Failed to open MI command element: command_name=`{}`",
1368 mi_lttng_element_command_enable_event));
1369 }
1370
1371 /* Open output element */
1372 ret = mi_lttng_writer_open_element(writer.get(), mi_lttng_element_command_output);
1373 if (ret) {
1374 LTTNG_THROW_ERROR(
1375 lttng::format("Failed to open MI element: element_name=`{}`",
1376 mi_lttng_element_command_output));
1377 }
1378 }
1379
1380 /* Close the MI command context when leaving the function, no matter the result. */
1381 const auto close_mi_on_exit = lttng::make_scope_exit([&success]() noexcept {
1382 if (!lttng_opt_mi) {
1383 return;
1384 }
1385
1386 /* Close output element. */
1387 if (mi_lttng_writer_close_element(writer.get())) {
1388 ERR_FMT("Failed to close MI output element");
1389 return;
1390 }
1391
1392 if (mi_lttng_writer_write_element_bool(
1393 writer.get(), mi_lttng_element_command_success, success)) {
1394 ERR_FMT("Failed to write MI element: element_name=`{}`, value={}",
1395 mi_lttng_element_command_success,
1396 success);
1397 return;
1398 }
1399
1400 /* Command element close. */
1401 if (mi_lttng_writer_command_close(writer.get())) {
1402 ERR_FMT("Failed to close MI command element");
1403 return;
1404 }
1405 });
1406
1407 arg_event_list = poptGetArg(pc.get());
1408 if (arg_event_list == nullptr && opt_enable_all == 0) {
1409 ERR("Missing event name(s).");
1410 return CMD_ERROR;
1411 }
1412
1413 for (std::string line; std::getline(event_list_arg_stream, line, ',');) {
1414 patterns.emplace_back(std::move(line));
1415 }
1416
1417 leftover = poptGetArg(pc.get());
1418 if (leftover) {
1419 ERR("Unknown argument: %s", leftover);
1420 return CMD_ERROR;
1421 }
1422
1423 if (!opt_session_name) {
1424 const auto rc_file_session_name =
1425 lttng::make_unique_wrapper<char, lttng::free>(get_session_name());
1426
1427 if (!rc_file_session_name) {
1428 return CMD_ERROR;
1429 }
1430
1431 session_name = rc_file_session_name.get();
1432 } else {
1433 session_name = opt_session_name;
1434 }
1435
1436 command_ret = enable_events(session_name, patterns);
1437 if (command_ret) {
1438 return CMD_ERROR;
1439 }
1440
1441 return CMD_SUCCESS;
1442 }
LTTng 2.0 tools and control repository
This page took 0.062566 seconds and 3 git commands to generate.