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>
26 #include <common/mi-lttng.h>
28 #include <lttng/event-internal.h>
30 #include "../command.h"
31 #include "../loglevel.h"
32 #include "../uprobe.h"
34 #if (LTTNG_SYMBOL_NAME_LEN == 256)
35 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
38 static char *opt_event_list
;
39 static int opt_event_type
;
40 static const char *opt_loglevel
;
41 static int opt_loglevel_type
;
42 static int opt_kernel
;
43 static char *opt_session_name
;
44 static int opt_userspace
;
47 static int opt_python
;
48 static int opt_enable_all
;
49 static char *opt_probe
;
50 static char *opt_userspace_probe
;
51 static char *opt_function
;
52 static char *opt_channel_name
;
53 static char *opt_filter
;
54 static char *opt_exclude
;
56 #ifdef LTTNG_EMBED_HELP
57 static const char help_msg
[] =
58 #include <lttng-enable-event.1.h>
77 static struct lttng_handle
*handle
;
78 static struct mi_writer
*writer
;
80 static struct poptOption long_options
[] = {
81 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
82 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
83 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
84 {"all", 'a', POPT_ARG_VAL
, &opt_enable_all
, 1, 0, 0},
85 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
86 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
87 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
88 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
89 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
90 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
91 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TRACEPOINT
, 0, 0},
92 {"probe", 0, POPT_ARG_STRING
, &opt_probe
, OPT_PROBE
, 0, 0},
93 {"userspace-probe",0, POPT_ARG_STRING
, &opt_userspace_probe
, OPT_USERSPACE_PROBE
, 0, 0},
94 {"function", 0, POPT_ARG_STRING
, &opt_function
, OPT_FUNCTION
, 0, 0},
95 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_SYSCALL
, 0, 0},
96 {"loglevel", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL
, 0, 0},
97 {"loglevel-only", 0, POPT_ARG_STRING
, 0, OPT_LOGLEVEL_ONLY
, 0, 0},
98 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
99 {"filter", 'f', POPT_ARG_STRING
, &opt_filter
, OPT_FILTER
, 0, 0},
100 {"exclude", 'x', POPT_ARG_STRING
, &opt_exclude
, OPT_EXCLUDE
, 0, 0},
101 {0, 0, 0, 0, 0, 0, 0}
105 * Parse probe options.
107 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
109 int ret
= CMD_SUCCESS
;
112 #define S_HEX_LEN_SCANF_IS_A_BROKEN_API "18" /* 18 is (19 - 1) (\0 is extra) */
113 char name
[LTTNG_SYMBOL_NAME_LEN
];
120 /* Check for symbol+offset */
121 match
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
122 "[^'+']+%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", name
, s_hex
);
124 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
125 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
126 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
127 if (*s_hex
== '\0') {
128 ERR("Invalid probe offset %s", s_hex
);
132 ev
->attr
.probe
.offset
= strtoul(s_hex
, NULL
, 0);
133 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
134 ev
->attr
.probe
.addr
= 0;
138 /* Check for symbol */
139 if (isalpha(name
[0]) || name
[0] == '_') {
140 match
= sscanf(opt
, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
"s",
143 strncpy(ev
->attr
.probe
.symbol_name
, name
, LTTNG_SYMBOL_NAME_LEN
);
144 ev
->attr
.probe
.symbol_name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
145 DBG("probe symbol %s", ev
->attr
.probe
.symbol_name
);
146 ev
->attr
.probe
.offset
= 0;
147 DBG("probe offset %" PRIu64
, ev
->attr
.probe
.offset
);
148 ev
->attr
.probe
.addr
= 0;
153 /* Check for address */
154 match
= sscanf(opt
, "%" S_HEX_LEN_SCANF_IS_A_BROKEN_API
"s", s_hex
);
157 * Return an error if the first character of the tentative
158 * address is NULL or not a digit. It can be "0" if the address
159 * is in hexadecimal and can be 1 to 9 if it's in decimal.
161 if (*s_hex
== '\0' || !isdigit(*s_hex
)) {
162 ERR("Invalid probe description %s", s_hex
);
166 ev
->attr
.probe
.addr
= strtoul(s_hex
, NULL
, 0);
167 DBG("probe addr %" PRIu64
, ev
->attr
.probe
.addr
);
168 ev
->attr
.probe
.offset
= 0;
169 memset(ev
->attr
.probe
.symbol_name
, 0, LTTNG_SYMBOL_NAME_LEN
);
181 const char *print_channel_name(const char *name
)
183 return name
? : DEFAULT_CHANNEL_NAME
;
187 const char *print_raw_channel_name(const char *name
)
189 return name
? : "<default>";
193 * Mi print exlcusion list
196 int mi_print_exclusion(char **names
)
199 int count
= names
? strutils_array_of_strings_len(names
) : 0;
207 ret
= mi_lttng_writer_open_element(writer
, config_element_exclusions
);
212 for (i
= 0; i
< count
; i
++) {
213 ret
= mi_lttng_writer_write_element_string(writer
,
214 config_element_exclusion
, names
[i
]);
220 /* Close exclusions element */
221 ret
= mi_lttng_writer_close_element(writer
);
228 * Return allocated string for pretty-printing exclusion names.
231 char *print_exclusions(char **names
)
235 const char preamble
[] = " excluding ";
237 int count
= names
? strutils_array_of_strings_len(names
) : 0;
243 /* calculate total required length */
244 for (i
= 0; i
< count
; i
++) {
245 length
+= strlen(names
[i
]) + 4;
248 length
+= sizeof(preamble
);
249 ret
= zmalloc(length
);
253 strncpy(ret
, preamble
, length
);
254 for (i
= 0; i
< count
; i
++) {
256 strcat(ret
, names
[i
]);
258 if (i
!= count
- 1) {
267 int check_exclusion_subsets(const char *event_name
, const char *exclusion
)
271 const char *e
= event_name
;
272 const char *x
= exclusion
;
274 /* Scan both the excluder and the event letter by letter */
288 /* Event is a subset of the excluder */
289 ERR("Event %s: %s excludes all events from %s",
290 event_name
, exclusion
, event_name
);
296 * Reached the end of the event name before the
297 * end of the exclusion: this is valid.
319 WARN("Event %s: %s does not exclude any events from %s",
320 event_name
, exclusion
, event_name
);
327 int create_exclusion_list_and_validate(const char *event_name
,
328 const char *exclusions_arg
,
329 char ***exclusion_list
)
332 char **exclusions
= NULL
;
334 /* Event name must be a valid globbing pattern to allow exclusions. */
335 if (!strutils_is_star_glob_pattern(event_name
)) {
336 ERR("Event %s: Exclusions can only be used with a globbing pattern",
341 /* Split exclusions. */
342 exclusions
= strutils_split(exclusions_arg
, ',', true);
348 * If the event name is a star-at-end only globbing pattern,
349 * then we can validate the individual exclusions. Otherwise
350 * all exclusions are passed to the session daemon.
352 if (strutils_is_star_at_the_end_only_glob_pattern(event_name
)) {
353 char * const *exclusion
;
355 for (exclusion
= exclusions
; *exclusion
; exclusion
++) {
356 if (!strutils_is_star_glob_pattern(*exclusion
) ||
357 strutils_is_star_at_the_end_only_glob_pattern(*exclusion
)) {
358 ret
= check_exclusion_subsets(event_name
, *exclusion
);
366 *exclusion_list
= exclusions
;
372 strutils_free_null_terminated_array_of_strings(exclusions
);
378 static void warn_on_truncated_exclusion_names(char * const *exclusion_list
,
381 char * const *exclusion
;
383 for (exclusion
= exclusion_list
; *exclusion
; exclusion
++) {
384 if (strlen(*exclusion
) >= LTTNG_SYMBOL_NAME_LEN
) {
385 WARN("Event exclusion \"%s\" will be truncated",
393 * Enabling event using the lttng API.
394 * Note: in case of error only the last error code will be return.
396 static int enable_events(char *session_name
)
398 int ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
;
399 int error_holder
= CMD_SUCCESS
, warn
= 0, error
= 0, success
= 1;
400 char *event_name
, *channel_name
= NULL
;
401 struct lttng_event
*ev
;
402 struct lttng_domain dom
;
403 char **exclusion_list
= NULL
;
404 struct lttng_userspace_probe_location
*uprobe_loc
= NULL
;
406 memset(&dom
, 0, sizeof(dom
));
408 ev
= lttng_event_create();
416 WARN("Kernel loglevels are not supported.");
420 /* Create lttng domain */
422 dom
.type
= LTTNG_DOMAIN_KERNEL
;
423 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
424 } else if (opt_userspace
) {
425 dom
.type
= LTTNG_DOMAIN_UST
;
427 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
428 } else if (opt_jul
) {
429 dom
.type
= LTTNG_DOMAIN_JUL
;
431 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
432 } else if (opt_log4j
) {
433 dom
.type
= LTTNG_DOMAIN_LOG4J
;
435 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
436 } else if (opt_python
) {
437 dom
.type
= LTTNG_DOMAIN_PYTHON
;
439 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
441 /* Checked by the caller. */
447 case LTTNG_DOMAIN_KERNEL
:
448 case LTTNG_DOMAIN_JUL
:
449 case LTTNG_DOMAIN_LOG4J
:
450 case LTTNG_DOMAIN_PYTHON
:
451 ERR("Event name exclusions are not yet implemented for %s events",
452 get_domain_str(dom
.type
));
455 case LTTNG_DOMAIN_UST
:
456 /* Exclusions supported */
464 * Adding a filter to a probe, function or userspace-probe would be
465 * denied by the kernel tracer as it's not supported at the moment. We
466 * do an early check here to warn the user.
468 if (opt_filter
&& opt_kernel
) {
469 switch (opt_event_type
) {
470 case LTTNG_EVENT_ALL
:
471 case LTTNG_EVENT_TRACEPOINT
:
472 case LTTNG_EVENT_SYSCALL
:
474 case LTTNG_EVENT_PROBE
:
475 case LTTNG_EVENT_USERSPACE_PROBE
:
476 case LTTNG_EVENT_FUNCTION
:
477 ERR("Filter expressions are not supported for %s events",
478 get_event_type_str(opt_event_type
));
487 channel_name
= opt_channel_name
;
489 handle
= lttng_create_handle(session_name
, &dom
);
490 if (handle
== NULL
) {
497 /* Open a events element */
498 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
505 if (opt_enable_all
) {
506 /* Default setup for enable all */
508 ev
->type
= opt_event_type
;
509 strcpy(ev
->name
, "*");
510 /* kernel loglevels not implemented */
511 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
513 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
514 strcpy(ev
->name
, "*");
515 ev
->loglevel_type
= opt_loglevel_type
;
519 assert(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
522 enum lttng_loglevel loglevel
;
524 name_search_ret
= loglevel_name_to_value(opt_loglevel
, &loglevel
);
525 ev
->loglevel
= (int) loglevel
;
526 } else if (opt_jul
) {
527 enum lttng_loglevel_jul loglevel
;
529 name_search_ret
= loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
530 ev
->loglevel
= (int) loglevel
;
531 } else if (opt_log4j
) {
532 enum lttng_loglevel_log4j loglevel
;
534 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
, &loglevel
);
535 ev
->loglevel
= (int) loglevel
;
538 enum lttng_loglevel_python loglevel
;
540 name_search_ret
= loglevel_python_name_to_value(opt_loglevel
, &loglevel
);
541 ev
->loglevel
= (int) loglevel
;
544 if (name_search_ret
== -1) {
545 ERR("Unknown loglevel %s", opt_loglevel
);
546 ret
= -LTTNG_ERR_INVALID
;
550 assert(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
553 } else if (opt_jul
) {
554 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
555 } else if (opt_log4j
) {
556 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
557 } else if (opt_python
) {
558 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
564 ret
= create_exclusion_list_and_validate("*",
565 opt_exclude
, &exclusion_list
);
572 warn_on_truncated_exclusion_names(exclusion_list
,
576 ret
= lttng_enable_event_with_exclusions(handle
,
579 exclusion_list
? strutils_array_of_strings_len(exclusion_list
) : 0,
583 case LTTNG_ERR_KERN_EVENT_EXIST
:
584 WARN("Kernel events already enabled (channel %s, session %s)",
585 print_channel_name(channel_name
), session_name
);
588 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
590 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
591 ERR("Events: %s (channel %s, session %s)",
593 print_channel_name(channel_name
),
599 ERR("Events: %s (channel %s, session %s)",
601 ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
602 ? print_raw_channel_name(channel_name
)
603 : print_channel_name(channel_name
),
611 switch (opt_event_type
) {
612 case LTTNG_EVENT_TRACEPOINT
:
613 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
614 char *exclusion_string
= print_exclusions(exclusion_list
);
616 if (!exclusion_string
) {
617 PERROR("Cannot allocate exclusion_string");
621 MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
622 get_domain_str(dom
.type
),
624 print_channel_name(channel_name
),
626 free(exclusion_string
);
628 char *exclusion_string
= print_exclusions(exclusion_list
);
630 if (!exclusion_string
) {
631 PERROR("Cannot allocate exclusion_string");
635 MSG("All %s tracepoints%s are enabled in channel %s",
636 get_domain_str(dom
.type
),
638 print_channel_name(channel_name
));
639 free(exclusion_string
);
642 case LTTNG_EVENT_SYSCALL
:
644 MSG("All %s system calls are enabled in channel %s",
645 get_domain_str(dom
.type
),
646 print_channel_name(channel_name
));
649 case LTTNG_EVENT_ALL
:
650 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
651 char *exclusion_string
= print_exclusions(exclusion_list
);
653 if (!exclusion_string
) {
654 PERROR("Cannot allocate exclusion_string");
658 MSG("All %s events%s are enabled in channel %s for loglevel %s",
659 get_domain_str(dom
.type
),
661 print_channel_name(channel_name
),
663 free(exclusion_string
);
665 char *exclusion_string
= print_exclusions(exclusion_list
);
667 if (!exclusion_string
) {
668 PERROR("Cannot allocate exclusion_string");
672 MSG("All %s events%s are enabled in channel %s",
673 get_domain_str(dom
.type
),
675 print_channel_name(channel_name
));
676 free(exclusion_string
);
681 * We should not be here since lttng_enable_event should have
682 * failed on the event type.
689 command_ret
= lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
691 exclusion_list
? strutils_array_of_strings_len(exclusion_list
) : 0,
693 if (command_ret
< 0) {
694 switch (-command_ret
) {
695 case LTTNG_ERR_FILTER_EXIST
:
696 WARN("Filter on all events is already enabled"
697 " (channel %s, session %s)",
698 print_channel_name(channel_name
), session_name
);
701 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
703 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
704 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
706 print_channel_name(channel_name
),
707 session_name
, opt_filter
);
712 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
713 lttng_strerror(command_ret
),
714 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
715 ? print_raw_channel_name(channel_name
)
716 : print_channel_name(channel_name
),
717 session_name
, opt_filter
);
721 error_holder
= command_ret
;
724 MSG("Filter '%s' successfully set", opt_filter
);
729 /* The wildcard * is used for kernel and ust domain to
730 * represent ALL. We copy * in event name to force the wildcard use
733 * Note: this is strictly for semantic and printing while in
734 * machine interface mode.
736 strcpy(ev
->name
, "*");
738 /* If we reach here the events are enabled */
739 if (!error
&& !warn
) {
745 ret
= mi_lttng_event(writer
, ev
, 1, handle
->domain
.type
);
751 /* print exclusion */
752 ret
= mi_print_exclusion(exclusion_list
);
759 ret
= mi_lttng_writer_write_element_bool(writer
,
760 mi_lttng_element_command_success
, success
);
766 /* Close event element */
767 ret
= mi_lttng_writer_close_element(writer
);
777 /* Strip event list */
778 event_name
= strtok(opt_event_list
, ",");
779 while (event_name
!= NULL
) {
780 /* Copy name and type of the event */
781 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
782 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
783 ev
->type
= opt_event_type
;
785 /* Kernel tracer action */
787 DBG("Enabling kernel event %s for channel %s",
789 print_channel_name(channel_name
));
791 switch (opt_event_type
) {
792 case LTTNG_EVENT_ALL
: /* Enable tracepoints and syscalls */
793 /* If event name differs from *, select tracepoint. */
794 if (strcmp(ev
->name
, "*")) {
795 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
798 case LTTNG_EVENT_TRACEPOINT
:
800 case LTTNG_EVENT_PROBE
:
801 ret
= parse_probe_opts(ev
, opt_probe
);
803 ERR("Unable to parse probe options");
808 case LTTNG_EVENT_USERSPACE_PROBE
:
809 assert(ev
->type
== LTTNG_EVENT_USERSPACE_PROBE
);
811 ret
= parse_userspace_probe_opts(opt_userspace_probe
, &uprobe_loc
);
814 case CMD_UNSUPPORTED
:
816 * Error message describing
817 * what is not supported was
818 * printed in the function.
823 ERR("Unable to parse userspace probe options");
829 ret
= lttng_event_set_userspace_probe_location(ev
, uprobe_loc
);
831 WARN("Failed to set probe location on event");
836 /* Ownership of the uprobe location was transferred to the event. */
839 case LTTNG_EVENT_FUNCTION
:
840 ret
= parse_probe_opts(ev
, opt_function
);
842 ERR("Unable to parse function probe options");
847 case LTTNG_EVENT_SYSCALL
:
848 ev
->type
= LTTNG_EVENT_SYSCALL
;
855 /* kernel loglevels not implemented */
856 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
857 } else if (opt_userspace
) { /* User-space tracer action */
858 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name
,
859 print_channel_name(channel_name
), opt_loglevel
? : "<all>");
861 switch (opt_event_type
) {
862 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
864 case LTTNG_EVENT_TRACEPOINT
:
865 /* Copy name and type of the event */
866 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
867 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
868 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
870 case LTTNG_EVENT_PROBE
:
871 case LTTNG_EVENT_FUNCTION
:
872 case LTTNG_EVENT_SYSCALL
:
873 case LTTNG_EVENT_USERSPACE_PROBE
:
875 ERR("Event type not available for user-space tracing");
876 ret
= CMD_UNSUPPORTED
;
882 if (opt_event_type
!= LTTNG_EVENT_ALL
&& opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
883 ERR("Exclusion option can only be used with tracepoint events");
887 /* Free previously allocated items */
888 strutils_free_null_terminated_array_of_strings(
890 exclusion_list
= NULL
;
891 ret
= create_exclusion_list_and_validate(
892 event_name
, opt_exclude
,
899 warn_on_truncated_exclusion_names(
900 exclusion_list
, &warn
);
903 ev
->loglevel_type
= opt_loglevel_type
;
905 enum lttng_loglevel loglevel
;
906 const int name_search_ret
= loglevel_name_to_value(opt_loglevel
, &loglevel
);
908 if (name_search_ret
== -1) {
909 ERR("Unknown loglevel %s", opt_loglevel
);
910 ret
= -LTTNG_ERR_INVALID
;
914 ev
->loglevel
= (int) loglevel
;
918 } else if (opt_jul
|| opt_log4j
|| opt_python
) {
919 if (opt_event_type
!= LTTNG_EVENT_ALL
&&
920 opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
921 ERR("Event type not supported for domain.");
922 ret
= CMD_UNSUPPORTED
;
926 ev
->loglevel_type
= opt_loglevel_type
;
931 enum lttng_loglevel_jul loglevel
;
933 name_search_ret
= loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
934 ev
->loglevel
= (int) loglevel
;
935 } else if (opt_log4j
) {
936 enum lttng_loglevel_log4j loglevel
;
938 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
, &loglevel
);
939 ev
->loglevel
= (int) loglevel
;
942 enum lttng_loglevel_python loglevel
;
944 name_search_ret
= loglevel_python_name_to_value(opt_loglevel
, &loglevel
);
945 ev
->loglevel
= (int) loglevel
;
948 if (name_search_ret
) {
949 ERR("Unknown loglevel %s", opt_loglevel
);
950 ret
= -LTTNG_ERR_INVALID
;
955 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
956 } else if (opt_log4j
) {
957 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
958 } else if (opt_python
) {
959 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
962 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
963 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
964 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
970 char *exclusion_string
;
972 command_ret
= lttng_enable_event_with_exclusions(handle
,
975 exclusion_list
? strutils_array_of_strings_len(exclusion_list
) : 0,
977 exclusion_string
= print_exclusions(exclusion_list
);
978 if (!exclusion_string
) {
979 PERROR("Cannot allocate exclusion_string");
983 if (command_ret
< 0) {
984 /* Turn ret to positive value to handle the positive error code */
985 switch (-command_ret
) {
986 case LTTNG_ERR_KERN_EVENT_EXIST
:
987 WARN("Kernel event %s%s already enabled (channel %s, session %s)",
990 print_channel_name(channel_name
), session_name
);
993 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
995 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
996 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
999 print_channel_name(channel_name
),
1004 case LTTNG_ERR_SDT_PROBE_SEMAPHORE
:
1005 ERR("SDT probes %s guarded by semaphores are not supported (channel %s, session %s)",
1006 event_name
, print_channel_name(channel_name
),
1011 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
1013 lttng_strerror(command_ret
),
1014 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1015 ? print_raw_channel_name(channel_name
)
1016 : print_channel_name(channel_name
),
1021 error_holder
= command_ret
;
1024 case LTTNG_DOMAIN_KERNEL
:
1025 case LTTNG_DOMAIN_UST
:
1026 MSG("%s event %s%s created in channel %s",
1027 get_domain_str(dom
.type
),
1030 print_channel_name(channel_name
));
1032 case LTTNG_DOMAIN_JUL
:
1033 case LTTNG_DOMAIN_LOG4J
:
1034 case LTTNG_DOMAIN_PYTHON
:
1036 * Don't print the default channel
1037 * name for agent domains.
1039 MSG("%s event %s%s enabled",
1040 get_domain_str(dom
.type
),
1048 free(exclusion_string
);
1052 char *exclusion_string
;
1054 /* Filter present */
1057 command_ret
= lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
1059 exclusion_list
? strutils_array_of_strings_len(exclusion_list
) : 0,
1061 exclusion_string
= print_exclusions(exclusion_list
);
1062 if (!exclusion_string
) {
1063 PERROR("Cannot allocate exclusion_string");
1067 if (command_ret
< 0) {
1068 switch (-command_ret
) {
1069 case LTTNG_ERR_FILTER_EXIST
:
1070 WARN("Filter on event %s%s is already enabled"
1071 " (channel %s, session %s)",
1074 print_channel_name(channel_name
), session_name
);
1077 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
1079 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
1080 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
->name
,
1083 print_channel_name(channel_name
),
1084 session_name
, opt_filter
);
1089 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
->name
,
1091 lttng_strerror(command_ret
),
1092 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1093 ? print_raw_channel_name(channel_name
)
1094 : print_channel_name(channel_name
),
1095 session_name
, opt_filter
);
1099 error_holder
= command_ret
;
1102 MSG("Event %s%s: Filter '%s' successfully set",
1103 event_name
, exclusion_string
,
1106 free(exclusion_string
);
1117 ret
= mi_lttng_event(writer
, ev
, 1, handle
->domain
.type
);
1123 /* print exclusion */
1124 ret
= mi_print_exclusion(exclusion_list
);
1131 ret
= mi_lttng_writer_write_element_bool(writer
,
1132 mi_lttng_element_command_success
, success
);
1138 /* Close event element */
1139 ret
= mi_lttng_writer_close_element(writer
);
1147 event_name
= strtok(NULL
, ",");
1148 /* Reset warn, error and success */
1155 /* Close events element */
1156 ret
= mi_lttng_writer_close_element(writer
);
1169 lttng_destroy_handle(handle
);
1170 strutils_free_null_terminated_array_of_strings(exclusion_list
);
1171 lttng_userspace_probe_location_destroy(uprobe_loc
);
1173 /* Overwrite ret with error_holder if there was an actual error with
1174 * enabling an event.
1176 ret
= error_holder
? error_holder
: ret
;
1178 lttng_event_destroy(ev
);
1183 * Add event to trace session
1185 int cmd_enable_events(int argc
, const char **argv
)
1187 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
1188 static poptContext pc
;
1189 char *session_name
= NULL
;
1190 const char *leftover
= NULL
;
1191 int event_type
= -1;
1193 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1194 poptReadDefaultConfig(pc
, 0);
1196 /* Default event type */
1197 opt_event_type
= LTTNG_EVENT_ALL
;
1199 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1204 case OPT_TRACEPOINT
:
1205 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
1208 opt_event_type
= LTTNG_EVENT_PROBE
;
1210 case OPT_USERSPACE_PROBE
:
1211 opt_event_type
= LTTNG_EVENT_USERSPACE_PROBE
;
1214 opt_event_type
= LTTNG_EVENT_FUNCTION
;
1217 opt_event_type
= LTTNG_EVENT_SYSCALL
;
1223 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
1224 opt_loglevel
= poptGetOptArg(pc
);
1226 case OPT_LOGLEVEL_ONLY
:
1227 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
1228 opt_loglevel
= poptGetOptArg(pc
);
1230 case OPT_LIST_OPTIONS
:
1231 list_cmd_options(stdout
, long_options
);
1238 ret
= CMD_UNDEFINED
;
1242 /* Validate event type. Multiple event type are not supported. */
1243 if (event_type
== -1) {
1244 event_type
= opt_event_type
;
1246 if (event_type
!= opt_event_type
) {
1247 ERR("Multiple event type not supported.");
1254 ret
= print_missing_or_multiple_domains(
1255 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
+
1265 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1267 ret
= -LTTNG_ERR_NOMEM
;
1271 /* Open command element */
1272 ret
= mi_lttng_writer_command_open(writer
,
1273 mi_lttng_element_command_enable_event
);
1279 /* Open output element */
1280 ret
= mi_lttng_writer_open_element(writer
,
1281 mi_lttng_element_command_output
);
1288 opt_event_list
= (char*) poptGetArg(pc
);
1289 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
1290 ERR("Missing event name(s).\n");
1295 leftover
= poptGetArg(pc
);
1297 ERR("Unknown argument: %s", leftover
);
1302 if (!opt_session_name
) {
1303 session_name
= get_session_name();
1304 if (session_name
== NULL
) {
1305 command_ret
= CMD_ERROR
;
1310 session_name
= opt_session_name
;
1313 command_ret
= enable_events(session_name
);
1322 /* Close output element */
1323 ret
= mi_lttng_writer_close_element(writer
);
1329 ret
= mi_lttng_writer_write_element_bool(writer
,
1330 mi_lttng_element_command_success
, success
);
1336 /* Command element close */
1337 ret
= mi_lttng_writer_command_close(writer
);
1346 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1347 /* Preserve original error code */
1348 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
1351 if (opt_session_name
== NULL
) {
1355 /* Overwrite ret if an error occurred in enable_events */
1356 ret
= command_ret
? command_ret
: ret
;
1358 poptFreeContext(pc
);