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/sessiond-comm/sessiond-comm.hpp>
12 #include <common/string-utils/string-utils.hpp>
13 #include <common/utils.hpp>
21 #include <sys/types.h>
25 #include "../command.hpp"
26 #include "../loglevel.hpp"
27 #include "../uprobe.hpp"
29 #include <common/mi-lttng.hpp>
31 #include <lttng/domain-internal.hpp>
32 #include <lttng/event-internal.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 */
121 "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
122 "[^'+']+%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s",
126 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
127 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
128 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
129 if (*s_hex
== '\0') {
130 ERR("Invalid probe offset %s", s_hex
);
134 ev
->attr
.probe
.offset
= strtoull(s_hex
, NULL
, 0);
135 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
136 ev
->attr
.probe
.addr
= 0;
140 /* Check for symbol */
141 if (isalpha(name
[0]) || name
[0] == '_') {
142 match
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
"s", name
);
144 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
145 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
146 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
147 ev
->attr
.probe
.offset
= 0;
148 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
149 ev
->attr
.probe
.addr
= 0;
154 /* Check for address */
155 match
= sscanf(opt
, "%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", s_hex
);
158 * Return an error if the first character of the tentative
159 * address is NULL or not a digit. It can be "0" if the address
160 * is in hexadecimal and can be 1 to 9 if it's in decimal.
162 if (*s_hex
== '\0' || !isdigit(*s_hex
)) {
163 ERR("Invalid probe description %s", s_hex
);
167 ev
->attr
.probe
.addr
= strtoull(s_hex
, NULL
, 0);
168 DBG("probe addr %" PRIu64
, ev
->attr
.probe
.addr
);
169 ev
->attr
.probe
.offset
= 0;
170 memset(ev
->attr
.probe
.symbol_name
, 0, LTTNG_SYMBOL_NAME_LEN
);
181 static const char *print_channel_name(const char *name
)
183 return name
?: DEFAULT_CHANNEL_NAME
;
186 static const char *print_raw_channel_name(const char *name
)
188 return name
?: "<default>";
192 * Mi print exlcusion list
194 static int mi_print_exclusion(const struct lttng_dynamic_pointer_array
*exclusions
)
198 const size_t count
= lttng_dynamic_pointer_array_get_count(exclusions
);
200 LTTNG_ASSERT(writer
);
207 ret
= mi_lttng_writer_open_element(writer
, config_element_exclusions
);
212 for (i
= 0; i
< count
; i
++) {
213 const char *exclusion
=
214 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions
, i
);
216 ret
= mi_lttng_writer_write_element_string(
217 writer
, config_element_exclusion
, exclusion
);
223 /* Close exclusions element */
224 ret
= mi_lttng_writer_close_element(writer
);
231 * Return allocated string for pretty-printing exclusion names.
233 static char *print_exclusions(const struct lttng_dynamic_pointer_array
*exclusions
)
237 const char preamble
[] = " excluding ";
239 const size_t count
= lttng_dynamic_pointer_array_get_count(exclusions
);
245 /* Calculate total required length. */
246 for (i
= 0; i
< count
; i
++) {
247 const char *exclusion
=
248 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions
, i
);
250 length
+= strlen(exclusion
) + 4;
253 length
+= sizeof(preamble
);
254 ret
= calloc
<char>(length
);
259 strncpy(ret
, preamble
, length
);
260 for (i
= 0; i
< count
; i
++) {
261 const char *exclusion
=
262 (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions
, i
);
265 strcat(ret
, exclusion
);
267 if (i
!= count
- 1) {
275 static int check_exclusion_subsets(const char *event_name
, const char *exclusion
)
279 const char *e
= event_name
;
280 const char *x
= exclusion
;
282 /* Scan both the excluder and the event letter by letter */
296 /* Event is a subset of the excluder */
297 ERR("Event %s: %s excludes all events from %s",
306 * Reached the end of the event name before the
307 * end of the exclusion: this is valid.
329 WARN("Event %s: %s does not exclude any events from %s",
338 int validate_exclusion_list(const char *event_name
,
339 const struct lttng_dynamic_pointer_array
*exclusions
)
343 /* Event name must be a valid globbing pattern to allow exclusions. */
344 if (!strutils_is_star_glob_pattern(event_name
)) {
345 ERR("Event %s: Exclusions can only be used with a globbing pattern", event_name
);
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(exclusions
,
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
) != 0) {
404 lttng_dynamic_pointer_array_reset(exclusions
);
410 static void warn_on_truncated_exclusion_names(const struct lttng_dynamic_pointer_array
*exclusions
,
414 const size_t num_exclusions
= lttng_dynamic_pointer_array_get_count(exclusions
);
416 for (i
= 0; i
< num_exclusions
; i
++) {
417 const char *const exclusion
=
418 (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", exclusion
);
428 * Enabling event using the lttng API.
429 * Note: in case of error only the last error code will be return.
431 static int enable_events(char *session_name
, char *event_list
)
433 int ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
;
434 int error_holder
= CMD_SUCCESS
, warn
= 0, error
= 0, success
= 1;
435 char *event_name
, *channel_name
= NULL
;
436 struct lttng_event
*ev
;
437 struct lttng_domain dom
= {};
438 struct lttng_dynamic_pointer_array exclusions
;
439 struct lttng_userspace_probe_location
*uprobe_loc
= NULL
;
441 lttng_dynamic_pointer_array_init(&exclusions
, NULL
);
443 ev
= lttng_event_create();
451 WARN("Kernel loglevels are not supported.");
455 /* Create lttng domain */
457 dom
.type
= LTTNG_DOMAIN_KERNEL
;
458 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
459 } else if (opt_userspace
) {
460 dom
.type
= LTTNG_DOMAIN_UST
;
462 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
463 } else if (opt_jul
) {
464 dom
.type
= LTTNG_DOMAIN_JUL
;
466 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
467 } else if (opt_log4j
) {
468 dom
.type
= LTTNG_DOMAIN_LOG4J
;
470 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
471 } else if (opt_python
) {
472 dom
.type
= LTTNG_DOMAIN_PYTHON
;
474 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
476 /* Checked by the caller. */
482 case LTTNG_DOMAIN_KERNEL
:
483 case LTTNG_DOMAIN_JUL
:
484 case LTTNG_DOMAIN_LOG4J
:
485 case LTTNG_DOMAIN_PYTHON
:
486 ERR("Event name exclusions are not yet implemented for %s events",
487 lttng_domain_type_str(dom
.type
));
490 case LTTNG_DOMAIN_UST
:
491 /* Exclusions supported */
499 * Adding a filter to a probe, function or userspace-probe would be
500 * denied by the kernel tracer as it's not supported at the moment. We
501 * do an early check here to warn the user.
503 if (opt_filter
&& opt_kernel
) {
504 switch (opt_event_type
) {
505 case LTTNG_EVENT_ALL
:
506 case LTTNG_EVENT_TRACEPOINT
:
507 case LTTNG_EVENT_SYSCALL
:
509 case LTTNG_EVENT_PROBE
:
510 case LTTNG_EVENT_USERSPACE_PROBE
:
511 case LTTNG_EVENT_FUNCTION
:
512 ERR("Filter expressions are not supported for %s events",
513 get_event_type_str((lttng_event_type
) opt_event_type
));
522 channel_name
= opt_channel_name
;
524 handle
= lttng_create_handle(session_name
, &dom
);
525 if (handle
== NULL
) {
532 /* Open a events element */
533 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
540 if (opt_enable_all
) {
541 /* Default setup for enable all */
543 ev
->type
= (lttng_event_type
) opt_event_type
;
544 strcpy(ev
->name
, "*");
545 /* kernel loglevels not implemented */
546 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
548 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
549 strcpy(ev
->name
, "*");
550 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
554 LTTNG_ASSERT(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
557 enum lttng_loglevel loglevel
;
560 loglevel_name_to_value(opt_loglevel
, &loglevel
);
561 ev
->loglevel
= (int) loglevel
;
562 } else if (opt_jul
) {
563 enum lttng_loglevel_jul loglevel
;
566 loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
567 ev
->loglevel
= (int) loglevel
;
568 } else if (opt_log4j
) {
569 enum lttng_loglevel_log4j loglevel
;
571 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
,
573 ev
->loglevel
= (int) loglevel
;
576 enum lttng_loglevel_python loglevel
;
578 name_search_ret
= loglevel_python_name_to_value(
579 opt_loglevel
, &loglevel
);
580 ev
->loglevel
= (int) loglevel
;
583 if (name_search_ret
== -1) {
584 ERR("Unknown loglevel %s", opt_loglevel
);
585 ret
= -LTTNG_ERR_INVALID
;
589 LTTNG_ASSERT(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
592 } else if (opt_jul
) {
593 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
594 } else if (opt_log4j
) {
595 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
596 } else if (opt_python
) {
597 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
603 ret
= create_exclusion_list_and_validate("*", opt_exclude
, &exclusions
);
610 warn_on_truncated_exclusion_names(&exclusions
, &warn
);
613 ret
= lttng_enable_event_with_exclusions(
618 lttng_dynamic_pointer_array_get_count(&exclusions
),
619 (char **) exclusions
.array
.buffer
.data
);
622 case LTTNG_ERR_KERN_EVENT_EXIST
:
623 WARN("Kernel events already enabled (channel %s, session %s)",
624 print_channel_name(channel_name
),
628 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
631 "The command tried to enable an event in a new domain for a session that has already been started once.";
632 ERR("Events: %s (channel %s, session %s)",
634 print_channel_name(channel_name
),
640 ERR("Events: %s (channel %s, session %s)",
642 ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
?
643 print_raw_channel_name(channel_name
) :
644 print_channel_name(channel_name
),
652 switch (opt_event_type
) {
653 case LTTNG_EVENT_TRACEPOINT
:
654 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
655 char *exclusion_string
= print_exclusions(&exclusions
);
657 if (!exclusion_string
) {
658 PERROR("Cannot allocate exclusion_string");
662 MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
663 lttng_domain_type_str(dom
.type
),
665 print_channel_name(channel_name
),
667 free(exclusion_string
);
669 char *exclusion_string
= print_exclusions(&exclusions
);
671 if (!exclusion_string
) {
672 PERROR("Cannot allocate exclusion_string");
676 MSG("All %s tracepoints%s are enabled in channel %s",
677 lttng_domain_type_str(dom
.type
),
679 print_channel_name(channel_name
));
680 free(exclusion_string
);
683 case LTTNG_EVENT_SYSCALL
:
685 MSG("All %s system calls are enabled in channel %s",
686 lttng_domain_type_str(dom
.type
),
687 print_channel_name(channel_name
));
690 case LTTNG_EVENT_ALL
:
691 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
692 char *exclusion_string
= print_exclusions(&exclusions
);
694 if (!exclusion_string
) {
695 PERROR("Cannot allocate exclusion_string");
699 MSG("All %s events%s are enabled in channel %s for loglevel %s",
700 lttng_domain_type_str(dom
.type
),
702 print_channel_name(channel_name
),
704 free(exclusion_string
);
706 char *exclusion_string
= print_exclusions(&exclusions
);
708 if (!exclusion_string
) {
709 PERROR("Cannot allocate exclusion_string");
713 MSG("All %s events%s are enabled in channel %s",
714 lttng_domain_type_str(dom
.type
),
716 print_channel_name(channel_name
));
717 free(exclusion_string
);
722 * We should not be here since lttng_enable_event should have
723 * failed on the event type.
730 command_ret
= lttng_enable_event_with_exclusions(
735 lttng_dynamic_pointer_array_get_count(&exclusions
),
736 (char **) exclusions
.array
.buffer
.data
);
737 if (command_ret
< 0) {
738 switch (-command_ret
) {
739 case LTTNG_ERR_FILTER_EXIST
:
740 WARN("Filter on all events is already enabled"
741 " (channel %s, session %s)",
742 print_channel_name(channel_name
),
746 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
749 "The command tried to enable an event in a new domain for a session that has already been started once.";
750 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
752 print_channel_name(channel_name
),
759 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
760 lttng_strerror(command_ret
),
761 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
?
762 print_raw_channel_name(channel_name
) :
763 print_channel_name(channel_name
),
769 error_holder
= command_ret
;
772 MSG("Filter '%s' successfully set", opt_filter
);
777 /* The wildcard * is used for kernel and ust domain to
778 * represent ALL. We copy * in event name to force the wildcard use
781 * Note: this is strictly for semantic and printing while in
782 * machine interface mode.
784 strcpy(ev
->name
, "*");
786 /* If we reach here the events are enabled */
787 if (!error
&& !warn
) {
793 ret
= mi_lttng_event(writer
, ev
, 1, handle
->domain
.type
);
799 /* print exclusion */
800 ret
= mi_print_exclusion(&exclusions
);
807 ret
= mi_lttng_writer_write_element_bool(
808 writer
, mi_lttng_element_command_success
, success
);
814 /* Close event element */
815 ret
= mi_lttng_writer_close_element(writer
);
825 /* Strip event list */
826 event_name
= strtok(event_list
, ",");
827 while (event_name
!= NULL
) {
828 /* Copy name and type of the event */
829 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
830 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
831 ev
->type
= (lttng_event_type
) opt_event_type
;
833 /* Kernel tracer action */
835 DBG("Enabling kernel event %s for channel %s",
837 print_channel_name(channel_name
));
839 switch (opt_event_type
) {
840 case LTTNG_EVENT_ALL
: /* Enable tracepoints and syscalls */
841 /* If event name differs from *, select tracepoint. */
842 if (strcmp(ev
->name
, "*")) {
843 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
846 case LTTNG_EVENT_TRACEPOINT
:
848 case LTTNG_EVENT_PROBE
:
849 ret
= parse_probe_opts(ev
, opt_probe
);
851 ERR("Unable to parse probe options");
856 case LTTNG_EVENT_USERSPACE_PROBE
:
857 LTTNG_ASSERT(ev
->type
== LTTNG_EVENT_USERSPACE_PROBE
);
859 ret
= parse_userspace_probe_opts(opt_userspace_probe
, &uprobe_loc
);
862 case CMD_UNSUPPORTED
:
864 * Error message describing
865 * what is not supported was
866 * printed in the function.
871 ERR("Unable to parse userspace probe options");
877 ret
= lttng_event_set_userspace_probe_location(ev
, uprobe_loc
);
879 WARN("Failed to set probe location on event");
884 /* Ownership of the uprobe location was transferred to the event. */
887 case LTTNG_EVENT_FUNCTION
:
888 ret
= parse_probe_opts(ev
, opt_function
);
890 ERR("Unable to parse function probe options");
895 case LTTNG_EVENT_SYSCALL
:
896 ev
->type
= LTTNG_EVENT_SYSCALL
;
903 /* kernel loglevels not implemented */
904 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
905 } else if (opt_userspace
) { /* User-space tracer action */
906 DBG("Enabling UST event %s for channel %s, loglevel %s",
908 print_channel_name(channel_name
),
909 opt_loglevel
?: "<all>");
911 switch (opt_event_type
) {
912 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
914 case LTTNG_EVENT_TRACEPOINT
:
915 /* Copy name and type of the event */
916 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
917 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
918 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
920 case LTTNG_EVENT_PROBE
:
921 case LTTNG_EVENT_FUNCTION
:
922 case LTTNG_EVENT_SYSCALL
:
923 case LTTNG_EVENT_USERSPACE_PROBE
:
925 ERR("Event type not available for user-space tracing");
926 ret
= CMD_UNSUPPORTED
;
932 if (opt_event_type
!= LTTNG_EVENT_ALL
&&
933 opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
934 ERR("Exclusion option can only be used with tracepoint events");
938 /* Free previously allocated items. */
939 lttng_dynamic_pointer_array_reset(&exclusions
);
940 ret
= create_exclusion_list_and_validate(
941 event_name
, opt_exclude
, &exclusions
);
947 warn_on_truncated_exclusion_names(&exclusions
, &warn
);
950 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
952 enum lttng_loglevel loglevel
;
953 const int name_search_ret
=
954 loglevel_name_to_value(opt_loglevel
, &loglevel
);
956 if (name_search_ret
== -1) {
957 ERR("Unknown loglevel %s", opt_loglevel
);
958 ret
= -LTTNG_ERR_INVALID
;
962 ev
->loglevel
= (int) loglevel
;
966 } else if (opt_jul
|| opt_log4j
|| opt_python
) {
967 if (opt_event_type
!= LTTNG_EVENT_ALL
&&
968 opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
969 ERR("Event type not supported for domain.");
970 ret
= CMD_UNSUPPORTED
;
974 ev
->loglevel_type
= (lttng_loglevel_type
) opt_loglevel_type
;
979 enum lttng_loglevel_jul loglevel
;
982 loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
983 ev
->loglevel
= (int) loglevel
;
984 } else if (opt_log4j
) {
985 enum lttng_loglevel_log4j loglevel
;
987 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
,
989 ev
->loglevel
= (int) loglevel
;
992 enum lttng_loglevel_python loglevel
;
994 name_search_ret
= loglevel_python_name_to_value(
995 opt_loglevel
, &loglevel
);
996 ev
->loglevel
= (int) loglevel
;
999 if (name_search_ret
) {
1000 ERR("Unknown loglevel %s", opt_loglevel
);
1001 ret
= -LTTNG_ERR_INVALID
;
1006 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
1007 } else if (opt_log4j
) {
1008 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
1009 } else if (opt_python
) {
1010 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
1013 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
1014 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
1015 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1021 char *exclusion_string
;
1023 command_ret
= lttng_enable_event_with_exclusions(
1028 lttng_dynamic_pointer_array_get_count(&exclusions
),
1029 (char **) exclusions
.array
.buffer
.data
);
1030 exclusion_string
= print_exclusions(&exclusions
);
1031 if (!exclusion_string
) {
1032 PERROR("Cannot allocate exclusion_string");
1036 if (command_ret
< 0) {
1037 /* Turn ret to positive value to handle the positive error code */
1038 switch (-command_ret
) {
1039 case LTTNG_ERR_KERN_EVENT_EXIST
:
1040 WARN("Kernel event %s%s already enabled (channel %s, session %s)",
1043 print_channel_name(channel_name
),
1047 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
1050 "The command tried to enable an event in a new domain for a session that has already been started once.";
1051 ERR("Event %s%s: %s (channel %s, session %s)",
1055 print_channel_name(channel_name
),
1060 case LTTNG_ERR_SDT_PROBE_SEMAPHORE
:
1061 ERR("SDT probes %s guarded by semaphores are not supported (channel %s, session %s)",
1063 print_channel_name(channel_name
),
1068 ERR("Event %s%s: %s (channel %s, session %s)",
1071 lttng_strerror(command_ret
),
1072 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
?
1073 print_raw_channel_name(channel_name
) :
1074 print_channel_name(channel_name
),
1079 error_holder
= command_ret
;
1082 case LTTNG_DOMAIN_KERNEL
:
1083 case LTTNG_DOMAIN_UST
:
1084 MSG("%s event %s%s created in channel %s",
1085 lttng_domain_type_str(dom
.type
),
1088 print_channel_name(channel_name
));
1090 case LTTNG_DOMAIN_JUL
:
1091 case LTTNG_DOMAIN_LOG4J
:
1092 case LTTNG_DOMAIN_PYTHON
:
1094 * Don't print the default channel
1095 * name for agent domains.
1097 MSG("%s event %s%s enabled",
1098 lttng_domain_type_str(dom
.type
),
1106 free(exclusion_string
);
1110 char *exclusion_string
;
1112 /* Filter present */
1115 command_ret
= lttng_enable_event_with_exclusions(
1120 lttng_dynamic_pointer_array_get_count(&exclusions
),
1121 (char **) exclusions
.array
.buffer
.data
);
1122 exclusion_string
= print_exclusions(&exclusions
);
1123 if (!exclusion_string
) {
1124 PERROR("Cannot allocate exclusion_string");
1128 if (command_ret
< 0) {
1129 switch (-command_ret
) {
1130 case LTTNG_ERR_FILTER_EXIST
:
1131 WARN("Filter on event %s%s is already enabled"
1132 " (channel %s, session %s)",
1135 print_channel_name(channel_name
),
1139 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
1142 "The command tried to enable an event in a new domain for a session that has already been started once.";
1143 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')",
1147 print_channel_name(channel_name
),
1154 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')",
1157 lttng_strerror(command_ret
),
1158 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
?
1159 print_raw_channel_name(channel_name
) :
1160 print_channel_name(channel_name
),
1166 error_holder
= command_ret
;
1169 MSG("Event %s%s: Filter '%s' successfully set",
1174 free(exclusion_string
);
1185 ret
= mi_lttng_event(writer
, ev
, 1, handle
->domain
.type
);
1191 /* print exclusion */
1192 ret
= mi_print_exclusion(&exclusions
);
1199 ret
= mi_lttng_writer_write_element_bool(
1200 writer
, mi_lttng_element_command_success
, success
);
1206 /* Close event element */
1207 ret
= mi_lttng_writer_close_element(writer
);
1215 event_name
= strtok(NULL
, ",");
1216 /* Reset warn, error and success */
1223 /* Close events element */
1224 ret
= mi_lttng_writer_close_element(writer
);
1237 lttng_destroy_handle(handle
);
1238 lttng_dynamic_pointer_array_reset(&exclusions
);
1239 lttng_userspace_probe_location_destroy(uprobe_loc
);
1241 /* Overwrite ret with error_holder if there was an actual error with
1242 * enabling an event.
1244 ret
= error_holder
? error_holder
: ret
;
1246 lttng_event_destroy(ev
);
1251 * Add event to trace session
1253 int cmd_enable_events(int argc
, const char **argv
)
1255 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
1256 static poptContext pc
;
1257 char *session_name
= NULL
;
1258 char *event_list
= NULL
;
1259 const char *arg_event_list
= NULL
;
1260 const char *leftover
= NULL
;
1261 int event_type
= -1;
1263 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1264 poptReadDefaultConfig(pc
, 0);
1266 /* Default event type */
1267 opt_event_type
= LTTNG_EVENT_ALL
;
1269 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1274 case OPT_TRACEPOINT
:
1275 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
1278 opt_event_type
= LTTNG_EVENT_PROBE
;
1280 case OPT_USERSPACE_PROBE
:
1281 opt_event_type
= LTTNG_EVENT_USERSPACE_PROBE
;
1284 opt_event_type
= LTTNG_EVENT_FUNCTION
;
1287 opt_event_type
= LTTNG_EVENT_SYSCALL
;
1293 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
1294 opt_loglevel
= poptGetOptArg(pc
);
1296 case OPT_LOGLEVEL_ONLY
:
1297 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
1298 opt_loglevel
= poptGetOptArg(pc
);
1300 case OPT_LIST_OPTIONS
:
1301 list_cmd_options(stdout
, long_options
);
1308 ret
= CMD_UNDEFINED
;
1312 /* Validate event type. Multiple event type are not supported. */
1313 if (event_type
== -1) {
1314 event_type
= opt_event_type
;
1316 if (event_type
!= opt_event_type
) {
1317 ERR("Multiple event type not supported.");
1324 ret
= print_missing_or_multiple_domains(
1325 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
+ opt_python
, true);
1333 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1335 ret
= -LTTNG_ERR_NOMEM
;
1339 /* Open command element */
1340 ret
= mi_lttng_writer_command_open(writer
, mi_lttng_element_command_enable_event
);
1346 /* Open output element */
1347 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_command_output
);
1354 arg_event_list
= poptGetArg(pc
);
1355 if (arg_event_list
== NULL
&& opt_enable_all
== 0) {
1356 ERR("Missing event name(s).");
1361 if (opt_enable_all
== 0) {
1362 event_list
= strdup(arg_event_list
);
1363 if (event_list
== NULL
) {
1364 PERROR("Failed to copy event name(s)");
1370 leftover
= poptGetArg(pc
);
1372 ERR("Unknown argument: %s", leftover
);
1377 if (!opt_session_name
) {
1378 session_name
= get_session_name();
1379 if (session_name
== NULL
) {
1380 command_ret
= CMD_ERROR
;
1385 session_name
= opt_session_name
;
1388 command_ret
= enable_events(session_name
, event_list
);
1397 /* Close output element */
1398 ret
= mi_lttng_writer_close_element(writer
);
1404 ret
= mi_lttng_writer_write_element_bool(
1405 writer
, mi_lttng_element_command_success
, success
);
1411 /* Command element close */
1412 ret
= mi_lttng_writer_command_close(writer
);
1421 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1422 /* Preserve original error code */
1423 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
1426 if (opt_session_name
== NULL
) {
1432 /* Overwrite ret if an error occurred in enable_events */
1433 ret
= command_ret
? command_ret
: ret
;
1435 poptFreeContext(pc
);