2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
4 * SPDX-License-Identifier: GPL-2.0-only
14 #include <sys/types.h>
19 #include <common/sessiond-comm/sessiond-comm.h>
20 #include <common/compat/string.h>
21 #include <common/compat/getenv.h>
22 #include <common/string-utils/string-utils.h>
23 #include <common/utils.h>
25 #include <lttng/constant.h>
27 #include <common/mi-lttng.h>
29 #include <lttng/event-internal.h>
31 #include "../command.h"
32 #include "../loglevel.h"
33 #include "../uprobe.h"
35 #if (LTTNG_SYMBOL_NAME_LEN == 256)
36 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
39 static char *opt_event_list
;
40 static int opt_event_type
;
41 static const char *opt_loglevel
;
42 static int opt_loglevel_type
;
43 static int opt_kernel
;
44 static char *opt_session_name
;
45 static int opt_userspace
;
48 static int opt_python
;
49 static int opt_enable_all
;
50 static char *opt_probe
;
51 static char *opt_userspace_probe
;
52 static char *opt_function
;
53 static char *opt_channel_name
;
54 static char *opt_filter
;
55 static char *opt_exclude
;
57 #ifdef LTTNG_EMBED_HELP
58 static const char help_msg
[] =
59 #include <lttng-enable-event.1.h>
78 static struct lttng_handle
*handle
;
79 static struct mi_writer
*writer
;
81 static struct poptOption long_options
[] = {
82 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
83 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
84 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
85 {"all", 'a', POPT_ARG_VAL
, &opt_enable_all
, 1, 0, 0},
86 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
87 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
88 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
89 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
90 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
91 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
92 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TRACEPOINT
, 0, 0},
93 {"probe", 0, POPT_ARG_STRING
, &opt_probe
, OPT_PROBE
, 0, 0},
94 {"userspace-probe",0, POPT_ARG_STRING
, &opt_userspace_probe
, OPT_USERSPACE_PROBE
, 0, 0},
95 {"function", 0, POPT_ARG_STRING
, &opt_function
, OPT_FUNCTION
, 0, 0},
96 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_SYSCALL
, 0, 0},
97 {"loglevel", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL
, 0, 0},
98 {"loglevel-only", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL_ONLY
, 0, 0},
99 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
100 {"filter", 'f', POPT_ARG_STRING
, &opt_filter
, OPT_FILTER
, 0, 0},
101 {"exclude", 'x', POPT_ARG_STRING
, &opt_exclude
, OPT_EXCLUDE
, 0, 0},
102 {0, 0, 0, 0, 0, 0, 0}
106 * Parse probe options.
108 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
110 int ret
= CMD_SUCCESS
;
113 #define S_HEX_LEN_SCANF_IS_A_BROKEN_API "18" /* 18 is (19 - 1) (\0 is extra) */
114 char name
[LTTNG_SYMBOL_NAME_LEN
];
121 /* Check for symbol+offset */
122 match
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
123 "[^'+']+%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", name
, s_hex
);
125 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
126 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
127 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
128 if (*s_hex
== '\0') {
129 ERR("Invalid probe offset %s", s_hex
);
133 ev
->attr
.probe
.offset
= strtoul(s_hex
, NULL
, 0);
134 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
135 ev
->attr
.probe
.addr
= 0;
139 /* Check for symbol */
140 if (isalpha(name
[0]) || name
[0] == '_') {
141 match
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
"s",
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
= strtoul(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
);
182 const char *print_channel_name(const char *name
)
184 return name
? : DEFAULT_CHANNEL_NAME
;
188 const char *print_raw_channel_name(const char *name
)
190 return name
? : "<default>";
194 * Mi print exlcusion list
197 int mi_print_exclusion(char **names
)
200 int count
= names
? strutils_array_of_strings_len(names
) : 0;
208 ret
= mi_lttng_writer_open_element(writer
, config_element_exclusions
);
213 for (i
= 0; i
< count
; i
++) {
214 ret
= mi_lttng_writer_write_element_string(writer
,
215 config_element_exclusion
, names
[i
]);
221 /* Close exclusions element */
222 ret
= mi_lttng_writer_close_element(writer
);
229 * Return allocated string for pretty-printing exclusion names.
232 char *print_exclusions(char **names
)
236 const char preamble
[] = " excluding ";
238 int count
= names
? strutils_array_of_strings_len(names
) : 0;
244 /* calculate total required length */
245 for (i
= 0; i
< count
; i
++) {
246 length
+= strlen(names
[i
]) + 4;
249 length
+= sizeof(preamble
);
250 ret
= zmalloc(length
);
254 strncpy(ret
, preamble
, length
);
255 for (i
= 0; i
< count
; i
++) {
257 strcat(ret
, names
[i
]);
259 if (i
!= count
- 1) {
268 int check_exclusion_subsets(const char *event_name
, const char *exclusion
)
272 const char *e
= event_name
;
273 const char *x
= exclusion
;
275 /* Scan both the excluder and the event letter by letter */
289 /* Event is a subset of the excluder */
290 ERR("Event %s: %s excludes all events from %s",
291 event_name
, exclusion
, event_name
);
297 * Reached the end of the event name before the
298 * end of the exclusion: this is valid.
320 WARN("Event %s: %s does not exclude any events from %s",
321 event_name
, exclusion
, event_name
);
328 int create_exclusion_list_and_validate(const char *event_name
,
329 const char *exclusions_arg
,
330 char ***exclusion_list
)
333 char **exclusions
= NULL
;
335 /* Event name must be a valid globbing pattern to allow exclusions. */
336 if (!strutils_is_star_glob_pattern(event_name
)) {
337 ERR("Event %s: Exclusions can only be used with a globbing pattern",
342 /* Split exclusions. */
343 exclusions
= strutils_split(exclusions_arg
, ',', true);
349 * If the event name is a star-at-end only globbing pattern,
350 * then we can validate the individual exclusions. Otherwise
351 * all exclusions are passed to the session daemon.
353 if (strutils_is_star_at_the_end_only_glob_pattern(event_name
)) {
354 char * const *exclusion
;
356 for (exclusion
= exclusions
; *exclusion
; exclusion
++) {
357 if (!strutils_is_star_glob_pattern(*exclusion
) ||
358 strutils_is_star_at_the_end_only_glob_pattern(*exclusion
)) {
359 ret
= check_exclusion_subsets(event_name
, *exclusion
);
367 *exclusion_list
= exclusions
;
373 strutils_free_null_terminated_array_of_strings(exclusions
);
379 static void warn_on_truncated_exclusion_names(char * const *exclusion_list
,
382 char * const *exclusion
;
384 for (exclusion
= exclusion_list
; *exclusion
; exclusion
++) {
385 if (strlen(*exclusion
) >= LTTNG_SYMBOL_NAME_LEN
) {
386 WARN("Event exclusion \"%s\" will be truncated",
394 * Enabling event using the lttng API.
395 * Note: in case of error only the last error code will be return.
397 static int enable_events(char *session_name
)
399 int ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
;
400 int error_holder
= CMD_SUCCESS
, warn
= 0, error
= 0, success
= 1;
401 char *event_name
, *channel_name
= NULL
;
402 struct lttng_event
*ev
;
403 struct lttng_domain dom
;
404 char **exclusion_list
= NULL
;
405 struct lttng_userspace_probe_location
*uprobe_loc
= NULL
;
407 memset(&dom
, 0, sizeof(dom
));
409 ev
= lttng_event_create();
417 WARN("Kernel loglevels are not supported.");
421 /* Create lttng domain */
423 dom
.type
= LTTNG_DOMAIN_KERNEL
;
424 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
425 } else if (opt_userspace
) {
426 dom
.type
= LTTNG_DOMAIN_UST
;
428 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
429 } else if (opt_jul
) {
430 dom
.type
= LTTNG_DOMAIN_JUL
;
432 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
433 } else if (opt_log4j
) {
434 dom
.type
= LTTNG_DOMAIN_LOG4J
;
436 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
437 } else if (opt_python
) {
438 dom
.type
= LTTNG_DOMAIN_PYTHON
;
440 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
442 /* Checked by the caller. */
448 case LTTNG_DOMAIN_KERNEL
:
449 case LTTNG_DOMAIN_JUL
:
450 case LTTNG_DOMAIN_LOG4J
:
451 case LTTNG_DOMAIN_PYTHON
:
452 ERR("Event name exclusions are not yet implemented for %s events",
453 get_domain_str(dom
.type
));
456 case LTTNG_DOMAIN_UST
:
457 /* Exclusions supported */
465 * Adding a filter to a probe, function or userspace-probe would be
466 * denied by the kernel tracer as it's not supported at the moment. We
467 * do an early check here to warn the user.
469 if (opt_filter
&& opt_kernel
) {
470 switch (opt_event_type
) {
471 case LTTNG_EVENT_ALL
:
472 case LTTNG_EVENT_TRACEPOINT
:
473 case LTTNG_EVENT_SYSCALL
:
475 case LTTNG_EVENT_PROBE
:
476 case LTTNG_EVENT_USERSPACE_PROBE
:
477 case LTTNG_EVENT_FUNCTION
:
478 ERR("Filter expressions are not supported for %s events",
479 get_event_type_str(opt_event_type
));
488 channel_name
= opt_channel_name
;
490 handle
= lttng_create_handle(session_name
, &dom
);
491 if (handle
== NULL
) {
498 /* Open a events element */
499 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
506 if (opt_enable_all
) {
507 /* Default setup for enable all */
509 ev
->type
= opt_event_type
;
510 strcpy(ev
->name
, "*");
511 /* kernel loglevels not implemented */
512 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
514 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
515 strcpy(ev
->name
, "*");
516 ev
->loglevel_type
= opt_loglevel_type
;
520 assert(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
523 enum lttng_loglevel loglevel
;
525 name_search_ret
= loglevel_name_to_value(opt_loglevel
, &loglevel
);
526 ev
->loglevel
= (int) loglevel
;
527 } else if (opt_jul
) {
528 enum lttng_loglevel_jul loglevel
;
530 name_search_ret
= loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
531 ev
->loglevel
= (int) loglevel
;
532 } else if (opt_log4j
) {
533 enum lttng_loglevel_log4j loglevel
;
535 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
, &loglevel
);
536 ev
->loglevel
= (int) loglevel
;
539 enum lttng_loglevel_python loglevel
;
541 name_search_ret
= loglevel_python_name_to_value(opt_loglevel
, &loglevel
);
542 ev
->loglevel
= (int) loglevel
;
545 if (name_search_ret
== -1) {
546 ERR("Unknown loglevel %s", opt_loglevel
);
547 ret
= -LTTNG_ERR_INVALID
;
551 assert(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
554 } else if (opt_jul
) {
555 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
556 } else if (opt_log4j
) {
557 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
558 } else if (opt_python
) {
559 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
565 ret
= create_exclusion_list_and_validate("*",
566 opt_exclude
, &exclusion_list
);
573 warn_on_truncated_exclusion_names(exclusion_list
,
577 ret
= lttng_enable_event_with_exclusions(handle
,
580 exclusion_list
? strutils_array_of_strings_len(exclusion_list
) : 0,
584 case LTTNG_ERR_KERN_EVENT_EXIST
:
585 WARN("Kernel events already enabled (channel %s, session %s)",
586 print_channel_name(channel_name
), session_name
);
589 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
591 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
592 ERR("Events: %s (channel %s, session %s)",
594 print_channel_name(channel_name
),
600 ERR("Events: %s (channel %s, session %s)",
602 ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
603 ? print_raw_channel_name(channel_name
)
604 : print_channel_name(channel_name
),
612 switch (opt_event_type
) {
613 case LTTNG_EVENT_TRACEPOINT
:
614 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
615 char *exclusion_string
= print_exclusions(exclusion_list
);
617 if (!exclusion_string
) {
618 PERROR("Cannot allocate exclusion_string");
622 MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
623 get_domain_str(dom
.type
),
625 print_channel_name(channel_name
),
627 free(exclusion_string
);
629 char *exclusion_string
= print_exclusions(exclusion_list
);
631 if (!exclusion_string
) {
632 PERROR("Cannot allocate exclusion_string");
636 MSG("All %s tracepoints%s are enabled in channel %s",
637 get_domain_str(dom
.type
),
639 print_channel_name(channel_name
));
640 free(exclusion_string
);
643 case LTTNG_EVENT_SYSCALL
:
645 MSG("All %s system calls are enabled in channel %s",
646 get_domain_str(dom
.type
),
647 print_channel_name(channel_name
));
650 case LTTNG_EVENT_ALL
:
651 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
652 char *exclusion_string
= print_exclusions(exclusion_list
);
654 if (!exclusion_string
) {
655 PERROR("Cannot allocate exclusion_string");
659 MSG("All %s events%s are enabled in channel %s for loglevel %s",
660 get_domain_str(dom
.type
),
662 print_channel_name(channel_name
),
664 free(exclusion_string
);
666 char *exclusion_string
= print_exclusions(exclusion_list
);
668 if (!exclusion_string
) {
669 PERROR("Cannot allocate exclusion_string");
673 MSG("All %s events%s are enabled in channel %s",
674 get_domain_str(dom
.type
),
676 print_channel_name(channel_name
));
677 free(exclusion_string
);
682 * We should not be here since lttng_enable_event should have
683 * failed on the event type.
690 command_ret
= lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
692 exclusion_list
? strutils_array_of_strings_len(exclusion_list
) : 0,
694 if (command_ret
< 0) {
695 switch (-command_ret
) {
696 case LTTNG_ERR_FILTER_EXIST
:
697 WARN("Filter on all events is already enabled"
698 " (channel %s, session %s)",
699 print_channel_name(channel_name
), session_name
);
702 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
704 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
705 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
707 print_channel_name(channel_name
),
708 session_name
, opt_filter
);
713 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
714 lttng_strerror(command_ret
),
715 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
716 ? print_raw_channel_name(channel_name
)
717 : print_channel_name(channel_name
),
718 session_name
, opt_filter
);
722 error_holder
= command_ret
;
725 MSG("Filter '%s' successfully set", opt_filter
);
730 /* The wildcard * is used for kernel and ust domain to
731 * represent ALL. We copy * in event name to force the wildcard use
734 * Note: this is strictly for semantic and printing while in
735 * machine interface mode.
737 strcpy(ev
->name
, "*");
739 /* If we reach here the events are enabled */
740 if (!error
&& !warn
) {
746 ret
= mi_lttng_event(writer
, ev
, 1, handle
->domain
.type
);
752 /* print exclusion */
753 ret
= mi_print_exclusion(exclusion_list
);
760 ret
= mi_lttng_writer_write_element_bool(writer
,
761 mi_lttng_element_command_success
, success
);
767 /* Close event element */
768 ret
= mi_lttng_writer_close_element(writer
);
778 /* Strip event list */
779 event_name
= strtok(opt_event_list
, ",");
780 while (event_name
!= NULL
) {
781 /* Copy name and type of the event */
782 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
783 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
784 ev
->type
= opt_event_type
;
786 /* Kernel tracer action */
788 DBG("Enabling kernel event %s for channel %s",
790 print_channel_name(channel_name
));
792 switch (opt_event_type
) {
793 case LTTNG_EVENT_ALL
: /* Enable tracepoints and syscalls */
794 /* If event name differs from *, select tracepoint. */
795 if (strcmp(ev
->name
, "*")) {
796 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
799 case LTTNG_EVENT_TRACEPOINT
:
801 case LTTNG_EVENT_PROBE
:
802 ret
= parse_probe_opts(ev
, opt_probe
);
804 ERR("Unable to parse probe options");
809 case LTTNG_EVENT_USERSPACE_PROBE
:
810 assert(ev
->type
== LTTNG_EVENT_USERSPACE_PROBE
);
812 ret
= parse_userspace_probe_opts(opt_userspace_probe
, &uprobe_loc
);
815 case CMD_UNSUPPORTED
:
817 * Error message describing
818 * what is not supported was
819 * printed in the function.
824 ERR("Unable to parse userspace probe options");
830 ret
= lttng_event_set_userspace_probe_location(ev
, uprobe_loc
);
832 WARN("Failed to set probe location on event");
837 /* Ownership of the uprobe location was transferred to the event. */
840 case LTTNG_EVENT_FUNCTION
:
841 ret
= parse_probe_opts(ev
, opt_function
);
843 ERR("Unable to parse function probe options");
848 case LTTNG_EVENT_SYSCALL
:
849 ev
->type
= LTTNG_EVENT_SYSCALL
;
856 /* kernel loglevels not implemented */
857 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
858 } else if (opt_userspace
) { /* User-space tracer action */
859 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name
,
860 print_channel_name(channel_name
), opt_loglevel
? : "<all>");
862 switch (opt_event_type
) {
863 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
865 case LTTNG_EVENT_TRACEPOINT
:
866 /* Copy name and type of the event */
867 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
868 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
869 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
871 case LTTNG_EVENT_PROBE
:
872 case LTTNG_EVENT_FUNCTION
:
873 case LTTNG_EVENT_SYSCALL
:
874 case LTTNG_EVENT_USERSPACE_PROBE
:
876 ERR("Event type not available for user-space tracing");
877 ret
= CMD_UNSUPPORTED
;
883 if (opt_event_type
!= LTTNG_EVENT_ALL
&& opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
884 ERR("Exclusion option can only be used with tracepoint events");
888 /* Free previously allocated items */
889 strutils_free_null_terminated_array_of_strings(
891 exclusion_list
= NULL
;
892 ret
= create_exclusion_list_and_validate(
893 event_name
, opt_exclude
,
900 warn_on_truncated_exclusion_names(
901 exclusion_list
, &warn
);
904 ev
->loglevel_type
= opt_loglevel_type
;
906 enum lttng_loglevel loglevel
;
907 const int name_search_ret
= loglevel_name_to_value(opt_loglevel
, &loglevel
);
909 if (name_search_ret
== -1) {
910 ERR("Unknown loglevel %s", opt_loglevel
);
911 ret
= -LTTNG_ERR_INVALID
;
915 ev
->loglevel
= (int) loglevel
;
919 } else if (opt_jul
|| opt_log4j
|| opt_python
) {
920 if (opt_event_type
!= LTTNG_EVENT_ALL
&&
921 opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
922 ERR("Event type not supported for domain.");
923 ret
= CMD_UNSUPPORTED
;
927 ev
->loglevel_type
= opt_loglevel_type
;
932 enum lttng_loglevel_jul loglevel
;
934 name_search_ret
= loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
935 ev
->loglevel
= (int) loglevel
;
936 } else if (opt_log4j
) {
937 enum lttng_loglevel_log4j loglevel
;
939 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
, &loglevel
);
940 ev
->loglevel
= (int) loglevel
;
943 enum lttng_loglevel_python loglevel
;
945 name_search_ret
= loglevel_python_name_to_value(opt_loglevel
, &loglevel
);
946 ev
->loglevel
= (int) loglevel
;
949 if (name_search_ret
) {
950 ERR("Unknown loglevel %s", opt_loglevel
);
951 ret
= -LTTNG_ERR_INVALID
;
956 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
957 } else if (opt_log4j
) {
958 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
959 } else if (opt_python
) {
960 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
963 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
964 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
965 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
971 char *exclusion_string
;
973 command_ret
= lttng_enable_event_with_exclusions(handle
,
976 exclusion_list
? strutils_array_of_strings_len(exclusion_list
) : 0,
978 exclusion_string
= print_exclusions(exclusion_list
);
979 if (!exclusion_string
) {
980 PERROR("Cannot allocate exclusion_string");
984 if (command_ret
< 0) {
985 /* Turn ret to positive value to handle the positive error code */
986 switch (-command_ret
) {
987 case LTTNG_ERR_KERN_EVENT_EXIST
:
988 WARN("Kernel event %s%s already enabled (channel %s, session %s)",
991 print_channel_name(channel_name
), session_name
);
994 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
996 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
997 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
1000 print_channel_name(channel_name
),
1005 case LTTNG_ERR_SDT_PROBE_SEMAPHORE
:
1006 ERR("SDT probes %s guarded by semaphores are not supported (channel %s, session %s)",
1007 event_name
, print_channel_name(channel_name
),
1012 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
1014 lttng_strerror(command_ret
),
1015 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1016 ? print_raw_channel_name(channel_name
)
1017 : print_channel_name(channel_name
),
1022 error_holder
= command_ret
;
1025 case LTTNG_DOMAIN_KERNEL
:
1026 case LTTNG_DOMAIN_UST
:
1027 MSG("%s event %s%s created in channel %s",
1028 get_domain_str(dom
.type
),
1031 print_channel_name(channel_name
));
1033 case LTTNG_DOMAIN_JUL
:
1034 case LTTNG_DOMAIN_LOG4J
:
1035 case LTTNG_DOMAIN_PYTHON
:
1037 * Don't print the default channel
1038 * name for agent domains.
1040 MSG("%s event %s%s enabled",
1041 get_domain_str(dom
.type
),
1049 free(exclusion_string
);
1053 char *exclusion_string
;
1055 /* Filter present */
1058 command_ret
= lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
1060 exclusion_list
? strutils_array_of_strings_len(exclusion_list
) : 0,
1062 exclusion_string
= print_exclusions(exclusion_list
);
1063 if (!exclusion_string
) {
1064 PERROR("Cannot allocate exclusion_string");
1068 if (command_ret
< 0) {
1069 switch (-command_ret
) {
1070 case LTTNG_ERR_FILTER_EXIST
:
1071 WARN("Filter on event %s%s is already enabled"
1072 " (channel %s, session %s)",
1075 print_channel_name(channel_name
), session_name
);
1078 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
1080 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
1081 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
->name
,
1084 print_channel_name(channel_name
),
1085 session_name
, opt_filter
);
1090 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
->name
,
1092 lttng_strerror(command_ret
),
1093 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1094 ? print_raw_channel_name(channel_name
)
1095 : print_channel_name(channel_name
),
1096 session_name
, opt_filter
);
1100 error_holder
= command_ret
;
1103 MSG("Event %s%s: Filter '%s' successfully set",
1104 event_name
, exclusion_string
,
1107 free(exclusion_string
);
1118 ret
= mi_lttng_event(writer
, ev
, 1, handle
->domain
.type
);
1124 /* print exclusion */
1125 ret
= mi_print_exclusion(exclusion_list
);
1132 ret
= mi_lttng_writer_write_element_bool(writer
,
1133 mi_lttng_element_command_success
, success
);
1139 /* Close event element */
1140 ret
= mi_lttng_writer_close_element(writer
);
1148 event_name
= strtok(NULL
, ",");
1149 /* Reset warn, error and success */
1156 /* Close events element */
1157 ret
= mi_lttng_writer_close_element(writer
);
1170 lttng_destroy_handle(handle
);
1171 strutils_free_null_terminated_array_of_strings(exclusion_list
);
1172 lttng_userspace_probe_location_destroy(uprobe_loc
);
1174 /* Overwrite ret with error_holder if there was an actual error with
1175 * enabling an event.
1177 ret
= error_holder
? error_holder
: ret
;
1179 lttng_event_destroy(ev
);
1184 * Add event to trace session
1186 int cmd_enable_events(int argc
, const char **argv
)
1188 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
1189 static poptContext pc
;
1190 char *session_name
= NULL
;
1191 const char *leftover
= NULL
;
1192 int event_type
= -1;
1194 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1195 poptReadDefaultConfig(pc
, 0);
1197 /* Default event type */
1198 opt_event_type
= LTTNG_EVENT_ALL
;
1200 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1205 case OPT_TRACEPOINT
:
1206 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
1209 opt_event_type
= LTTNG_EVENT_PROBE
;
1211 case OPT_USERSPACE_PROBE
:
1212 opt_event_type
= LTTNG_EVENT_USERSPACE_PROBE
;
1215 opt_event_type
= LTTNG_EVENT_FUNCTION
;
1218 opt_event_type
= LTTNG_EVENT_SYSCALL
;
1224 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
1225 opt_loglevel
= poptGetOptArg(pc
);
1227 case OPT_LOGLEVEL_ONLY
:
1228 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
1229 opt_loglevel
= poptGetOptArg(pc
);
1231 case OPT_LIST_OPTIONS
:
1232 list_cmd_options(stdout
, long_options
);
1239 ret
= CMD_UNDEFINED
;
1243 /* Validate event type. Multiple event type are not supported. */
1244 if (event_type
== -1) {
1245 event_type
= opt_event_type
;
1247 if (event_type
!= opt_event_type
) {
1248 ERR("Multiple event type not supported.");
1255 ret
= print_missing_or_multiple_domains(
1256 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
+
1266 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1268 ret
= -LTTNG_ERR_NOMEM
;
1272 /* Open command element */
1273 ret
= mi_lttng_writer_command_open(writer
,
1274 mi_lttng_element_command_enable_event
);
1280 /* Open output element */
1281 ret
= mi_lttng_writer_open_element(writer
,
1282 mi_lttng_element_command_output
);
1289 opt_event_list
= (char*) poptGetArg(pc
);
1290 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
1291 ERR("Missing event name(s).\n");
1296 leftover
= poptGetArg(pc
);
1298 ERR("Unknown argument: %s", leftover
);
1303 if (!opt_session_name
) {
1304 session_name
= get_session_name();
1305 if (session_name
== NULL
) {
1306 command_ret
= CMD_ERROR
;
1311 session_name
= opt_session_name
;
1314 command_ret
= enable_events(session_name
);
1323 /* Close output element */
1324 ret
= mi_lttng_writer_close_element(writer
);
1330 ret
= mi_lttng_writer_write_element_bool(writer
,
1331 mi_lttng_element_command_success
, success
);
1337 /* Command element close */
1338 ret
= mi_lttng_writer_command_close(writer
);
1347 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1348 /* Preserve original error code */
1349 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
1352 if (opt_session_name
== NULL
) {
1356 /* Overwrite ret if an error occurred in enable_events */
1357 ret
= command_ret
? command_ret
: ret
;
1359 poptFreeContext(pc
);