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("Event %s: %s excludes all events from %s", pattern
, exclusion
, pattern
);
327 * Reached the end of the event name before the
328 * end of the exclusion: this is valid.
350 WARN("Event %s: %s does not exclude any events from %s",
359 int create_exclusion_list_and_validate(const char *pattern
,
360 const char *exclusions_arg
,
361 struct lttng_dynamic_pointer_array
*exclusions
)
365 /* Split exclusions. */
366 ret
= strutils_split(exclusions_arg
, ',', true, exclusions
);
371 if (validate_exclusion_list(pattern
, exclusions
) != 0) {
379 lttng_dynamic_pointer_array_reset(exclusions
);
385 void warn_on_truncated_exclusion_names(const struct lttng_dynamic_pointer_array
*exclusions
,
389 const size_t num_exclusions
= lttng_dynamic_pointer_array_get_count(exclusions
);
391 for (i
= 0; i
< num_exclusions
; i
++) {
392 const char *const exclusion
=
393 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions
, i
);
395 if (strlen(exclusion
) >= LTTNG_SYMBOL_NAME_LEN
) {
396 WARN("Event exclusion \"%s\" will be truncated", exclusion
);
403 * Enabling event using the lttng API.
404 * Note: in case of error only the last error code will be return.
406 int enable_events(const std::string
& session_name
, const event_rule_patterns
& patterns
)
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;
416 lttng_dynamic_pointer_array_init(&exclusions
, nullptr);
418 ev
= lttng_event_create();
426 WARN("Kernel loglevels are not supported.");
430 /* Create lttng domain */
432 dom
.type
= LTTNG_DOMAIN_KERNEL
;
433 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
434 } else if (opt_userspace
) {
435 dom
.type
= LTTNG_DOMAIN_UST
;
437 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
438 } else if (opt_jul
) {
439 dom
.type
= LTTNG_DOMAIN_JUL
;
441 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
442 } else if (opt_log4j
) {
443 dom
.type
= LTTNG_DOMAIN_LOG4J
;
445 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
446 } else if (opt_python
) {
447 dom
.type
= LTTNG_DOMAIN_PYTHON
;
449 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
451 /* Checked by the caller. */
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
));
465 case LTTNG_DOMAIN_UST
:
466 /* Exclusions supported */
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.
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
:
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
));
497 channel_name
= opt_channel_name
;
499 handle
= lttng_create_handle(session_name
.c_str(), &dom
);
500 if (handle
== nullptr) {
507 /* Open a events element */
508 ret
= mi_lttng_writer_open_element(writer
.get(), config_element_events
);
515 if (opt_enable_all
) {
516 /* Default setup for enable all */
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
;
523 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
524 strcpy(ev
->name
, "*");
525 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
529 LTTNG_ASSERT(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
532 enum lttng_loglevel loglevel
;
535 loglevel_name_to_value(opt_loglevel
, &loglevel
);
536 ev
->loglevel
= (int) loglevel
;
537 } else if (opt_jul
) {
538 enum lttng_loglevel_jul loglevel
;
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
;
546 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
,
548 ev
->loglevel
= (int) loglevel
;
551 enum lttng_loglevel_python loglevel
;
553 name_search_ret
= loglevel_python_name_to_value(
554 opt_loglevel
, &loglevel
);
555 ev
->loglevel
= (int) loglevel
;
558 if (name_search_ret
== -1) {
559 ERR("Unknown loglevel %s", opt_loglevel
);
560 ret
= -LTTNG_ERR_INVALID
;
564 LTTNG_ASSERT(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
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
;
578 ret
= create_exclusion_list_and_validate("*", opt_exclude
, &exclusions
);
585 warn_on_truncated_exclusion_names(&exclusions
, &warn
);
588 ret
= lttng_enable_event_with_exclusions(
593 lttng_dynamic_pointer_array_get_count(&exclusions
),
594 (char **) exclusions
.array
.buffer
.data
);
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());
603 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
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)",
609 print_channel_name(channel_name
),
610 session_name
.c_str());
615 ERR("Events: %s (channel %s, session %s)",
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());
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
);
632 if (!exclusion_string
) {
633 PERROR("Cannot allocate exclusion_string");
637 MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
638 lttng_domain_type_str(dom
.type
),
640 print_channel_name(channel_name
),
642 free(exclusion_string
);
644 char *exclusion_string
= print_exclusions(&exclusions
);
646 if (!exclusion_string
) {
647 PERROR("Cannot allocate exclusion_string");
651 MSG("All %s tracepoints%s are enabled in channel %s",
652 lttng_domain_type_str(dom
.type
),
654 print_channel_name(channel_name
));
655 free(exclusion_string
);
658 case LTTNG_EVENT_SYSCALL
:
660 MSG("All %s system calls are enabled in channel %s",
661 lttng_domain_type_str(dom
.type
),
662 print_channel_name(channel_name
));
665 case LTTNG_EVENT_ALL
:
666 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
667 char *exclusion_string
= print_exclusions(&exclusions
);
669 if (!exclusion_string
) {
670 PERROR("Cannot allocate exclusion_string");
674 MSG("All %s events%s are enabled in channel %s for loglevel %s",
675 lttng_domain_type_str(dom
.type
),
677 print_channel_name(channel_name
),
679 free(exclusion_string
);
681 char *exclusion_string
= print_exclusions(&exclusions
);
683 if (!exclusion_string
) {
684 PERROR("Cannot allocate exclusion_string");
688 MSG("All %s events%s are enabled in channel %s",
689 lttng_domain_type_str(dom
.type
),
691 print_channel_name(channel_name
));
692 free(exclusion_string
);
697 * We should not be here since lttng_enable_event should have
698 * failed on the event type.
705 command_ret
= lttng_enable_event_with_exclusions(
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());
721 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
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\')",
727 print_channel_name(channel_name
),
728 session_name
.c_str(),
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(),
744 error_holder
= command_ret
;
747 MSG("Filter '%s' successfully set", opt_filter
);
752 /* The wildcard * is used for kernel and ust domain to
753 * represent ALL. We copy * in event name to force the wildcard use
756 * Note: this is strictly for semantic and printing while in
757 * machine interface mode.
759 strcpy(ev
->name
, "*");
761 /* If we reach here the events are enabled */
762 if (!error
&& !warn
) {
768 ret
= mi_lttng_event(writer
.get(), ev
, 1, handle
->domain
.type
);
774 /* print exclusion */
775 ret
= mi_print_exclusion(&exclusions
);
782 ret
= mi_lttng_writer_write_element_bool(
783 writer
.get(), mi_lttng_element_command_success
, success
);
789 /* Close event element */
790 ret
= mi_lttng_writer_close_element(writer
.get());
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
;
807 /* Kernel tracer action */
809 DBG_FMT("Enabling kernel event: pattern=`{}`, channel_name=`{}`",
811 print_channel_name(channel_name
));
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
;
820 case LTTNG_EVENT_TRACEPOINT
:
822 case LTTNG_EVENT_PROBE
:
823 ret
= parse_probe_opts(ev
, opt_probe
);
825 ERR("Unable to parse probe options");
830 case LTTNG_EVENT_USERSPACE_PROBE
:
831 LTTNG_ASSERT(ev
->type
== LTTNG_EVENT_USERSPACE_PROBE
);
833 ret
= parse_userspace_probe_opts(opt_userspace_probe
, &uprobe_loc
);
836 case CMD_UNSUPPORTED
:
838 * Error message describing
839 * what is not supported was
840 * printed in the function.
845 ERR("Unable to parse userspace probe options");
851 ret
= lttng_event_set_userspace_probe_location(ev
, uprobe_loc
);
853 WARN("Failed to set probe location on event");
858 /* Ownership of the uprobe location was transferred to the event. */
859 uprobe_loc
= nullptr;
861 case LTTNG_EVENT_FUNCTION
:
862 ret
= parse_probe_opts(ev
, opt_function
);
864 ERR("Unable to parse function probe options");
869 case LTTNG_EVENT_SYSCALL
:
870 ev
->type
= LTTNG_EVENT_SYSCALL
;
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",
882 print_channel_name(channel_name
),
883 opt_loglevel
?: "<all>");
885 switch (opt_event_type
) {
886 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
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';
894 case LTTNG_EVENT_PROBE
:
895 case LTTNG_EVENT_FUNCTION
:
896 case LTTNG_EVENT_SYSCALL
:
897 case LTTNG_EVENT_USERSPACE_PROBE
:
899 ERR("Event type not available for user-space tracing");
900 ret
= CMD_UNSUPPORTED
;
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");
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
);
921 warn_on_truncated_exclusion_names(&exclusions
, &warn
);
924 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
926 enum lttng_loglevel loglevel
;
927 const int name_search_ret
=
928 loglevel_name_to_value(opt_loglevel
, &loglevel
);
930 if (name_search_ret
== -1) {
931 ERR("Unknown loglevel %s", opt_loglevel
);
932 ret
= -LTTNG_ERR_INVALID
;
936 ev
->loglevel
= (int) loglevel
;
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
;
948 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
953 enum lttng_loglevel_jul loglevel
;
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
;
961 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
,
963 ev
->loglevel
= (int) loglevel
;
966 enum lttng_loglevel_python loglevel
;
968 name_search_ret
= loglevel_python_name_to_value(
969 opt_loglevel
, &loglevel
);
970 ev
->loglevel
= (int) loglevel
;
973 if (name_search_ret
) {
974 ERR("Unknown loglevel %s", opt_loglevel
);
975 ret
= -LTTNG_ERR_INVALID
;
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
;
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';
995 char *exclusion_string
;
997 command_ret
= lttng_enable_event_with_exclusions(
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");
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)",
1017 print_channel_name(channel_name
),
1018 session_name
.c_str());
1021 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
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)",
1029 print_channel_name(channel_name
),
1030 session_name
.c_str());
1034 case LTTNG_ERR_SDT_PROBE_SEMAPHORE
:
1035 ERR("SDT probes %s guarded by semaphores are not supported (channel %s, session %s)",
1037 print_channel_name(channel_name
),
1038 session_name
.c_str());
1042 ERR("Event %s%s: %s (channel %s, session %s)",
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());
1053 error_holder
= command_ret
;
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
),
1062 print_channel_name(channel_name
));
1064 case LTTNG_DOMAIN_JUL
:
1065 case LTTNG_DOMAIN_LOG4J
:
1066 case LTTNG_DOMAIN_PYTHON
:
1068 * Don't print the default channel
1069 * name for agent domains.
1071 MSG("%s event %s%s enabled",
1072 lttng_domain_type_str(dom
.type
),
1080 free(exclusion_string
);
1084 char *exclusion_string
;
1086 /* Filter present */
1089 command_ret
= lttng_enable_event_with_exclusions(
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");
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)",
1109 print_channel_name(channel_name
),
1110 session_name
.c_str());
1113 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
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\')",
1121 print_channel_name(channel_name
),
1122 session_name
.c_str(),
1128 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')",
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(),
1140 error_holder
= command_ret
;
1143 MSG("Event %s%s: Filter '%s' successfully set",
1148 free(exclusion_string
);
1159 ret
= mi_lttng_event(writer
.get(), ev
, 1, handle
->domain
.type
);
1165 /* print exclusion */
1166 ret
= mi_print_exclusion(&exclusions
);
1173 ret
= mi_lttng_writer_write_element_bool(
1174 writer
.get(), mi_lttng_element_command_success
, success
);
1180 /* Close event element */
1181 ret
= mi_lttng_writer_close_element(writer
.get());
1188 /* Reset warn, error and success */
1195 /* Close events element */
1196 ret
= mi_lttng_writer_close_element(writer
.get());
1209 lttng_destroy_handle(handle
);
1210 lttng_dynamic_pointer_array_reset(&exclusions
);
1211 lttng_userspace_probe_location_destroy(uprobe_loc
);
1213 /* Overwrite ret with error_holder if there was an actual error with
1214 * enabling an event.
1216 ret
= error_holder
? error_holder
: ret
;
1218 lttng_event_destroy(ev
);
1222 void _poptContextFree_deleter_func(poptContext ctx
)
1224 poptFreeContext(ctx
);
1229 int validate_exclusion_list(const char *pattern
,
1230 const struct lttng_dynamic_pointer_array
*exclusions
)
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
);
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.
1245 if (strutils_is_star_at_the_end_only_glob_pattern(pattern
)) {
1246 size_t i
, num_exclusions
;
1248 num_exclusions
= lttng_dynamic_pointer_array_get_count(exclusions
);
1250 for (i
= 0; i
< num_exclusions
; i
++) {
1251 const char *exclusion
=
1252 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions
,
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
);
1276 * Add event to trace session
1278 int cmd_enable_events(int argc
, const char **argv
)
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
);
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);
1292 /* Default event type */
1293 opt_event_type
= LTTNG_EVENT_ALL
;
1295 while ((opt
= poptGetNextOpt(pc
.get())) != -1) {
1300 case OPT_TRACEPOINT
:
1301 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
1304 opt_event_type
= LTTNG_EVENT_PROBE
;
1306 case OPT_USERSPACE_PROBE
:
1307 opt_event_type
= LTTNG_EVENT_USERSPACE_PROBE
;
1310 opt_event_type
= LTTNG_EVENT_FUNCTION
;
1313 opt_event_type
= LTTNG_EVENT_SYSCALL
;
1319 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
1320 opt_loglevel
= poptGetOptArg(pc
.get());
1322 case OPT_LOGLEVEL_ONLY
:
1323 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
1324 opt_loglevel
= poptGetOptArg(pc
.get());
1326 case OPT_LIST_OPTIONS
:
1327 list_cmd_options(stdout
, long_options
);
1334 return CMD_UNDEFINED
;
1337 /* Validate event type. Multiple event type are not supported. */
1338 if (event_type
== -1) {
1339 event_type
= opt_event_type
;
1341 if (event_type
!= opt_event_type
) {
1342 ERR("Multiple event type not supported.");
1348 ret
= print_missing_or_multiple_domains(
1349 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
+ opt_python
, true);
1356 writer
= mi_writer_uptr(mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
));
1358 LTTNG_THROW_ERROR(lttng::format(
1359 "Failed to create MI writer: format_code={}", lttng_opt_mi
));
1362 /* Open command element */
1363 ret
= mi_lttng_writer_command_open(writer
.get(),
1364 mi_lttng_element_command_enable_event
);
1366 LTTNG_THROW_ERROR(lttng::format(
1367 "Failed to open MI command element: command_name=`{}`",
1368 mi_lttng_element_command_enable_event
));
1371 /* Open output element */
1372 ret
= mi_lttng_writer_open_element(writer
.get(), mi_lttng_element_command_output
);
1375 lttng::format("Failed to open MI element: element_name=`{}`",
1376 mi_lttng_element_command_output
));
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
) {
1386 /* Close output element. */
1387 if (mi_lttng_writer_close_element(writer
.get())) {
1388 ERR_FMT("Failed to close MI output element");
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
,
1400 /* Command element close. */
1401 if (mi_lttng_writer_command_close(writer
.get())) {
1402 ERR_FMT("Failed to close MI command element");
1407 arg_event_list
= poptGetArg(pc
.get());
1408 if (arg_event_list
== nullptr && opt_enable_all
== 0) {
1409 ERR("Missing event name(s).");
1413 for (std::string line
; std::getline(event_list_arg_stream
, line
, ',');) {
1414 patterns
.emplace_back(std::move(line
));
1417 leftover
= poptGetArg(pc
.get());
1419 ERR("Unknown argument: %s", leftover
);
1423 if (!opt_session_name
) {
1424 const auto rc_file_session_name
=
1425 lttng::make_unique_wrapper
<char, lttng::free
>(get_session_name());
1427 if (!rc_file_session_name
) {
1431 session_name
= rc_file_session_name
.get();
1433 session_name
= opt_session_name
;
1436 command_ret
= enable_events(session_name
, patterns
);