2 * Copyright (C) 2011 EfficiOS Inc.
4 * SPDX-License-Identifier: GPL-2.0-only
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>
25 #include <sys/types.h>
30 #include "../command.hpp"
31 #include "../loglevel.hpp"
32 #include "../uprobe.hpp"
34 #include <common/mi-lttng.hpp>
36 #include <lttng/domain-internal.hpp>
37 #include <lttng/event-internal.hpp>
39 #if (LTTNG_SYMBOL_NAME_LEN == 256)
40 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
44 void _mi_lttng_writer_deleter_func(mi_writer
*writer
)
46 if (writer
&& mi_lttng_writer_destroy(writer
)) {
47 LTTNG_THROW_ERROR("Failed to destroy mi_writer instance");
51 using mi_writer_uptr
= std::unique_ptr
<
53 lttng::memory::create_deleter_class
<mi_writer
, _mi_lttng_writer_deleter_func
>::deleter
>;
54 using event_rule_patterns
= std::vector
<std::string
>;
57 const char *opt_loglevel
;
58 int opt_loglevel_type
;
60 char *opt_session_name
;
67 char *opt_userspace_probe
;
69 char *opt_channel_name
;
73 struct lttng_handle
*handle
;
74 mi_writer_uptr writer
;
76 #ifdef LTTNG_EMBED_HELP
77 static const char help_msg
[] =
78 #include <lttng-enable-event.1.h>
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 },
113 &opt_userspace_probe
,
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 }
128 * Parse probe options.
130 int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
132 int ret
= CMD_SUCCESS
;
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
];
138 if (opt
== nullptr) {
143 /* Check for symbol+offset */
145 "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
146 "[^'+']+%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s",
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
);
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;
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
);
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;
178 /* Check for address */
179 match
= sscanf(opt
, "%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", s_hex
);
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.
186 if (*s_hex
== '\0' || !isdigit(*s_hex
)) {
187 ERR("Invalid probe description `%s`", s_hex
);
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
);
205 const char *print_channel_name(const char *name
)
207 return name
?: DEFAULT_CHANNEL_NAME
;
210 const char *print_raw_channel_name(const char *name
)
212 return name
?: "<default>";
216 * Mi print exlcusion list
218 int mi_print_exclusion(const struct lttng_dynamic_pointer_array
*exclusions
)
222 const size_t count
= lttng_dynamic_pointer_array_get_count(exclusions
);
224 LTTNG_ASSERT(writer
);
231 ret
= mi_lttng_writer_open_element(writer
.get(), config_element_exclusions
);
236 for (i
= 0; i
< count
; i
++) {
237 const char *exclusion
=
238 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions
, i
);
240 ret
= mi_lttng_writer_write_element_string(
241 writer
.get(), config_element_exclusion
, exclusion
);
247 /* Close exclusions element */
248 ret
= mi_lttng_writer_close_element(writer
.get());
255 * Return allocated string for pretty-printing exclusion names.
257 char *print_exclusions(const struct lttng_dynamic_pointer_array
*exclusions
)
261 const char preamble
[] = " excluding ";
263 const size_t count
= lttng_dynamic_pointer_array_get_count(exclusions
);
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
);
274 length
+= strlen(exclusion
) + 4;
277 length
+= sizeof(preamble
);
278 ret
= calloc
<char>(length
);
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
);
289 strcat(ret
, exclusion
);
291 if (i
!= count
- 1) {
299 int check_exclusion_subsets(const char *pattern
, const char *exclusion
)
303 const char *e
= pattern
;
304 const char *x
= exclusion
;
306 /* Scan both the excluder and the event letter by letter */
320 /* Event is a subset of the excluder */
321 ERR("Exclusion pattern `%s` excludes all events from `%s`",
329 * Reached the end of the event name before the
330 * end of the exclusion: this is valid.
352 WARN("Exclusion pattern `%s` does not exclude any event from `%s`",
360 int create_exclusion_list_and_validate(const char *pattern
,
361 const char *exclusions_arg
,
362 struct lttng_dynamic_pointer_array
*exclusions
)
366 /* Split exclusions. */
367 ret
= strutils_split(exclusions_arg
, ',', true, exclusions
);
372 if (validate_exclusion_list(pattern
, exclusions
) != 0) {
380 lttng_dynamic_pointer_array_reset(exclusions
);
386 void warn_on_truncated_exclusion_names(const struct lttng_dynamic_pointer_array
*exclusions
,
390 const size_t num_exclusions
= lttng_dynamic_pointer_array_get_count(exclusions
);
392 for (i
= 0; i
< num_exclusions
; i
++) {
393 const char *const exclusion
=
394 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions
, i
);
396 if (strlen(exclusion
) >= LTTNG_SYMBOL_NAME_LEN
) {
397 WARN("Event exclusion \"%s\" will be truncated", exclusion
);
404 * Enabling event using the lttng API.
405 * Note: in case of error only the last error code will be return.
407 int enable_events(const std::string
& session_name
, const event_rule_patterns
& patterns
)
409 int ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
;
410 int error_holder
= CMD_SUCCESS
, warn
= 0, error
= 0, success
= 1;
411 char *channel_name
= nullptr;
412 struct lttng_event
*ev
;
413 struct lttng_domain dom
= {};
414 struct lttng_dynamic_pointer_array exclusions
;
415 struct lttng_userspace_probe_location
*uprobe_loc
= nullptr;
417 lttng_dynamic_pointer_array_init(&exclusions
, nullptr);
419 ev
= lttng_event_create();
427 WARN("Kernel log levels are not supported");
431 /* Create lttng domain */
433 dom
.type
= LTTNG_DOMAIN_KERNEL
;
434 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
435 } else if (opt_userspace
) {
436 dom
.type
= LTTNG_DOMAIN_UST
;
438 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
439 } else if (opt_jul
) {
440 dom
.type
= LTTNG_DOMAIN_JUL
;
442 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
443 } else if (opt_log4j
) {
444 dom
.type
= LTTNG_DOMAIN_LOG4J
;
446 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
447 } else if (opt_python
) {
448 dom
.type
= LTTNG_DOMAIN_PYTHON
;
450 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
452 /* Checked by the caller. */
458 case LTTNG_DOMAIN_KERNEL
:
459 case LTTNG_DOMAIN_JUL
:
460 case LTTNG_DOMAIN_LOG4J
:
461 case LTTNG_DOMAIN_PYTHON
:
462 ERR("Event name exclusions are not supported for %s event rules",
463 lttng_domain_type_str(dom
.type
));
466 case LTTNG_DOMAIN_UST
:
467 /* Exclusions supported */
475 * Adding a filter to a probe, function or userspace-probe would be
476 * denied by the kernel tracer as it's not supported at the moment. We
477 * do an early check here to warn the user.
479 if (opt_filter
&& opt_kernel
) {
480 switch (opt_event_type
) {
481 case LTTNG_EVENT_ALL
:
482 case LTTNG_EVENT_TRACEPOINT
:
483 case LTTNG_EVENT_SYSCALL
:
485 case LTTNG_EVENT_PROBE
:
486 case LTTNG_EVENT_USERSPACE_PROBE
:
487 case LTTNG_EVENT_FUNCTION
:
488 ERR("Filter expressions are not supported for %s event rules",
489 get_event_type_str((lttng_event_type
) opt_event_type
));
498 channel_name
= opt_channel_name
;
500 handle
= lttng_create_handle(session_name
.c_str(), &dom
);
501 if (handle
== nullptr) {
508 /* Open a events element */
509 ret
= mi_lttng_writer_open_element(writer
.get(), config_element_events
);
516 for (const auto& pattern
: patterns
) {
517 /* Copy name and type of the event */
518 strncpy(ev
->name
, pattern
.c_str(), LTTNG_SYMBOL_NAME_LEN
);
519 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
520 ev
->type
= (lttng_event_type
) opt_event_type
;
522 /* Kernel tracer action */
524 DBG_FMT("Enabling kernel event rule: pattern=`{}`, channel_name=`{}`",
526 print_channel_name(channel_name
));
528 switch (opt_event_type
) {
529 case LTTNG_EVENT_ALL
: /* Enable tracepoints and syscalls */
530 /* If event name differs from *, select tracepoint. */
531 if (strcmp(ev
->name
, "*") != 0) {
532 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
535 case LTTNG_EVENT_TRACEPOINT
:
537 case LTTNG_EVENT_PROBE
:
538 ret
= parse_probe_opts(ev
, opt_probe
);
540 ERR("Unable to parse probe options");
545 case LTTNG_EVENT_USERSPACE_PROBE
:
546 LTTNG_ASSERT(ev
->type
== LTTNG_EVENT_USERSPACE_PROBE
);
548 ret
= parse_userspace_probe_opts(opt_userspace_probe
, &uprobe_loc
);
551 case CMD_UNSUPPORTED
:
553 * Error message describing
554 * what is not supported was
555 * printed in the function.
560 ERR("Unable to parse user space probe options");
566 ret
= lttng_event_set_userspace_probe_location(ev
, uprobe_loc
);
568 WARN("Failed to set probe location on event");
573 /* Ownership of the uprobe location was transferred to the event. */
574 uprobe_loc
= nullptr;
576 case LTTNG_EVENT_FUNCTION
:
577 ret
= parse_probe_opts(ev
, opt_function
);
579 ERR("Unable to parse function probe options");
584 case LTTNG_EVENT_SYSCALL
:
585 ev
->type
= LTTNG_EVENT_SYSCALL
;
592 /* kernel loglevels not implemented */
593 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
594 } else if (opt_userspace
) { /* User-space tracer action */
595 DBG_FMT("Enabling user space event rule: pattern=`{}`, channel_name=`{}`, log_level=`{}`",
597 print_channel_name(channel_name
),
598 opt_loglevel
?: "all");
600 switch (opt_event_type
) {
601 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
603 case LTTNG_EVENT_TRACEPOINT
:
604 /* Copy name and type of the event */
605 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
606 strncpy(ev
->name
, pattern
.c_str(), LTTNG_SYMBOL_NAME_LEN
);
607 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
609 case LTTNG_EVENT_PROBE
:
610 case LTTNG_EVENT_FUNCTION
:
611 case LTTNG_EVENT_SYSCALL
:
612 case LTTNG_EVENT_USERSPACE_PROBE
:
614 ERR("Instrumentation point type not supported for the %s domain",
615 lttng_domain_type_str(dom
.type
));
616 ret
= CMD_UNSUPPORTED
;
622 if (opt_event_type
!= LTTNG_EVENT_ALL
&&
623 opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
624 ERR("Exclusion option can only be used with tracepoint events");
628 /* Free previously allocated items. */
629 lttng_dynamic_pointer_array_reset(&exclusions
);
630 ret
= create_exclusion_list_and_validate(
631 pattern
.c_str(), opt_exclude
, &exclusions
);
637 warn_on_truncated_exclusion_names(&exclusions
, &warn
);
640 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
642 enum lttng_loglevel loglevel
;
643 const int name_search_ret
=
644 loglevel_name_to_value(opt_loglevel
, &loglevel
);
646 if (name_search_ret
== -1) {
647 ERR("Unknown log level `%s`", opt_loglevel
);
648 ret
= -LTTNG_ERR_INVALID
;
652 ev
->loglevel
= (int) loglevel
;
656 } else if (opt_jul
|| opt_log4j
|| opt_python
) {
657 if (opt_event_type
!= LTTNG_EVENT_ALL
&&
658 opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
659 ERR("Instrumentation point type not supported for the %s domain",
660 lttng_domain_type_str(dom
.type
));
661 ret
= CMD_UNSUPPORTED
;
665 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
670 enum lttng_loglevel_jul loglevel
;
673 loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
674 ev
->loglevel
= (int) loglevel
;
675 } else if (opt_log4j
) {
676 enum lttng_loglevel_log4j loglevel
;
678 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
,
680 ev
->loglevel
= (int) loglevel
;
683 enum lttng_loglevel_python loglevel
;
685 name_search_ret
= loglevel_python_name_to_value(
686 opt_loglevel
, &loglevel
);
687 ev
->loglevel
= (int) loglevel
;
690 if (name_search_ret
) {
691 ERR("Unknown log level `%s`", opt_loglevel
);
692 ret
= -LTTNG_ERR_INVALID
;
697 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
698 } else if (opt_log4j
) {
699 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
700 } else if (opt_python
) {
701 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
704 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
705 strncpy(ev
->name
, pattern
.c_str(), LTTNG_SYMBOL_NAME_LEN
);
706 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
712 command_ret
= lttng_enable_event_with_exclusions(
717 lttng_dynamic_pointer_array_get_count(&exclusions
),
718 (char **) exclusions
.array
.buffer
.data
);
720 auto exclusion_string
=
721 lttng::make_unique_wrapper
<char, lttng::memory::free
>(
722 print_exclusions(&exclusions
));
723 if (!exclusion_string
) {
724 PERROR("Cannot allocate exclusion_string");
729 if (command_ret
< 0) {
730 /* Turn ret to positive value to handle the positive error code */
731 switch (-command_ret
) {
732 case LTTNG_ERR_KERN_EVENT_EXIST
:
733 WARN("Kernel event rule %s%s and attached to channel `%s` is already enabled (session `%s`)",
734 opt_enable_all
? "matching all events" :
735 (std::string("with pattern `") +
736 pattern
+ std::string("`"))
738 exclusion_string
.get(),
739 print_channel_name(channel_name
),
740 session_name
.c_str());
743 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
745 ERR("Can't enable an event in a new domain for a session that has already been started once (session `%s`)",
746 session_name
.c_str());
750 case LTTNG_ERR_SDT_PROBE_SEMAPHORE
:
751 ERR("Failed to enable event rule with pattern `%s` and attached to channel `%s` as SDT probes guarded by semaphores are not supported (session `%s`)",
753 print_channel_name(channel_name
),
754 session_name
.c_str());
758 ERR("Failed to enable event rule %s%s and attached to channel `%s`: %s (session `%s`)",
759 opt_enable_all
? "matching all events" :
760 (std::string("with pattern `") +
761 pattern
+ std::string("`"))
763 exclusion_string
.get(),
764 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
?
765 print_raw_channel_name(channel_name
) :
766 print_channel_name(channel_name
),
767 lttng_strerror(command_ret
),
768 session_name
.c_str());
771 print_kernel_tracer_status_error();
777 error_holder
= command_ret
;
780 case LTTNG_DOMAIN_KERNEL
:
781 case LTTNG_DOMAIN_UST
:
783 MSG("Enabled %s event rule %s%s and attached to channel `%s`",
784 lttng_domain_type_str(dom
.type
),
785 opt_enable_all
? "matching all events" :
786 (std::string("with pattern `") +
787 pattern
+ std::string("`"))
789 exclusion_string
.get(),
790 print_channel_name(channel_name
));
793 case LTTNG_DOMAIN_JUL
:
794 case LTTNG_DOMAIN_LOG4J
:
795 case LTTNG_DOMAIN_PYTHON
:
797 * Don't print the default channel
798 * name for agent domains.
800 MSG("Enabled %s event rule %s%s",
801 lttng_domain_type_str(dom
.type
),
802 opt_enable_all
? "matching all events" :
803 (std::string("with pattern `") +
804 pattern
+ std::string("`"))
806 exclusion_string
.get());
816 command_ret
= lttng_enable_event_with_exclusions(
821 lttng_dynamic_pointer_array_get_count(&exclusions
),
822 (char **) exclusions
.array
.buffer
.data
);
824 auto exclusion_string
=
825 lttng::make_unique_wrapper
<char, lttng::memory::free
>(
826 print_exclusions(&exclusions
));
827 if (!exclusion_string
) {
828 PERROR("Failed allocate exclusion string");
832 if (command_ret
< 0) {
833 switch (-command_ret
) {
834 case LTTNG_ERR_FILTER_EXIST
:
835 WARN("An event rule %s%s and filter expression `%s` is already attached to channel `%s`",
836 opt_enable_all
? "matching all events" :
837 (std::string("with pattern `") +
838 pattern
+ std::string("`"))
840 exclusion_string
.get(),
842 print_channel_name(channel_name
));
845 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
847 ERR("Can't enable an event in a new domain for a session that has already been started once (session `%s`)",
848 session_name
.c_str());
853 ERR("Failed to enable event rule %s%s, with filter expression `%s`, and attached to channel `%s`: %s (session `%s`)",
854 opt_enable_all
? "matching all events" :
855 (std::string("with pattern `") +
856 pattern
+ std::string("`"))
858 exclusion_string
.get(),
860 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
?
861 print_raw_channel_name(channel_name
) :
862 print_channel_name(channel_name
),
863 lttng_strerror(command_ret
),
864 session_name
.c_str());
868 print_kernel_tracer_status_error();
874 error_holder
= command_ret
;
876 MSG("Enabled %s event rule %s%s and filter expression `%s`",
877 lttng_domain_type_str(dom
.type
),
878 opt_enable_all
? "matching all events" :
879 (std::string("with pattern `") + pattern
+
883 exclusion_string
.get(),
896 ret
= mi_lttng_event(writer
.get(), ev
, 1, handle
->domain
.type
);
902 /* print exclusion */
903 ret
= mi_print_exclusion(&exclusions
);
910 ret
= mi_lttng_writer_write_element_bool(
911 writer
.get(), mi_lttng_element_command_success
, success
);
917 /* Close event element */
918 ret
= mi_lttng_writer_close_element(writer
.get());
925 /* Reset warn, error and success */
932 /* Close events element */
933 ret
= mi_lttng_writer_close_element(writer
.get());
946 lttng_destroy_handle(handle
);
947 lttng_dynamic_pointer_array_reset(&exclusions
);
948 lttng_userspace_probe_location_destroy(uprobe_loc
);
950 /* Overwrite ret with error_holder if there was an actual error with
953 ret
= error_holder
? error_holder
: ret
;
955 lttng_event_destroy(ev
);
959 void _poptContextFree_deleter_func(poptContext ctx
)
961 poptFreeContext(ctx
);
966 int validate_exclusion_list(const char *pattern
,
967 const struct lttng_dynamic_pointer_array
*exclusions
)
971 /* Event name pattern must be a valid globbing pattern to allow exclusions. */
972 if (!strutils_is_star_glob_pattern(pattern
)) {
973 ERR("Event name pattern must contain wildcard characters to use exclusions");
978 * If the event name is a star-at-end only globbing pattern,
979 * then we can validate the individual exclusions. Otherwise
980 * all exclusions are passed to the session daemon.
982 if (strutils_is_star_at_the_end_only_glob_pattern(pattern
)) {
983 size_t i
, num_exclusions
;
985 num_exclusions
= lttng_dynamic_pointer_array_get_count(exclusions
);
987 for (i
= 0; i
< num_exclusions
; i
++) {
988 const char *exclusion
=
989 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions
,
992 if (!strutils_is_star_glob_pattern(exclusion
) ||
993 strutils_is_star_at_the_end_only_glob_pattern(exclusion
)) {
994 ret
= check_exclusion_subsets(pattern
, exclusion
);
1013 * Add event to trace session
1015 int cmd_enable_events(int argc
, const char **argv
)
1017 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
1018 std::string session_name
;
1019 const char *arg_event_list
= nullptr;
1020 const char *leftover
= nullptr;
1021 int event_type
= -1;
1022 event_rule_patterns patterns
;
1024 auto pc
= lttng::make_unique_wrapper
<poptContext_s
, _poptContextFree_deleter_func
>(
1025 poptGetContext(nullptr, argc
, argv
, long_options
, 0));
1026 poptReadDefaultConfig(pc
.get(), 0);
1028 /* Default event type */
1029 opt_event_type
= LTTNG_EVENT_ALL
;
1031 while ((opt
= poptGetNextOpt(pc
.get())) != -1) {
1036 case OPT_TRACEPOINT
:
1037 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
1040 opt_event_type
= LTTNG_EVENT_PROBE
;
1042 case OPT_USERSPACE_PROBE
:
1043 opt_event_type
= LTTNG_EVENT_USERSPACE_PROBE
;
1046 opt_event_type
= LTTNG_EVENT_FUNCTION
;
1049 opt_event_type
= LTTNG_EVENT_SYSCALL
;
1055 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
1056 opt_loglevel
= poptGetOptArg(pc
.get());
1058 case OPT_LOGLEVEL_ONLY
:
1059 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
1060 opt_loglevel
= poptGetOptArg(pc
.get());
1062 case OPT_LIST_OPTIONS
:
1063 list_cmd_options(stdout
, long_options
);
1070 return CMD_UNDEFINED
;
1073 /* Validate event type. Multiple event type are not supported. */
1074 if (event_type
== -1) {
1075 event_type
= opt_event_type
;
1077 if (event_type
!= opt_event_type
) {
1078 ERR("Only one event type may be enabled at once");
1084 ret
= print_missing_or_multiple_domains(
1085 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
+ opt_python
, true);
1092 writer
= mi_writer_uptr(mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
));
1094 LTTNG_THROW_ERROR(lttng::format(
1095 "Failed to create MI writer: format_code={}", lttng_opt_mi
));
1098 /* Open command element */
1099 ret
= mi_lttng_writer_command_open(writer
.get(),
1100 mi_lttng_element_command_enable_event
);
1102 LTTNG_THROW_ERROR(lttng::format(
1103 "Failed to open MI command element: command_name=`{}`",
1104 mi_lttng_element_command_enable_event
));
1107 /* Open output element */
1108 ret
= mi_lttng_writer_open_element(writer
.get(), mi_lttng_element_command_output
);
1111 lttng::format("Failed to open MI element: element_name=`{}`",
1112 mi_lttng_element_command_output
));
1116 /* Close the MI command context when leaving the function, no matter the result. */
1117 const auto close_mi_on_exit
= lttng::make_scope_exit([&success
]() noexcept
{
1118 if (!lttng_opt_mi
) {
1122 /* Close output element. */
1123 if (mi_lttng_writer_close_element(writer
.get())) {
1124 ERR_FMT("Failed to close MI output element");
1128 if (mi_lttng_writer_write_element_bool(
1129 writer
.get(), mi_lttng_element_command_success
, success
)) {
1130 ERR_FMT("Failed to write MI element: element_name=`{}`, value={}",
1131 mi_lttng_element_command_success
,
1136 /* Command element close. */
1137 if (mi_lttng_writer_command_close(writer
.get())) {
1138 ERR_FMT("Failed to close MI command element");
1143 arg_event_list
= poptGetArg(pc
.get());
1144 if (arg_event_list
== nullptr && opt_enable_all
== 0) {
1145 ERR("Missing event name pattern(s)");
1149 if (opt_enable_all
) {
1150 patterns
.emplace_back("*");
1152 std::stringstream
event_list_arg_stream(arg_event_list
);
1154 for (std::string line
; std::getline(event_list_arg_stream
, line
, ',');) {
1155 patterns
.emplace_back(std::move(line
));
1159 leftover
= poptGetArg(pc
.get());
1161 ERR("Unknown argument: %s", leftover
);
1165 if (!opt_session_name
) {
1166 const auto rc_file_session_name
=
1167 lttng::make_unique_wrapper
<char, lttng::memory::free
>(get_session_name());
1169 if (!rc_file_session_name
) {
1173 session_name
= rc_file_session_name
.get();
1175 session_name
= opt_session_name
;
1178 command_ret
= enable_events(session_name
, patterns
);