2 * Copyright (C) 2011 EfficiOS Inc.
4 * SPDX-License-Identifier: GPL-2.0-only
13 #include <sys/types.h>
18 #include <common/sessiond-comm/sessiond-comm.hpp>
19 #include <common/compat/string.hpp>
20 #include <common/compat/getenv.hpp>
21 #include <common/string-utils/string-utils.hpp>
22 #include <common/utils.hpp>
25 #include <common/mi-lttng.hpp>
27 #include <lttng/domain-internal.hpp>
28 #include <lttng/event-internal.hpp>
30 #include "../command.hpp"
31 #include "../loglevel.hpp"
32 #include "../uprobe.hpp"
34 #if (LTTNG_SYMBOL_NAME_LEN == 256)
35 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
38 static int opt_event_type
;
39 static const char *opt_loglevel
;
40 static int opt_loglevel_type
;
41 static int opt_kernel
;
42 static char *opt_session_name
;
43 static int opt_userspace
;
46 static int opt_python
;
47 static int opt_enable_all
;
48 static char *opt_probe
;
49 static char *opt_userspace_probe
;
50 static char *opt_function
;
51 static char *opt_channel_name
;
52 static char *opt_filter
;
53 static char *opt_exclude
;
55 #ifdef LTTNG_EMBED_HELP
56 static const char help_msg
[] =
57 #include <lttng-enable-event.1.h>
76 static struct lttng_handle
*handle
;
77 static struct mi_writer
*writer
;
79 static struct poptOption long_options
[] = {
80 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
81 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
82 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
83 {"all", 'a', POPT_ARG_VAL
, &opt_enable_all
, 1, 0, 0},
84 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
85 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
86 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
87 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
88 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
89 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
90 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TRACEPOINT
, 0, 0},
91 {"probe", 0, POPT_ARG_STRING
, &opt_probe
, OPT_PROBE
, 0, 0},
92 {"userspace-probe",0, POPT_ARG_STRING
, &opt_userspace_probe
, OPT_USERSPACE_PROBE
, 0, 0},
93 {"function", 0, POPT_ARG_STRING
, &opt_function
, OPT_FUNCTION
, 0, 0},
94 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_SYSCALL
, 0, 0},
95 {"loglevel", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL
, 0, 0},
96 {"loglevel-only", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL_ONLY
, 0, 0},
97 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
98 {"filter", 'f', POPT_ARG_STRING
, &opt_filter
, OPT_FILTER
, 0, 0},
99 {"exclude", 'x', POPT_ARG_STRING
, &opt_exclude
, OPT_EXCLUDE
, 0, 0},
100 {0, 0, 0, 0, 0, 0, 0}
104 * Parse probe options.
106 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
108 int ret
= CMD_SUCCESS
;
111 #define S_HEX_LEN_SCANF_IS_A_BROKEN_API "18" /* 18 is (19 - 1) (\0 is extra) */
112 char name
[LTTNG_SYMBOL_NAME_LEN
];
119 /* Check for symbol+offset */
120 match
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
121 "[^'+']+%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", name
, s_hex
);
123 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
124 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
125 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
126 if (*s_hex
== '\0') {
127 ERR("Invalid probe offset %s", s_hex
);
131 ev
->attr
.probe
.offset
= strtoull(s_hex
, NULL
, 0);
132 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
133 ev
->attr
.probe
.addr
= 0;
137 /* Check for symbol */
138 if (isalpha(name
[0]) || name
[0] == '_') {
139 match
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
"s",
142 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
143 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
144 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
145 ev
->attr
.probe
.offset
= 0;
146 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
147 ev
->attr
.probe
.addr
= 0;
152 /* Check for address */
153 match
= sscanf(opt
, "%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", s_hex
);
156 * Return an error if the first character of the tentative
157 * address is NULL or not a digit. It can be "0" if the address
158 * is in hexadecimal and can be 1 to 9 if it's in decimal.
160 if (*s_hex
== '\0' || !isdigit(*s_hex
)) {
161 ERR("Invalid probe description %s", s_hex
);
165 ev
->attr
.probe
.addr
= strtoull(s_hex
, NULL
, 0);
166 DBG("probe addr %" PRIu64
, ev
->attr
.probe
.addr
);
167 ev
->attr
.probe
.offset
= 0;
168 memset(ev
->attr
.probe
.symbol_name
, 0, LTTNG_SYMBOL_NAME_LEN
);
180 const char *print_channel_name(const char *name
)
182 return name
? : DEFAULT_CHANNEL_NAME
;
186 const char *print_raw_channel_name(const char *name
)
188 return name
? : "<default>";
192 * Mi print exlcusion list
195 int mi_print_exclusion(const struct lttng_dynamic_pointer_array
*exclusions
)
199 const size_t count
= lttng_dynamic_pointer_array_get_count(exclusions
);
201 LTTNG_ASSERT(writer
);
208 ret
= mi_lttng_writer_open_element(writer
, config_element_exclusions
);
213 for (i
= 0; i
< count
; i
++) {
214 const char *exclusion
= (const char *) lttng_dynamic_pointer_array_get_pointer(
217 ret
= mi_lttng_writer_write_element_string(writer
,
218 config_element_exclusion
, exclusion
);
224 /* Close exclusions element */
225 ret
= mi_lttng_writer_close_element(writer
);
232 * Return allocated string for pretty-printing exclusion names.
235 char *print_exclusions(const struct lttng_dynamic_pointer_array
*exclusions
)
239 const char preamble
[] = " excluding ";
241 const size_t count
= lttng_dynamic_pointer_array_get_count(exclusions
);
247 /* Calculate total required length. */
248 for (i
= 0; i
< count
; i
++) {
249 const char *exclusion
= (const char *) lttng_dynamic_pointer_array_get_pointer(
252 length
+= strlen(exclusion
) + 4;
255 length
+= sizeof(preamble
);
256 ret
= calloc
<char>(length
);
261 strncpy(ret
, preamble
, length
);
262 for (i
= 0; i
< count
; i
++) {
263 const char *exclusion
= (const char *) lttng_dynamic_pointer_array_get_pointer(
267 strcat(ret
, exclusion
);
269 if (i
!= count
- 1) {
278 int check_exclusion_subsets(const char *event_name
, const char *exclusion
)
282 const char *e
= event_name
;
283 const char *x
= exclusion
;
285 /* Scan both the excluder and the event letter by letter */
299 /* Event is a subset of the excluder */
300 ERR("Event %s: %s excludes all events from %s",
301 event_name
, exclusion
, event_name
);
307 * Reached the end of the event name before the
308 * end of the exclusion: this is valid.
330 WARN("Event %s: %s does not exclude any events from %s",
331 event_name
, exclusion
, event_name
);
337 int validate_exclusion_list(const char *event_name
,
338 const struct lttng_dynamic_pointer_array
*exclusions
)
342 /* Event name must be a valid globbing pattern to allow exclusions. */
343 if (!strutils_is_star_glob_pattern(event_name
)) {
344 ERR("Event %s: Exclusions can only be used with a globbing pattern",
350 * If the event name is a star-at-end only globbing pattern,
351 * then we can validate the individual exclusions. Otherwise
352 * all exclusions are passed to the session daemon.
354 if (strutils_is_star_at_the_end_only_glob_pattern(event_name
)) {
355 size_t i
, num_exclusions
;
357 num_exclusions
= lttng_dynamic_pointer_array_get_count(exclusions
);
359 for (i
= 0; i
< num_exclusions
; i
++) {
360 const char *exclusion
=
361 (const char *) lttng_dynamic_pointer_array_get_pointer(
364 if (!strutils_is_star_glob_pattern(exclusion
) ||
365 strutils_is_star_at_the_end_only_glob_pattern(exclusion
)) {
366 ret
= check_exclusion_subsets(event_name
, exclusion
);
384 static int create_exclusion_list_and_validate(const char *event_name
,
385 const char *exclusions_arg
,
386 struct lttng_dynamic_pointer_array
*exclusions
)
390 /* Split exclusions. */
391 ret
= strutils_split(exclusions_arg
, ',', true, exclusions
);
396 if (validate_exclusion_list(event_name
, exclusions
) !=
405 lttng_dynamic_pointer_array_reset(exclusions
);
411 static void warn_on_truncated_exclusion_names(const struct lttng_dynamic_pointer_array
*exclusions
,
415 const size_t num_exclusions
= lttng_dynamic_pointer_array_get_count(exclusions
);
417 for (i
= 0; i
< num_exclusions
; i
++) {
418 const char * const exclusion
= (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions
, i
);
420 if (strlen(exclusion
) >= LTTNG_SYMBOL_NAME_LEN
) {
421 WARN("Event exclusion \"%s\" will be truncated",
429 * Enabling event using the lttng API.
430 * Note: in case of error only the last error code will be return.
432 static int enable_events(char *session_name
, char *event_list
)
434 int ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
;
435 int error_holder
= CMD_SUCCESS
, warn
= 0, error
= 0, success
= 1;
436 char *event_name
, *channel_name
= NULL
;
437 struct lttng_event
*ev
;
438 struct lttng_domain dom
= {};
439 struct lttng_dynamic_pointer_array exclusions
;
440 struct lttng_userspace_probe_location
*uprobe_loc
= NULL
;
442 lttng_dynamic_pointer_array_init(&exclusions
, NULL
);
444 ev
= lttng_event_create();
452 WARN("Kernel loglevels are not supported.");
456 /* Create lttng domain */
458 dom
.type
= LTTNG_DOMAIN_KERNEL
;
459 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
460 } else if (opt_userspace
) {
461 dom
.type
= LTTNG_DOMAIN_UST
;
463 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
464 } else if (opt_jul
) {
465 dom
.type
= LTTNG_DOMAIN_JUL
;
467 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
468 } else if (opt_log4j
) {
469 dom
.type
= LTTNG_DOMAIN_LOG4J
;
471 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
472 } else if (opt_python
) {
473 dom
.type
= LTTNG_DOMAIN_PYTHON
;
475 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
477 /* Checked by the caller. */
483 case LTTNG_DOMAIN_KERNEL
:
484 case LTTNG_DOMAIN_JUL
:
485 case LTTNG_DOMAIN_LOG4J
:
486 case LTTNG_DOMAIN_PYTHON
:
487 ERR("Event name exclusions are not yet implemented for %s events",
488 lttng_domain_type_str(dom
.type
));
491 case LTTNG_DOMAIN_UST
:
492 /* Exclusions supported */
500 * Adding a filter to a probe, function or userspace-probe would be
501 * denied by the kernel tracer as it's not supported at the moment. We
502 * do an early check here to warn the user.
504 if (opt_filter
&& opt_kernel
) {
505 switch (opt_event_type
) {
506 case LTTNG_EVENT_ALL
:
507 case LTTNG_EVENT_TRACEPOINT
:
508 case LTTNG_EVENT_SYSCALL
:
510 case LTTNG_EVENT_PROBE
:
511 case LTTNG_EVENT_USERSPACE_PROBE
:
512 case LTTNG_EVENT_FUNCTION
:
513 ERR("Filter expressions are not supported for %s events",
514 get_event_type_str((lttng_event_type
) opt_event_type
));
523 channel_name
= opt_channel_name
;
525 handle
= lttng_create_handle(session_name
, &dom
);
526 if (handle
== NULL
) {
533 /* Open a events element */
534 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
541 if (opt_enable_all
) {
542 /* Default setup for enable all */
544 ev
->type
= (lttng_event_type
) opt_event_type
;
545 strcpy(ev
->name
, "*");
546 /* kernel loglevels not implemented */
547 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
549 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
550 strcpy(ev
->name
, "*");
551 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
555 LTTNG_ASSERT(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
558 enum lttng_loglevel loglevel
;
560 name_search_ret
= loglevel_name_to_value(opt_loglevel
, &loglevel
);
561 ev
->loglevel
= (int) loglevel
;
562 } else if (opt_jul
) {
563 enum lttng_loglevel_jul loglevel
;
565 name_search_ret
= loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
566 ev
->loglevel
= (int) loglevel
;
567 } else if (opt_log4j
) {
568 enum lttng_loglevel_log4j loglevel
;
570 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
, &loglevel
);
571 ev
->loglevel
= (int) loglevel
;
574 enum lttng_loglevel_python loglevel
;
576 name_search_ret
= loglevel_python_name_to_value(opt_loglevel
, &loglevel
);
577 ev
->loglevel
= (int) loglevel
;
580 if (name_search_ret
== -1) {
581 ERR("Unknown loglevel %s", opt_loglevel
);
582 ret
= -LTTNG_ERR_INVALID
;
586 LTTNG_ASSERT(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
589 } else if (opt_jul
) {
590 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
591 } else if (opt_log4j
) {
592 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
593 } else if (opt_python
) {
594 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
600 ret
= create_exclusion_list_and_validate("*",
601 opt_exclude
, &exclusions
);
608 warn_on_truncated_exclusion_names(&exclusions
,
612 ret
= lttng_enable_event_with_exclusions(handle
,
615 lttng_dynamic_pointer_array_get_count(&exclusions
),
616 (char **) exclusions
.array
.buffer
.data
);
619 case LTTNG_ERR_KERN_EVENT_EXIST
:
620 WARN("Kernel events already enabled (channel %s, session %s)",
621 print_channel_name(channel_name
), session_name
);
624 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
626 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
627 ERR("Events: %s (channel %s, session %s)",
629 print_channel_name(channel_name
),
635 ERR("Events: %s (channel %s, session %s)",
637 ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
638 ? print_raw_channel_name(channel_name
)
639 : print_channel_name(channel_name
),
647 switch (opt_event_type
) {
648 case LTTNG_EVENT_TRACEPOINT
:
649 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
650 char *exclusion_string
= print_exclusions(&exclusions
);
652 if (!exclusion_string
) {
653 PERROR("Cannot allocate exclusion_string");
657 MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
658 lttng_domain_type_str(dom
.type
),
660 print_channel_name(channel_name
),
662 free(exclusion_string
);
664 char *exclusion_string
= print_exclusions(&exclusions
);
666 if (!exclusion_string
) {
667 PERROR("Cannot allocate exclusion_string");
671 MSG("All %s tracepoints%s are enabled in channel %s",
672 lttng_domain_type_str(dom
.type
),
674 print_channel_name(channel_name
));
675 free(exclusion_string
);
678 case LTTNG_EVENT_SYSCALL
:
680 MSG("All %s system calls are enabled in channel %s",
681 lttng_domain_type_str(dom
.type
),
682 print_channel_name(channel_name
));
685 case LTTNG_EVENT_ALL
:
686 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
687 char *exclusion_string
= print_exclusions(&exclusions
);
689 if (!exclusion_string
) {
690 PERROR("Cannot allocate exclusion_string");
694 MSG("All %s events%s are enabled in channel %s for loglevel %s",
695 lttng_domain_type_str(dom
.type
),
697 print_channel_name(channel_name
),
699 free(exclusion_string
);
701 char *exclusion_string
= print_exclusions(&exclusions
);
703 if (!exclusion_string
) {
704 PERROR("Cannot allocate exclusion_string");
708 MSG("All %s events%s are enabled in channel %s",
709 lttng_domain_type_str(dom
.type
),
711 print_channel_name(channel_name
));
712 free(exclusion_string
);
717 * We should not be here since lttng_enable_event should have
718 * failed on the event type.
725 command_ret
= lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
727 lttng_dynamic_pointer_array_get_count(&exclusions
),
728 (char **) exclusions
.array
.buffer
.data
);
729 if (command_ret
< 0) {
730 switch (-command_ret
) {
731 case LTTNG_ERR_FILTER_EXIST
:
732 WARN("Filter on all events is already enabled"
733 " (channel %s, session %s)",
734 print_channel_name(channel_name
), session_name
);
737 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
739 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
740 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
742 print_channel_name(channel_name
),
743 session_name
, opt_filter
);
748 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
749 lttng_strerror(command_ret
),
750 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
751 ? print_raw_channel_name(channel_name
)
752 : print_channel_name(channel_name
),
753 session_name
, opt_filter
);
757 error_holder
= command_ret
;
760 MSG("Filter '%s' successfully set", opt_filter
);
765 /* The wildcard * is used for kernel and ust domain to
766 * represent ALL. We copy * in event name to force the wildcard use
769 * Note: this is strictly for semantic and printing while in
770 * machine interface mode.
772 strcpy(ev
->name
, "*");
774 /* If we reach here the events are enabled */
775 if (!error
&& !warn
) {
781 ret
= mi_lttng_event(writer
, ev
, 1, handle
->domain
.type
);
787 /* print exclusion */
788 ret
= mi_print_exclusion(&exclusions
);
795 ret
= mi_lttng_writer_write_element_bool(writer
,
796 mi_lttng_element_command_success
, success
);
802 /* Close event element */
803 ret
= mi_lttng_writer_close_element(writer
);
813 /* Strip event list */
814 event_name
= strtok(event_list
, ",");
815 while (event_name
!= NULL
) {
816 /* Copy name and type of the event */
817 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
818 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
819 ev
->type
= (lttng_event_type
) opt_event_type
;
821 /* Kernel tracer action */
823 DBG("Enabling kernel event %s for channel %s",
825 print_channel_name(channel_name
));
827 switch (opt_event_type
) {
828 case LTTNG_EVENT_ALL
: /* Enable tracepoints and syscalls */
829 /* If event name differs from *, select tracepoint. */
830 if (strcmp(ev
->name
, "*")) {
831 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
834 case LTTNG_EVENT_TRACEPOINT
:
836 case LTTNG_EVENT_PROBE
:
837 ret
= parse_probe_opts(ev
, opt_probe
);
839 ERR("Unable to parse probe options");
844 case LTTNG_EVENT_USERSPACE_PROBE
:
845 LTTNG_ASSERT(ev
->type
== LTTNG_EVENT_USERSPACE_PROBE
);
847 ret
= parse_userspace_probe_opts(opt_userspace_probe
, &uprobe_loc
);
850 case CMD_UNSUPPORTED
:
852 * Error message describing
853 * what is not supported was
854 * printed in the function.
859 ERR("Unable to parse userspace probe options");
865 ret
= lttng_event_set_userspace_probe_location(ev
, uprobe_loc
);
867 WARN("Failed to set probe location on event");
872 /* Ownership of the uprobe location was transferred to the event. */
875 case LTTNG_EVENT_FUNCTION
:
876 ret
= parse_probe_opts(ev
, opt_function
);
878 ERR("Unable to parse function probe options");
883 case LTTNG_EVENT_SYSCALL
:
884 ev
->type
= LTTNG_EVENT_SYSCALL
;
891 /* kernel loglevels not implemented */
892 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
893 } else if (opt_userspace
) { /* User-space tracer action */
894 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name
,
895 print_channel_name(channel_name
), opt_loglevel
? : "<all>");
897 switch (opt_event_type
) {
898 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
900 case LTTNG_EVENT_TRACEPOINT
:
901 /* Copy name and type of the event */
902 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
903 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
904 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
906 case LTTNG_EVENT_PROBE
:
907 case LTTNG_EVENT_FUNCTION
:
908 case LTTNG_EVENT_SYSCALL
:
909 case LTTNG_EVENT_USERSPACE_PROBE
:
911 ERR("Event type not available for user-space tracing");
912 ret
= CMD_UNSUPPORTED
;
918 if (opt_event_type
!= LTTNG_EVENT_ALL
&& opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
919 ERR("Exclusion option can only be used with tracepoint events");
923 /* Free previously allocated items. */
924 lttng_dynamic_pointer_array_reset(&exclusions
);
925 ret
= create_exclusion_list_and_validate(
926 event_name
, opt_exclude
,
933 warn_on_truncated_exclusion_names(
937 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
939 enum lttng_loglevel loglevel
;
940 const int name_search_ret
= loglevel_name_to_value(opt_loglevel
, &loglevel
);
942 if (name_search_ret
== -1) {
943 ERR("Unknown loglevel %s", opt_loglevel
);
944 ret
= -LTTNG_ERR_INVALID
;
948 ev
->loglevel
= (int) loglevel
;
952 } else if (opt_jul
|| opt_log4j
|| opt_python
) {
953 if (opt_event_type
!= LTTNG_EVENT_ALL
&&
954 opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
955 ERR("Event type not supported for domain.");
956 ret
= CMD_UNSUPPORTED
;
960 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
965 enum lttng_loglevel_jul loglevel
;
967 name_search_ret
= loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
968 ev
->loglevel
= (int) loglevel
;
969 } else if (opt_log4j
) {
970 enum lttng_loglevel_log4j loglevel
;
972 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
, &loglevel
);
973 ev
->loglevel
= (int) loglevel
;
976 enum lttng_loglevel_python loglevel
;
978 name_search_ret
= loglevel_python_name_to_value(opt_loglevel
, &loglevel
);
979 ev
->loglevel
= (int) loglevel
;
982 if (name_search_ret
) {
983 ERR("Unknown loglevel %s", opt_loglevel
);
984 ret
= -LTTNG_ERR_INVALID
;
989 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
990 } else if (opt_log4j
) {
991 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
992 } else if (opt_python
) {
993 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
996 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
997 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
998 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1004 char *exclusion_string
;
1006 command_ret
= lttng_enable_event_with_exclusions(handle
,
1009 lttng_dynamic_pointer_array_get_count(&exclusions
),
1010 (char **) exclusions
.array
.buffer
.data
);
1011 exclusion_string
= print_exclusions(&exclusions
);
1012 if (!exclusion_string
) {
1013 PERROR("Cannot allocate exclusion_string");
1017 if (command_ret
< 0) {
1018 /* Turn ret to positive value to handle the positive error code */
1019 switch (-command_ret
) {
1020 case LTTNG_ERR_KERN_EVENT_EXIST
:
1021 WARN("Kernel event %s%s already enabled (channel %s, session %s)",
1024 print_channel_name(channel_name
), session_name
);
1027 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
1029 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
1030 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
1033 print_channel_name(channel_name
),
1038 case LTTNG_ERR_SDT_PROBE_SEMAPHORE
:
1039 ERR("SDT probes %s guarded by semaphores are not supported (channel %s, session %s)",
1040 event_name
, print_channel_name(channel_name
),
1045 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
1047 lttng_strerror(command_ret
),
1048 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1049 ? print_raw_channel_name(channel_name
)
1050 : print_channel_name(channel_name
),
1055 error_holder
= command_ret
;
1058 case LTTNG_DOMAIN_KERNEL
:
1059 case LTTNG_DOMAIN_UST
:
1060 MSG("%s event %s%s created in channel %s",
1061 lttng_domain_type_str(dom
.type
),
1064 print_channel_name(channel_name
));
1066 case LTTNG_DOMAIN_JUL
:
1067 case LTTNG_DOMAIN_LOG4J
:
1068 case LTTNG_DOMAIN_PYTHON
:
1070 * Don't print the default channel
1071 * name for agent domains.
1073 MSG("%s event %s%s enabled",
1074 lttng_domain_type_str(dom
.type
),
1082 free(exclusion_string
);
1086 char *exclusion_string
;
1088 /* Filter present */
1091 command_ret
= lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
1093 lttng_dynamic_pointer_array_get_count(&exclusions
),
1094 (char **) exclusions
.array
.buffer
.data
);
1095 exclusion_string
= print_exclusions(&exclusions
);
1096 if (!exclusion_string
) {
1097 PERROR("Cannot allocate exclusion_string");
1101 if (command_ret
< 0) {
1102 switch (-command_ret
) {
1103 case LTTNG_ERR_FILTER_EXIST
:
1104 WARN("Filter on event %s%s is already enabled"
1105 " (channel %s, session %s)",
1108 print_channel_name(channel_name
), session_name
);
1111 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
1113 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
1114 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
->name
,
1117 print_channel_name(channel_name
),
1118 session_name
, opt_filter
);
1123 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
->name
,
1125 lttng_strerror(command_ret
),
1126 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1127 ? print_raw_channel_name(channel_name
)
1128 : print_channel_name(channel_name
),
1129 session_name
, opt_filter
);
1133 error_holder
= command_ret
;
1136 MSG("Event %s%s: Filter '%s' successfully set",
1137 event_name
, exclusion_string
,
1140 free(exclusion_string
);
1151 ret
= mi_lttng_event(writer
, ev
, 1, handle
->domain
.type
);
1157 /* print exclusion */
1158 ret
= mi_print_exclusion(&exclusions
);
1165 ret
= mi_lttng_writer_write_element_bool(writer
,
1166 mi_lttng_element_command_success
, success
);
1172 /* Close event element */
1173 ret
= mi_lttng_writer_close_element(writer
);
1181 event_name
= strtok(NULL
, ",");
1182 /* Reset warn, error and success */
1189 /* Close events element */
1190 ret
= mi_lttng_writer_close_element(writer
);
1203 lttng_destroy_handle(handle
);
1204 lttng_dynamic_pointer_array_reset(&exclusions
);
1205 lttng_userspace_probe_location_destroy(uprobe_loc
);
1207 /* Overwrite ret with error_holder if there was an actual error with
1208 * enabling an event.
1210 ret
= error_holder
? error_holder
: ret
;
1212 lttng_event_destroy(ev
);
1217 * Add event to trace session
1219 int cmd_enable_events(int argc
, const char **argv
)
1221 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
1222 static poptContext pc
;
1223 char *session_name
= NULL
;
1224 char *event_list
= NULL
;
1225 const char *arg_event_list
= NULL
;
1226 const char *leftover
= NULL
;
1227 int event_type
= -1;
1229 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1230 poptReadDefaultConfig(pc
, 0);
1232 /* Default event type */
1233 opt_event_type
= LTTNG_EVENT_ALL
;
1235 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1240 case OPT_TRACEPOINT
:
1241 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
1244 opt_event_type
= LTTNG_EVENT_PROBE
;
1246 case OPT_USERSPACE_PROBE
:
1247 opt_event_type
= LTTNG_EVENT_USERSPACE_PROBE
;
1250 opt_event_type
= LTTNG_EVENT_FUNCTION
;
1253 opt_event_type
= LTTNG_EVENT_SYSCALL
;
1259 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
1260 opt_loglevel
= poptGetOptArg(pc
);
1262 case OPT_LOGLEVEL_ONLY
:
1263 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
1264 opt_loglevel
= poptGetOptArg(pc
);
1266 case OPT_LIST_OPTIONS
:
1267 list_cmd_options(stdout
, long_options
);
1274 ret
= CMD_UNDEFINED
;
1278 /* Validate event type. Multiple event type are not supported. */
1279 if (event_type
== -1) {
1280 event_type
= opt_event_type
;
1282 if (event_type
!= opt_event_type
) {
1283 ERR("Multiple event type not supported.");
1290 ret
= print_missing_or_multiple_domains(
1291 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
+
1301 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1303 ret
= -LTTNG_ERR_NOMEM
;
1307 /* Open command element */
1308 ret
= mi_lttng_writer_command_open(writer
,
1309 mi_lttng_element_command_enable_event
);
1315 /* Open output element */
1316 ret
= mi_lttng_writer_open_element(writer
,
1317 mi_lttng_element_command_output
);
1324 arg_event_list
= poptGetArg(pc
);
1325 if (arg_event_list
== NULL
&& opt_enable_all
== 0) {
1326 ERR("Missing event name(s).");
1331 if (opt_enable_all
== 0) {
1332 event_list
= strdup(arg_event_list
);
1333 if (event_list
== NULL
) {
1334 PERROR("Failed to copy event name(s)");
1340 leftover
= poptGetArg(pc
);
1342 ERR("Unknown argument: %s", leftover
);
1347 if (!opt_session_name
) {
1348 session_name
= get_session_name();
1349 if (session_name
== NULL
) {
1350 command_ret
= CMD_ERROR
;
1355 session_name
= opt_session_name
;
1358 command_ret
= enable_events(session_name
, event_list
);
1367 /* Close output element */
1368 ret
= mi_lttng_writer_close_element(writer
);
1374 ret
= mi_lttng_writer_write_element_bool(writer
,
1375 mi_lttng_element_command_success
, success
);
1381 /* Command element close */
1382 ret
= mi_lttng_writer_command_close(writer
);
1391 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1392 /* Preserve original error code */
1393 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
1396 if (opt_session_name
== NULL
) {
1402 /* Overwrite ret if an error occurred in enable_events */
1403 ret
= command_ret
? command_ret
: ret
;
1405 poptFreeContext(pc
);